@supernova-studio/client 0.54.25 → 0.54.27

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.
Files changed (15) hide show
  1. package/dist/index.d.mts +894 -296
  2. package/dist/index.d.ts +894 -296
  3. package/dist/index.js +63 -11
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +102 -50
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/src/api/dto/design-systems/design-system.ts +2 -2
  9. package/src/api/dto/workspaces/membership.ts +1 -1
  10. package/src/api/dto/workspaces/workspace.ts +2 -2
  11. package/src/api/endpoints/design-system-members.ts +24 -0
  12. package/src/api/endpoints/design-systems.ts +11 -12
  13. package/src/api/endpoints/index.ts +2 -0
  14. package/src/api/endpoints/workspace-members.ts +31 -0
  15. package/src/api/endpoints/workspaces.ts +11 -5
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- import { DocumentationGroupV1, DocumentationPageV1, DocumentationPageV2, DocumentationPageApproval, PageBlockDefinitionLayout as PageBlockDefinitionLayout$1, PageBlockV1, ElementGroup, DocumentationItemConfigurationV1, DocumentationItemConfigurationV2, Pipeline, GitOrganization, GitProject, GitRepository, GitBranch, ExtendedIntegration, IntegrationCredentials, SsoProvider, PageBlockItemUntypedValue, PageBlockDefinition, PageBlockItemRichTextEditorValue, PageBlockText, PageBlockDefinitionProperty, PageBlockDefinitionMultiRichTextPropertyStyle, PageBlockItemV2, PageBlockItemRichTextValue, PageBlockItemMultiRichTextValue, PageBlockItemTableValue, PageBlockItemEmbedValue, PageBlockDefinitionPropertyType, DocumentationPageSnapshot, ElementGroupSnapshot } from '@supernova-studio/model';
1
+ import { DocumentationGroupV1, DocumentationPageV1, DocumentationPageV2, DocumentationPageApproval, PageBlockDefinitionLayout as PageBlockDefinitionLayout$1, PageBlockV1, ElementGroup, DocumentationItemConfigurationV1, DocumentationItemConfigurationV2, Pipeline, GitOrganization, GitProject, GitRepository, GitBranch, ExtendedIntegration, IntegrationCredentials, SsoProvider, UpdateMembershipRolesInput, PageBlockItemUntypedValue, PageBlockDefinition, PageBlockItemRichTextEditorValue, PageBlockText, PageBlockDefinitionProperty, PageBlockDefinitionMultiRichTextPropertyStyle, PageBlockItemV2, PageBlockItemRichTextValue, PageBlockItemMultiRichTextValue, PageBlockItemTableValue, PageBlockItemEmbedValue, PageBlockDefinitionPropertyType, DocumentationPageSnapshot, ElementGroupSnapshot } from '@supernova-studio/model';
2
2
  import * as zod from 'zod';
3
- import { z, ZodSchema, ZodTypeDef } from 'zod';
3
+ import { z, ZodTypeDef, ZodSchema } from 'zod';
4
4
  import { RequestInit } from 'node-fetch';
5
5
  import * as Y from 'yjs';
6
6
  import { Schema } from 'prosemirror-model';
@@ -7298,7 +7298,7 @@ declare const DTODesignSystem: z.ZodObject<z.objectUtil.extendShape<Omit<{
7298
7298
  role?: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor" | undefined;
7299
7299
  }>;
7300
7300
  type DTODesignSystem = z.infer<typeof DTODesignSystem>;
7301
- declare const DTODesignSystemCreateResponse: z.ZodObject<{
7301
+ declare const DTODesignSystemResponse: z.ZodObject<{
7302
7302
  designSystem: z.ZodObject<z.objectUtil.extendShape<Omit<{
7303
7303
  id: z.ZodString;
7304
7304
  workspaceId: z.ZodString;
@@ -7459,7 +7459,7 @@ declare const DTODesignSystemCreateResponse: z.ZodObject<{
7459
7459
  role?: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor" | undefined;
7460
7460
  };
7461
7461
  }>;
7462
- type DTODesignSystemCreateResponse = z.infer<typeof DTODesignSystemCreateResponse>;
7462
+ type DTODesignSystemResponse = z.infer<typeof DTODesignSystemResponse>;
7463
7463
  declare const DTODesignSystemsListResponse: z.ZodObject<{
7464
7464
  designSystems: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<Omit<{
7465
7465
  id: z.ZodString;
@@ -42660,7 +42660,7 @@ declare const DTOWorkspaceCreateInput: z.ZodObject<{
42660
42660
  name: string;
42661
42661
  }>;
42662
42662
  type DTOWorkspaceCreateInput = z.infer<typeof DTOWorkspaceCreateInput>;
42663
- declare const DTOWorkspaceCreateResponse: z.ZodObject<{
42663
+ declare const DTOWorkspaceResponse: z.ZodObject<{
42664
42664
  workspace: z.ZodObject<{
42665
42665
  id: z.ZodString;
42666
42666
  profile: z.ZodObject<{
@@ -44358,7 +44358,7 @@ declare const DTOWorkspaceCreateResponse: z.ZodObject<{
44358
44358
  } | undefined;
44359
44359
  };
44360
44360
  }>;
44361
- type DTOWorkspaceCreateResponse = z.infer<typeof DTOWorkspaceCreateResponse>;
44361
+ type DTOWorkspaceResponse = z.infer<typeof DTOWorkspaceResponse>;
44362
44362
 
44363
44363
  declare function elementGroupsToDocumentationGroupDTOV2(groups: ElementGroup[], pages: (DocumentationPageV1 | DocumentationPageV2)[]): DTODocumentationGroupV2[];
44364
44364
  declare function elementGroupsToDocumentationGroupFixedConfigurationDTOV2(groups: ElementGroup[], pages: (DocumentationPageV1 | DocumentationPageV2)[]): DTODocumentationGroupV2[];
@@ -44419,295 +44419,6 @@ declare function gitBranchToDto(branch: GitBranch): DTOGitBranch;
44419
44419
  declare function integrationToDto(integration: ExtendedIntegration): DTOIntegration;
44420
44420
  declare function integrationCredentialToDto(credential: IntegrationCredentials): DTOIntegrationCredentials;
44421
44421
 
44422
- type RequestExecutorConfig = {
44423
- host: string;
44424
- accessToken?: string;
44425
- };
44426
- type RequestExecutorJSONRequest = Omit<RequestInit, "body"> & {
44427
- body?: object;
44428
- };
44429
- declare class RequestExecutor {
44430
- private readonly testServerConfig;
44431
- constructor(testServerConfig: RequestExecutorConfig);
44432
- json<O, I>(path: string, schema: ZodSchema<O, ZodTypeDef, I>, requestInit?: RequestExecutorJSONRequest): Promise<O>;
44433
- private fullUrl;
44434
- }
44435
-
44436
- declare class DesignSystemsEndpoint {
44437
- private readonly requestExecutor;
44438
- constructor(requestExecutor: RequestExecutor);
44439
- create(body: DTODesignSystemCreateInput): Promise<{
44440
- designSystem: {
44441
- id: string;
44442
- meta: {
44443
- name: string;
44444
- description?: string | undefined;
44445
- };
44446
- createdAt: Date;
44447
- updatedAt: Date;
44448
- sources: any[];
44449
- workspaceId: string;
44450
- docExporterId: string;
44451
- docSlug: string;
44452
- docSlugDeprecated: string;
44453
- isPublic: boolean;
44454
- isMultibrand: boolean;
44455
- basePrefixes: string[];
44456
- isApprovalFeatureEnabled: boolean;
44457
- approvalRequiredForPublishing: boolean;
44458
- accessMode: "Open" | "InviteOnly";
44459
- membersGenerated: boolean;
44460
- docUserSlug?: string | undefined;
44461
- docViewUrl?: string | undefined;
44462
- designSystemSwitcher?: {
44463
- isEnabled: boolean;
44464
- designSystemIds: string[];
44465
- } | undefined;
44466
- role?: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor" | undefined;
44467
- };
44468
- }>;
44469
- list(wsId: string): Promise<{
44470
- designSystems: {
44471
- id: string;
44472
- meta: {
44473
- name: string;
44474
- description?: string | undefined;
44475
- };
44476
- createdAt: Date;
44477
- updatedAt: Date;
44478
- sources: any[];
44479
- workspaceId: string;
44480
- docExporterId: string;
44481
- docSlug: string;
44482
- docSlugDeprecated: string;
44483
- isPublic: boolean;
44484
- isMultibrand: boolean;
44485
- basePrefixes: string[];
44486
- isApprovalFeatureEnabled: boolean;
44487
- approvalRequiredForPublishing: boolean;
44488
- accessMode: "Open" | "InviteOnly";
44489
- membersGenerated: boolean;
44490
- docUserSlug?: string | undefined;
44491
- docViewUrl?: string | undefined;
44492
- designSystemSwitcher?: {
44493
- isEnabled: boolean;
44494
- designSystemIds: string[];
44495
- } | undefined;
44496
- role?: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor" | undefined;
44497
- }[];
44498
- }>;
44499
- get(dsId: string): Promise<any>;
44500
- delete(dsId: string): Promise<any>;
44501
- editMembers(dsId: string, body: DTODesignSystemMembersUpdatePayload): Promise<{
44502
- ok: true;
44503
- }>;
44504
- }
44505
-
44506
- declare class UsersEndpoint {
44507
- private readonly requestExecutor;
44508
- constructor(requestExecutor: RequestExecutor);
44509
- getMe(): Promise<{
44510
- user: {
44511
- id: string;
44512
- profile: {
44513
- name: string;
44514
- avatar?: string | undefined;
44515
- nickname?: string | undefined;
44516
- };
44517
- email: string;
44518
- };
44519
- }>;
44520
- }
44521
-
44522
- declare class WorkspacesEndpoint {
44523
- private readonly requestExecutor;
44524
- constructor(requestExecutor: RequestExecutor);
44525
- create(body: DTOWorkspaceCreateInput): Promise<{
44526
- workspace: {
44527
- id: string;
44528
- profile: {
44529
- name: string;
44530
- color: string;
44531
- handle: string;
44532
- avatar?: string | undefined;
44533
- billingDetails?: {
44534
- address?: {
44535
- street1?: string | undefined;
44536
- street2?: string | undefined;
44537
- city?: string | undefined;
44538
- postal?: string | undefined;
44539
- country?: string | undefined;
44540
- state?: string | undefined;
44541
- } | undefined;
44542
- email?: string | undefined;
44543
- companyName?: string | undefined;
44544
- companyId?: string | undefined;
44545
- notes?: string | undefined;
44546
- vat?: string | undefined;
44547
- poNumber?: string | undefined;
44548
- } | undefined;
44549
- };
44550
- subscription: {
44551
- product: "free" | "team" | "company" | "enterprise";
44552
- planPriceId: string;
44553
- planInterval: "yearly" | "daily" | "monthly" | "weekly";
44554
- seats: number;
44555
- seatLimit: number;
44556
- status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
44557
- card?: {
44558
- cardId?: string | null | undefined;
44559
- last4?: string | null | undefined;
44560
- expiryMonth?: string | null | undefined;
44561
- expiryYear?: string | null | undefined;
44562
- brand?: string | null | undefined;
44563
- name?: string | null | undefined;
44564
- } | undefined;
44565
- amount?: number | null | undefined;
44566
- stripeProductDescription?: string | undefined;
44567
- isPricePerCreator?: boolean | undefined;
44568
- isTrial?: boolean | undefined;
44569
- legacyVersion?: string | undefined;
44570
- stripeProductFeatures?: string[] | undefined;
44571
- stripeProductAdditionalFeatures?: string[] | undefined;
44572
- stripeSubscriptionId?: string | null | undefined;
44573
- stripeCustomerId?: string | null | undefined;
44574
- subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
44575
- internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
44576
- featuresSummary?: {
44577
- designSystems: {
44578
- max: number;
44579
- errorMessage: string;
44580
- errorReason: string;
44581
- };
44582
- designSystemSources: {
44583
- max: number;
44584
- errorMessage: string;
44585
- errorReason: string;
44586
- noImportJobsErrorMessage: string;
44587
- noImportJobsErrorReason: string;
44588
- };
44589
- designSystemVersions: {
44590
- max: number;
44591
- errorMessage: string;
44592
- errorReason: string;
44593
- };
44594
- themes: {
44595
- max: number;
44596
- errorMessage: string;
44597
- errorReason: string;
44598
- };
44599
- brands: {
44600
- max: number;
44601
- errorMessage: string;
44602
- errorReason: string;
44603
- };
44604
- codegenSchedules: {
44605
- max: number;
44606
- errorMessage: string;
44607
- errorReason: string;
44608
- };
44609
- publicDocumentation: {
44610
- errorMessage: string;
44611
- errorReason: string;
44612
- enabled: boolean;
44613
- };
44614
- customDocumentationUrl: {
44615
- errorMessage: string;
44616
- errorReason: string;
44617
- enabled: boolean;
44618
- };
44619
- customDocumentationViewButton: {
44620
- errorMessage: string;
44621
- errorReason: string;
44622
- enabled: boolean;
44623
- };
44624
- designSystemSourceAutoImport: {
44625
- errorMessage: string;
44626
- errorReason: string;
44627
- enabled: boolean;
44628
- };
44629
- designSystemSlug: {
44630
- errorMessage: string;
44631
- errorReason: string;
44632
- enabled: boolean;
44633
- };
44634
- ipWhitelisting: {
44635
- errorMessage: string;
44636
- errorReason: string;
44637
- enabled: boolean;
44638
- };
44639
- npmRegistry: {
44640
- errorMessage: string;
44641
- errorReason: string;
44642
- enabled: boolean;
44643
- };
44644
- sso: {
44645
- errorMessage: string;
44646
- errorReason: string;
44647
- enabled: boolean;
44648
- };
44649
- workspacePaidSeats: {
44650
- max: number;
44651
- errorMessage: string;
44652
- errorReason: string;
44653
- };
44654
- workspaceViewers: {
44655
- max: number;
44656
- errorMessage: string;
44657
- errorReason: string;
44658
- };
44659
- customDocumentationExporter: {
44660
- errorMessage: string;
44661
- errorReason: string;
44662
- enabled: boolean;
44663
- };
44664
- protectedPages: {
44665
- errorMessage: string;
44666
- errorReason: string;
44667
- enabled: boolean;
44668
- };
44669
- approvals: {
44670
- errorMessage: string;
44671
- errorReason: string;
44672
- enabled: boolean;
44673
- };
44674
- selectivePublishing: {
44675
- errorMessage: string;
44676
- errorReason: string;
44677
- enabled: boolean;
44678
- };
44679
- designSystemAccessModes: {
44680
- errorMessage: string;
44681
- errorReason: string;
44682
- enabled: boolean;
44683
- };
44684
- } | undefined;
44685
- stripeSubscriptionMainItemId?: string | undefined;
44686
- currentPeriodStart?: string | undefined;
44687
- currentPeriodEnd?: string | undefined;
44688
- subscriptionStatusUpdatedAt?: string | undefined;
44689
- cancelAt?: string | null | undefined;
44690
- billingType?: "Auto" | "Invoice" | undefined;
44691
- daysUntilDue?: number | undefined;
44692
- };
44693
- npmRegistry?: {
44694
- enabledScopes: string[];
44695
- bypassProxy: boolean;
44696
- registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
44697
- authType: "Custom" | "None" | "Basic" | "Bearer";
44698
- registryUrl: string;
44699
- proxyUrl: string;
44700
- customRegistryUrl?: string | undefined;
44701
- accessToken?: string | undefined;
44702
- username?: string | undefined;
44703
- password?: string | undefined;
44704
- } | undefined;
44705
- };
44706
- }>;
44707
- delete(workspaceId: string): Promise<any>;
44708
- invite(workspaceId: string, body: DTOWorkspaceInvitationsListInput): Promise<any>;
44709
- }
44710
-
44711
44422
  declare const DTOCreateBrandInput: z.ZodObject<{
44712
44423
  persistentId: z.ZodString;
44713
44424
  meta: z.ZodObject<{
@@ -47112,6 +46823,147 @@ declare const DTOWorkspaceIntegrationGetGitObjectsInput: z.ZodObject<{
47112
46823
  }>;
47113
46824
  type DTOWorkspaceIntegrationGetGitObjectsInput = z.infer<typeof DTOWorkspaceIntegrationGetGitObjectsInput>;
47114
46825
 
46826
+ type RequestExecutorConfig = {
46827
+ host: string;
46828
+ accessToken?: string;
46829
+ };
46830
+ type RequestExecutorJSONRequest = Omit<RequestInit, "body"> & {
46831
+ body?: object;
46832
+ };
46833
+ declare class RequestExecutor {
46834
+ private readonly testServerConfig;
46835
+ constructor(testServerConfig: RequestExecutorConfig);
46836
+ json<O, I>(path: string, schema: ZodSchema<O, ZodTypeDef, I>, requestInit?: RequestExecutorJSONRequest): Promise<O>;
46837
+ private fullUrl;
46838
+ }
46839
+
46840
+ declare class DesignSystemMembersEndpoint {
46841
+ private readonly requestExecutor;
46842
+ constructor(requestExecutor: RequestExecutor);
46843
+ list(dsId: string): Promise<{
46844
+ members: {
46845
+ userId: string;
46846
+ }[];
46847
+ }>;
46848
+ update(dsId: string, body: DTODesignSystemMembersUpdatePayload): Promise<{
46849
+ ok: true;
46850
+ }>;
46851
+ }
46852
+
46853
+ declare class DesignSystemsEndpoint {
46854
+ private readonly requestExecutor;
46855
+ members: DesignSystemMembersEndpoint;
46856
+ constructor(requestExecutor: RequestExecutor);
46857
+ create(body: DTODesignSystemCreateInput): Promise<{
46858
+ designSystem: {
46859
+ id: string;
46860
+ meta: {
46861
+ name: string;
46862
+ description?: string | undefined;
46863
+ };
46864
+ createdAt: Date;
46865
+ updatedAt: Date;
46866
+ sources: any[];
46867
+ workspaceId: string;
46868
+ docExporterId: string;
46869
+ docSlug: string;
46870
+ docSlugDeprecated: string;
46871
+ isPublic: boolean;
46872
+ isMultibrand: boolean;
46873
+ basePrefixes: string[];
46874
+ isApprovalFeatureEnabled: boolean;
46875
+ approvalRequiredForPublishing: boolean;
46876
+ accessMode: "Open" | "InviteOnly";
46877
+ membersGenerated: boolean;
46878
+ docUserSlug?: string | undefined;
46879
+ docViewUrl?: string | undefined;
46880
+ designSystemSwitcher?: {
46881
+ isEnabled: boolean;
46882
+ designSystemIds: string[];
46883
+ } | undefined;
46884
+ role?: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor" | undefined;
46885
+ };
46886
+ }>;
46887
+ list(wsId: string): Promise<{
46888
+ designSystems: {
46889
+ id: string;
46890
+ meta: {
46891
+ name: string;
46892
+ description?: string | undefined;
46893
+ };
46894
+ createdAt: Date;
46895
+ updatedAt: Date;
46896
+ sources: any[];
46897
+ workspaceId: string;
46898
+ docExporterId: string;
46899
+ docSlug: string;
46900
+ docSlugDeprecated: string;
46901
+ isPublic: boolean;
46902
+ isMultibrand: boolean;
46903
+ basePrefixes: string[];
46904
+ isApprovalFeatureEnabled: boolean;
46905
+ approvalRequiredForPublishing: boolean;
46906
+ accessMode: "Open" | "InviteOnly";
46907
+ membersGenerated: boolean;
46908
+ docUserSlug?: string | undefined;
46909
+ docViewUrl?: string | undefined;
46910
+ designSystemSwitcher?: {
46911
+ isEnabled: boolean;
46912
+ designSystemIds: string[];
46913
+ } | undefined;
46914
+ role?: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor" | undefined;
46915
+ }[];
46916
+ }>;
46917
+ get(dsId: string): Promise<any>;
46918
+ delete(dsId: string): Promise<any>;
46919
+ update(dsId: string, body: DTODesignSystemUpdateInput): Promise<{
46920
+ designSystem: {
46921
+ id: string;
46922
+ meta: {
46923
+ name: string;
46924
+ description?: string | undefined;
46925
+ };
46926
+ createdAt: Date;
46927
+ updatedAt: Date;
46928
+ sources: any[];
46929
+ workspaceId: string;
46930
+ docExporterId: string;
46931
+ docSlug: string;
46932
+ docSlugDeprecated: string;
46933
+ isPublic: boolean;
46934
+ isMultibrand: boolean;
46935
+ basePrefixes: string[];
46936
+ isApprovalFeatureEnabled: boolean;
46937
+ approvalRequiredForPublishing: boolean;
46938
+ accessMode: "Open" | "InviteOnly";
46939
+ membersGenerated: boolean;
46940
+ docUserSlug?: string | undefined;
46941
+ docViewUrl?: string | undefined;
46942
+ designSystemSwitcher?: {
46943
+ isEnabled: boolean;
46944
+ designSystemIds: string[];
46945
+ } | undefined;
46946
+ role?: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor" | undefined;
46947
+ };
46948
+ }>;
46949
+ }
46950
+
46951
+ declare class UsersEndpoint {
46952
+ private readonly requestExecutor;
46953
+ constructor(requestExecutor: RequestExecutor);
46954
+ getMe(): Promise<{
46955
+ user: {
46956
+ id: string;
46957
+ profile: {
46958
+ name: string;
46959
+ avatar?: string | undefined;
46960
+ nickname?: string | undefined;
46961
+ };
46962
+ email: string;
46963
+ };
46964
+ }>;
46965
+ }
46966
+
47115
46967
  type RequestExecutorErrorType = "ServerError" | "ResponseParsingError";
47116
46968
  declare class RequestExecutorError extends Error {
47117
46969
  static serverError(endpoint: string, status: number, bodyText: string): RequestExecutorError;
@@ -47120,6 +46972,752 @@ declare class RequestExecutorError extends Error {
47120
46972
  private constructor();
47121
46973
  }
47122
46974
 
46975
+ declare class WorkspaceMembersEndpoint {
46976
+ private readonly requestExecutor;
46977
+ constructor(requestExecutor: RequestExecutor);
46978
+ list(workspaceId: string): Promise<{
46979
+ membership: {
46980
+ role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
46981
+ workspace: {
46982
+ id: string;
46983
+ profile: {
46984
+ name: string;
46985
+ color: string;
46986
+ handle: string;
46987
+ avatar?: string | undefined;
46988
+ billingDetails?: {
46989
+ address?: {
46990
+ street1?: string | undefined;
46991
+ street2?: string | undefined;
46992
+ city?: string | undefined;
46993
+ postal?: string | undefined;
46994
+ country?: string | undefined;
46995
+ state?: string | undefined;
46996
+ } | undefined;
46997
+ email?: string | undefined;
46998
+ companyName?: string | undefined;
46999
+ companyId?: string | undefined;
47000
+ notes?: string | undefined;
47001
+ vat?: string | undefined;
47002
+ poNumber?: string | undefined;
47003
+ } | undefined;
47004
+ };
47005
+ subscription: {
47006
+ product: "free" | "team" | "company" | "enterprise";
47007
+ planPriceId: string;
47008
+ planInterval: "yearly" | "daily" | "monthly" | "weekly";
47009
+ seats: number;
47010
+ seatLimit: number;
47011
+ status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47012
+ card?: {
47013
+ cardId?: string | null | undefined;
47014
+ last4?: string | null | undefined;
47015
+ expiryMonth?: string | null | undefined;
47016
+ expiryYear?: string | null | undefined;
47017
+ brand?: string | null | undefined;
47018
+ name?: string | null | undefined;
47019
+ } | undefined;
47020
+ amount?: number | null | undefined;
47021
+ stripeProductDescription?: string | undefined;
47022
+ isPricePerCreator?: boolean | undefined;
47023
+ isTrial?: boolean | undefined;
47024
+ legacyVersion?: string | undefined;
47025
+ stripeProductFeatures?: string[] | undefined;
47026
+ stripeProductAdditionalFeatures?: string[] | undefined;
47027
+ stripeSubscriptionId?: string | null | undefined;
47028
+ stripeCustomerId?: string | null | undefined;
47029
+ subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
47030
+ internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47031
+ featuresSummary?: {
47032
+ designSystems: {
47033
+ max: number;
47034
+ errorMessage: string;
47035
+ errorReason: string;
47036
+ };
47037
+ designSystemSources: {
47038
+ max: number;
47039
+ errorMessage: string;
47040
+ errorReason: string;
47041
+ noImportJobsErrorMessage: string;
47042
+ noImportJobsErrorReason: string;
47043
+ };
47044
+ designSystemVersions: {
47045
+ max: number;
47046
+ errorMessage: string;
47047
+ errorReason: string;
47048
+ };
47049
+ themes: {
47050
+ max: number;
47051
+ errorMessage: string;
47052
+ errorReason: string;
47053
+ };
47054
+ brands: {
47055
+ max: number;
47056
+ errorMessage: string;
47057
+ errorReason: string;
47058
+ };
47059
+ codegenSchedules: {
47060
+ max: number;
47061
+ errorMessage: string;
47062
+ errorReason: string;
47063
+ };
47064
+ publicDocumentation: {
47065
+ errorMessage: string;
47066
+ errorReason: string;
47067
+ enabled: boolean;
47068
+ };
47069
+ customDocumentationUrl: {
47070
+ errorMessage: string;
47071
+ errorReason: string;
47072
+ enabled: boolean;
47073
+ };
47074
+ customDocumentationViewButton: {
47075
+ errorMessage: string;
47076
+ errorReason: string;
47077
+ enabled: boolean;
47078
+ };
47079
+ designSystemSourceAutoImport: {
47080
+ errorMessage: string;
47081
+ errorReason: string;
47082
+ enabled: boolean;
47083
+ };
47084
+ designSystemSlug: {
47085
+ errorMessage: string;
47086
+ errorReason: string;
47087
+ enabled: boolean;
47088
+ };
47089
+ ipWhitelisting: {
47090
+ errorMessage: string;
47091
+ errorReason: string;
47092
+ enabled: boolean;
47093
+ };
47094
+ npmRegistry: {
47095
+ errorMessage: string;
47096
+ errorReason: string;
47097
+ enabled: boolean;
47098
+ };
47099
+ sso: {
47100
+ errorMessage: string;
47101
+ errorReason: string;
47102
+ enabled: boolean;
47103
+ };
47104
+ workspacePaidSeats: {
47105
+ max: number;
47106
+ errorMessage: string;
47107
+ errorReason: string;
47108
+ };
47109
+ workspaceViewers: {
47110
+ max: number;
47111
+ errorMessage: string;
47112
+ errorReason: string;
47113
+ };
47114
+ customDocumentationExporter: {
47115
+ errorMessage: string;
47116
+ errorReason: string;
47117
+ enabled: boolean;
47118
+ };
47119
+ protectedPages: {
47120
+ errorMessage: string;
47121
+ errorReason: string;
47122
+ enabled: boolean;
47123
+ };
47124
+ approvals: {
47125
+ errorMessage: string;
47126
+ errorReason: string;
47127
+ enabled: boolean;
47128
+ };
47129
+ selectivePublishing: {
47130
+ errorMessage: string;
47131
+ errorReason: string;
47132
+ enabled: boolean;
47133
+ };
47134
+ designSystemAccessModes: {
47135
+ errorMessage: string;
47136
+ errorReason: string;
47137
+ enabled: boolean;
47138
+ };
47139
+ } | undefined;
47140
+ stripeSubscriptionMainItemId?: string | undefined;
47141
+ currentPeriodStart?: string | undefined;
47142
+ currentPeriodEnd?: string | undefined;
47143
+ subscriptionStatusUpdatedAt?: string | undefined;
47144
+ cancelAt?: string | null | undefined;
47145
+ billingType?: "Auto" | "Invoice" | undefined;
47146
+ daysUntilDue?: number | undefined;
47147
+ };
47148
+ npmRegistry?: {
47149
+ enabledScopes: string[];
47150
+ bypassProxy: boolean;
47151
+ registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
47152
+ authType: "Custom" | "None" | "Basic" | "Bearer";
47153
+ registryUrl: string;
47154
+ proxyUrl: string;
47155
+ customRegistryUrl?: string | undefined;
47156
+ accessToken?: string | undefined;
47157
+ username?: string | undefined;
47158
+ password?: string | undefined;
47159
+ } | undefined;
47160
+ };
47161
+ effectiveRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
47162
+ }[];
47163
+ }>;
47164
+ update(workspaceId: string, body: UpdateMembershipRolesInput): Promise<{
47165
+ workspace: {
47166
+ id: string;
47167
+ profile: {
47168
+ name: string;
47169
+ color: string;
47170
+ handle: string;
47171
+ avatar?: string | undefined;
47172
+ billingDetails?: {
47173
+ address?: {
47174
+ street1?: string | undefined;
47175
+ street2?: string | undefined;
47176
+ city?: string | undefined;
47177
+ postal?: string | undefined;
47178
+ country?: string | undefined;
47179
+ state?: string | undefined;
47180
+ } | undefined;
47181
+ email?: string | undefined;
47182
+ companyName?: string | undefined;
47183
+ companyId?: string | undefined;
47184
+ notes?: string | undefined;
47185
+ vat?: string | undefined;
47186
+ poNumber?: string | undefined;
47187
+ } | undefined;
47188
+ };
47189
+ subscription: {
47190
+ product: "free" | "team" | "company" | "enterprise";
47191
+ planPriceId: string;
47192
+ planInterval: "yearly" | "daily" | "monthly" | "weekly";
47193
+ seats: number;
47194
+ seatLimit: number;
47195
+ status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47196
+ card?: {
47197
+ cardId?: string | null | undefined;
47198
+ last4?: string | null | undefined;
47199
+ expiryMonth?: string | null | undefined;
47200
+ expiryYear?: string | null | undefined;
47201
+ brand?: string | null | undefined;
47202
+ name?: string | null | undefined;
47203
+ } | undefined;
47204
+ amount?: number | null | undefined;
47205
+ stripeProductDescription?: string | undefined;
47206
+ isPricePerCreator?: boolean | undefined;
47207
+ isTrial?: boolean | undefined;
47208
+ legacyVersion?: string | undefined;
47209
+ stripeProductFeatures?: string[] | undefined;
47210
+ stripeProductAdditionalFeatures?: string[] | undefined;
47211
+ stripeSubscriptionId?: string | null | undefined;
47212
+ stripeCustomerId?: string | null | undefined;
47213
+ subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
47214
+ internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47215
+ featuresSummary?: {
47216
+ designSystems: {
47217
+ max: number;
47218
+ errorMessage: string;
47219
+ errorReason: string;
47220
+ };
47221
+ designSystemSources: {
47222
+ max: number;
47223
+ errorMessage: string;
47224
+ errorReason: string;
47225
+ noImportJobsErrorMessage: string;
47226
+ noImportJobsErrorReason: string;
47227
+ };
47228
+ designSystemVersions: {
47229
+ max: number;
47230
+ errorMessage: string;
47231
+ errorReason: string;
47232
+ };
47233
+ themes: {
47234
+ max: number;
47235
+ errorMessage: string;
47236
+ errorReason: string;
47237
+ };
47238
+ brands: {
47239
+ max: number;
47240
+ errorMessage: string;
47241
+ errorReason: string;
47242
+ };
47243
+ codegenSchedules: {
47244
+ max: number;
47245
+ errorMessage: string;
47246
+ errorReason: string;
47247
+ };
47248
+ publicDocumentation: {
47249
+ errorMessage: string;
47250
+ errorReason: string;
47251
+ enabled: boolean;
47252
+ };
47253
+ customDocumentationUrl: {
47254
+ errorMessage: string;
47255
+ errorReason: string;
47256
+ enabled: boolean;
47257
+ };
47258
+ customDocumentationViewButton: {
47259
+ errorMessage: string;
47260
+ errorReason: string;
47261
+ enabled: boolean;
47262
+ };
47263
+ designSystemSourceAutoImport: {
47264
+ errorMessage: string;
47265
+ errorReason: string;
47266
+ enabled: boolean;
47267
+ };
47268
+ designSystemSlug: {
47269
+ errorMessage: string;
47270
+ errorReason: string;
47271
+ enabled: boolean;
47272
+ };
47273
+ ipWhitelisting: {
47274
+ errorMessage: string;
47275
+ errorReason: string;
47276
+ enabled: boolean;
47277
+ };
47278
+ npmRegistry: {
47279
+ errorMessage: string;
47280
+ errorReason: string;
47281
+ enabled: boolean;
47282
+ };
47283
+ sso: {
47284
+ errorMessage: string;
47285
+ errorReason: string;
47286
+ enabled: boolean;
47287
+ };
47288
+ workspacePaidSeats: {
47289
+ max: number;
47290
+ errorMessage: string;
47291
+ errorReason: string;
47292
+ };
47293
+ workspaceViewers: {
47294
+ max: number;
47295
+ errorMessage: string;
47296
+ errorReason: string;
47297
+ };
47298
+ customDocumentationExporter: {
47299
+ errorMessage: string;
47300
+ errorReason: string;
47301
+ enabled: boolean;
47302
+ };
47303
+ protectedPages: {
47304
+ errorMessage: string;
47305
+ errorReason: string;
47306
+ enabled: boolean;
47307
+ };
47308
+ approvals: {
47309
+ errorMessage: string;
47310
+ errorReason: string;
47311
+ enabled: boolean;
47312
+ };
47313
+ selectivePublishing: {
47314
+ errorMessage: string;
47315
+ errorReason: string;
47316
+ enabled: boolean;
47317
+ };
47318
+ designSystemAccessModes: {
47319
+ errorMessage: string;
47320
+ errorReason: string;
47321
+ enabled: boolean;
47322
+ };
47323
+ } | undefined;
47324
+ stripeSubscriptionMainItemId?: string | undefined;
47325
+ currentPeriodStart?: string | undefined;
47326
+ currentPeriodEnd?: string | undefined;
47327
+ subscriptionStatusUpdatedAt?: string | undefined;
47328
+ cancelAt?: string | null | undefined;
47329
+ billingType?: "Auto" | "Invoice" | undefined;
47330
+ daysUntilDue?: number | undefined;
47331
+ };
47332
+ npmRegistry?: {
47333
+ enabledScopes: string[];
47334
+ bypassProxy: boolean;
47335
+ registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
47336
+ authType: "Custom" | "None" | "Basic" | "Bearer";
47337
+ registryUrl: string;
47338
+ proxyUrl: string;
47339
+ customRegistryUrl?: string | undefined;
47340
+ accessToken?: string | undefined;
47341
+ username?: string | undefined;
47342
+ password?: string | undefined;
47343
+ } | undefined;
47344
+ };
47345
+ }>;
47346
+ invite(workspaceId: string, body: DTOWorkspaceInvitationsListInput): Promise<any>;
47347
+ delete(workspaceId: string, userId: string): Promise<{
47348
+ workspace: {
47349
+ id: string;
47350
+ profile: {
47351
+ name: string;
47352
+ color: string;
47353
+ handle: string;
47354
+ avatar?: string | undefined;
47355
+ billingDetails?: {
47356
+ address?: {
47357
+ street1?: string | undefined;
47358
+ street2?: string | undefined;
47359
+ city?: string | undefined;
47360
+ postal?: string | undefined;
47361
+ country?: string | undefined;
47362
+ state?: string | undefined;
47363
+ } | undefined;
47364
+ email?: string | undefined;
47365
+ companyName?: string | undefined;
47366
+ companyId?: string | undefined;
47367
+ notes?: string | undefined;
47368
+ vat?: string | undefined;
47369
+ poNumber?: string | undefined;
47370
+ } | undefined;
47371
+ };
47372
+ subscription: {
47373
+ product: "free" | "team" | "company" | "enterprise";
47374
+ planPriceId: string;
47375
+ planInterval: "yearly" | "daily" | "monthly" | "weekly";
47376
+ seats: number;
47377
+ seatLimit: number;
47378
+ status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47379
+ card?: {
47380
+ cardId?: string | null | undefined;
47381
+ last4?: string | null | undefined;
47382
+ expiryMonth?: string | null | undefined;
47383
+ expiryYear?: string | null | undefined;
47384
+ brand?: string | null | undefined;
47385
+ name?: string | null | undefined;
47386
+ } | undefined;
47387
+ amount?: number | null | undefined;
47388
+ stripeProductDescription?: string | undefined;
47389
+ isPricePerCreator?: boolean | undefined;
47390
+ isTrial?: boolean | undefined;
47391
+ legacyVersion?: string | undefined;
47392
+ stripeProductFeatures?: string[] | undefined;
47393
+ stripeProductAdditionalFeatures?: string[] | undefined;
47394
+ stripeSubscriptionId?: string | null | undefined;
47395
+ stripeCustomerId?: string | null | undefined;
47396
+ subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
47397
+ internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47398
+ featuresSummary?: {
47399
+ designSystems: {
47400
+ max: number;
47401
+ errorMessage: string;
47402
+ errorReason: string;
47403
+ };
47404
+ designSystemSources: {
47405
+ max: number;
47406
+ errorMessage: string;
47407
+ errorReason: string;
47408
+ noImportJobsErrorMessage: string;
47409
+ noImportJobsErrorReason: string;
47410
+ };
47411
+ designSystemVersions: {
47412
+ max: number;
47413
+ errorMessage: string;
47414
+ errorReason: string;
47415
+ };
47416
+ themes: {
47417
+ max: number;
47418
+ errorMessage: string;
47419
+ errorReason: string;
47420
+ };
47421
+ brands: {
47422
+ max: number;
47423
+ errorMessage: string;
47424
+ errorReason: string;
47425
+ };
47426
+ codegenSchedules: {
47427
+ max: number;
47428
+ errorMessage: string;
47429
+ errorReason: string;
47430
+ };
47431
+ publicDocumentation: {
47432
+ errorMessage: string;
47433
+ errorReason: string;
47434
+ enabled: boolean;
47435
+ };
47436
+ customDocumentationUrl: {
47437
+ errorMessage: string;
47438
+ errorReason: string;
47439
+ enabled: boolean;
47440
+ };
47441
+ customDocumentationViewButton: {
47442
+ errorMessage: string;
47443
+ errorReason: string;
47444
+ enabled: boolean;
47445
+ };
47446
+ designSystemSourceAutoImport: {
47447
+ errorMessage: string;
47448
+ errorReason: string;
47449
+ enabled: boolean;
47450
+ };
47451
+ designSystemSlug: {
47452
+ errorMessage: string;
47453
+ errorReason: string;
47454
+ enabled: boolean;
47455
+ };
47456
+ ipWhitelisting: {
47457
+ errorMessage: string;
47458
+ errorReason: string;
47459
+ enabled: boolean;
47460
+ };
47461
+ npmRegistry: {
47462
+ errorMessage: string;
47463
+ errorReason: string;
47464
+ enabled: boolean;
47465
+ };
47466
+ sso: {
47467
+ errorMessage: string;
47468
+ errorReason: string;
47469
+ enabled: boolean;
47470
+ };
47471
+ workspacePaidSeats: {
47472
+ max: number;
47473
+ errorMessage: string;
47474
+ errorReason: string;
47475
+ };
47476
+ workspaceViewers: {
47477
+ max: number;
47478
+ errorMessage: string;
47479
+ errorReason: string;
47480
+ };
47481
+ customDocumentationExporter: {
47482
+ errorMessage: string;
47483
+ errorReason: string;
47484
+ enabled: boolean;
47485
+ };
47486
+ protectedPages: {
47487
+ errorMessage: string;
47488
+ errorReason: string;
47489
+ enabled: boolean;
47490
+ };
47491
+ approvals: {
47492
+ errorMessage: string;
47493
+ errorReason: string;
47494
+ enabled: boolean;
47495
+ };
47496
+ selectivePublishing: {
47497
+ errorMessage: string;
47498
+ errorReason: string;
47499
+ enabled: boolean;
47500
+ };
47501
+ designSystemAccessModes: {
47502
+ errorMessage: string;
47503
+ errorReason: string;
47504
+ enabled: boolean;
47505
+ };
47506
+ } | undefined;
47507
+ stripeSubscriptionMainItemId?: string | undefined;
47508
+ currentPeriodStart?: string | undefined;
47509
+ currentPeriodEnd?: string | undefined;
47510
+ subscriptionStatusUpdatedAt?: string | undefined;
47511
+ cancelAt?: string | null | undefined;
47512
+ billingType?: "Auto" | "Invoice" | undefined;
47513
+ daysUntilDue?: number | undefined;
47514
+ };
47515
+ npmRegistry?: {
47516
+ enabledScopes: string[];
47517
+ bypassProxy: boolean;
47518
+ registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
47519
+ authType: "Custom" | "None" | "Basic" | "Bearer";
47520
+ registryUrl: string;
47521
+ proxyUrl: string;
47522
+ customRegistryUrl?: string | undefined;
47523
+ accessToken?: string | undefined;
47524
+ username?: string | undefined;
47525
+ password?: string | undefined;
47526
+ } | undefined;
47527
+ };
47528
+ }>;
47529
+ }
47530
+
47531
+ declare class WorkspacesEndpoint {
47532
+ private readonly requestExecutor;
47533
+ members: WorkspaceMembersEndpoint;
47534
+ constructor(requestExecutor: RequestExecutor);
47535
+ create(body: DTOWorkspaceCreateInput): Promise<{
47536
+ workspace: {
47537
+ id: string;
47538
+ profile: {
47539
+ name: string;
47540
+ color: string;
47541
+ handle: string;
47542
+ avatar?: string | undefined;
47543
+ billingDetails?: {
47544
+ address?: {
47545
+ street1?: string | undefined;
47546
+ street2?: string | undefined;
47547
+ city?: string | undefined;
47548
+ postal?: string | undefined;
47549
+ country?: string | undefined;
47550
+ state?: string | undefined;
47551
+ } | undefined;
47552
+ email?: string | undefined;
47553
+ companyName?: string | undefined;
47554
+ companyId?: string | undefined;
47555
+ notes?: string | undefined;
47556
+ vat?: string | undefined;
47557
+ poNumber?: string | undefined;
47558
+ } | undefined;
47559
+ };
47560
+ subscription: {
47561
+ product: "free" | "team" | "company" | "enterprise";
47562
+ planPriceId: string;
47563
+ planInterval: "yearly" | "daily" | "monthly" | "weekly";
47564
+ seats: number;
47565
+ seatLimit: number;
47566
+ status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47567
+ card?: {
47568
+ cardId?: string | null | undefined;
47569
+ last4?: string | null | undefined;
47570
+ expiryMonth?: string | null | undefined;
47571
+ expiryYear?: string | null | undefined;
47572
+ brand?: string | null | undefined;
47573
+ name?: string | null | undefined;
47574
+ } | undefined;
47575
+ amount?: number | null | undefined;
47576
+ stripeProductDescription?: string | undefined;
47577
+ isPricePerCreator?: boolean | undefined;
47578
+ isTrial?: boolean | undefined;
47579
+ legacyVersion?: string | undefined;
47580
+ stripeProductFeatures?: string[] | undefined;
47581
+ stripeProductAdditionalFeatures?: string[] | undefined;
47582
+ stripeSubscriptionId?: string | null | undefined;
47583
+ stripeCustomerId?: string | null | undefined;
47584
+ subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
47585
+ internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
47586
+ featuresSummary?: {
47587
+ designSystems: {
47588
+ max: number;
47589
+ errorMessage: string;
47590
+ errorReason: string;
47591
+ };
47592
+ designSystemSources: {
47593
+ max: number;
47594
+ errorMessage: string;
47595
+ errorReason: string;
47596
+ noImportJobsErrorMessage: string;
47597
+ noImportJobsErrorReason: string;
47598
+ };
47599
+ designSystemVersions: {
47600
+ max: number;
47601
+ errorMessage: string;
47602
+ errorReason: string;
47603
+ };
47604
+ themes: {
47605
+ max: number;
47606
+ errorMessage: string;
47607
+ errorReason: string;
47608
+ };
47609
+ brands: {
47610
+ max: number;
47611
+ errorMessage: string;
47612
+ errorReason: string;
47613
+ };
47614
+ codegenSchedules: {
47615
+ max: number;
47616
+ errorMessage: string;
47617
+ errorReason: string;
47618
+ };
47619
+ publicDocumentation: {
47620
+ errorMessage: string;
47621
+ errorReason: string;
47622
+ enabled: boolean;
47623
+ };
47624
+ customDocumentationUrl: {
47625
+ errorMessage: string;
47626
+ errorReason: string;
47627
+ enabled: boolean;
47628
+ };
47629
+ customDocumentationViewButton: {
47630
+ errorMessage: string;
47631
+ errorReason: string;
47632
+ enabled: boolean;
47633
+ };
47634
+ designSystemSourceAutoImport: {
47635
+ errorMessage: string;
47636
+ errorReason: string;
47637
+ enabled: boolean;
47638
+ };
47639
+ designSystemSlug: {
47640
+ errorMessage: string;
47641
+ errorReason: string;
47642
+ enabled: boolean;
47643
+ };
47644
+ ipWhitelisting: {
47645
+ errorMessage: string;
47646
+ errorReason: string;
47647
+ enabled: boolean;
47648
+ };
47649
+ npmRegistry: {
47650
+ errorMessage: string;
47651
+ errorReason: string;
47652
+ enabled: boolean;
47653
+ };
47654
+ sso: {
47655
+ errorMessage: string;
47656
+ errorReason: string;
47657
+ enabled: boolean;
47658
+ };
47659
+ workspacePaidSeats: {
47660
+ max: number;
47661
+ errorMessage: string;
47662
+ errorReason: string;
47663
+ };
47664
+ workspaceViewers: {
47665
+ max: number;
47666
+ errorMessage: string;
47667
+ errorReason: string;
47668
+ };
47669
+ customDocumentationExporter: {
47670
+ errorMessage: string;
47671
+ errorReason: string;
47672
+ enabled: boolean;
47673
+ };
47674
+ protectedPages: {
47675
+ errorMessage: string;
47676
+ errorReason: string;
47677
+ enabled: boolean;
47678
+ };
47679
+ approvals: {
47680
+ errorMessage: string;
47681
+ errorReason: string;
47682
+ enabled: boolean;
47683
+ };
47684
+ selectivePublishing: {
47685
+ errorMessage: string;
47686
+ errorReason: string;
47687
+ enabled: boolean;
47688
+ };
47689
+ designSystemAccessModes: {
47690
+ errorMessage: string;
47691
+ errorReason: string;
47692
+ enabled: boolean;
47693
+ };
47694
+ } | undefined;
47695
+ stripeSubscriptionMainItemId?: string | undefined;
47696
+ currentPeriodStart?: string | undefined;
47697
+ currentPeriodEnd?: string | undefined;
47698
+ subscriptionStatusUpdatedAt?: string | undefined;
47699
+ cancelAt?: string | null | undefined;
47700
+ billingType?: "Auto" | "Invoice" | undefined;
47701
+ daysUntilDue?: number | undefined;
47702
+ };
47703
+ npmRegistry?: {
47704
+ enabledScopes: string[];
47705
+ bypassProxy: boolean;
47706
+ registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
47707
+ authType: "Custom" | "None" | "Basic" | "Bearer";
47708
+ registryUrl: string;
47709
+ proxyUrl: string;
47710
+ customRegistryUrl?: string | undefined;
47711
+ accessToken?: string | undefined;
47712
+ username?: string | undefined;
47713
+ password?: string | undefined;
47714
+ } | undefined;
47715
+ };
47716
+ }>;
47717
+ delete(workspaceId: string): Promise<any>;
47718
+ subscription(workspaceId: string): Promise<any>;
47719
+ }
47720
+
47123
47721
  type SupernovaApiClientConfig = {
47124
47722
  host: string;
47125
47723
  accessToken: string;
@@ -49681,4 +50279,4 @@ declare class FrontendVersionRoomYDoc {
49681
50279
 
49682
50280
  declare function generatePageContentHash(content: DocumentationPageEditorModel, definitions: PageBlockDefinition[], debug?: boolean): string;
49683
50281
 
49684
- export { BackendVersionRoomYDoc, BlockDefinitionUtils, BlockParsingUtils, DTOAppBootstrapDataQuery, DTOAppBootstrapDataResponse, DTOAssetRenderConfiguration, DTOBrand, DTOBrandCreateResponse, DTOBrandGetResponse, DTOBrandsListResponse, DTOCreateBrandInput, DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTOCreateElementPropertyDefinitionInputV2, DTOCreateVersionInput, DTODataSource, DTODataSourceCreationResponse, DTODataSourceFigma, DTODataSourceFigmaCloud, DTODataSourceFigmaVariablesPlugin, DTODataSourceTokenStudio, DTODataSourcesListResponse, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODeleteElementPropertyDefinitionInputV2, DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemCreateInput, DTODesignSystemCreateResponse, DTODesignSystemMember, DTODesignSystemMemberListResponse, DTODesignSystemMembersUpdatePayload, DTODesignSystemMembersUpdateResponse, DTODesignSystemUpdateInput, DTODesignSystemVersion, DTODesignSystemVersionCreationResponse, DTODesignSystemVersionGetResponse, DTODesignSystemVersionJobStatusResponse, DTODesignSystemVersionJobsResponse, DTODesignSystemVersionsListResponse, DTODesignSystemsListResponse, DTODiffCountBase, DTODocumentationDraftChangeType, DTODocumentationDraftState, DTODocumentationDraftStateCreated, DTODocumentationDraftStateDeleted, DTODocumentationDraftStateUpdated, DTODocumentationGroupApprovalState, DTODocumentationGroupCreateActionInputV2, DTODocumentationGroupCreateActionOutputV2, DTODocumentationGroupDeleteActionInputV2, DTODocumentationGroupDeleteActionOutputV2, DTODocumentationGroupDuplicateActionInputV2, DTODocumentationGroupDuplicateActionOutputV2, DTODocumentationGroupMoveActionInputV2, DTODocumentationGroupMoveActionOutputV2, DTODocumentationGroupRestoreActionInput, DTODocumentationGroupRestoreActionOutput, DTODocumentationGroupStructureV1, DTODocumentationGroupUpdateActionInputV2, DTODocumentationGroupUpdateActionOutputV2, DTODocumentationGroupV1, DTODocumentationGroupV2, DTODocumentationHierarchyV2, DTODocumentationItemConfigurationV1, DTODocumentationItemConfigurationV2, DTODocumentationItemHeaderV2, DTODocumentationLinkPreviewRequest, DTODocumentationLinkPreviewResponse, DTODocumentationPageAnchor, DTODocumentationPageApprovalState, DTODocumentationPageApprovalStateChangeActionInput, DTODocumentationPageApprovalStateChangeActionOutput, DTODocumentationPageApprovalStateChangeInput, DTODocumentationPageContent, DTODocumentationPageContentGetResponse, DTODocumentationPageCreateActionInputV2, DTODocumentationPageCreateActionOutputV2, DTODocumentationPageDeleteActionInputV2, DTODocumentationPageDeleteActionOutputV2, DTODocumentationPageDuplicateActionInputV2, DTODocumentationPageDuplicateActionOutputV2, DTODocumentationPageMoveActionInputV2, DTODocumentationPageMoveActionOutputV2, DTODocumentationPageRestoreActionInput, DTODocumentationPageRestoreActionOutput, DTODocumentationPageRoomHeaderData, DTODocumentationPageRoomHeaderDataUpdate, DTODocumentationPageSnapshot, DTODocumentationPageUpdateActionInputV2, DTODocumentationPageUpdateActionOutputV2, DTODocumentationPageV2, DTODocumentationPublishMetadata, DTODocumentationPublishTypeQueryParams, DTODocumentationTabCreateActionInputV2, DTODocumentationTabCreateActionOutputV2, type DTODocumentationTabGroupCreateActionInputV2, DTODocumentationTabGroupDeleteActionInputV2, DTODocumentationTabGroupDeleteActionOutputV2, DTODownloadAssetsRequest, DTODownloadAssetsResponse, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementActionOutput, DTOElementPropertyDefinition, DTOElementPropertyDefinitionsGetResponse, DTOElementPropertyValue, DTOElementPropertyValuesGetResponse, DTOElementView, DTOElementViewBasePropertyColumn, DTOElementViewColumn, DTOElementViewColumnSharedAttributes, DTOElementViewPropertyDefinitionColumn, DTOElementViewThemeColumn, DTOElementViewsListResponse, DTOElementsGetOutput, type DTOElementsGetQueryParsed, type DTOElementsGetQueryRaw, DTOElementsGetQuerySchema, DTOElementsGetTypeFilter, DTOExportJob, DTOExportJobCreatedBy, DTOExportJobDesignSystemPreview, DTOExportJobDesignSystemVersionPreview, DTOExportJobDestinations, DTOExportJobResponse, DTOExportJobResult, DTOExportJobsListFilter, DTOExporter, DTOExporterCreateInput, DTOExporterCreateOutput, DTOExporterGitProviderEnum, DTOExporterMembership, DTOExporterMembershipRole, DTOExporterProperty, DTOExporterPropertyListResponse, DTOExporterSource, DTOExporterType, DTOExporterUpdateInput, DTOFigmaComponent, DTOFigmaComponentBooleanProperty, DTOFigmaComponentInstanceSwapProperty, DTOFigmaComponentListResponse, DTOFigmaComponentProperty, DTOFigmaComponentPropertyMap, DTOFigmaComponentTextProperty, DTOFigmaComponentVariantProperty, DTOFigmaNode, DTOFigmaNodeData, DTOFigmaNodeOrigin, DTOFigmaNodeRenderActionInput, DTOFigmaNodeRenderActionOutput, DTOFigmaNodeRenderFormat, DTOFigmaNodeRenderInput, DTOGetBlockDefinitionsOutput, DTOGetDocumentationPageAnchorsResponse, DTOGitBranch, DTOGitOrganization, DTOGitProject, DTOGitRepository, DTOIntegration, DTOIntegrationCredentials, DTOIntegrationOAuthGetResponse, DTOIntegrationPostResponse, DTOIntegrationsGetListResponse, DTOLiveblocksAuthRequest, DTOLiveblocksAuthResponse, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTONpmRegistryConfig, DTONpmRegistryConfigConstants, DTOPageBlockColorV2, DTOPageBlockDefinition, DTOPageBlockDefinitionBehavior, DTOPageBlockDefinitionItem, DTOPageBlockDefinitionLayout, DTOPageBlockDefinitionProperty, DTOPageBlockDefinitionVariant, DTOPageBlockItemV2, DTOPagination, DTOPipeline, DTOPipelineCreateBody, DTOPipelineTriggerBody, DTOPipelineUpdateBody, DTOPropertyDefinitionCreateActionInputV2, DTOPropertyDefinitionCreateActionOutputV2, DTOPropertyDefinitionDeleteActionInputV2, DTOPropertyDefinitionDeleteActionOutputV2, DTOPropertyDefinitionUpdateActionInputV2, DTOPropertyDefinitionUpdateActionOutputV2, DTOPublishDocumentationChanges, DTOPublishDocumentationRequest, DTOPublishDocumentationResponse, DTORenderedAssetFile, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTOUpdateElementPropertyDefinitionInputV2, DTOUpdateUserNotificationSettingsPayload, DTOUpdateVersionInput, DTOUser, DTOUserGetResponse, DTOUserNotificationSettingsResponse, DTOUserProfile, DTOUserProfileUpdatePayload, DTOUserProfileUpdateResponse, DTOUserWorkspaceMembership, DTOUserWorkspaceMembershipsResponse, DTOWorkspace, DTOWorkspaceCreateInput, DTOWorkspaceCreateResponse, DTOWorkspaceIntegrationGetGitObjectsInput, DTOWorkspaceIntegrationOauthInput, DTOWorkspaceIntegrationPATInput, DTOWorkspaceInvitationInput, DTOWorkspaceInvitationsListInput, DTOWorkspaceRole, DesignSystemsEndpoint, DocumentationHierarchySettings, DocumentationPageEditorModel, DocumentationPageV1DTO, FrontendVersionRoomYDoc, type ListItemNode, type ListNode, ListTreeBuilder, NpmRegistryInput, ObjectMeta, PageBlockEditorModel, PageSectionEditorModel, type ProsemirrorBlockItem, type ProsemirrorMark, type ProsemirrorNode, RequestExecutor, type RequestExecutorConfig, RequestExecutorError, type RequestExecutorErrorType, type RequestExecutorJSONRequest, SupernovaApiClient, UsersEndpoint, VersionRoomBaseYDoc, VersionSQSPayload, WorkspaceConfigurationPayload, WorkspacesEndpoint, applyPrivacyConfigurationToNestedItems, blockToProsemirrorNode, buildDocPagePublishPaths, calculateElementParentChain, documentationItemConfigurationToDTOV1, documentationItemConfigurationToDTOV2, documentationPageToDTOV2, documentationPagesFixedConfigurationToDTOV1, documentationPagesFixedConfigurationToDTOV2, documentationPagesToDTOV1, documentationPagesToDTOV2, elementGroupsToDocumentationGroupDTOV1, elementGroupsToDocumentationGroupDTOV2, elementGroupsToDocumentationGroupFixedConfigurationDTOV1, elementGroupsToDocumentationGroupFixedConfigurationDTOV2, elementGroupsToDocumentationGroupStructureDTOV1, generateHash, generatePageContentHash, getDtoDefaultItemConfigurationV1, getDtoDefaultItemConfigurationV2, getMockPageBlockDefinitions, gitBranchToDto, gitOrganizationToDto, gitProjectToDto, gitRepositoryToDto, innerEditorProsemirrorSchema, integrationCredentialToDto, integrationToDto, itemConfigurationToYjs, mainEditorProsemirrorSchema, pageToProsemirrorDoc, pageToYDoc, pageToYXmlFragment, pipelineToDto, prosemirrorDocToPage, prosemirrorDocToRichTextPropertyValue, prosemirrorNodeToSection, prosemirrorNodesToBlocks, richTextPropertyValueToProsemirror, serializeAsCustomBlock, shallowProsemirrorNodeToBlock, validateDesignSystemVersion, validateSsoPayload, yDocToPage, yXmlFragmentToPage, yjsToDocumentationHierarchy, yjsToItemConfiguration };
50282
+ export { BackendVersionRoomYDoc, BlockDefinitionUtils, BlockParsingUtils, DTOAppBootstrapDataQuery, DTOAppBootstrapDataResponse, DTOAssetRenderConfiguration, DTOBrand, DTOBrandCreateResponse, DTOBrandGetResponse, DTOBrandsListResponse, DTOCreateBrandInput, DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTOCreateElementPropertyDefinitionInputV2, DTOCreateVersionInput, DTODataSource, DTODataSourceCreationResponse, DTODataSourceFigma, DTODataSourceFigmaCloud, DTODataSourceFigmaVariablesPlugin, DTODataSourceTokenStudio, DTODataSourcesListResponse, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODeleteElementPropertyDefinitionInputV2, DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemCreateInput, DTODesignSystemMember, DTODesignSystemMemberListResponse, DTODesignSystemMembersUpdatePayload, DTODesignSystemMembersUpdateResponse, DTODesignSystemResponse, DTODesignSystemUpdateInput, DTODesignSystemVersion, DTODesignSystemVersionCreationResponse, DTODesignSystemVersionGetResponse, DTODesignSystemVersionJobStatusResponse, DTODesignSystemVersionJobsResponse, DTODesignSystemVersionsListResponse, DTODesignSystemsListResponse, DTODiffCountBase, DTODocumentationDraftChangeType, DTODocumentationDraftState, DTODocumentationDraftStateCreated, DTODocumentationDraftStateDeleted, DTODocumentationDraftStateUpdated, DTODocumentationGroupApprovalState, DTODocumentationGroupCreateActionInputV2, DTODocumentationGroupCreateActionOutputV2, DTODocumentationGroupDeleteActionInputV2, DTODocumentationGroupDeleteActionOutputV2, DTODocumentationGroupDuplicateActionInputV2, DTODocumentationGroupDuplicateActionOutputV2, DTODocumentationGroupMoveActionInputV2, DTODocumentationGroupMoveActionOutputV2, DTODocumentationGroupRestoreActionInput, DTODocumentationGroupRestoreActionOutput, DTODocumentationGroupStructureV1, DTODocumentationGroupUpdateActionInputV2, DTODocumentationGroupUpdateActionOutputV2, DTODocumentationGroupV1, DTODocumentationGroupV2, DTODocumentationHierarchyV2, DTODocumentationItemConfigurationV1, DTODocumentationItemConfigurationV2, DTODocumentationItemHeaderV2, DTODocumentationLinkPreviewRequest, DTODocumentationLinkPreviewResponse, DTODocumentationPageAnchor, DTODocumentationPageApprovalState, DTODocumentationPageApprovalStateChangeActionInput, DTODocumentationPageApprovalStateChangeActionOutput, DTODocumentationPageApprovalStateChangeInput, DTODocumentationPageContent, DTODocumentationPageContentGetResponse, DTODocumentationPageCreateActionInputV2, DTODocumentationPageCreateActionOutputV2, DTODocumentationPageDeleteActionInputV2, DTODocumentationPageDeleteActionOutputV2, DTODocumentationPageDuplicateActionInputV2, DTODocumentationPageDuplicateActionOutputV2, DTODocumentationPageMoveActionInputV2, DTODocumentationPageMoveActionOutputV2, DTODocumentationPageRestoreActionInput, DTODocumentationPageRestoreActionOutput, DTODocumentationPageRoomHeaderData, DTODocumentationPageRoomHeaderDataUpdate, DTODocumentationPageSnapshot, DTODocumentationPageUpdateActionInputV2, DTODocumentationPageUpdateActionOutputV2, DTODocumentationPageV2, DTODocumentationPublishMetadata, DTODocumentationPublishTypeQueryParams, DTODocumentationTabCreateActionInputV2, DTODocumentationTabCreateActionOutputV2, type DTODocumentationTabGroupCreateActionInputV2, DTODocumentationTabGroupDeleteActionInputV2, DTODocumentationTabGroupDeleteActionOutputV2, DTODownloadAssetsRequest, DTODownloadAssetsResponse, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementActionOutput, DTOElementPropertyDefinition, DTOElementPropertyDefinitionsGetResponse, DTOElementPropertyValue, DTOElementPropertyValuesGetResponse, DTOElementView, DTOElementViewBasePropertyColumn, DTOElementViewColumn, DTOElementViewColumnSharedAttributes, DTOElementViewPropertyDefinitionColumn, DTOElementViewThemeColumn, DTOElementViewsListResponse, DTOElementsGetOutput, type DTOElementsGetQueryParsed, type DTOElementsGetQueryRaw, DTOElementsGetQuerySchema, DTOElementsGetTypeFilter, DTOExportJob, DTOExportJobCreatedBy, DTOExportJobDesignSystemPreview, DTOExportJobDesignSystemVersionPreview, DTOExportJobDestinations, DTOExportJobResponse, DTOExportJobResult, DTOExportJobsListFilter, DTOExporter, DTOExporterCreateInput, DTOExporterCreateOutput, DTOExporterGitProviderEnum, DTOExporterMembership, DTOExporterMembershipRole, DTOExporterProperty, DTOExporterPropertyListResponse, DTOExporterSource, DTOExporterType, DTOExporterUpdateInput, DTOFigmaComponent, DTOFigmaComponentBooleanProperty, DTOFigmaComponentInstanceSwapProperty, DTOFigmaComponentListResponse, DTOFigmaComponentProperty, DTOFigmaComponentPropertyMap, DTOFigmaComponentTextProperty, DTOFigmaComponentVariantProperty, DTOFigmaNode, DTOFigmaNodeData, DTOFigmaNodeOrigin, DTOFigmaNodeRenderActionInput, DTOFigmaNodeRenderActionOutput, DTOFigmaNodeRenderFormat, DTOFigmaNodeRenderInput, DTOGetBlockDefinitionsOutput, DTOGetDocumentationPageAnchorsResponse, DTOGitBranch, DTOGitOrganization, DTOGitProject, DTOGitRepository, DTOIntegration, DTOIntegrationCredentials, DTOIntegrationOAuthGetResponse, DTOIntegrationPostResponse, DTOIntegrationsGetListResponse, DTOLiveblocksAuthRequest, DTOLiveblocksAuthResponse, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTONpmRegistryConfig, DTONpmRegistryConfigConstants, DTOPageBlockColorV2, DTOPageBlockDefinition, DTOPageBlockDefinitionBehavior, DTOPageBlockDefinitionItem, DTOPageBlockDefinitionLayout, DTOPageBlockDefinitionProperty, DTOPageBlockDefinitionVariant, DTOPageBlockItemV2, DTOPagination, DTOPipeline, DTOPipelineCreateBody, DTOPipelineTriggerBody, DTOPipelineUpdateBody, DTOPropertyDefinitionCreateActionInputV2, DTOPropertyDefinitionCreateActionOutputV2, DTOPropertyDefinitionDeleteActionInputV2, DTOPropertyDefinitionDeleteActionOutputV2, DTOPropertyDefinitionUpdateActionInputV2, DTOPropertyDefinitionUpdateActionOutputV2, DTOPublishDocumentationChanges, DTOPublishDocumentationRequest, DTOPublishDocumentationResponse, DTORenderedAssetFile, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTOUpdateElementPropertyDefinitionInputV2, DTOUpdateUserNotificationSettingsPayload, DTOUpdateVersionInput, DTOUser, DTOUserGetResponse, DTOUserNotificationSettingsResponse, DTOUserProfile, DTOUserProfileUpdatePayload, DTOUserProfileUpdateResponse, DTOUserWorkspaceMembership, DTOUserWorkspaceMembershipsResponse, DTOWorkspace, DTOWorkspaceCreateInput, DTOWorkspaceIntegrationGetGitObjectsInput, DTOWorkspaceIntegrationOauthInput, DTOWorkspaceIntegrationPATInput, DTOWorkspaceInvitationInput, DTOWorkspaceInvitationsListInput, DTOWorkspaceResponse, DTOWorkspaceRole, DesignSystemsEndpoint, DocumentationHierarchySettings, DocumentationPageEditorModel, DocumentationPageV1DTO, FrontendVersionRoomYDoc, type ListItemNode, type ListNode, ListTreeBuilder, NpmRegistryInput, ObjectMeta, PageBlockEditorModel, PageSectionEditorModel, type ProsemirrorBlockItem, type ProsemirrorMark, type ProsemirrorNode, RequestExecutor, type RequestExecutorConfig, RequestExecutorError, type RequestExecutorErrorType, type RequestExecutorJSONRequest, SupernovaApiClient, UsersEndpoint, VersionRoomBaseYDoc, VersionSQSPayload, WorkspaceConfigurationPayload, WorkspaceMembersEndpoint, WorkspacesEndpoint, applyPrivacyConfigurationToNestedItems, blockToProsemirrorNode, buildDocPagePublishPaths, calculateElementParentChain, documentationItemConfigurationToDTOV1, documentationItemConfigurationToDTOV2, documentationPageToDTOV2, documentationPagesFixedConfigurationToDTOV1, documentationPagesFixedConfigurationToDTOV2, documentationPagesToDTOV1, documentationPagesToDTOV2, elementGroupsToDocumentationGroupDTOV1, elementGroupsToDocumentationGroupDTOV2, elementGroupsToDocumentationGroupFixedConfigurationDTOV1, elementGroupsToDocumentationGroupFixedConfigurationDTOV2, elementGroupsToDocumentationGroupStructureDTOV1, generateHash, generatePageContentHash, getDtoDefaultItemConfigurationV1, getDtoDefaultItemConfigurationV2, getMockPageBlockDefinitions, gitBranchToDto, gitOrganizationToDto, gitProjectToDto, gitRepositoryToDto, innerEditorProsemirrorSchema, integrationCredentialToDto, integrationToDto, itemConfigurationToYjs, mainEditorProsemirrorSchema, pageToProsemirrorDoc, pageToYDoc, pageToYXmlFragment, pipelineToDto, prosemirrorDocToPage, prosemirrorDocToRichTextPropertyValue, prosemirrorNodeToSection, prosemirrorNodesToBlocks, richTextPropertyValueToProsemirror, serializeAsCustomBlock, shallowProsemirrorNodeToBlock, validateDesignSystemVersion, validateSsoPayload, yDocToPage, yXmlFragmentToPage, yjsToDocumentationHierarchy, yjsToItemConfiguration };