@supernova-studio/client 0.55.20 → 0.55.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +654 -654
- package/dist/index.d.ts +654 -654
- package/dist/index.js +35 -35
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +35 -35
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -48218,221 +48218,58 @@ declare class DesignSystemsEndpoint {
|
|
|
48218
48218
|
}>;
|
|
48219
48219
|
}
|
|
48220
48220
|
|
|
48221
|
-
|
|
48222
|
-
type RequestEexecutorServerErrorCode = SupernovaExceptionType | undefined;
|
|
48223
|
-
declare class RequestExecutorError extends Error {
|
|
48224
|
-
readonly type: RequestExecutorErrorType;
|
|
48225
|
-
readonly errorCode: RequestEexecutorServerErrorCode;
|
|
48226
|
-
readonly serverErrorType: SupernovaExceptionType | undefined;
|
|
48227
|
-
static tryParseErrorCode(body: string): any;
|
|
48228
|
-
static tryParseServerErrorType(body: string): any;
|
|
48229
|
-
static serverError(endpoint: string, status: number, bodyText: string): RequestExecutorError;
|
|
48230
|
-
static responseParsingError(endpoint: string, cause: Error): RequestExecutorError;
|
|
48231
|
-
private constructor();
|
|
48232
|
-
}
|
|
48233
|
-
|
|
48234
|
-
declare class WorkspaceInvitationsEndpoint {
|
|
48221
|
+
declare class TokenCollectionsEndpoint {
|
|
48235
48222
|
private readonly requestExecutor;
|
|
48236
48223
|
constructor(requestExecutor: RequestExecutor);
|
|
48237
|
-
list(
|
|
48238
|
-
|
|
48224
|
+
list(dsId: string, vId: string): Promise<{
|
|
48225
|
+
collections: {
|
|
48239
48226
|
id: string;
|
|
48227
|
+
persistentId: string;
|
|
48228
|
+
meta: {
|
|
48229
|
+
name: string;
|
|
48230
|
+
description?: string | undefined;
|
|
48231
|
+
};
|
|
48232
|
+
designSystemVersionId: string;
|
|
48240
48233
|
createdAt: Date;
|
|
48241
|
-
|
|
48242
|
-
|
|
48243
|
-
|
|
48244
|
-
|
|
48245
|
-
|
|
48234
|
+
updatedAt: Date;
|
|
48235
|
+
origin: {
|
|
48236
|
+
id: string;
|
|
48237
|
+
sourceId: string;
|
|
48238
|
+
};
|
|
48246
48239
|
}[];
|
|
48247
48240
|
}>;
|
|
48248
|
-
|
|
48249
|
-
|
|
48241
|
+
}
|
|
48242
|
+
|
|
48243
|
+
declare class UsersEndpoint {
|
|
48244
|
+
private readonly requestExecutor;
|
|
48245
|
+
constructor(requestExecutor: RequestExecutor);
|
|
48246
|
+
getMe(): Promise<{
|
|
48247
|
+
user: {
|
|
48250
48248
|
id: string;
|
|
48249
|
+
createdAt: Date;
|
|
48251
48250
|
profile: {
|
|
48252
48251
|
name: string;
|
|
48253
|
-
color: string;
|
|
48254
|
-
handle: string;
|
|
48255
48252
|
avatar?: string | undefined;
|
|
48256
|
-
|
|
48257
|
-
|
|
48258
|
-
street1?: string | undefined;
|
|
48259
|
-
street2?: string | undefined;
|
|
48260
|
-
city?: string | undefined;
|
|
48261
|
-
postal?: string | undefined;
|
|
48262
|
-
country?: string | undefined;
|
|
48263
|
-
state?: string | undefined;
|
|
48264
|
-
} | undefined;
|
|
48265
|
-
email?: string | undefined;
|
|
48253
|
+
nickname?: string | undefined;
|
|
48254
|
+
onboarding?: {
|
|
48266
48255
|
companyName?: string | undefined;
|
|
48267
|
-
|
|
48268
|
-
|
|
48269
|
-
|
|
48270
|
-
|
|
48271
|
-
|
|
48272
|
-
|
|
48273
|
-
|
|
48274
|
-
|
|
48275
|
-
|
|
48276
|
-
planInterval: "yearly" | "daily" | "monthly" | "weekly";
|
|
48277
|
-
seats: number;
|
|
48278
|
-
seatLimit: number;
|
|
48279
|
-
status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
48280
|
-
card?: {
|
|
48281
|
-
cardId?: string | null | undefined;
|
|
48282
|
-
last4?: string | null | undefined;
|
|
48283
|
-
expiryMonth?: string | null | undefined;
|
|
48284
|
-
expiryYear?: string | null | undefined;
|
|
48285
|
-
brand?: string | null | undefined;
|
|
48286
|
-
name?: string | null | undefined;
|
|
48287
|
-
} | undefined;
|
|
48288
|
-
amount?: number | null | undefined;
|
|
48289
|
-
stripeProductDescription?: string | undefined;
|
|
48290
|
-
isPricePerCreator?: boolean | undefined;
|
|
48291
|
-
isTrial?: boolean | undefined;
|
|
48292
|
-
legacyVersion?: string | undefined;
|
|
48293
|
-
stripeProductFeatures?: string[] | undefined;
|
|
48294
|
-
stripeProductAdditionalFeatures?: string[] | undefined;
|
|
48295
|
-
stripeSubscriptionId?: string | null | undefined;
|
|
48296
|
-
stripeCustomerId?: string | null | undefined;
|
|
48297
|
-
subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
|
|
48298
|
-
internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
48299
|
-
featuresSummary?: {
|
|
48300
|
-
designSystems: {
|
|
48301
|
-
max: number;
|
|
48302
|
-
errorMessage: string;
|
|
48303
|
-
errorReason: string;
|
|
48304
|
-
};
|
|
48305
|
-
designSystemSources: {
|
|
48306
|
-
max: number;
|
|
48307
|
-
errorMessage: string;
|
|
48308
|
-
errorReason: string;
|
|
48309
|
-
noImportJobsErrorMessage: string;
|
|
48310
|
-
noImportJobsErrorReason: string;
|
|
48311
|
-
};
|
|
48312
|
-
designSystemVersions: {
|
|
48313
|
-
max: number;
|
|
48314
|
-
errorMessage: string;
|
|
48315
|
-
errorReason: string;
|
|
48316
|
-
};
|
|
48317
|
-
themes: {
|
|
48318
|
-
max: number;
|
|
48319
|
-
errorMessage: string;
|
|
48320
|
-
errorReason: string;
|
|
48321
|
-
};
|
|
48322
|
-
brands: {
|
|
48323
|
-
max: number;
|
|
48324
|
-
errorMessage: string;
|
|
48325
|
-
errorReason: string;
|
|
48326
|
-
};
|
|
48327
|
-
codegenSchedules: {
|
|
48328
|
-
max: number;
|
|
48329
|
-
errorMessage: string;
|
|
48330
|
-
errorReason: string;
|
|
48331
|
-
};
|
|
48332
|
-
publicDocumentation: {
|
|
48333
|
-
errorMessage: string;
|
|
48334
|
-
errorReason: string;
|
|
48335
|
-
enabled: boolean;
|
|
48336
|
-
};
|
|
48337
|
-
customDocumentationUrl: {
|
|
48338
|
-
errorMessage: string;
|
|
48339
|
-
errorReason: string;
|
|
48340
|
-
enabled: boolean;
|
|
48341
|
-
};
|
|
48342
|
-
customDocumentationViewButton: {
|
|
48343
|
-
errorMessage: string;
|
|
48344
|
-
errorReason: string;
|
|
48345
|
-
enabled: boolean;
|
|
48346
|
-
};
|
|
48347
|
-
designSystemSourceAutoImport: {
|
|
48348
|
-
errorMessage: string;
|
|
48349
|
-
errorReason: string;
|
|
48350
|
-
enabled: boolean;
|
|
48351
|
-
};
|
|
48352
|
-
designSystemSlug: {
|
|
48353
|
-
errorMessage: string;
|
|
48354
|
-
errorReason: string;
|
|
48355
|
-
enabled: boolean;
|
|
48356
|
-
};
|
|
48357
|
-
ipWhitelisting: {
|
|
48358
|
-
errorMessage: string;
|
|
48359
|
-
errorReason: string;
|
|
48360
|
-
enabled: boolean;
|
|
48361
|
-
};
|
|
48362
|
-
npmRegistry: {
|
|
48363
|
-
errorMessage: string;
|
|
48364
|
-
errorReason: string;
|
|
48365
|
-
enabled: boolean;
|
|
48366
|
-
};
|
|
48367
|
-
sso: {
|
|
48368
|
-
errorMessage: string;
|
|
48369
|
-
errorReason: string;
|
|
48370
|
-
enabled: boolean;
|
|
48371
|
-
};
|
|
48372
|
-
workspacePaidSeats: {
|
|
48373
|
-
max: number;
|
|
48374
|
-
errorMessage: string;
|
|
48375
|
-
errorReason: string;
|
|
48376
|
-
};
|
|
48377
|
-
workspaceViewers: {
|
|
48378
|
-
max: number;
|
|
48379
|
-
errorMessage: string;
|
|
48380
|
-
errorReason: string;
|
|
48381
|
-
};
|
|
48382
|
-
customDocumentationExporter: {
|
|
48383
|
-
errorMessage: string;
|
|
48384
|
-
errorReason: string;
|
|
48385
|
-
enabled: boolean;
|
|
48386
|
-
};
|
|
48387
|
-
protectedPages: {
|
|
48388
|
-
errorMessage: string;
|
|
48389
|
-
errorReason: string;
|
|
48390
|
-
enabled: boolean;
|
|
48391
|
-
};
|
|
48392
|
-
approvals: {
|
|
48393
|
-
errorMessage: string;
|
|
48394
|
-
errorReason: string;
|
|
48395
|
-
enabled: boolean;
|
|
48396
|
-
};
|
|
48397
|
-
selectivePublishing: {
|
|
48398
|
-
errorMessage: string;
|
|
48399
|
-
errorReason: string;
|
|
48400
|
-
enabled: boolean;
|
|
48401
|
-
};
|
|
48402
|
-
designSystemAccessModes: {
|
|
48403
|
-
errorMessage: string;
|
|
48404
|
-
errorReason: string;
|
|
48405
|
-
enabled: boolean;
|
|
48406
|
-
};
|
|
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;
|
|
48407
48265
|
} | undefined;
|
|
48408
|
-
stripeSubscriptionMainItemId?: string | undefined;
|
|
48409
|
-
currentPeriodStart?: string | undefined;
|
|
48410
|
-
currentPeriodEnd?: string | undefined;
|
|
48411
|
-
subscriptionStatusUpdatedAt?: string | undefined;
|
|
48412
|
-
cancelAt?: string | null | undefined;
|
|
48413
|
-
billingType?: "Auto" | "Invoice" | undefined;
|
|
48414
|
-
daysUntilDue?: number | undefined;
|
|
48415
48266
|
};
|
|
48416
|
-
|
|
48417
|
-
|
|
48418
|
-
|
|
48419
|
-
registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
|
|
48420
|
-
authType: "Custom" | "None" | "Basic" | "Bearer";
|
|
48421
|
-
registryUrl: string;
|
|
48422
|
-
proxyUrl: string;
|
|
48423
|
-
customRegistryUrl?: string | undefined;
|
|
48424
|
-
accessToken?: string | undefined;
|
|
48425
|
-
username?: string | undefined;
|
|
48426
|
-
password?: string | undefined;
|
|
48427
|
-
} | undefined;
|
|
48267
|
+
email: string;
|
|
48268
|
+
source?: "SignUp" | "Invite" | "SSO" | undefined;
|
|
48269
|
+
loggedOutAt?: Date | undefined;
|
|
48428
48270
|
};
|
|
48429
48271
|
}>;
|
|
48430
|
-
|
|
48431
|
-
|
|
48432
|
-
declare class WorkspaceMembersEndpoint {
|
|
48433
|
-
private readonly requestExecutor;
|
|
48434
|
-
constructor(requestExecutor: RequestExecutor);
|
|
48435
|
-
list(workspaceId: string): Promise<{
|
|
48272
|
+
listWorkspaces(uid: string): Promise<{
|
|
48436
48273
|
membership: {
|
|
48437
48274
|
role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
|
|
48438
48275
|
effectiveRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
|
|
@@ -48618,190 +48455,88 @@ declare class WorkspaceMembersEndpoint {
|
|
|
48618
48455
|
};
|
|
48619
48456
|
}[];
|
|
48620
48457
|
}>;
|
|
48621
|
-
|
|
48622
|
-
|
|
48458
|
+
delete(uid: string): Promise<{
|
|
48459
|
+
user: {
|
|
48623
48460
|
id: string;
|
|
48461
|
+
createdAt: Date;
|
|
48624
48462
|
profile: {
|
|
48625
48463
|
name: string;
|
|
48626
|
-
color: string;
|
|
48627
|
-
handle: string;
|
|
48628
48464
|
avatar?: string | undefined;
|
|
48629
|
-
|
|
48630
|
-
|
|
48631
|
-
street1?: string | undefined;
|
|
48632
|
-
street2?: string | undefined;
|
|
48633
|
-
city?: string | undefined;
|
|
48634
|
-
postal?: string | undefined;
|
|
48635
|
-
country?: string | undefined;
|
|
48636
|
-
state?: string | undefined;
|
|
48637
|
-
} | undefined;
|
|
48638
|
-
email?: string | undefined;
|
|
48465
|
+
nickname?: string | undefined;
|
|
48466
|
+
onboarding?: {
|
|
48639
48467
|
companyName?: string | undefined;
|
|
48640
|
-
|
|
48641
|
-
|
|
48642
|
-
|
|
48643
|
-
|
|
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;
|
|
48644
48477
|
} | undefined;
|
|
48645
48478
|
};
|
|
48646
|
-
|
|
48647
|
-
|
|
48648
|
-
|
|
48649
|
-
|
|
48650
|
-
|
|
48651
|
-
|
|
48652
|
-
|
|
48653
|
-
|
|
48654
|
-
|
|
48655
|
-
|
|
48656
|
-
|
|
48657
|
-
|
|
48658
|
-
|
|
48659
|
-
|
|
48660
|
-
|
|
48661
|
-
|
|
48662
|
-
|
|
48663
|
-
|
|
48664
|
-
|
|
48665
|
-
|
|
48666
|
-
|
|
48667
|
-
|
|
48668
|
-
|
|
48669
|
-
|
|
48670
|
-
subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
|
|
48671
|
-
internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
48672
|
-
featuresSummary?: {
|
|
48673
|
-
designSystems: {
|
|
48674
|
-
max: number;
|
|
48675
|
-
errorMessage: string;
|
|
48676
|
-
errorReason: string;
|
|
48677
|
-
};
|
|
48678
|
-
designSystemSources: {
|
|
48679
|
-
max: number;
|
|
48680
|
-
errorMessage: string;
|
|
48681
|
-
errorReason: string;
|
|
48682
|
-
noImportJobsErrorMessage: string;
|
|
48683
|
-
noImportJobsErrorReason: string;
|
|
48684
|
-
};
|
|
48685
|
-
designSystemVersions: {
|
|
48686
|
-
max: number;
|
|
48687
|
-
errorMessage: string;
|
|
48688
|
-
errorReason: string;
|
|
48689
|
-
};
|
|
48690
|
-
themes: {
|
|
48691
|
-
max: number;
|
|
48692
|
-
errorMessage: string;
|
|
48693
|
-
errorReason: string;
|
|
48694
|
-
};
|
|
48695
|
-
brands: {
|
|
48696
|
-
max: number;
|
|
48697
|
-
errorMessage: string;
|
|
48698
|
-
errorReason: string;
|
|
48699
|
-
};
|
|
48700
|
-
codegenSchedules: {
|
|
48701
|
-
max: number;
|
|
48702
|
-
errorMessage: string;
|
|
48703
|
-
errorReason: string;
|
|
48704
|
-
};
|
|
48705
|
-
publicDocumentation: {
|
|
48706
|
-
errorMessage: string;
|
|
48707
|
-
errorReason: string;
|
|
48708
|
-
enabled: boolean;
|
|
48709
|
-
};
|
|
48710
|
-
customDocumentationUrl: {
|
|
48711
|
-
errorMessage: string;
|
|
48712
|
-
errorReason: string;
|
|
48713
|
-
enabled: boolean;
|
|
48714
|
-
};
|
|
48715
|
-
customDocumentationViewButton: {
|
|
48716
|
-
errorMessage: string;
|
|
48717
|
-
errorReason: string;
|
|
48718
|
-
enabled: boolean;
|
|
48719
|
-
};
|
|
48720
|
-
designSystemSourceAutoImport: {
|
|
48721
|
-
errorMessage: string;
|
|
48722
|
-
errorReason: string;
|
|
48723
|
-
enabled: boolean;
|
|
48724
|
-
};
|
|
48725
|
-
designSystemSlug: {
|
|
48726
|
-
errorMessage: string;
|
|
48727
|
-
errorReason: string;
|
|
48728
|
-
enabled: boolean;
|
|
48729
|
-
};
|
|
48730
|
-
ipWhitelisting: {
|
|
48731
|
-
errorMessage: string;
|
|
48732
|
-
errorReason: string;
|
|
48733
|
-
enabled: boolean;
|
|
48734
|
-
};
|
|
48735
|
-
npmRegistry: {
|
|
48736
|
-
errorMessage: string;
|
|
48737
|
-
errorReason: string;
|
|
48738
|
-
enabled: boolean;
|
|
48739
|
-
};
|
|
48740
|
-
sso: {
|
|
48741
|
-
errorMessage: string;
|
|
48742
|
-
errorReason: string;
|
|
48743
|
-
enabled: boolean;
|
|
48744
|
-
};
|
|
48745
|
-
workspacePaidSeats: {
|
|
48746
|
-
max: number;
|
|
48747
|
-
errorMessage: string;
|
|
48748
|
-
errorReason: string;
|
|
48749
|
-
};
|
|
48750
|
-
workspaceViewers: {
|
|
48751
|
-
max: number;
|
|
48752
|
-
errorMessage: string;
|
|
48753
|
-
errorReason: string;
|
|
48754
|
-
};
|
|
48755
|
-
customDocumentationExporter: {
|
|
48756
|
-
errorMessage: string;
|
|
48757
|
-
errorReason: string;
|
|
48758
|
-
enabled: boolean;
|
|
48759
|
-
};
|
|
48760
|
-
protectedPages: {
|
|
48761
|
-
errorMessage: string;
|
|
48762
|
-
errorReason: string;
|
|
48763
|
-
enabled: boolean;
|
|
48764
|
-
};
|
|
48765
|
-
approvals: {
|
|
48766
|
-
errorMessage: string;
|
|
48767
|
-
errorReason: string;
|
|
48768
|
-
enabled: boolean;
|
|
48769
|
-
};
|
|
48770
|
-
selectivePublishing: {
|
|
48771
|
-
errorMessage: string;
|
|
48772
|
-
errorReason: string;
|
|
48773
|
-
enabled: boolean;
|
|
48774
|
-
};
|
|
48775
|
-
designSystemAccessModes: {
|
|
48776
|
-
errorMessage: string;
|
|
48777
|
-
errorReason: string;
|
|
48778
|
-
enabled: boolean;
|
|
48779
|
-
};
|
|
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;
|
|
48780
48503
|
} | undefined;
|
|
48781
|
-
stripeSubscriptionMainItemId?: string | undefined;
|
|
48782
|
-
currentPeriodStart?: string | undefined;
|
|
48783
|
-
currentPeriodEnd?: string | undefined;
|
|
48784
|
-
subscriptionStatusUpdatedAt?: string | undefined;
|
|
48785
|
-
cancelAt?: string | null | undefined;
|
|
48786
|
-
billingType?: "Auto" | "Invoice" | undefined;
|
|
48787
|
-
daysUntilDue?: number | undefined;
|
|
48788
48504
|
};
|
|
48789
|
-
|
|
48790
|
-
|
|
48791
|
-
|
|
48792
|
-
registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
|
|
48793
|
-
authType: "Custom" | "None" | "Basic" | "Bearer";
|
|
48794
|
-
registryUrl: string;
|
|
48795
|
-
proxyUrl: string;
|
|
48796
|
-
customRegistryUrl?: string | undefined;
|
|
48797
|
-
accessToken?: string | undefined;
|
|
48798
|
-
username?: string | undefined;
|
|
48799
|
-
password?: string | undefined;
|
|
48800
|
-
} | undefined;
|
|
48505
|
+
email: string;
|
|
48506
|
+
source?: "SignUp" | "Invite" | "SSO" | undefined;
|
|
48507
|
+
loggedOutAt?: Date | undefined;
|
|
48801
48508
|
};
|
|
48802
48509
|
}>;
|
|
48803
|
-
|
|
48804
|
-
|
|
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<{
|
|
48805
48540
|
workspace: {
|
|
48806
48541
|
id: string;
|
|
48807
48542
|
profile: {
|
|
@@ -48985,249 +48720,10 @@ declare class WorkspaceMembersEndpoint {
|
|
|
48985
48720
|
}>;
|
|
48986
48721
|
}
|
|
48987
48722
|
|
|
48988
|
-
declare class
|
|
48723
|
+
declare class WorkspaceMembersEndpoint {
|
|
48989
48724
|
private readonly requestExecutor;
|
|
48990
|
-
members: WorkspaceMembersEndpoint;
|
|
48991
|
-
invitations: WorkspaceInvitationsEndpoint;
|
|
48992
48725
|
constructor(requestExecutor: RequestExecutor);
|
|
48993
|
-
|
|
48994
|
-
workspace: {
|
|
48995
|
-
id: string;
|
|
48996
|
-
profile: {
|
|
48997
|
-
name: string;
|
|
48998
|
-
color: string;
|
|
48999
|
-
handle: string;
|
|
49000
|
-
avatar?: string | undefined;
|
|
49001
|
-
billingDetails?: {
|
|
49002
|
-
address?: {
|
|
49003
|
-
street1?: string | undefined;
|
|
49004
|
-
street2?: string | undefined;
|
|
49005
|
-
city?: string | undefined;
|
|
49006
|
-
postal?: string | undefined;
|
|
49007
|
-
country?: string | undefined;
|
|
49008
|
-
state?: string | undefined;
|
|
49009
|
-
} | undefined;
|
|
49010
|
-
email?: string | undefined;
|
|
49011
|
-
companyName?: string | undefined;
|
|
49012
|
-
companyId?: string | undefined;
|
|
49013
|
-
notes?: string | undefined;
|
|
49014
|
-
vat?: string | undefined;
|
|
49015
|
-
poNumber?: string | undefined;
|
|
49016
|
-
} | undefined;
|
|
49017
|
-
};
|
|
49018
|
-
subscription: {
|
|
49019
|
-
product: "free" | "team" | "company" | "enterprise";
|
|
49020
|
-
planPriceId: string;
|
|
49021
|
-
planInterval: "yearly" | "daily" | "monthly" | "weekly";
|
|
49022
|
-
seats: number;
|
|
49023
|
-
seatLimit: number;
|
|
49024
|
-
status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
49025
|
-
card?: {
|
|
49026
|
-
cardId?: string | null | undefined;
|
|
49027
|
-
last4?: string | null | undefined;
|
|
49028
|
-
expiryMonth?: string | null | undefined;
|
|
49029
|
-
expiryYear?: string | null | undefined;
|
|
49030
|
-
brand?: string | null | undefined;
|
|
49031
|
-
name?: string | null | undefined;
|
|
49032
|
-
} | undefined;
|
|
49033
|
-
amount?: number | null | undefined;
|
|
49034
|
-
stripeProductDescription?: string | undefined;
|
|
49035
|
-
isPricePerCreator?: boolean | undefined;
|
|
49036
|
-
isTrial?: boolean | undefined;
|
|
49037
|
-
legacyVersion?: string | undefined;
|
|
49038
|
-
stripeProductFeatures?: string[] | undefined;
|
|
49039
|
-
stripeProductAdditionalFeatures?: string[] | undefined;
|
|
49040
|
-
stripeSubscriptionId?: string | null | undefined;
|
|
49041
|
-
stripeCustomerId?: string | null | undefined;
|
|
49042
|
-
subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
|
|
49043
|
-
internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
49044
|
-
featuresSummary?: {
|
|
49045
|
-
designSystems: {
|
|
49046
|
-
max: number;
|
|
49047
|
-
errorMessage: string;
|
|
49048
|
-
errorReason: string;
|
|
49049
|
-
};
|
|
49050
|
-
designSystemSources: {
|
|
49051
|
-
max: number;
|
|
49052
|
-
errorMessage: string;
|
|
49053
|
-
errorReason: string;
|
|
49054
|
-
noImportJobsErrorMessage: string;
|
|
49055
|
-
noImportJobsErrorReason: string;
|
|
49056
|
-
};
|
|
49057
|
-
designSystemVersions: {
|
|
49058
|
-
max: number;
|
|
49059
|
-
errorMessage: string;
|
|
49060
|
-
errorReason: string;
|
|
49061
|
-
};
|
|
49062
|
-
themes: {
|
|
49063
|
-
max: number;
|
|
49064
|
-
errorMessage: string;
|
|
49065
|
-
errorReason: string;
|
|
49066
|
-
};
|
|
49067
|
-
brands: {
|
|
49068
|
-
max: number;
|
|
49069
|
-
errorMessage: string;
|
|
49070
|
-
errorReason: string;
|
|
49071
|
-
};
|
|
49072
|
-
codegenSchedules: {
|
|
49073
|
-
max: number;
|
|
49074
|
-
errorMessage: string;
|
|
49075
|
-
errorReason: string;
|
|
49076
|
-
};
|
|
49077
|
-
publicDocumentation: {
|
|
49078
|
-
errorMessage: string;
|
|
49079
|
-
errorReason: string;
|
|
49080
|
-
enabled: boolean;
|
|
49081
|
-
};
|
|
49082
|
-
customDocumentationUrl: {
|
|
49083
|
-
errorMessage: string;
|
|
49084
|
-
errorReason: string;
|
|
49085
|
-
enabled: boolean;
|
|
49086
|
-
};
|
|
49087
|
-
customDocumentationViewButton: {
|
|
49088
|
-
errorMessage: string;
|
|
49089
|
-
errorReason: string;
|
|
49090
|
-
enabled: boolean;
|
|
49091
|
-
};
|
|
49092
|
-
designSystemSourceAutoImport: {
|
|
49093
|
-
errorMessage: string;
|
|
49094
|
-
errorReason: string;
|
|
49095
|
-
enabled: boolean;
|
|
49096
|
-
};
|
|
49097
|
-
designSystemSlug: {
|
|
49098
|
-
errorMessage: string;
|
|
49099
|
-
errorReason: string;
|
|
49100
|
-
enabled: boolean;
|
|
49101
|
-
};
|
|
49102
|
-
ipWhitelisting: {
|
|
49103
|
-
errorMessage: string;
|
|
49104
|
-
errorReason: string;
|
|
49105
|
-
enabled: boolean;
|
|
49106
|
-
};
|
|
49107
|
-
npmRegistry: {
|
|
49108
|
-
errorMessage: string;
|
|
49109
|
-
errorReason: string;
|
|
49110
|
-
enabled: boolean;
|
|
49111
|
-
};
|
|
49112
|
-
sso: {
|
|
49113
|
-
errorMessage: string;
|
|
49114
|
-
errorReason: string;
|
|
49115
|
-
enabled: boolean;
|
|
49116
|
-
};
|
|
49117
|
-
workspacePaidSeats: {
|
|
49118
|
-
max: number;
|
|
49119
|
-
errorMessage: string;
|
|
49120
|
-
errorReason: string;
|
|
49121
|
-
};
|
|
49122
|
-
workspaceViewers: {
|
|
49123
|
-
max: number;
|
|
49124
|
-
errorMessage: string;
|
|
49125
|
-
errorReason: string;
|
|
49126
|
-
};
|
|
49127
|
-
customDocumentationExporter: {
|
|
49128
|
-
errorMessage: string;
|
|
49129
|
-
errorReason: string;
|
|
49130
|
-
enabled: boolean;
|
|
49131
|
-
};
|
|
49132
|
-
protectedPages: {
|
|
49133
|
-
errorMessage: string;
|
|
49134
|
-
errorReason: string;
|
|
49135
|
-
enabled: boolean;
|
|
49136
|
-
};
|
|
49137
|
-
approvals: {
|
|
49138
|
-
errorMessage: string;
|
|
49139
|
-
errorReason: string;
|
|
49140
|
-
enabled: boolean;
|
|
49141
|
-
};
|
|
49142
|
-
selectivePublishing: {
|
|
49143
|
-
errorMessage: string;
|
|
49144
|
-
errorReason: string;
|
|
49145
|
-
enabled: boolean;
|
|
49146
|
-
};
|
|
49147
|
-
designSystemAccessModes: {
|
|
49148
|
-
errorMessage: string;
|
|
49149
|
-
errorReason: string;
|
|
49150
|
-
enabled: boolean;
|
|
49151
|
-
};
|
|
49152
|
-
} | undefined;
|
|
49153
|
-
stripeSubscriptionMainItemId?: string | undefined;
|
|
49154
|
-
currentPeriodStart?: string | undefined;
|
|
49155
|
-
currentPeriodEnd?: string | undefined;
|
|
49156
|
-
subscriptionStatusUpdatedAt?: string | undefined;
|
|
49157
|
-
cancelAt?: string | null | undefined;
|
|
49158
|
-
billingType?: "Auto" | "Invoice" | undefined;
|
|
49159
|
-
daysUntilDue?: number | undefined;
|
|
49160
|
-
};
|
|
49161
|
-
npmRegistry?: {
|
|
49162
|
-
enabledScopes: string[];
|
|
49163
|
-
bypassProxy: boolean;
|
|
49164
|
-
registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
|
|
49165
|
-
authType: "Custom" | "None" | "Basic" | "Bearer";
|
|
49166
|
-
registryUrl: string;
|
|
49167
|
-
proxyUrl: string;
|
|
49168
|
-
customRegistryUrl?: string | undefined;
|
|
49169
|
-
accessToken?: string | undefined;
|
|
49170
|
-
username?: string | undefined;
|
|
49171
|
-
password?: string | undefined;
|
|
49172
|
-
} | undefined;
|
|
49173
|
-
};
|
|
49174
|
-
}>;
|
|
49175
|
-
delete(workspaceId: string): Promise<any>;
|
|
49176
|
-
subscription(workspaceId: string): Promise<any>;
|
|
49177
|
-
}
|
|
49178
|
-
|
|
49179
|
-
declare class TokenCollectionsEndpoint {
|
|
49180
|
-
private readonly requestExecutor;
|
|
49181
|
-
constructor(requestExecutor: RequestExecutor);
|
|
49182
|
-
list(dsId: string, vId: string): Promise<{
|
|
49183
|
-
collections: {
|
|
49184
|
-
id: string;
|
|
49185
|
-
persistentId: string;
|
|
49186
|
-
meta: {
|
|
49187
|
-
name: string;
|
|
49188
|
-
description?: string | undefined;
|
|
49189
|
-
};
|
|
49190
|
-
designSystemVersionId: string;
|
|
49191
|
-
createdAt: Date;
|
|
49192
|
-
updatedAt: Date;
|
|
49193
|
-
origin: {
|
|
49194
|
-
id: string;
|
|
49195
|
-
sourceId: string;
|
|
49196
|
-
};
|
|
49197
|
-
}[];
|
|
49198
|
-
}>;
|
|
49199
|
-
}
|
|
49200
|
-
|
|
49201
|
-
declare class UsersEndpoint {
|
|
49202
|
-
private readonly requestExecutor;
|
|
49203
|
-
constructor(requestExecutor: RequestExecutor);
|
|
49204
|
-
getMe(): Promise<{
|
|
49205
|
-
user: {
|
|
49206
|
-
id: string;
|
|
49207
|
-
createdAt: Date;
|
|
49208
|
-
profile: {
|
|
49209
|
-
name: string;
|
|
49210
|
-
avatar?: string | undefined;
|
|
49211
|
-
nickname?: string | undefined;
|
|
49212
|
-
onboarding?: {
|
|
49213
|
-
companyName?: string | undefined;
|
|
49214
|
-
numberOfPeopleInOrg?: string | undefined;
|
|
49215
|
-
numberOfPeopleInDesignTeam?: string | undefined;
|
|
49216
|
-
department?: "Design" | "Engineering" | "Product" | "Brand" | "Other" | undefined;
|
|
49217
|
-
jobTitle?: string | undefined;
|
|
49218
|
-
phase?: string | undefined;
|
|
49219
|
-
jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
|
|
49220
|
-
designSystemName?: string | undefined;
|
|
49221
|
-
defaultDestination?: string | undefined;
|
|
49222
|
-
isPageDraftOnboardingFinished?: boolean | undefined;
|
|
49223
|
-
} | undefined;
|
|
49224
|
-
};
|
|
49225
|
-
email: string;
|
|
49226
|
-
source?: "SignUp" | "Invite" | "SSO" | undefined;
|
|
49227
|
-
loggedOutAt?: Date | undefined;
|
|
49228
|
-
};
|
|
49229
|
-
}>;
|
|
49230
|
-
listWorkspaces(uid: string): Promise<{
|
|
48726
|
+
list(workspaceId: string): Promise<{
|
|
49231
48727
|
membership: {
|
|
49232
48728
|
role: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
|
|
49233
48729
|
effectiveRole: "Owner" | "Admin" | "Creator" | "Viewer" | "Billing" | "Contributor";
|
|
@@ -49413,58 +48909,562 @@ declare class UsersEndpoint {
|
|
|
49413
48909
|
};
|
|
49414
48910
|
}[];
|
|
49415
48911
|
}>;
|
|
49416
|
-
|
|
49417
|
-
|
|
48912
|
+
update(workspaceId: string, body: UpdateMembershipRolesInput): Promise<{
|
|
48913
|
+
workspace: {
|
|
49418
48914
|
id: string;
|
|
49419
|
-
createdAt: Date;
|
|
49420
48915
|
profile: {
|
|
49421
48916
|
name: string;
|
|
48917
|
+
color: string;
|
|
48918
|
+
handle: string;
|
|
49422
48919
|
avatar?: string | undefined;
|
|
49423
|
-
|
|
49424
|
-
|
|
48920
|
+
billingDetails?: {
|
|
48921
|
+
address?: {
|
|
48922
|
+
street1?: string | undefined;
|
|
48923
|
+
street2?: string | undefined;
|
|
48924
|
+
city?: string | undefined;
|
|
48925
|
+
postal?: string | undefined;
|
|
48926
|
+
country?: string | undefined;
|
|
48927
|
+
state?: string | undefined;
|
|
48928
|
+
} | undefined;
|
|
48929
|
+
email?: string | undefined;
|
|
49425
48930
|
companyName?: string | undefined;
|
|
49426
|
-
|
|
49427
|
-
|
|
49428
|
-
|
|
49429
|
-
|
|
49430
|
-
phase?: string | undefined;
|
|
49431
|
-
jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
|
|
49432
|
-
designSystemName?: string | undefined;
|
|
49433
|
-
defaultDestination?: string | undefined;
|
|
49434
|
-
isPageDraftOnboardingFinished?: boolean | undefined;
|
|
48931
|
+
companyId?: string | undefined;
|
|
48932
|
+
notes?: string | undefined;
|
|
48933
|
+
vat?: string | undefined;
|
|
48934
|
+
poNumber?: string | undefined;
|
|
49435
48935
|
} | undefined;
|
|
49436
48936
|
};
|
|
49437
|
-
|
|
49438
|
-
|
|
49439
|
-
|
|
49440
|
-
|
|
49441
|
-
|
|
49442
|
-
|
|
49443
|
-
|
|
49444
|
-
|
|
49445
|
-
|
|
49446
|
-
|
|
49447
|
-
|
|
49448
|
-
|
|
49449
|
-
|
|
49450
|
-
|
|
48937
|
+
subscription: {
|
|
48938
|
+
product: "free" | "team" | "company" | "enterprise";
|
|
48939
|
+
planPriceId: string;
|
|
48940
|
+
planInterval: "yearly" | "daily" | "monthly" | "weekly";
|
|
48941
|
+
seats: number;
|
|
48942
|
+
seatLimit: number;
|
|
48943
|
+
status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
48944
|
+
card?: {
|
|
48945
|
+
cardId?: string | null | undefined;
|
|
48946
|
+
last4?: string | null | undefined;
|
|
48947
|
+
expiryMonth?: string | null | undefined;
|
|
48948
|
+
expiryYear?: string | null | undefined;
|
|
48949
|
+
brand?: string | null | undefined;
|
|
48950
|
+
name?: string | null | undefined;
|
|
48951
|
+
} | undefined;
|
|
48952
|
+
amount?: number | null | undefined;
|
|
48953
|
+
stripeProductDescription?: string | undefined;
|
|
48954
|
+
isPricePerCreator?: boolean | undefined;
|
|
48955
|
+
isTrial?: boolean | undefined;
|
|
48956
|
+
legacyVersion?: string | undefined;
|
|
48957
|
+
stripeProductFeatures?: string[] | undefined;
|
|
48958
|
+
stripeProductAdditionalFeatures?: string[] | undefined;
|
|
48959
|
+
stripeSubscriptionId?: string | null | undefined;
|
|
48960
|
+
stripeCustomerId?: string | null | undefined;
|
|
48961
|
+
subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
|
|
48962
|
+
internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
48963
|
+
featuresSummary?: {
|
|
48964
|
+
designSystems: {
|
|
48965
|
+
max: number;
|
|
48966
|
+
errorMessage: string;
|
|
48967
|
+
errorReason: string;
|
|
48968
|
+
};
|
|
48969
|
+
designSystemSources: {
|
|
48970
|
+
max: number;
|
|
48971
|
+
errorMessage: string;
|
|
48972
|
+
errorReason: string;
|
|
48973
|
+
noImportJobsErrorMessage: string;
|
|
48974
|
+
noImportJobsErrorReason: string;
|
|
48975
|
+
};
|
|
48976
|
+
designSystemVersions: {
|
|
48977
|
+
max: number;
|
|
48978
|
+
errorMessage: string;
|
|
48979
|
+
errorReason: string;
|
|
48980
|
+
};
|
|
48981
|
+
themes: {
|
|
48982
|
+
max: number;
|
|
48983
|
+
errorMessage: string;
|
|
48984
|
+
errorReason: string;
|
|
48985
|
+
};
|
|
48986
|
+
brands: {
|
|
48987
|
+
max: number;
|
|
48988
|
+
errorMessage: string;
|
|
48989
|
+
errorReason: string;
|
|
48990
|
+
};
|
|
48991
|
+
codegenSchedules: {
|
|
48992
|
+
max: number;
|
|
48993
|
+
errorMessage: string;
|
|
48994
|
+
errorReason: string;
|
|
48995
|
+
};
|
|
48996
|
+
publicDocumentation: {
|
|
48997
|
+
errorMessage: string;
|
|
48998
|
+
errorReason: string;
|
|
48999
|
+
enabled: boolean;
|
|
49000
|
+
};
|
|
49001
|
+
customDocumentationUrl: {
|
|
49002
|
+
errorMessage: string;
|
|
49003
|
+
errorReason: string;
|
|
49004
|
+
enabled: boolean;
|
|
49005
|
+
};
|
|
49006
|
+
customDocumentationViewButton: {
|
|
49007
|
+
errorMessage: string;
|
|
49008
|
+
errorReason: string;
|
|
49009
|
+
enabled: boolean;
|
|
49010
|
+
};
|
|
49011
|
+
designSystemSourceAutoImport: {
|
|
49012
|
+
errorMessage: string;
|
|
49013
|
+
errorReason: string;
|
|
49014
|
+
enabled: boolean;
|
|
49015
|
+
};
|
|
49016
|
+
designSystemSlug: {
|
|
49017
|
+
errorMessage: string;
|
|
49018
|
+
errorReason: string;
|
|
49019
|
+
enabled: boolean;
|
|
49020
|
+
};
|
|
49021
|
+
ipWhitelisting: {
|
|
49022
|
+
errorMessage: string;
|
|
49023
|
+
errorReason: string;
|
|
49024
|
+
enabled: boolean;
|
|
49025
|
+
};
|
|
49026
|
+
npmRegistry: {
|
|
49027
|
+
errorMessage: string;
|
|
49028
|
+
errorReason: string;
|
|
49029
|
+
enabled: boolean;
|
|
49030
|
+
};
|
|
49031
|
+
sso: {
|
|
49032
|
+
errorMessage: string;
|
|
49033
|
+
errorReason: string;
|
|
49034
|
+
enabled: boolean;
|
|
49035
|
+
};
|
|
49036
|
+
workspacePaidSeats: {
|
|
49037
|
+
max: number;
|
|
49038
|
+
errorMessage: string;
|
|
49039
|
+
errorReason: string;
|
|
49040
|
+
};
|
|
49041
|
+
workspaceViewers: {
|
|
49042
|
+
max: number;
|
|
49043
|
+
errorMessage: string;
|
|
49044
|
+
errorReason: string;
|
|
49045
|
+
};
|
|
49046
|
+
customDocumentationExporter: {
|
|
49047
|
+
errorMessage: string;
|
|
49048
|
+
errorReason: string;
|
|
49049
|
+
enabled: boolean;
|
|
49050
|
+
};
|
|
49051
|
+
protectedPages: {
|
|
49052
|
+
errorMessage: string;
|
|
49053
|
+
errorReason: string;
|
|
49054
|
+
enabled: boolean;
|
|
49055
|
+
};
|
|
49056
|
+
approvals: {
|
|
49057
|
+
errorMessage: string;
|
|
49058
|
+
errorReason: string;
|
|
49059
|
+
enabled: boolean;
|
|
49060
|
+
};
|
|
49061
|
+
selectivePublishing: {
|
|
49062
|
+
errorMessage: string;
|
|
49063
|
+
errorReason: string;
|
|
49064
|
+
enabled: boolean;
|
|
49065
|
+
};
|
|
49066
|
+
designSystemAccessModes: {
|
|
49067
|
+
errorMessage: string;
|
|
49068
|
+
errorReason: string;
|
|
49069
|
+
enabled: boolean;
|
|
49070
|
+
};
|
|
49071
|
+
} | undefined;
|
|
49072
|
+
stripeSubscriptionMainItemId?: string | undefined;
|
|
49073
|
+
currentPeriodStart?: string | undefined;
|
|
49074
|
+
currentPeriodEnd?: string | undefined;
|
|
49075
|
+
subscriptionStatusUpdatedAt?: string | undefined;
|
|
49076
|
+
cancelAt?: string | null | undefined;
|
|
49077
|
+
billingType?: "Auto" | "Invoice" | undefined;
|
|
49078
|
+
daysUntilDue?: number | undefined;
|
|
49079
|
+
};
|
|
49080
|
+
npmRegistry?: {
|
|
49081
|
+
enabledScopes: string[];
|
|
49082
|
+
bypassProxy: boolean;
|
|
49083
|
+
registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
|
|
49084
|
+
authType: "Custom" | "None" | "Basic" | "Bearer";
|
|
49085
|
+
registryUrl: string;
|
|
49086
|
+
proxyUrl: string;
|
|
49087
|
+
customRegistryUrl?: string | undefined;
|
|
49088
|
+
accessToken?: string | undefined;
|
|
49089
|
+
username?: string | undefined;
|
|
49090
|
+
password?: string | undefined;
|
|
49091
|
+
} | undefined;
|
|
49092
|
+
};
|
|
49093
|
+
}>;
|
|
49094
|
+
invite(workspaceId: string, body: DTOWorkspaceInvitationsListInput): Promise<any>;
|
|
49095
|
+
delete(workspaceId: string, userId: string): Promise<{
|
|
49096
|
+
workspace: {
|
|
49097
|
+
id: string;
|
|
49098
|
+
profile: {
|
|
49099
|
+
name: string;
|
|
49100
|
+
color: string;
|
|
49101
|
+
handle: string;
|
|
49102
|
+
avatar?: string | undefined;
|
|
49103
|
+
billingDetails?: {
|
|
49104
|
+
address?: {
|
|
49105
|
+
street1?: string | undefined;
|
|
49106
|
+
street2?: string | undefined;
|
|
49107
|
+
city?: string | undefined;
|
|
49108
|
+
postal?: string | undefined;
|
|
49109
|
+
country?: string | undefined;
|
|
49110
|
+
state?: string | undefined;
|
|
49111
|
+
} | undefined;
|
|
49112
|
+
email?: string | undefined;
|
|
49113
|
+
companyName?: string | undefined;
|
|
49114
|
+
companyId?: string | undefined;
|
|
49115
|
+
notes?: string | undefined;
|
|
49116
|
+
vat?: string | undefined;
|
|
49117
|
+
poNumber?: string | undefined;
|
|
49118
|
+
} | undefined;
|
|
49119
|
+
};
|
|
49120
|
+
subscription: {
|
|
49121
|
+
product: "free" | "team" | "company" | "enterprise";
|
|
49122
|
+
planPriceId: string;
|
|
49123
|
+
planInterval: "yearly" | "daily" | "monthly" | "weekly";
|
|
49124
|
+
seats: number;
|
|
49125
|
+
seatLimit: number;
|
|
49126
|
+
status?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
49127
|
+
card?: {
|
|
49128
|
+
cardId?: string | null | undefined;
|
|
49129
|
+
last4?: string | null | undefined;
|
|
49130
|
+
expiryMonth?: string | null | undefined;
|
|
49131
|
+
expiryYear?: string | null | undefined;
|
|
49132
|
+
brand?: string | null | undefined;
|
|
49133
|
+
name?: string | null | undefined;
|
|
49134
|
+
} | undefined;
|
|
49135
|
+
amount?: number | null | undefined;
|
|
49136
|
+
stripeProductDescription?: string | undefined;
|
|
49137
|
+
isPricePerCreator?: boolean | undefined;
|
|
49138
|
+
isTrial?: boolean | undefined;
|
|
49139
|
+
legacyVersion?: string | undefined;
|
|
49140
|
+
stripeProductFeatures?: string[] | undefined;
|
|
49141
|
+
stripeProductAdditionalFeatures?: string[] | undefined;
|
|
49142
|
+
stripeSubscriptionId?: string | null | undefined;
|
|
49143
|
+
stripeCustomerId?: string | null | undefined;
|
|
49144
|
+
subscriptionStatus?: "unknown" | "active" | "trialing" | "past_due" | "canceled" | "unpaid" | "incomplete_expired" | "incomplete" | undefined;
|
|
49145
|
+
internalStatus?: "active" | "suspended" | "gracePeriod" | "cancelled" | "downgraded_to_free" | undefined;
|
|
49146
|
+
featuresSummary?: {
|
|
49147
|
+
designSystems: {
|
|
49148
|
+
max: number;
|
|
49149
|
+
errorMessage: string;
|
|
49150
|
+
errorReason: string;
|
|
49151
|
+
};
|
|
49152
|
+
designSystemSources: {
|
|
49153
|
+
max: number;
|
|
49154
|
+
errorMessage: string;
|
|
49155
|
+
errorReason: string;
|
|
49156
|
+
noImportJobsErrorMessage: string;
|
|
49157
|
+
noImportJobsErrorReason: string;
|
|
49158
|
+
};
|
|
49159
|
+
designSystemVersions: {
|
|
49160
|
+
max: number;
|
|
49161
|
+
errorMessage: string;
|
|
49162
|
+
errorReason: string;
|
|
49163
|
+
};
|
|
49164
|
+
themes: {
|
|
49165
|
+
max: number;
|
|
49166
|
+
errorMessage: string;
|
|
49167
|
+
errorReason: string;
|
|
49168
|
+
};
|
|
49169
|
+
brands: {
|
|
49170
|
+
max: number;
|
|
49171
|
+
errorMessage: string;
|
|
49172
|
+
errorReason: string;
|
|
49173
|
+
};
|
|
49174
|
+
codegenSchedules: {
|
|
49175
|
+
max: number;
|
|
49176
|
+
errorMessage: string;
|
|
49177
|
+
errorReason: string;
|
|
49178
|
+
};
|
|
49179
|
+
publicDocumentation: {
|
|
49180
|
+
errorMessage: string;
|
|
49181
|
+
errorReason: string;
|
|
49182
|
+
enabled: boolean;
|
|
49183
|
+
};
|
|
49184
|
+
customDocumentationUrl: {
|
|
49185
|
+
errorMessage: string;
|
|
49186
|
+
errorReason: string;
|
|
49187
|
+
enabled: boolean;
|
|
49188
|
+
};
|
|
49189
|
+
customDocumentationViewButton: {
|
|
49190
|
+
errorMessage: string;
|
|
49191
|
+
errorReason: string;
|
|
49192
|
+
enabled: boolean;
|
|
49193
|
+
};
|
|
49194
|
+
designSystemSourceAutoImport: {
|
|
49195
|
+
errorMessage: string;
|
|
49196
|
+
errorReason: string;
|
|
49197
|
+
enabled: boolean;
|
|
49198
|
+
};
|
|
49199
|
+
designSystemSlug: {
|
|
49200
|
+
errorMessage: string;
|
|
49201
|
+
errorReason: string;
|
|
49202
|
+
enabled: boolean;
|
|
49203
|
+
};
|
|
49204
|
+
ipWhitelisting: {
|
|
49205
|
+
errorMessage: string;
|
|
49206
|
+
errorReason: string;
|
|
49207
|
+
enabled: boolean;
|
|
49208
|
+
};
|
|
49209
|
+
npmRegistry: {
|
|
49210
|
+
errorMessage: string;
|
|
49211
|
+
errorReason: string;
|
|
49212
|
+
enabled: boolean;
|
|
49213
|
+
};
|
|
49214
|
+
sso: {
|
|
49215
|
+
errorMessage: string;
|
|
49216
|
+
errorReason: string;
|
|
49217
|
+
enabled: boolean;
|
|
49218
|
+
};
|
|
49219
|
+
workspacePaidSeats: {
|
|
49220
|
+
max: number;
|
|
49221
|
+
errorMessage: string;
|
|
49222
|
+
errorReason: string;
|
|
49223
|
+
};
|
|
49224
|
+
workspaceViewers: {
|
|
49225
|
+
max: number;
|
|
49226
|
+
errorMessage: string;
|
|
49227
|
+
errorReason: string;
|
|
49228
|
+
};
|
|
49229
|
+
customDocumentationExporter: {
|
|
49230
|
+
errorMessage: string;
|
|
49231
|
+
errorReason: string;
|
|
49232
|
+
enabled: boolean;
|
|
49233
|
+
};
|
|
49234
|
+
protectedPages: {
|
|
49235
|
+
errorMessage: string;
|
|
49236
|
+
errorReason: string;
|
|
49237
|
+
enabled: boolean;
|
|
49238
|
+
};
|
|
49239
|
+
approvals: {
|
|
49240
|
+
errorMessage: string;
|
|
49241
|
+
errorReason: string;
|
|
49242
|
+
enabled: boolean;
|
|
49243
|
+
};
|
|
49244
|
+
selectivePublishing: {
|
|
49245
|
+
errorMessage: string;
|
|
49246
|
+
errorReason: string;
|
|
49247
|
+
enabled: boolean;
|
|
49248
|
+
};
|
|
49249
|
+
designSystemAccessModes: {
|
|
49250
|
+
errorMessage: string;
|
|
49251
|
+
errorReason: string;
|
|
49252
|
+
enabled: boolean;
|
|
49253
|
+
};
|
|
49254
|
+
} | undefined;
|
|
49255
|
+
stripeSubscriptionMainItemId?: string | undefined;
|
|
49256
|
+
currentPeriodStart?: string | undefined;
|
|
49257
|
+
currentPeriodEnd?: string | undefined;
|
|
49258
|
+
subscriptionStatusUpdatedAt?: string | undefined;
|
|
49259
|
+
cancelAt?: string | null | undefined;
|
|
49260
|
+
billingType?: "Auto" | "Invoice" | undefined;
|
|
49261
|
+
daysUntilDue?: number | undefined;
|
|
49262
|
+
};
|
|
49263
|
+
npmRegistry?: {
|
|
49264
|
+
enabledScopes: string[];
|
|
49265
|
+
bypassProxy: boolean;
|
|
49266
|
+
registryType: "Custom" | "NPMJS" | "GitHub" | "AzureDevOps" | "Artifactory";
|
|
49267
|
+
authType: "Custom" | "None" | "Basic" | "Bearer";
|
|
49268
|
+
registryUrl: string;
|
|
49269
|
+
proxyUrl: string;
|
|
49270
|
+
customRegistryUrl?: string | undefined;
|
|
49271
|
+
accessToken?: string | undefined;
|
|
49272
|
+
username?: string | undefined;
|
|
49273
|
+
password?: string | undefined;
|
|
49274
|
+
} | undefined;
|
|
49275
|
+
};
|
|
49276
|
+
}>;
|
|
49277
|
+
}
|
|
49278
|
+
|
|
49279
|
+
declare class WorkspacesEndpoint {
|
|
49280
|
+
private readonly requestExecutor;
|
|
49281
|
+
members: WorkspaceMembersEndpoint;
|
|
49282
|
+
invitations: WorkspaceInvitationsEndpoint;
|
|
49283
|
+
constructor(requestExecutor: RequestExecutor);
|
|
49284
|
+
create(body: DTOWorkspaceCreateInput): Promise<{
|
|
49285
|
+
workspace: {
|
|
49286
|
+
id: string;
|
|
49287
|
+
profile: {
|
|
49288
|
+
name: string;
|
|
49289
|
+
color: string;
|
|
49290
|
+
handle: string;
|
|
49291
|
+
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;
|
|
49451
49302
|
companyName?: string | undefined;
|
|
49452
|
-
|
|
49453
|
-
|
|
49454
|
-
|
|
49455
|
-
|
|
49456
|
-
phase?: string | undefined;
|
|
49457
|
-
jobLevel?: "Other" | "Executive" | "Manager" | "IndividualContributor" | undefined;
|
|
49458
|
-
designSystemName?: string | undefined;
|
|
49459
|
-
defaultDestination?: string | undefined;
|
|
49460
|
-
isPageDraftOnboardingFinished?: boolean | undefined;
|
|
49303
|
+
companyId?: string | undefined;
|
|
49304
|
+
notes?: string | undefined;
|
|
49305
|
+
vat?: string | undefined;
|
|
49306
|
+
poNumber?: string | undefined;
|
|
49461
49307
|
} | undefined;
|
|
49462
49308
|
};
|
|
49463
|
-
|
|
49464
|
-
|
|
49465
|
-
|
|
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;
|
|
49323
|
+
} | 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
|
+
};
|
|
49443
|
+
} | 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
|
+
};
|
|
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;
|
|
49466
49464
|
};
|
|
49467
49465
|
}>;
|
|
49466
|
+
delete(workspaceId: string): Promise<any>;
|
|
49467
|
+
subscription(workspaceId: string): Promise<any>;
|
|
49468
49468
|
}
|
|
49469
49469
|
|
|
49470
49470
|
type SupernovaApiClientConfig = {
|