@supernova-studio/client 0.55.21 → 0.55.22

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 (7) hide show
  1. package/dist/index.d.mts +544 -488
  2. package/dist/index.d.ts +544 -488
  3. package/dist/index.js +45 -35
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +45 -35
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -7887,6 +7887,26 @@ declare const DTODesignSystemCreateInput: z.ZodObject<{
7887
7887
  workspaceRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor";
7888
7888
  designSystemRole?: "Admin" | "Creator" | "Viewer" | "Contributor" | undefined;
7889
7889
  }>, "many">>;
7890
+ usersToUpdate: z.ZodOptional<z.ZodArray<z.ZodObject<{
7891
+ userId: z.ZodString;
7892
+ designSystemRole: z.ZodNullable<z.ZodEnum<["Admin", "Contributor", "Creator", "Viewer"]>>;
7893
+ }, "strip", z.ZodTypeAny, {
7894
+ userId: string;
7895
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
7896
+ }, {
7897
+ userId: string;
7898
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
7899
+ }>, "many">>;
7900
+ invitesToUpdate: z.ZodOptional<z.ZodArray<z.ZodObject<{
7901
+ inviteId: z.ZodString;
7902
+ designSystemRole: z.ZodNullable<z.ZodEnum<["Admin", "Contributor", "Creator", "Viewer"]>>;
7903
+ }, "strip", z.ZodTypeAny, {
7904
+ inviteId: string;
7905
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
7906
+ }, {
7907
+ inviteId: string;
7908
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
7909
+ }>, "many">>;
7890
7910
  removeUserIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
7891
7911
  deleteInvitationIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
7892
7912
  }, "usersToInvite" | "invitesToInvite" | "emailsToInvite">, "strip", z.ZodTypeAny, {
@@ -8174,6 +8194,26 @@ declare const DTODesignSystemMembersUpdatePayload: z.ZodObject<{
8174
8194
  workspaceRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor";
8175
8195
  designSystemRole?: "Admin" | "Creator" | "Viewer" | "Contributor" | undefined;
8176
8196
  }>, "many">>;
8197
+ usersToUpdate: z.ZodOptional<z.ZodArray<z.ZodObject<{
8198
+ userId: z.ZodString;
8199
+ designSystemRole: z.ZodNullable<z.ZodEnum<["Admin", "Contributor", "Creator", "Viewer"]>>;
8200
+ }, "strip", z.ZodTypeAny, {
8201
+ userId: string;
8202
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8203
+ }, {
8204
+ userId: string;
8205
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8206
+ }>, "many">>;
8207
+ invitesToUpdate: z.ZodOptional<z.ZodArray<z.ZodObject<{
8208
+ inviteId: z.ZodString;
8209
+ designSystemRole: z.ZodNullable<z.ZodEnum<["Admin", "Contributor", "Creator", "Viewer"]>>;
8210
+ }, "strip", z.ZodTypeAny, {
8211
+ inviteId: string;
8212
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8213
+ }, {
8214
+ inviteId: string;
8215
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8216
+ }>, "many">>;
8177
8217
  removeUserIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
8178
8218
  deleteInvitationIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
8179
8219
  }, "strip", z.ZodTypeAny, {
@@ -8190,6 +8230,14 @@ declare const DTODesignSystemMembersUpdatePayload: z.ZodObject<{
8190
8230
  workspaceRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor";
8191
8231
  designSystemRole?: "Admin" | "Creator" | "Viewer" | "Contributor" | undefined;
8192
8232
  }[] | undefined;
8233
+ usersToUpdate?: {
8234
+ userId: string;
8235
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8236
+ }[] | undefined;
8237
+ invitesToUpdate?: {
8238
+ inviteId: string;
8239
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8240
+ }[] | undefined;
8193
8241
  removeUserIds?: string[] | undefined;
8194
8242
  deleteInvitationIds?: string[] | undefined;
8195
8243
  }, {
@@ -8206,6 +8254,14 @@ declare const DTODesignSystemMembersUpdatePayload: z.ZodObject<{
8206
8254
  workspaceRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor";
8207
8255
  designSystemRole?: "Admin" | "Creator" | "Viewer" | "Contributor" | undefined;
8208
8256
  }[] | undefined;
8257
+ usersToUpdate?: {
8258
+ userId: string;
8259
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8260
+ }[] | undefined;
8261
+ invitesToUpdate?: {
8262
+ inviteId: string;
8263
+ designSystemRole: "Admin" | "Creator" | "Viewer" | "Contributor" | null;
8264
+ }[] | undefined;
8209
8265
  removeUserIds?: string[] | undefined;
8210
8266
  deleteInvitationIds?: string[] | undefined;
8211
8267
  }>;
@@ -48218,58 +48274,221 @@ declare class DesignSystemsEndpoint {
48218
48274
  }>;
48219
48275
  }
48220
48276
 
48221
- declare class TokenCollectionsEndpoint {
48277
+ type RequestExecutorErrorType = "ServerError" | "ResponseParsingError";
48278
+ type RequestEexecutorServerErrorCode = SupernovaExceptionType | undefined;
48279
+ declare class RequestExecutorError extends Error {
48280
+ readonly type: RequestExecutorErrorType;
48281
+ readonly errorCode: RequestEexecutorServerErrorCode;
48282
+ readonly serverErrorType: SupernovaExceptionType | undefined;
48283
+ static tryParseErrorCode(body: string): any;
48284
+ static tryParseServerErrorType(body: string): any;
48285
+ static serverError(endpoint: string, status: number, bodyText: string): RequestExecutorError;
48286
+ static responseParsingError(endpoint: string, cause: Error): RequestExecutorError;
48287
+ private constructor();
48288
+ }
48289
+
48290
+ declare class WorkspaceInvitationsEndpoint {
48222
48291
  private readonly requestExecutor;
48223
48292
  constructor(requestExecutor: RequestExecutor);
48224
- list(dsId: string, vId: string): Promise<{
48225
- collections: {
48293
+ list(workspaceId: string): Promise<{
48294
+ invitations: {
48226
48295
  id: string;
48227
- persistentId: string;
48228
- meta: {
48229
- name: string;
48230
- description?: string | undefined;
48231
- };
48232
- designSystemVersionId: string;
48233
48296
  createdAt: Date;
48234
- updatedAt: Date;
48235
- origin: {
48236
- id: string;
48237
- sourceId: string;
48238
- };
48297
+ email: string;
48298
+ workspaceId: string;
48299
+ role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor";
48300
+ invitedBy: string;
48301
+ resentAt?: Date | null | undefined;
48239
48302
  }[];
48240
48303
  }>;
48241
- }
48242
-
48243
- declare class UsersEndpoint {
48244
- private readonly requestExecutor;
48245
- constructor(requestExecutor: RequestExecutor);
48246
- getMe(): Promise<{
48247
- user: {
48304
+ delete(workspaceId: string, invitationId: string): Promise<{
48305
+ workspace: {
48248
48306
  id: string;
48249
- createdAt: Date;
48250
48307
  profile: {
48251
48308
  name: string;
48309
+ color: string;
48310
+ handle: string;
48252
48311
  avatar?: string | undefined;
48253
- nickname?: string | undefined;
48254
- onboarding?: {
48312
+ billingDetails?: {
48313
+ address?: {
48314
+ street1?: string | undefined;
48315
+ street2?: string | undefined;
48316
+ city?: string | undefined;
48317
+ postal?: string | undefined;
48318
+ country?: string | undefined;
48319
+ state?: string | undefined;
48320
+ } | undefined;
48321
+ email?: string | undefined;
48255
48322
  companyName?: string | undefined;
48256
- numberOfPeopleInOrg?: string | undefined;
48257
- numberOfPeopleInDesignTeam?: string | undefined;
48258
- department?: "Design" | "Engineering" | "Product" | "Brand" | "Other" | undefined;
48259
- jobTitle?: string | undefined;
48260
- phase?: string | undefined;
48261
- jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
48262
- designSystemName?: string | undefined;
48263
- defaultDestination?: string | undefined;
48264
- isPageDraftOnboardingFinished?: boolean | undefined;
48323
+ companyId?: string | undefined;
48324
+ notes?: string | undefined;
48325
+ vat?: string | undefined;
48326
+ poNumber?: string | undefined;
48265
48327
  } | undefined;
48266
48328
  };
48267
- email: string;
48268
- source?: "SignUp" | "Invite" | "SSO" | undefined;
48269
- loggedOutAt?: Date | undefined;
48329
+ subscription: {
48330
+ product: "free" | "team" | "company" | "enterprise";
48331
+ planPriceId: string;
48332
+ planInterval: "yearly" | "daily" | "monthly" | "weekly";
48333
+ seats: number;
48334
+ seatLimit: number;
48335
+ status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
48336
+ card?: {
48337
+ cardId?: string | null | undefined;
48338
+ last4?: string | null | undefined;
48339
+ expiryMonth?: string | null | undefined;
48340
+ expiryYear?: string | null | undefined;
48341
+ brand?: string | null | undefined;
48342
+ name?: string | null | undefined;
48343
+ } | undefined;
48344
+ amount?: number | null | undefined;
48345
+ stripeProductDescription?: string | undefined;
48346
+ isPricePerCreator?: boolean | undefined;
48347
+ isTrial?: boolean | undefined;
48348
+ legacyVersion?: string | undefined;
48349
+ stripeProductFeatures?: string[] | undefined;
48350
+ stripeProductAdditionalFeatures?: string[] | undefined;
48351
+ stripeSubscriptionId?: string | null | undefined;
48352
+ stripeCustomerId?: string | null | undefined;
48353
+ subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
48354
+ internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
48355
+ featuresSummary?: {
48356
+ designSystems: {
48357
+ max: number;
48358
+ errorMessage: string;
48359
+ errorReason: string;
48360
+ };
48361
+ designSystemSources: {
48362
+ max: number;
48363
+ errorMessage: string;
48364
+ errorReason: string;
48365
+ noImportJobsErrorMessage: string;
48366
+ noImportJobsErrorReason: string;
48367
+ };
48368
+ designSystemVersions: {
48369
+ max: number;
48370
+ errorMessage: string;
48371
+ errorReason: string;
48372
+ };
48373
+ themes: {
48374
+ max: number;
48375
+ errorMessage: string;
48376
+ errorReason: string;
48377
+ };
48378
+ brands: {
48379
+ max: number;
48380
+ errorMessage: string;
48381
+ errorReason: string;
48382
+ };
48383
+ codegenSchedules: {
48384
+ max: number;
48385
+ errorMessage: string;
48386
+ errorReason: string;
48387
+ };
48388
+ publicDocumentation: {
48389
+ errorMessage: string;
48390
+ errorReason: string;
48391
+ enabled: boolean;
48392
+ };
48393
+ customDocumentationUrl: {
48394
+ errorMessage: string;
48395
+ errorReason: string;
48396
+ enabled: boolean;
48397
+ };
48398
+ customDocumentationViewButton: {
48399
+ errorMessage: string;
48400
+ errorReason: string;
48401
+ enabled: boolean;
48402
+ };
48403
+ designSystemSourceAutoImport: {
48404
+ errorMessage: string;
48405
+ errorReason: string;
48406
+ enabled: boolean;
48407
+ };
48408
+ designSystemSlug: {
48409
+ errorMessage: string;
48410
+ errorReason: string;
48411
+ enabled: boolean;
48412
+ };
48413
+ ipWhitelisting: {
48414
+ errorMessage: string;
48415
+ errorReason: string;
48416
+ enabled: boolean;
48417
+ };
48418
+ npmRegistry: {
48419
+ errorMessage: string;
48420
+ errorReason: string;
48421
+ enabled: boolean;
48422
+ };
48423
+ sso: {
48424
+ errorMessage: string;
48425
+ errorReason: string;
48426
+ enabled: boolean;
48427
+ };
48428
+ workspacePaidSeats: {
48429
+ max: number;
48430
+ errorMessage: string;
48431
+ errorReason: string;
48432
+ };
48433
+ workspaceViewers: {
48434
+ max: number;
48435
+ errorMessage: string;
48436
+ errorReason: string;
48437
+ };
48438
+ customDocumentationExporter: {
48439
+ errorMessage: string;
48440
+ errorReason: string;
48441
+ enabled: boolean;
48442
+ };
48443
+ protectedPages: {
48444
+ errorMessage: string;
48445
+ errorReason: string;
48446
+ enabled: boolean;
48447
+ };
48448
+ approvals: {
48449
+ errorMessage: string;
48450
+ errorReason: string;
48451
+ enabled: boolean;
48452
+ };
48453
+ selectivePublishing: {
48454
+ errorMessage: string;
48455
+ errorReason: string;
48456
+ enabled: boolean;
48457
+ };
48458
+ designSystemAccessModes: {
48459
+ errorMessage: string;
48460
+ errorReason: string;
48461
+ enabled: boolean;
48462
+ };
48463
+ } | undefined;
48464
+ stripeSubscriptionMainItemId?: string | undefined;
48465
+ currentPeriodStart?: string | undefined;
48466
+ currentPeriodEnd?: string | undefined;
48467
+ subscriptionStatusUpdatedAt?: string | undefined;
48468
+ cancelAt?: string | null | undefined;
48469
+ billingType?: "Auto" | "Invoice" | undefined;
48470
+ daysUntilDue?: number | undefined;
48471
+ };
48472
+ npmRegistry?: {
48473
+ enabledScopes: string[];
48474
+ bypassProxy: boolean;
48475
+ registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
48476
+ authType: "Custom" | "None" | "Basic" | "Bearer";
48477
+ registryUrl: string;
48478
+ proxyUrl: string;
48479
+ customRegistryUrl?: string | undefined;
48480
+ accessToken?: string | undefined;
48481
+ username?: string | undefined;
48482
+ password?: string | undefined;
48483
+ } | undefined;
48270
48484
  };
48271
48485
  }>;
48272
- listWorkspaces(uid: string): Promise<{
48486
+ }
48487
+
48488
+ declare class WorkspaceMembersEndpoint {
48489
+ private readonly requestExecutor;
48490
+ constructor(requestExecutor: RequestExecutor);
48491
+ list(workspaceId: string): Promise<{
48273
48492
  membership: {
48274
48493
  role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
48275
48494
  effectiveRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
@@ -48455,88 +48674,7 @@ declare class UsersEndpoint {
48455
48674
  };
48456
48675
  }[];
48457
48676
  }>;
48458
- delete(uid: string): Promise<{
48459
- user: {
48460
- id: string;
48461
- createdAt: Date;
48462
- profile: {
48463
- name: string;
48464
- avatar?: string | undefined;
48465
- nickname?: string | undefined;
48466
- onboarding?: {
48467
- companyName?: string | undefined;
48468
- numberOfPeopleInOrg?: string | undefined;
48469
- numberOfPeopleInDesignTeam?: string | undefined;
48470
- department?: "Design" | "Engineering" | "Product" | "Brand" | "Other" | undefined;
48471
- jobTitle?: string | undefined;
48472
- phase?: string | undefined;
48473
- jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
48474
- designSystemName?: string | undefined;
48475
- defaultDestination?: string | undefined;
48476
- isPageDraftOnboardingFinished?: boolean | undefined;
48477
- } | undefined;
48478
- };
48479
- email: string;
48480
- source?: "SignUp" | "Invite" | "SSO" | undefined;
48481
- loggedOutAt?: Date | undefined;
48482
- };
48483
- }>;
48484
- updateProfile(uid: string, body: DTOUserProfileUpdate): Promise<{
48485
- user: {
48486
- id: string;
48487
- createdAt: Date;
48488
- profile: {
48489
- name: string;
48490
- avatar?: string | undefined;
48491
- nickname?: string | undefined;
48492
- onboarding?: {
48493
- companyName?: string | undefined;
48494
- numberOfPeopleInOrg?: string | undefined;
48495
- numberOfPeopleInDesignTeam?: string | undefined;
48496
- department?: "Design" | "Engineering" | "Product" | "Brand" | "Other" | undefined;
48497
- jobTitle?: string | undefined;
48498
- phase?: string | undefined;
48499
- jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
48500
- designSystemName?: string | undefined;
48501
- defaultDestination?: string | undefined;
48502
- isPageDraftOnboardingFinished?: boolean | undefined;
48503
- } | undefined;
48504
- };
48505
- email: string;
48506
- source?: "SignUp" | "Invite" | "SSO" | undefined;
48507
- loggedOutAt?: Date | undefined;
48508
- };
48509
- }>;
48510
- }
48511
-
48512
- type RequestExecutorErrorType = "ServerError" | "ResponseParsingError";
48513
- type RequestEexecutorServerErrorCode = SupernovaExceptionType | undefined;
48514
- declare class RequestExecutorError extends Error {
48515
- readonly type: RequestExecutorErrorType;
48516
- readonly errorCode: RequestEexecutorServerErrorCode;
48517
- readonly serverErrorType: SupernovaExceptionType | undefined;
48518
- static tryParseErrorCode(body: string): any;
48519
- static tryParseServerErrorType(body: string): any;
48520
- static serverError(endpoint: string, status: number, bodyText: string): RequestExecutorError;
48521
- static responseParsingError(endpoint: string, cause: Error): RequestExecutorError;
48522
- private constructor();
48523
- }
48524
-
48525
- declare class WorkspaceInvitationsEndpoint {
48526
- private readonly requestExecutor;
48527
- constructor(requestExecutor: RequestExecutor);
48528
- list(workspaceId: string): Promise<{
48529
- invitations: {
48530
- id: string;
48531
- createdAt: Date;
48532
- email: string;
48533
- workspaceId: string;
48534
- role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Guest" | "Contributor";
48535
- invitedBy: string;
48536
- resentAt?: Date | null | undefined;
48537
- }[];
48538
- }>;
48539
- delete(workspaceId: string, invitationId: string): Promise<{
48677
+ update(workspaceId: string, body: UpdateMembershipRolesInput): Promise<{
48540
48678
  workspace: {
48541
48679
  id: string;
48542
48680
  profile: {
@@ -48718,198 +48856,8 @@ declare class WorkspaceInvitationsEndpoint {
48718
48856
  } | undefined;
48719
48857
  };
48720
48858
  }>;
48721
- }
48722
-
48723
- declare class WorkspaceMembersEndpoint {
48724
- private readonly requestExecutor;
48725
- constructor(requestExecutor: RequestExecutor);
48726
- list(workspaceId: string): Promise<{
48727
- membership: {
48728
- role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
48729
- effectiveRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
48730
- workspace: {
48731
- id: string;
48732
- profile: {
48733
- name: string;
48734
- color: string;
48735
- handle: string;
48736
- avatar?: string | undefined;
48737
- billingDetails?: {
48738
- address?: {
48739
- street1?: string | undefined;
48740
- street2?: string | undefined;
48741
- city?: string | undefined;
48742
- postal?: string | undefined;
48743
- country?: string | undefined;
48744
- state?: string | undefined;
48745
- } | undefined;
48746
- email?: string | undefined;
48747
- companyName?: string | undefined;
48748
- companyId?: string | undefined;
48749
- notes?: string | undefined;
48750
- vat?: string | undefined;
48751
- poNumber?: string | undefined;
48752
- } | undefined;
48753
- };
48754
- subscription: {
48755
- product: "free" | "team" | "company" | "enterprise";
48756
- planPriceId: string;
48757
- planInterval: "yearly" | "daily" | "monthly" | "weekly";
48758
- seats: number;
48759
- seatLimit: number;
48760
- status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
48761
- card?: {
48762
- cardId?: string | null | undefined;
48763
- last4?: string | null | undefined;
48764
- expiryMonth?: string | null | undefined;
48765
- expiryYear?: string | null | undefined;
48766
- brand?: string | null | undefined;
48767
- name?: string | null | undefined;
48768
- } | undefined;
48769
- amount?: number | null | undefined;
48770
- stripeProductDescription?: string | undefined;
48771
- isPricePerCreator?: boolean | undefined;
48772
- isTrial?: boolean | undefined;
48773
- legacyVersion?: string | undefined;
48774
- stripeProductFeatures?: string[] | undefined;
48775
- stripeProductAdditionalFeatures?: string[] | undefined;
48776
- stripeSubscriptionId?: string | null | undefined;
48777
- stripeCustomerId?: string | null | undefined;
48778
- subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
48779
- internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
48780
- featuresSummary?: {
48781
- designSystems: {
48782
- max: number;
48783
- errorMessage: string;
48784
- errorReason: string;
48785
- };
48786
- designSystemSources: {
48787
- max: number;
48788
- errorMessage: string;
48789
- errorReason: string;
48790
- noImportJobsErrorMessage: string;
48791
- noImportJobsErrorReason: string;
48792
- };
48793
- designSystemVersions: {
48794
- max: number;
48795
- errorMessage: string;
48796
- errorReason: string;
48797
- };
48798
- themes: {
48799
- max: number;
48800
- errorMessage: string;
48801
- errorReason: string;
48802
- };
48803
- brands: {
48804
- max: number;
48805
- errorMessage: string;
48806
- errorReason: string;
48807
- };
48808
- codegenSchedules: {
48809
- max: number;
48810
- errorMessage: string;
48811
- errorReason: string;
48812
- };
48813
- publicDocumentation: {
48814
- errorMessage: string;
48815
- errorReason: string;
48816
- enabled: boolean;
48817
- };
48818
- customDocumentationUrl: {
48819
- errorMessage: string;
48820
- errorReason: string;
48821
- enabled: boolean;
48822
- };
48823
- customDocumentationViewButton: {
48824
- errorMessage: string;
48825
- errorReason: string;
48826
- enabled: boolean;
48827
- };
48828
- designSystemSourceAutoImport: {
48829
- errorMessage: string;
48830
- errorReason: string;
48831
- enabled: boolean;
48832
- };
48833
- designSystemSlug: {
48834
- errorMessage: string;
48835
- errorReason: string;
48836
- enabled: boolean;
48837
- };
48838
- ipWhitelisting: {
48839
- errorMessage: string;
48840
- errorReason: string;
48841
- enabled: boolean;
48842
- };
48843
- npmRegistry: {
48844
- errorMessage: string;
48845
- errorReason: string;
48846
- enabled: boolean;
48847
- };
48848
- sso: {
48849
- errorMessage: string;
48850
- errorReason: string;
48851
- enabled: boolean;
48852
- };
48853
- workspacePaidSeats: {
48854
- max: number;
48855
- errorMessage: string;
48856
- errorReason: string;
48857
- };
48858
- workspaceViewers: {
48859
- max: number;
48860
- errorMessage: string;
48861
- errorReason: string;
48862
- };
48863
- customDocumentationExporter: {
48864
- errorMessage: string;
48865
- errorReason: string;
48866
- enabled: boolean;
48867
- };
48868
- protectedPages: {
48869
- errorMessage: string;
48870
- errorReason: string;
48871
- enabled: boolean;
48872
- };
48873
- approvals: {
48874
- errorMessage: string;
48875
- errorReason: string;
48876
- enabled: boolean;
48877
- };
48878
- selectivePublishing: {
48879
- errorMessage: string;
48880
- errorReason: string;
48881
- enabled: boolean;
48882
- };
48883
- designSystemAccessModes: {
48884
- errorMessage: string;
48885
- errorReason: string;
48886
- enabled: boolean;
48887
- };
48888
- } | undefined;
48889
- stripeSubscriptionMainItemId?: string | undefined;
48890
- currentPeriodStart?: string | undefined;
48891
- currentPeriodEnd?: string | undefined;
48892
- subscriptionStatusUpdatedAt?: string | undefined;
48893
- cancelAt?: string | null | undefined;
48894
- billingType?: "Auto" | "Invoice" | undefined;
48895
- daysUntilDue?: number | undefined;
48896
- };
48897
- npmRegistry?: {
48898
- enabledScopes: string[];
48899
- bypassProxy: boolean;
48900
- registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
48901
- authType: "Custom" | "None" | "Basic" | "Bearer";
48902
- registryUrl: string;
48903
- proxyUrl: string;
48904
- customRegistryUrl?: string | undefined;
48905
- accessToken?: string | undefined;
48906
- username?: string | undefined;
48907
- password?: string | undefined;
48908
- } | undefined;
48909
- };
48910
- }[];
48911
- }>;
48912
- update(workspaceId: string, body: UpdateMembershipRolesInput): Promise<{
48859
+ invite(workspaceId: string, body: DTOWorkspaceInvitationsListInput): Promise<any>;
48860
+ delete(workspaceId: string, userId: string): Promise<{
48913
48861
  workspace: {
48914
48862
  id: string;
48915
48863
  profile: {
@@ -49091,8 +49039,14 @@ declare class WorkspaceMembersEndpoint {
49091
49039
  } | undefined;
49092
49040
  };
49093
49041
  }>;
49094
- invite(workspaceId: string, body: DTOWorkspaceInvitationsListInput): Promise<any>;
49095
- delete(workspaceId: string, userId: string): Promise<{
49042
+ }
49043
+
49044
+ declare class WorkspacesEndpoint {
49045
+ private readonly requestExecutor;
49046
+ members: WorkspaceMembersEndpoint;
49047
+ invitations: WorkspaceInvitationsEndpoint;
49048
+ constructor(requestExecutor: RequestExecutor);
49049
+ create(body: DTOWorkspaceCreateInput): Promise<{
49096
49050
  workspace: {
49097
49051
  id: string;
49098
49052
  profile: {
@@ -49274,197 +49228,299 @@ declare class WorkspaceMembersEndpoint {
49274
49228
  } | undefined;
49275
49229
  };
49276
49230
  }>;
49231
+ delete(workspaceId: string): Promise<any>;
49232
+ subscription(workspaceId: string): Promise<any>;
49277
49233
  }
49278
49234
 
49279
- declare class WorkspacesEndpoint {
49235
+ declare class TokenCollectionsEndpoint {
49280
49236
  private readonly requestExecutor;
49281
- members: WorkspaceMembersEndpoint;
49282
- invitations: WorkspaceInvitationsEndpoint;
49283
49237
  constructor(requestExecutor: RequestExecutor);
49284
- create(body: DTOWorkspaceCreateInput): Promise<{
49285
- workspace: {
49238
+ list(dsId: string, vId: string): Promise<{
49239
+ collections: {
49240
+ id: string;
49241
+ persistentId: string;
49242
+ meta: {
49243
+ name: string;
49244
+ description?: string | undefined;
49245
+ };
49246
+ designSystemVersionId: string;
49247
+ createdAt: Date;
49248
+ updatedAt: Date;
49249
+ origin: {
49250
+ id: string;
49251
+ sourceId: string;
49252
+ };
49253
+ }[];
49254
+ }>;
49255
+ }
49256
+
49257
+ declare class UsersEndpoint {
49258
+ private readonly requestExecutor;
49259
+ constructor(requestExecutor: RequestExecutor);
49260
+ getMe(): Promise<{
49261
+ user: {
49286
49262
  id: string;
49263
+ createdAt: Date;
49287
49264
  profile: {
49288
49265
  name: string;
49289
- color: string;
49290
- handle: string;
49291
49266
  avatar?: string | undefined;
49292
- billingDetails?: {
49293
- address?: {
49294
- street1?: string | undefined;
49295
- street2?: string | undefined;
49296
- city?: string | undefined;
49297
- postal?: string | undefined;
49298
- country?: string | undefined;
49299
- state?: string | undefined;
49300
- } | undefined;
49301
- email?: string | undefined;
49267
+ nickname?: string | undefined;
49268
+ onboarding?: {
49302
49269
  companyName?: string | undefined;
49303
- companyId?: string | undefined;
49304
- notes?: string | undefined;
49305
- vat?: string | undefined;
49306
- poNumber?: string | undefined;
49270
+ numberOfPeopleInOrg?: string | undefined;
49271
+ numberOfPeopleInDesignTeam?: string | undefined;
49272
+ department?: "Design" | "Engineering" | "Product" | "Brand" | "Other" | undefined;
49273
+ jobTitle?: string | undefined;
49274
+ phase?: string | undefined;
49275
+ jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
49276
+ designSystemName?: string | undefined;
49277
+ defaultDestination?: string | undefined;
49278
+ isPageDraftOnboardingFinished?: boolean | undefined;
49307
49279
  } | undefined;
49308
49280
  };
49309
- subscription: {
49310
- product: "free" | "team" | "company" | "enterprise";
49311
- planPriceId: string;
49312
- planInterval: "yearly" | "daily" | "monthly" | "weekly";
49313
- seats: number;
49314
- seatLimit: number;
49315
- status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
49316
- card?: {
49317
- cardId?: string | null | undefined;
49318
- last4?: string | null | undefined;
49319
- expiryMonth?: string | null | undefined;
49320
- expiryYear?: string | null | undefined;
49321
- brand?: string | null | undefined;
49322
- name?: string | null | undefined;
49281
+ email: string;
49282
+ source?: "SignUp" | "Invite" | "SSO" | undefined;
49283
+ loggedOutAt?: Date | undefined;
49284
+ };
49285
+ }>;
49286
+ listWorkspaces(uid: string): Promise<{
49287
+ membership: {
49288
+ role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
49289
+ effectiveRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
49290
+ workspace: {
49291
+ id: string;
49292
+ profile: {
49293
+ name: string;
49294
+ color: string;
49295
+ handle: string;
49296
+ avatar?: string | undefined;
49297
+ billingDetails?: {
49298
+ address?: {
49299
+ street1?: string | undefined;
49300
+ street2?: string | undefined;
49301
+ city?: string | undefined;
49302
+ postal?: string | undefined;
49303
+ country?: string | undefined;
49304
+ state?: string | undefined;
49305
+ } | undefined;
49306
+ email?: string | undefined;
49307
+ companyName?: string | undefined;
49308
+ companyId?: string | undefined;
49309
+ notes?: string | undefined;
49310
+ vat?: string | undefined;
49311
+ poNumber?: string | undefined;
49312
+ } | undefined;
49313
+ };
49314
+ subscription: {
49315
+ product: "free" | "team" | "company" | "enterprise";
49316
+ planPriceId: string;
49317
+ planInterval: "yearly" | "daily" | "monthly" | "weekly";
49318
+ seats: number;
49319
+ seatLimit: number;
49320
+ status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
49321
+ card?: {
49322
+ cardId?: string | null | undefined;
49323
+ last4?: string | null | undefined;
49324
+ expiryMonth?: string | null | undefined;
49325
+ expiryYear?: string | null | undefined;
49326
+ brand?: string | null | undefined;
49327
+ name?: string | null | undefined;
49328
+ } | undefined;
49329
+ amount?: number | null | undefined;
49330
+ stripeProductDescription?: string | undefined;
49331
+ isPricePerCreator?: boolean | undefined;
49332
+ isTrial?: boolean | undefined;
49333
+ legacyVersion?: string | undefined;
49334
+ stripeProductFeatures?: string[] | undefined;
49335
+ stripeProductAdditionalFeatures?: string[] | undefined;
49336
+ stripeSubscriptionId?: string | null | undefined;
49337
+ stripeCustomerId?: string | null | undefined;
49338
+ subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
49339
+ internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
49340
+ featuresSummary?: {
49341
+ designSystems: {
49342
+ max: number;
49343
+ errorMessage: string;
49344
+ errorReason: string;
49345
+ };
49346
+ designSystemSources: {
49347
+ max: number;
49348
+ errorMessage: string;
49349
+ errorReason: string;
49350
+ noImportJobsErrorMessage: string;
49351
+ noImportJobsErrorReason: string;
49352
+ };
49353
+ designSystemVersions: {
49354
+ max: number;
49355
+ errorMessage: string;
49356
+ errorReason: string;
49357
+ };
49358
+ themes: {
49359
+ max: number;
49360
+ errorMessage: string;
49361
+ errorReason: string;
49362
+ };
49363
+ brands: {
49364
+ max: number;
49365
+ errorMessage: string;
49366
+ errorReason: string;
49367
+ };
49368
+ codegenSchedules: {
49369
+ max: number;
49370
+ errorMessage: string;
49371
+ errorReason: string;
49372
+ };
49373
+ publicDocumentation: {
49374
+ errorMessage: string;
49375
+ errorReason: string;
49376
+ enabled: boolean;
49377
+ };
49378
+ customDocumentationUrl: {
49379
+ errorMessage: string;
49380
+ errorReason: string;
49381
+ enabled: boolean;
49382
+ };
49383
+ customDocumentationViewButton: {
49384
+ errorMessage: string;
49385
+ errorReason: string;
49386
+ enabled: boolean;
49387
+ };
49388
+ designSystemSourceAutoImport: {
49389
+ errorMessage: string;
49390
+ errorReason: string;
49391
+ enabled: boolean;
49392
+ };
49393
+ designSystemSlug: {
49394
+ errorMessage: string;
49395
+ errorReason: string;
49396
+ enabled: boolean;
49397
+ };
49398
+ ipWhitelisting: {
49399
+ errorMessage: string;
49400
+ errorReason: string;
49401
+ enabled: boolean;
49402
+ };
49403
+ npmRegistry: {
49404
+ errorMessage: string;
49405
+ errorReason: string;
49406
+ enabled: boolean;
49407
+ };
49408
+ sso: {
49409
+ errorMessage: string;
49410
+ errorReason: string;
49411
+ enabled: boolean;
49412
+ };
49413
+ workspacePaidSeats: {
49414
+ max: number;
49415
+ errorMessage: string;
49416
+ errorReason: string;
49417
+ };
49418
+ workspaceViewers: {
49419
+ max: number;
49420
+ errorMessage: string;
49421
+ errorReason: string;
49422
+ };
49423
+ customDocumentationExporter: {
49424
+ errorMessage: string;
49425
+ errorReason: string;
49426
+ enabled: boolean;
49427
+ };
49428
+ protectedPages: {
49429
+ errorMessage: string;
49430
+ errorReason: string;
49431
+ enabled: boolean;
49432
+ };
49433
+ approvals: {
49434
+ errorMessage: string;
49435
+ errorReason: string;
49436
+ enabled: boolean;
49437
+ };
49438
+ selectivePublishing: {
49439
+ errorMessage: string;
49440
+ errorReason: string;
49441
+ enabled: boolean;
49442
+ };
49443
+ designSystemAccessModes: {
49444
+ errorMessage: string;
49445
+ errorReason: string;
49446
+ enabled: boolean;
49447
+ };
49448
+ } | undefined;
49449
+ stripeSubscriptionMainItemId?: string | undefined;
49450
+ currentPeriodStart?: string | undefined;
49451
+ currentPeriodEnd?: string | undefined;
49452
+ subscriptionStatusUpdatedAt?: string | undefined;
49453
+ cancelAt?: string | null | undefined;
49454
+ billingType?: "Auto" | "Invoice" | undefined;
49455
+ daysUntilDue?: number | undefined;
49456
+ };
49457
+ npmRegistry?: {
49458
+ enabledScopes: string[];
49459
+ bypassProxy: boolean;
49460
+ registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
49461
+ authType: "Custom" | "None" | "Basic" | "Bearer";
49462
+ registryUrl: string;
49463
+ proxyUrl: string;
49464
+ customRegistryUrl?: string | undefined;
49465
+ accessToken?: string | undefined;
49466
+ username?: string | undefined;
49467
+ password?: string | undefined;
49323
49468
  } | undefined;
49324
- amount?: number | null | undefined;
49325
- stripeProductDescription?: string | undefined;
49326
- isPricePerCreator?: boolean | undefined;
49327
- isTrial?: boolean | undefined;
49328
- legacyVersion?: string | undefined;
49329
- stripeProductFeatures?: string[] | undefined;
49330
- stripeProductAdditionalFeatures?: string[] | undefined;
49331
- stripeSubscriptionId?: string | null | undefined;
49332
- stripeCustomerId?: string | null | undefined;
49333
- subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
49334
- internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
49335
- featuresSummary?: {
49336
- designSystems: {
49337
- max: number;
49338
- errorMessage: string;
49339
- errorReason: string;
49340
- };
49341
- designSystemSources: {
49342
- max: number;
49343
- errorMessage: string;
49344
- errorReason: string;
49345
- noImportJobsErrorMessage: string;
49346
- noImportJobsErrorReason: string;
49347
- };
49348
- designSystemVersions: {
49349
- max: number;
49350
- errorMessage: string;
49351
- errorReason: string;
49352
- };
49353
- themes: {
49354
- max: number;
49355
- errorMessage: string;
49356
- errorReason: string;
49357
- };
49358
- brands: {
49359
- max: number;
49360
- errorMessage: string;
49361
- errorReason: string;
49362
- };
49363
- codegenSchedules: {
49364
- max: number;
49365
- errorMessage: string;
49366
- errorReason: string;
49367
- };
49368
- publicDocumentation: {
49369
- errorMessage: string;
49370
- errorReason: string;
49371
- enabled: boolean;
49372
- };
49373
- customDocumentationUrl: {
49374
- errorMessage: string;
49375
- errorReason: string;
49376
- enabled: boolean;
49377
- };
49378
- customDocumentationViewButton: {
49379
- errorMessage: string;
49380
- errorReason: string;
49381
- enabled: boolean;
49382
- };
49383
- designSystemSourceAutoImport: {
49384
- errorMessage: string;
49385
- errorReason: string;
49386
- enabled: boolean;
49387
- };
49388
- designSystemSlug: {
49389
- errorMessage: string;
49390
- errorReason: string;
49391
- enabled: boolean;
49392
- };
49393
- ipWhitelisting: {
49394
- errorMessage: string;
49395
- errorReason: string;
49396
- enabled: boolean;
49397
- };
49398
- npmRegistry: {
49399
- errorMessage: string;
49400
- errorReason: string;
49401
- enabled: boolean;
49402
- };
49403
- sso: {
49404
- errorMessage: string;
49405
- errorReason: string;
49406
- enabled: boolean;
49407
- };
49408
- workspacePaidSeats: {
49409
- max: number;
49410
- errorMessage: string;
49411
- errorReason: string;
49412
- };
49413
- workspaceViewers: {
49414
- max: number;
49415
- errorMessage: string;
49416
- errorReason: string;
49417
- };
49418
- customDocumentationExporter: {
49419
- errorMessage: string;
49420
- errorReason: string;
49421
- enabled: boolean;
49422
- };
49423
- protectedPages: {
49424
- errorMessage: string;
49425
- errorReason: string;
49426
- enabled: boolean;
49427
- };
49428
- approvals: {
49429
- errorMessage: string;
49430
- errorReason: string;
49431
- enabled: boolean;
49432
- };
49433
- selectivePublishing: {
49434
- errorMessage: string;
49435
- errorReason: string;
49436
- enabled: boolean;
49437
- };
49438
- designSystemAccessModes: {
49439
- errorMessage: string;
49440
- errorReason: string;
49441
- enabled: boolean;
49442
- };
49469
+ };
49470
+ }[];
49471
+ }>;
49472
+ delete(uid: string): Promise<{
49473
+ user: {
49474
+ id: string;
49475
+ createdAt: Date;
49476
+ profile: {
49477
+ name: string;
49478
+ avatar?: string | undefined;
49479
+ nickname?: string | undefined;
49480
+ onboarding?: {
49481
+ companyName?: string | undefined;
49482
+ numberOfPeopleInOrg?: string | undefined;
49483
+ numberOfPeopleInDesignTeam?: string | undefined;
49484
+ department?: "Design" | "Engineering" | "Product" | "Brand" | "Other" | undefined;
49485
+ jobTitle?: string | undefined;
49486
+ phase?: string | undefined;
49487
+ jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
49488
+ designSystemName?: string | undefined;
49489
+ defaultDestination?: string | undefined;
49490
+ isPageDraftOnboardingFinished?: boolean | undefined;
49443
49491
  } | undefined;
49444
- stripeSubscriptionMainItemId?: string | undefined;
49445
- currentPeriodStart?: string | undefined;
49446
- currentPeriodEnd?: string | undefined;
49447
- subscriptionStatusUpdatedAt?: string | undefined;
49448
- cancelAt?: string | null | undefined;
49449
- billingType?: "Auto" | "Invoice" | undefined;
49450
- daysUntilDue?: number | undefined;
49451
49492
  };
49452
- npmRegistry?: {
49453
- enabledScopes: string[];
49454
- bypassProxy: boolean;
49455
- registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
49456
- authType: "Custom" | "None" | "Basic" | "Bearer";
49457
- registryUrl: string;
49458
- proxyUrl: string;
49459
- customRegistryUrl?: string | undefined;
49460
- accessToken?: string | undefined;
49461
- username?: string | undefined;
49462
- password?: string | undefined;
49463
- } | undefined;
49493
+ email: string;
49494
+ source?: "SignUp" | "Invite" | "SSO" | undefined;
49495
+ loggedOutAt?: Date | undefined;
49496
+ };
49497
+ }>;
49498
+ updateProfile(uid: string, body: DTOUserProfileUpdate): Promise<{
49499
+ user: {
49500
+ id: string;
49501
+ createdAt: Date;
49502
+ profile: {
49503
+ name: string;
49504
+ avatar?: string | undefined;
49505
+ nickname?: string | undefined;
49506
+ onboarding?: {
49507
+ companyName?: string | undefined;
49508
+ numberOfPeopleInOrg?: string | undefined;
49509
+ numberOfPeopleInDesignTeam?: string | undefined;
49510
+ department?: "Design" | "Engineering" | "Product" | "Brand" | "Other" | undefined;
49511
+ jobTitle?: string | undefined;
49512
+ phase?: string | undefined;
49513
+ jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
49514
+ designSystemName?: string | undefined;
49515
+ defaultDestination?: string | undefined;
49516
+ isPageDraftOnboardingFinished?: boolean | undefined;
49517
+ } | undefined;
49518
+ };
49519
+ email: string;
49520
+ source?: "SignUp" | "Invite" | "SSO" | undefined;
49521
+ loggedOutAt?: Date | undefined;
49464
49522
  };
49465
49523
  }>;
49466
- delete(workspaceId: string): Promise<any>;
49467
- subscription(workspaceId: string): Promise<any>;
49468
49524
  }
49469
49525
 
49470
49526
  type SupernovaApiClientConfig = {