@ticketlayer/backstage 1.1.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +1040 -514
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +133 -259
- package/dist/generated/types.d.ts +9458 -7656
- package/dist/generated/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -7,6 +7,7 @@ type CreateRoleRequest = components['schemas']['CreateRoleRequest'];
|
|
|
7
7
|
type CreateSubscriptionRequest = components['schemas']['CreateSubscriptionRequest'];
|
|
8
8
|
type CreateUserInvitationRequest = components['schemas']['CreateUserInvitationRequest'];
|
|
9
9
|
type CreateWebhookEndpoint = components['schemas']['CreateWebhookEndpoint'];
|
|
10
|
+
type GrantSalesChannelAccessRequest = components['schemas']['GrantSalesChannelAccessRequest'];
|
|
10
11
|
type LoginRequest = components['schemas']['LoginRequest'];
|
|
11
12
|
type RedeemInvitationRequest = components['schemas']['RedeemInvitationRequest'];
|
|
12
13
|
type RefreshTokenRequest = components['schemas']['RefreshTokenRequest'];
|
|
@@ -22,7 +23,12 @@ type ValidateLayoutChangesRequest = components['schemas']['ValidateLayoutChanges
|
|
|
22
23
|
export declare class BackstageAPIError extends Error {
|
|
23
24
|
readonly code: string;
|
|
24
25
|
readonly statusCode: number;
|
|
25
|
-
|
|
26
|
+
readonly moreInfo?: string;
|
|
27
|
+
readonly requestId?: string;
|
|
28
|
+
constructor(message: string, code: string, statusCode: number, details?: {
|
|
29
|
+
moreInfo?: string;
|
|
30
|
+
requestId?: string;
|
|
31
|
+
});
|
|
26
32
|
isPermissionDenied(): boolean;
|
|
27
33
|
isAuthenticationError(): boolean;
|
|
28
34
|
isSessionExpired(): boolean;
|
|
@@ -214,6 +220,7 @@ export declare class BackstageClient {
|
|
|
214
220
|
name: string;
|
|
215
221
|
slug: string;
|
|
216
222
|
plan: string;
|
|
223
|
+
template: string | null;
|
|
217
224
|
apiVersion: string;
|
|
218
225
|
};
|
|
219
226
|
owner: {
|
|
@@ -948,8 +955,11 @@ export declare class BackstageClient {
|
|
|
948
955
|
venueId?: any;
|
|
949
956
|
venueName?: any;
|
|
950
957
|
timezone?: string;
|
|
951
|
-
|
|
952
|
-
|
|
958
|
+
rules?: {
|
|
959
|
+
discoverable?: components["schemas"]["ListingRule"];
|
|
960
|
+
visible?: components["schemas"]["ListingRule"];
|
|
961
|
+
sellable?: components["schemas"]["ListingRule"];
|
|
962
|
+
};
|
|
953
963
|
tags?: string[];
|
|
954
964
|
ticketTypes?: {
|
|
955
965
|
id?: string;
|
|
@@ -981,12 +991,20 @@ export declare class BackstageClient {
|
|
|
981
991
|
organisationId: string;
|
|
982
992
|
accountId: string;
|
|
983
993
|
name: string;
|
|
994
|
+
subtitle: string | null;
|
|
984
995
|
description?: string;
|
|
996
|
+
shortDescription: string | null;
|
|
985
997
|
status: "draft" | "published" | "on_sale" | "sold_out" | "completed" | "cancelled";
|
|
998
|
+
images: components["schemas"]["EventImages"];
|
|
999
|
+
imageUrl: string | null;
|
|
1000
|
+
heroImageUrl: string | null;
|
|
1001
|
+
presentation: components["schemas"]["EventPresentation"];
|
|
986
1002
|
venueId?: string;
|
|
1003
|
+
venueName: string | null;
|
|
987
1004
|
timezone: string;
|
|
988
|
-
|
|
989
|
-
|
|
1005
|
+
rules: components["schemas"]["ListingRules"];
|
|
1006
|
+
ticketTypes: components["schemas"]["EventTicketType"][];
|
|
1007
|
+
defaultPriceSchemeId: string | null;
|
|
990
1008
|
occurrenceCount: number;
|
|
991
1009
|
ticketCount: number;
|
|
992
1010
|
productCount: number;
|
|
@@ -994,6 +1012,7 @@ export declare class BackstageClient {
|
|
|
994
1012
|
isDeleted: boolean;
|
|
995
1013
|
createdAt: string;
|
|
996
1014
|
updatedAt: string;
|
|
1015
|
+
contentUpdatedAt: string;
|
|
997
1016
|
createdBy?: string;
|
|
998
1017
|
}>;
|
|
999
1018
|
list: (options?: {
|
|
@@ -1001,34 +1020,24 @@ export declare class BackstageClient {
|
|
|
1001
1020
|
status?: "draft" | "published" | "on_sale" | "sold_out" | "completed" | "cancelled";
|
|
1002
1021
|
venueId?: string;
|
|
1003
1022
|
accountId?: string;
|
|
1023
|
+
updatedSince?: string;
|
|
1024
|
+
cursor?: string;
|
|
1025
|
+
include?: ("occurrences" | "venue" | "prices")[];
|
|
1026
|
+
visibility?: "discoverable" | "visible";
|
|
1004
1027
|
expand?: string;
|
|
1005
1028
|
page?: string;
|
|
1006
1029
|
limit?: string;
|
|
1007
1030
|
}) => Promise<{
|
|
1008
|
-
events: components["schemas"]["
|
|
1009
|
-
pagination: components["schemas"]["
|
|
1031
|
+
events: components["schemas"]["EventInChannel"][];
|
|
1032
|
+
pagination: components["schemas"]["EventListPagination"];
|
|
1033
|
+
channel: components["schemas"]["ChannelContext"];
|
|
1010
1034
|
}>;
|
|
1011
1035
|
get: (id: string, options?: {
|
|
1036
|
+
include?: ("occurrences" | "venue" | "prices")[];
|
|
1012
1037
|
expand?: string;
|
|
1013
1038
|
}) => Promise<{
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
accountId: string;
|
|
1017
|
-
name: string;
|
|
1018
|
-
description?: string;
|
|
1019
|
-
status: "draft" | "published" | "on_sale" | "sold_out" | "completed" | "cancelled";
|
|
1020
|
-
venueId?: string;
|
|
1021
|
-
timezone: string;
|
|
1022
|
-
onSaleDate?: string;
|
|
1023
|
-
offSaleDate?: string;
|
|
1024
|
-
occurrenceCount: number;
|
|
1025
|
-
ticketCount: number;
|
|
1026
|
-
productCount: number;
|
|
1027
|
-
tags: string[];
|
|
1028
|
-
isDeleted: boolean;
|
|
1029
|
-
createdAt: string;
|
|
1030
|
-
updatedAt: string;
|
|
1031
|
-
createdBy?: string;
|
|
1039
|
+
event: components["schemas"]["EventInChannel"];
|
|
1040
|
+
channel: components["schemas"]["ChannelContext"] & unknown;
|
|
1032
1041
|
}>;
|
|
1033
1042
|
update: (id: string, request: {
|
|
1034
1043
|
name?: string;
|
|
@@ -1042,8 +1051,11 @@ export declare class BackstageClient {
|
|
|
1042
1051
|
venueId?: any;
|
|
1043
1052
|
venueName?: any;
|
|
1044
1053
|
timezone?: string;
|
|
1045
|
-
|
|
1046
|
-
|
|
1054
|
+
rules?: {
|
|
1055
|
+
discoverable?: components["schemas"]["ListingRule"];
|
|
1056
|
+
visible?: components["schemas"]["ListingRule"];
|
|
1057
|
+
sellable?: components["schemas"]["ListingRule"];
|
|
1058
|
+
};
|
|
1047
1059
|
tags?: string[];
|
|
1048
1060
|
ticketTypes?: {
|
|
1049
1061
|
id?: string;
|
|
@@ -1075,12 +1087,20 @@ export declare class BackstageClient {
|
|
|
1075
1087
|
organisationId: string;
|
|
1076
1088
|
accountId: string;
|
|
1077
1089
|
name: string;
|
|
1090
|
+
subtitle: string | null;
|
|
1078
1091
|
description?: string;
|
|
1092
|
+
shortDescription: string | null;
|
|
1079
1093
|
status: "draft" | "published" | "on_sale" | "sold_out" | "completed" | "cancelled";
|
|
1094
|
+
images: components["schemas"]["EventImages"];
|
|
1095
|
+
imageUrl: string | null;
|
|
1096
|
+
heroImageUrl: string | null;
|
|
1097
|
+
presentation: components["schemas"]["EventPresentation"];
|
|
1080
1098
|
venueId?: string;
|
|
1099
|
+
venueName: string | null;
|
|
1081
1100
|
timezone: string;
|
|
1082
|
-
|
|
1083
|
-
|
|
1101
|
+
rules: components["schemas"]["ListingRules"];
|
|
1102
|
+
ticketTypes: components["schemas"]["EventTicketType"][];
|
|
1103
|
+
defaultPriceSchemeId: string | null;
|
|
1084
1104
|
occurrenceCount: number;
|
|
1085
1105
|
ticketCount: number;
|
|
1086
1106
|
productCount: number;
|
|
@@ -1088,6 +1108,7 @@ export declare class BackstageClient {
|
|
|
1088
1108
|
isDeleted: boolean;
|
|
1089
1109
|
createdAt: string;
|
|
1090
1110
|
updatedAt: string;
|
|
1111
|
+
contentUpdatedAt: string;
|
|
1091
1112
|
createdBy?: string;
|
|
1092
1113
|
}>;
|
|
1093
1114
|
delete: (id: string) => Promise<{
|
|
@@ -2270,6 +2291,18 @@ export declare class BackstageClient {
|
|
|
2270
2291
|
totalPages: number;
|
|
2271
2292
|
};
|
|
2272
2293
|
}>;
|
|
2294
|
+
match: (request: {
|
|
2295
|
+
email?: string;
|
|
2296
|
+
phone?: string;
|
|
2297
|
+
}) => Promise<{
|
|
2298
|
+
id: string;
|
|
2299
|
+
accountId: string | null;
|
|
2300
|
+
firstName: string | null;
|
|
2301
|
+
lastInitial: string | null;
|
|
2302
|
+
maskedEmail: string;
|
|
2303
|
+
maskedPhone: string | null;
|
|
2304
|
+
isBlocked: boolean;
|
|
2305
|
+
} | null>;
|
|
2273
2306
|
get: (customerId: string) => Promise<{
|
|
2274
2307
|
id: string;
|
|
2275
2308
|
organisationId: string;
|
|
@@ -2865,7 +2898,7 @@ export declare class BackstageClient {
|
|
|
2865
2898
|
printPass: (orderId: string, passId: string, request: {
|
|
2866
2899
|
printerId: string;
|
|
2867
2900
|
type?: "print.ticket" | "print.label" | "print.receipt";
|
|
2868
|
-
}) => Promise<
|
|
2901
|
+
}) => Promise<string>;
|
|
2869
2902
|
};
|
|
2870
2903
|
payments: {
|
|
2871
2904
|
create: (request: {
|
|
@@ -3017,8 +3050,26 @@ export declare class BackstageClient {
|
|
|
3017
3050
|
}>;
|
|
3018
3051
|
getTicketlayerPay: (options?: {
|
|
3019
3052
|
refresh?: "0" | "1" | "true" | "false";
|
|
3020
|
-
}) => Promise<
|
|
3021
|
-
|
|
3053
|
+
}) => Promise<{
|
|
3054
|
+
enabled: boolean;
|
|
3055
|
+
providerId: string | null;
|
|
3056
|
+
providerStatus: "active" | "inactive" | "pending_setup" | null;
|
|
3057
|
+
connectedAccountId: string | null;
|
|
3058
|
+
onboardingStatus: "not_started" | "in_progress" | "pending_verification" | "complete" | "restricted" | "disabled" | null;
|
|
3059
|
+
chargesEnabled: boolean;
|
|
3060
|
+
payoutsEnabled: boolean;
|
|
3061
|
+
detailsSubmitted: boolean;
|
|
3062
|
+
disabledReason: string | null;
|
|
3063
|
+
requirements: components["schemas"]["ConnectedAccountRequirements"];
|
|
3064
|
+
applicationFee: components["schemas"]["ApplicationFee"];
|
|
3065
|
+
lastSyncedAt: string | null;
|
|
3066
|
+
}>;
|
|
3067
|
+
createTicketlayerPayOnboardingSession: () => Promise<{
|
|
3068
|
+
clientSecret: string;
|
|
3069
|
+
expiresAt: string;
|
|
3070
|
+
publishableKey: string;
|
|
3071
|
+
connectedAccountId: string;
|
|
3072
|
+
}>;
|
|
3022
3073
|
createTicketlayerPayOnboardingLink: (request: {
|
|
3023
3074
|
returnUrl: string;
|
|
3024
3075
|
refreshUrl: string;
|
|
@@ -3038,11 +3089,58 @@ export declare class BackstageClient {
|
|
|
3038
3089
|
provider: components["schemas"]["StripeConnectProvider"];
|
|
3039
3090
|
created: boolean;
|
|
3040
3091
|
}>;
|
|
3041
|
-
getStripeConnect: () => Promise<
|
|
3042
|
-
|
|
3092
|
+
getStripeConnect: () => Promise<{
|
|
3093
|
+
id: string;
|
|
3094
|
+
name: string;
|
|
3095
|
+
status: "active" | "inactive" | "pending_setup";
|
|
3096
|
+
defaultMode: "direct" | "connected";
|
|
3097
|
+
publishableKey: string | null;
|
|
3098
|
+
platformAccountId: string | null;
|
|
3099
|
+
platformCountry: string | null;
|
|
3100
|
+
platformCurrency: string | null;
|
|
3101
|
+
livemode: boolean;
|
|
3102
|
+
applicationFee: components["schemas"]["ApplicationFee"] & (Record<string, never> | null);
|
|
3103
|
+
refundApplicationFee: boolean;
|
|
3104
|
+
webhookRegistered: boolean;
|
|
3105
|
+
connectWebhookRegistered: boolean;
|
|
3106
|
+
webhookRegistrationError: string | null;
|
|
3107
|
+
createdAt: string;
|
|
3108
|
+
updatedAt: string;
|
|
3109
|
+
} & Record<string, never>>;
|
|
3110
|
+
listAccounts: (providerId: string) => Promise<{
|
|
3111
|
+
id: string;
|
|
3112
|
+
providerId: string;
|
|
3113
|
+
accountId: string;
|
|
3114
|
+
mode: "direct" | "connected";
|
|
3115
|
+
connectedAccountId: string | null;
|
|
3116
|
+
onboardingStatus: "not_started" | "in_progress" | "pending_verification" | "complete" | "restricted" | "disabled" | null;
|
|
3117
|
+
chargesEnabled: boolean;
|
|
3118
|
+
payoutsEnabled: boolean;
|
|
3119
|
+
detailsSubmitted: boolean;
|
|
3120
|
+
disabledReason: string | null;
|
|
3121
|
+
requirements: components["schemas"]["ConnectedAccountRequirements"];
|
|
3122
|
+
lastSyncedAt: string | null;
|
|
3123
|
+
createdAt: string;
|
|
3124
|
+
updatedAt: string;
|
|
3125
|
+
}[]>;
|
|
3043
3126
|
getAccount: (providerId: string, accountId: string, options?: {
|
|
3044
3127
|
refresh?: "0" | "1" | "true" | "false";
|
|
3045
|
-
}) => Promise<
|
|
3128
|
+
}) => Promise<{
|
|
3129
|
+
id: string;
|
|
3130
|
+
providerId: string;
|
|
3131
|
+
accountId: string;
|
|
3132
|
+
mode: "direct" | "connected";
|
|
3133
|
+
connectedAccountId: string | null;
|
|
3134
|
+
onboardingStatus: "not_started" | "in_progress" | "pending_verification" | "complete" | "restricted" | "disabled" | null;
|
|
3135
|
+
chargesEnabled: boolean;
|
|
3136
|
+
payoutsEnabled: boolean;
|
|
3137
|
+
detailsSubmitted: boolean;
|
|
3138
|
+
disabledReason: string | null;
|
|
3139
|
+
requirements: components["schemas"]["ConnectedAccountRequirements"];
|
|
3140
|
+
lastSyncedAt: string | null;
|
|
3141
|
+
createdAt: string;
|
|
3142
|
+
updatedAt: string;
|
|
3143
|
+
} & Record<string, never>>;
|
|
3046
3144
|
setAccountMode: (providerId: string, accountId: string, request: {
|
|
3047
3145
|
mode: "direct" | "connected";
|
|
3048
3146
|
connectedAccountId?: string;
|
|
@@ -3050,8 +3148,28 @@ export declare class BackstageClient {
|
|
|
3050
3148
|
contactEmail?: string;
|
|
3051
3149
|
country?: string;
|
|
3052
3150
|
currency?: string;
|
|
3053
|
-
}) => Promise<
|
|
3054
|
-
|
|
3151
|
+
}) => Promise<{
|
|
3152
|
+
id: string;
|
|
3153
|
+
providerId: string;
|
|
3154
|
+
accountId: string;
|
|
3155
|
+
mode: "direct" | "connected";
|
|
3156
|
+
connectedAccountId: string | null;
|
|
3157
|
+
onboardingStatus: "not_started" | "in_progress" | "pending_verification" | "complete" | "restricted" | "disabled" | null;
|
|
3158
|
+
chargesEnabled: boolean;
|
|
3159
|
+
payoutsEnabled: boolean;
|
|
3160
|
+
detailsSubmitted: boolean;
|
|
3161
|
+
disabledReason: string | null;
|
|
3162
|
+
requirements: components["schemas"]["ConnectedAccountRequirements"];
|
|
3163
|
+
lastSyncedAt: string | null;
|
|
3164
|
+
createdAt: string;
|
|
3165
|
+
updatedAt: string;
|
|
3166
|
+
}>;
|
|
3167
|
+
createAccountOnboardingSession: (providerId: string, accountId: string) => Promise<{
|
|
3168
|
+
clientSecret: string;
|
|
3169
|
+
expiresAt: string;
|
|
3170
|
+
publishableKey: string;
|
|
3171
|
+
connectedAccountId: string;
|
|
3172
|
+
}>;
|
|
3055
3173
|
createAccountOnboardingLink: (providerId: string, accountId: string, request: {
|
|
3056
3174
|
returnUrl: string;
|
|
3057
3175
|
refreshUrl: string;
|
|
@@ -3287,6 +3405,7 @@ export declare class BackstageClient {
|
|
|
3287
3405
|
id: string;
|
|
3288
3406
|
channelId: string;
|
|
3289
3407
|
keyType: "publishable" | "secret";
|
|
3408
|
+
mode: "live" | "test";
|
|
3290
3409
|
name: string;
|
|
3291
3410
|
publishableKey: string | null;
|
|
3292
3411
|
last4: string;
|
|
@@ -3306,75 +3425,67 @@ export declare class BackstageClient {
|
|
|
3306
3425
|
listings: {
|
|
3307
3426
|
create: (request: {
|
|
3308
3427
|
eventId: string;
|
|
3309
|
-
|
|
3310
|
-
|
|
3428
|
+
rules?: {
|
|
3429
|
+
discoverable?: any;
|
|
3430
|
+
visible?: any;
|
|
3431
|
+
sellable?: any;
|
|
3432
|
+
};
|
|
3311
3433
|
}) => Promise<{
|
|
3312
3434
|
id: string;
|
|
3313
|
-
organisationId: string;
|
|
3314
3435
|
channelId: string;
|
|
3315
3436
|
eventId: string;
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
createdBy: string | null;
|
|
3437
|
+
rules: components["schemas"]["ListingRuleOverrides"];
|
|
3438
|
+
effective: components["schemas"]["ListingRules"];
|
|
3439
|
+
state: components["schemas"]["ListingState"];
|
|
3320
3440
|
createdAt: string;
|
|
3321
3441
|
updatedAt: string;
|
|
3322
3442
|
}>;
|
|
3323
3443
|
list: () => Promise<{
|
|
3324
3444
|
id: string;
|
|
3325
|
-
organisationId: string;
|
|
3326
3445
|
channelId: string;
|
|
3327
3446
|
eventId: string;
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
createdBy: string | null;
|
|
3447
|
+
rules: components["schemas"]["ListingRuleOverrides"];
|
|
3448
|
+
effective: components["schemas"]["ListingRules"];
|
|
3449
|
+
state: components["schemas"]["ListingState"];
|
|
3332
3450
|
createdAt: string;
|
|
3333
3451
|
updatedAt: string;
|
|
3334
3452
|
}[]>;
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
|
|
3340
|
-
metadata?: Record<string, any>;
|
|
3341
|
-
}) => Promise<{
|
|
3342
|
-
cart: components["schemas"]["StaffCart"];
|
|
3343
|
-
items: components["schemas"]["StaffCartItem"][];
|
|
3344
|
-
}>;
|
|
3345
|
-
get: (cartId: string) => Promise<{
|
|
3346
|
-
cart: components["schemas"]["StaffCart"];
|
|
3347
|
-
items: components["schemas"]["StaffCartItem"][];
|
|
3348
|
-
}>;
|
|
3349
|
-
addItem: (cartId: string, request: {
|
|
3350
|
-
eventOccurrenceId: string;
|
|
3351
|
-
categoryId: string;
|
|
3352
|
-
ticketTypeId: string;
|
|
3353
|
-
quantity?: number;
|
|
3354
|
-
eventLayoutAreaId?: string;
|
|
3355
|
-
eventLayoutSeatIds?: string[];
|
|
3356
|
-
}) => Promise<{
|
|
3357
|
-
cart: components["schemas"]["StaffCart"];
|
|
3358
|
-
items: components["schemas"]["StaffCartItem"][];
|
|
3359
|
-
}>;
|
|
3360
|
-
removeItem: (cartId: string, itemId: string) => Promise<{
|
|
3361
|
-
cart: components["schemas"]["StaffCart"];
|
|
3362
|
-
items: components["schemas"]["StaffCartItem"][];
|
|
3363
|
-
}>;
|
|
3364
|
-
checkout: (cartId: string, request: {
|
|
3365
|
-
customerId?: string;
|
|
3366
|
-
customerNotes?: string;
|
|
3367
|
-
metadata?: Record<string, any>;
|
|
3368
|
-
discount?: {
|
|
3369
|
-
amount?: number;
|
|
3370
|
-
percent?: number;
|
|
3371
|
-
label?: string;
|
|
3372
|
-
reason: string;
|
|
3453
|
+
update: (listingId: string, request: {
|
|
3454
|
+
rules?: {
|
|
3455
|
+
discoverable?: any;
|
|
3456
|
+
visible?: any;
|
|
3457
|
+
sellable?: any;
|
|
3373
3458
|
};
|
|
3374
3459
|
}) => Promise<{
|
|
3375
|
-
|
|
3376
|
-
|
|
3460
|
+
id: string;
|
|
3461
|
+
channelId: string;
|
|
3462
|
+
eventId: string;
|
|
3463
|
+
rules: components["schemas"]["ListingRuleOverrides"];
|
|
3464
|
+
effective: components["schemas"]["ListingRules"];
|
|
3465
|
+
state: components["schemas"]["ListingState"];
|
|
3466
|
+
createdAt: string;
|
|
3467
|
+
updatedAt: string;
|
|
3468
|
+
}>;
|
|
3469
|
+
delete: (listingId: string) => Promise<boolean>;
|
|
3470
|
+
};
|
|
3471
|
+
channelaccess: {
|
|
3472
|
+
list: () => Promise<{
|
|
3473
|
+
id: string;
|
|
3474
|
+
organisationId: string;
|
|
3475
|
+
salesChannelId: string;
|
|
3476
|
+
subjectType: "user" | "role";
|
|
3477
|
+
subjectId: string;
|
|
3478
|
+
createdAt: string;
|
|
3479
|
+
}[]>;
|
|
3480
|
+
grant: (request: GrantSalesChannelAccessRequest) => Promise<{
|
|
3481
|
+
id: string;
|
|
3482
|
+
organisationId: string;
|
|
3483
|
+
salesChannelId: string;
|
|
3484
|
+
subjectType: "user" | "role";
|
|
3485
|
+
subjectId: string;
|
|
3486
|
+
createdAt: string;
|
|
3377
3487
|
}>;
|
|
3488
|
+
revoke: (accessId: string) => Promise<boolean>;
|
|
3378
3489
|
};
|
|
3379
3490
|
}) & {
|
|
3380
3491
|
create: (request: {
|
|
@@ -3415,6 +3526,7 @@ export declare class BackstageClient {
|
|
|
3415
3526
|
checkoutTtlSeconds?: number;
|
|
3416
3527
|
receivingAccountId?: string;
|
|
3417
3528
|
feeProfileId?: string;
|
|
3529
|
+
autoList?: boolean;
|
|
3418
3530
|
}) => Promise<{
|
|
3419
3531
|
id: string;
|
|
3420
3532
|
organisationId: string;
|
|
@@ -3456,6 +3568,7 @@ export declare class BackstageClient {
|
|
|
3456
3568
|
receivingAccountId: string;
|
|
3457
3569
|
feeProfileId: string | null;
|
|
3458
3570
|
brandId: string | null;
|
|
3571
|
+
autoList: boolean;
|
|
3459
3572
|
isActive: boolean;
|
|
3460
3573
|
isDeleted: boolean;
|
|
3461
3574
|
deletedAt: string | null;
|
|
@@ -3503,6 +3616,7 @@ export declare class BackstageClient {
|
|
|
3503
3616
|
receivingAccountId: string;
|
|
3504
3617
|
feeProfileId: string | null;
|
|
3505
3618
|
brandId: string | null;
|
|
3619
|
+
autoList: boolean;
|
|
3506
3620
|
isActive: boolean;
|
|
3507
3621
|
isDeleted: boolean;
|
|
3508
3622
|
deletedAt: string | null;
|
|
@@ -3550,6 +3664,7 @@ export declare class BackstageClient {
|
|
|
3550
3664
|
receivingAccountId: string;
|
|
3551
3665
|
feeProfileId: string | null;
|
|
3552
3666
|
brandId: string | null;
|
|
3667
|
+
autoList: boolean;
|
|
3553
3668
|
isActive: boolean;
|
|
3554
3669
|
isDeleted: boolean;
|
|
3555
3670
|
deletedAt: string | null;
|
|
@@ -3593,6 +3708,7 @@ export declare class BackstageClient {
|
|
|
3593
3708
|
feeProfileId?: any;
|
|
3594
3709
|
paymentProviderId?: any;
|
|
3595
3710
|
brandId?: any;
|
|
3711
|
+
autoList?: boolean;
|
|
3596
3712
|
isActive?: boolean;
|
|
3597
3713
|
}) => Promise<{
|
|
3598
3714
|
id: string;
|
|
@@ -3635,6 +3751,7 @@ export declare class BackstageClient {
|
|
|
3635
3751
|
receivingAccountId: string;
|
|
3636
3752
|
feeProfileId: string | null;
|
|
3637
3753
|
brandId: string | null;
|
|
3754
|
+
autoList: boolean;
|
|
3638
3755
|
isActive: boolean;
|
|
3639
3756
|
isDeleted: boolean;
|
|
3640
3757
|
deletedAt: string | null;
|
|
@@ -3642,62 +3759,57 @@ export declare class BackstageClient {
|
|
|
3642
3759
|
updatedAt: string;
|
|
3643
3760
|
}>;
|
|
3644
3761
|
delete: (channelId: string) => Promise<boolean>;
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
|
|
3650
|
-
|
|
3651
|
-
name: string;
|
|
3652
|
-
subtitle: string | null;
|
|
3653
|
-
description: string | null;
|
|
3654
|
-
shortDescription: string | null;
|
|
3655
|
-
status: string;
|
|
3656
|
-
imageUrl: string | null;
|
|
3657
|
-
heroImageUrl: string | null;
|
|
3658
|
-
presentation: {
|
|
3659
|
-
heroLayout?: {
|
|
3660
|
-
type: "hero" | "cinema";
|
|
3661
|
-
size: "small" | "medium" | "large";
|
|
3662
|
-
};
|
|
3663
|
-
cinemaGradient?: {
|
|
3664
|
-
strength: 20 | 50 | 70;
|
|
3665
|
-
position: "bottom" | "center";
|
|
3666
|
-
};
|
|
3667
|
-
twoColumnSplit?: [number, number];
|
|
3668
|
-
navbar?: {
|
|
3669
|
-
transparent?: boolean;
|
|
3670
|
-
};
|
|
3671
|
-
buttonSize?: "small" | "medium" | "large";
|
|
3672
|
-
} | null;
|
|
3673
|
-
venueId: string | null;
|
|
3674
|
-
venueName: string | null;
|
|
3675
|
-
venueCity: string | null;
|
|
3676
|
-
priceFrom: number | null;
|
|
3677
|
-
currency: string | null;
|
|
3678
|
-
timezone: string;
|
|
3679
|
-
occurrences: {
|
|
3680
|
-
id: string;
|
|
3681
|
-
startsAt: string | null;
|
|
3682
|
-
endsAt: string | null;
|
|
3683
|
-
timezone: string;
|
|
3684
|
-
startDate: string;
|
|
3685
|
-
startTime: string;
|
|
3686
|
-
endDate: string;
|
|
3687
|
-
endTime: string;
|
|
3688
|
-
status: string;
|
|
3689
|
-
ticketTypes: {
|
|
3690
|
-
ticketTypeId: string;
|
|
3691
|
-
ticketTypeName: string;
|
|
3692
|
-
description: string | null;
|
|
3693
|
-
categoryId: string;
|
|
3694
|
-
categoryName: string;
|
|
3695
|
-
unitPrice: number;
|
|
3696
|
-
currency: string;
|
|
3697
|
-
}[];
|
|
3762
|
+
mySalesChannels: () => Promise<{
|
|
3763
|
+
scope: "channel" | "all";
|
|
3764
|
+
channels: components["schemas"]["SalesChannelSummary"][];
|
|
3765
|
+
permissions: {
|
|
3766
|
+
permission: string;
|
|
3767
|
+
scope: "channel" | "all";
|
|
3698
3768
|
}[];
|
|
3699
3769
|
}>;
|
|
3700
3770
|
};
|
|
3771
|
+
carts: {
|
|
3772
|
+
create: (request: {
|
|
3773
|
+
customerId?: string;
|
|
3774
|
+
metadata?: Record<string, any>;
|
|
3775
|
+
}) => Promise<{
|
|
3776
|
+
cart: components["schemas"]["StaffCart"];
|
|
3777
|
+
items: components["schemas"]["StaffCartItem"][];
|
|
3778
|
+
}>;
|
|
3779
|
+
get: (cartId: string) => Promise<{
|
|
3780
|
+
cart: components["schemas"]["StaffCart"];
|
|
3781
|
+
items: components["schemas"]["StaffCartItem"][];
|
|
3782
|
+
}>;
|
|
3783
|
+
addItem: (cartId: string, request: {
|
|
3784
|
+
eventOccurrenceId: string;
|
|
3785
|
+
categoryId: string;
|
|
3786
|
+
ticketTypeId: string;
|
|
3787
|
+
quantity?: number;
|
|
3788
|
+
eventLayoutAreaId?: string;
|
|
3789
|
+
eventLayoutSeatIds?: string[];
|
|
3790
|
+
}) => Promise<{
|
|
3791
|
+
cart: components["schemas"]["StaffCart"];
|
|
3792
|
+
items: components["schemas"]["StaffCartItem"][];
|
|
3793
|
+
}>;
|
|
3794
|
+
removeItem: (cartId: string, itemId: string) => Promise<{
|
|
3795
|
+
cart: components["schemas"]["StaffCart"];
|
|
3796
|
+
items: components["schemas"]["StaffCartItem"][];
|
|
3797
|
+
}>;
|
|
3798
|
+
checkout: (cartId: string, request: {
|
|
3799
|
+
customerId?: string;
|
|
3800
|
+
customerNotes?: string;
|
|
3801
|
+
metadata?: Record<string, any>;
|
|
3802
|
+
discount?: {
|
|
3803
|
+
amount?: number;
|
|
3804
|
+
percent?: number;
|
|
3805
|
+
label?: string;
|
|
3806
|
+
reason: string;
|
|
3807
|
+
};
|
|
3808
|
+
}) => Promise<{
|
|
3809
|
+
cart: components["schemas"]["StaffCart"];
|
|
3810
|
+
order: components["schemas"]["StaffSalesOrder"];
|
|
3811
|
+
}>;
|
|
3812
|
+
};
|
|
3701
3813
|
presaleCodes: {
|
|
3702
3814
|
create: (request: {
|
|
3703
3815
|
accountId: string;
|
|
@@ -4389,9 +4501,81 @@ export declare class BackstageClient {
|
|
|
4389
4501
|
validFrom?: string;
|
|
4390
4502
|
validUntil?: string;
|
|
4391
4503
|
isTest?: boolean;
|
|
4392
|
-
}) => Promise<
|
|
4393
|
-
|
|
4394
|
-
|
|
4504
|
+
}) => Promise<{
|
|
4505
|
+
id: string;
|
|
4506
|
+
name: string;
|
|
4507
|
+
status: string;
|
|
4508
|
+
accountId: string;
|
|
4509
|
+
eventFilter: {
|
|
4510
|
+
mode: "all" | "events" | "occurrences";
|
|
4511
|
+
eventIds?: string[];
|
|
4512
|
+
occurrenceIds?: string[];
|
|
4513
|
+
};
|
|
4514
|
+
entitlementFilter: {
|
|
4515
|
+
types?: string[];
|
|
4516
|
+
ticketTypeIds?: string[];
|
|
4517
|
+
entitlementIds?: string[];
|
|
4518
|
+
tags?: string[];
|
|
4519
|
+
} | null;
|
|
4520
|
+
allowedKinds: ("validate" | "redeem" | "reverse")[];
|
|
4521
|
+
gates: string[] | null;
|
|
4522
|
+
validFrom: string | null;
|
|
4523
|
+
validUntil: string | null;
|
|
4524
|
+
isTest: boolean;
|
|
4525
|
+
deviceIds?: string[];
|
|
4526
|
+
createdAt: string;
|
|
4527
|
+
updatedAt: string;
|
|
4528
|
+
}>;
|
|
4529
|
+
list: () => Promise<{
|
|
4530
|
+
id: string;
|
|
4531
|
+
name: string;
|
|
4532
|
+
status: string;
|
|
4533
|
+
accountId: string;
|
|
4534
|
+
eventFilter: {
|
|
4535
|
+
mode: "all" | "events" | "occurrences";
|
|
4536
|
+
eventIds?: string[];
|
|
4537
|
+
occurrenceIds?: string[];
|
|
4538
|
+
};
|
|
4539
|
+
entitlementFilter: {
|
|
4540
|
+
types?: string[];
|
|
4541
|
+
ticketTypeIds?: string[];
|
|
4542
|
+
entitlementIds?: string[];
|
|
4543
|
+
tags?: string[];
|
|
4544
|
+
} | null;
|
|
4545
|
+
allowedKinds: ("validate" | "redeem" | "reverse")[];
|
|
4546
|
+
gates: string[] | null;
|
|
4547
|
+
validFrom: string | null;
|
|
4548
|
+
validUntil: string | null;
|
|
4549
|
+
isTest: boolean;
|
|
4550
|
+
deviceIds?: string[];
|
|
4551
|
+
createdAt: string;
|
|
4552
|
+
updatedAt: string;
|
|
4553
|
+
}[]>;
|
|
4554
|
+
get: (configId: string) => Promise<{
|
|
4555
|
+
id: string;
|
|
4556
|
+
name: string;
|
|
4557
|
+
status: string;
|
|
4558
|
+
accountId: string;
|
|
4559
|
+
eventFilter: {
|
|
4560
|
+
mode: "all" | "events" | "occurrences";
|
|
4561
|
+
eventIds?: string[];
|
|
4562
|
+
occurrenceIds?: string[];
|
|
4563
|
+
};
|
|
4564
|
+
entitlementFilter: {
|
|
4565
|
+
types?: string[];
|
|
4566
|
+
ticketTypeIds?: string[];
|
|
4567
|
+
entitlementIds?: string[];
|
|
4568
|
+
tags?: string[];
|
|
4569
|
+
} | null;
|
|
4570
|
+
allowedKinds: ("validate" | "redeem" | "reverse")[];
|
|
4571
|
+
gates: string[] | null;
|
|
4572
|
+
validFrom: string | null;
|
|
4573
|
+
validUntil: string | null;
|
|
4574
|
+
isTest: boolean;
|
|
4575
|
+
deviceIds?: string[];
|
|
4576
|
+
createdAt: string;
|
|
4577
|
+
updatedAt: string;
|
|
4578
|
+
}>;
|
|
4395
4579
|
update: (configId: string, request: {
|
|
4396
4580
|
accountId?: string;
|
|
4397
4581
|
name?: string;
|
|
@@ -4412,20 +4596,83 @@ export declare class BackstageClient {
|
|
|
4412
4596
|
validUntil?: string;
|
|
4413
4597
|
isTest?: boolean;
|
|
4414
4598
|
status?: "active" | "archived";
|
|
4415
|
-
}) => Promise<
|
|
4416
|
-
|
|
4599
|
+
}) => Promise<{
|
|
4600
|
+
id: string;
|
|
4601
|
+
name: string;
|
|
4602
|
+
status: string;
|
|
4603
|
+
accountId: string;
|
|
4604
|
+
eventFilter: {
|
|
4605
|
+
mode: "all" | "events" | "occurrences";
|
|
4606
|
+
eventIds?: string[];
|
|
4607
|
+
occurrenceIds?: string[];
|
|
4608
|
+
};
|
|
4609
|
+
entitlementFilter: {
|
|
4610
|
+
types?: string[];
|
|
4611
|
+
ticketTypeIds?: string[];
|
|
4612
|
+
entitlementIds?: string[];
|
|
4613
|
+
tags?: string[];
|
|
4614
|
+
} | null;
|
|
4615
|
+
allowedKinds: ("validate" | "redeem" | "reverse")[];
|
|
4616
|
+
gates: string[] | null;
|
|
4617
|
+
validFrom: string | null;
|
|
4618
|
+
validUntil: string | null;
|
|
4619
|
+
isTest: boolean;
|
|
4620
|
+
deviceIds?: string[];
|
|
4621
|
+
createdAt: string;
|
|
4622
|
+
updatedAt: string;
|
|
4623
|
+
}>;
|
|
4624
|
+
delete: (configId: string) => Promise<boolean>;
|
|
4417
4625
|
setDevices: (configId: string, request: {
|
|
4418
4626
|
deviceIds: string[];
|
|
4419
|
-
}) => Promise<
|
|
4627
|
+
}) => Promise<string[]>;
|
|
4420
4628
|
};
|
|
4421
4629
|
scan: {
|
|
4422
|
-
config: () => Promise<
|
|
4630
|
+
config: () => Promise<{
|
|
4631
|
+
id: string;
|
|
4632
|
+
name: string;
|
|
4633
|
+
eventFilter: {
|
|
4634
|
+
[key: string]: unknown;
|
|
4635
|
+
};
|
|
4636
|
+
entitlementFilter: {
|
|
4637
|
+
[key: string]: unknown;
|
|
4638
|
+
} | null;
|
|
4639
|
+
allowedKinds: string[];
|
|
4640
|
+
gates: string[] | null;
|
|
4641
|
+
validFrom: string | null;
|
|
4642
|
+
validUntil: string | null;
|
|
4643
|
+
isTest: boolean;
|
|
4644
|
+
configVersion: string;
|
|
4645
|
+
}>;
|
|
4423
4646
|
manifest: (options?: {
|
|
4424
4647
|
since?: string;
|
|
4425
|
-
}) => Promise<
|
|
4426
|
-
|
|
4427
|
-
|
|
4428
|
-
|
|
4648
|
+
}) => Promise<{
|
|
4649
|
+
entitlements: {
|
|
4650
|
+
barcode: string;
|
|
4651
|
+
passId: string;
|
|
4652
|
+
entitlementId: string;
|
|
4653
|
+
occurrenceId: string | null;
|
|
4654
|
+
holderName: string | null;
|
|
4655
|
+
ticketTypeName: string;
|
|
4656
|
+
type: string;
|
|
4657
|
+
seatLabel: string | null;
|
|
4658
|
+
orderRef: string;
|
|
4659
|
+
passStatus: string;
|
|
4660
|
+
entitlementStatus: string;
|
|
4661
|
+
redemptionLimit: number | null;
|
|
4662
|
+
redemptionCount: number;
|
|
4663
|
+
rulesSummary?: unknown;
|
|
4664
|
+
updatedAt: string;
|
|
4665
|
+
}[];
|
|
4666
|
+
redemptions: {
|
|
4667
|
+
[key: string]: unknown;
|
|
4668
|
+
}[];
|
|
4669
|
+
nextCursor: string;
|
|
4670
|
+
hasMore: boolean;
|
|
4671
|
+
full: boolean;
|
|
4672
|
+
}>;
|
|
4673
|
+
operations: (request: {
|
|
4674
|
+
operations: ({
|
|
4675
|
+
opId: string;
|
|
4429
4676
|
kind: "validate" | "redeem" | "reverse";
|
|
4430
4677
|
passBarcode: string;
|
|
4431
4678
|
entitlementId?: string;
|
|
@@ -4441,7 +4688,24 @@ export declare class BackstageClient {
|
|
|
4441
4688
|
};
|
|
4442
4689
|
hopPath?: string[];
|
|
4443
4690
|
})[];
|
|
4444
|
-
}) => Promise<
|
|
4691
|
+
}) => Promise<{
|
|
4692
|
+
opId: string;
|
|
4693
|
+
outcome: "valid" | "duplicate" | "rejected" | "reversed";
|
|
4694
|
+
reason?: string;
|
|
4695
|
+
holderName?: string | null;
|
|
4696
|
+
ticketTypeName?: string;
|
|
4697
|
+
seatLabel?: string | null;
|
|
4698
|
+
orderRef?: string;
|
|
4699
|
+
entitlement?: {
|
|
4700
|
+
[key: string]: unknown;
|
|
4701
|
+
};
|
|
4702
|
+
conflict?: {
|
|
4703
|
+
[key: string]: unknown;
|
|
4704
|
+
};
|
|
4705
|
+
redemption?: {
|
|
4706
|
+
[key: string]: unknown;
|
|
4707
|
+
};
|
|
4708
|
+
}[]>;
|
|
4445
4709
|
};
|
|
4446
4710
|
scans: {
|
|
4447
4711
|
list: (options?: {
|
|
@@ -4452,10 +4716,31 @@ export declare class BackstageClient {
|
|
|
4452
4716
|
from?: string;
|
|
4453
4717
|
to?: string;
|
|
4454
4718
|
limit?: number;
|
|
4455
|
-
}) => Promise<
|
|
4719
|
+
}) => Promise<{
|
|
4720
|
+
id: string;
|
|
4721
|
+
status: string;
|
|
4722
|
+
entitlementId: string;
|
|
4723
|
+
passId: string;
|
|
4724
|
+
barcode: string;
|
|
4725
|
+
holderName: string | null;
|
|
4726
|
+
ticketTypeName: string;
|
|
4727
|
+
seatLabel: string | null;
|
|
4728
|
+
occurrenceId: string | null;
|
|
4729
|
+
gate: string | null;
|
|
4730
|
+
deviceId: string | null;
|
|
4731
|
+
reason: string | null;
|
|
4732
|
+
occurredAt: string | null;
|
|
4733
|
+
createdAt: string;
|
|
4734
|
+
}[]>;
|
|
4456
4735
|
reverse: (redemptionId: string, request: {
|
|
4457
4736
|
reason?: string;
|
|
4458
|
-
}) => Promise<
|
|
4737
|
+
}) => Promise<{
|
|
4738
|
+
id: string;
|
|
4739
|
+
status: string;
|
|
4740
|
+
entitlementId: string;
|
|
4741
|
+
reversedAt: string | null;
|
|
4742
|
+
reversalReason: string | null;
|
|
4743
|
+
}>;
|
|
4459
4744
|
};
|
|
4460
4745
|
assets: {
|
|
4461
4746
|
list: (options?: {
|
|
@@ -4479,6 +4764,8 @@ export declare class BackstageClient {
|
|
|
4479
4764
|
storageBucket: string | null;
|
|
4480
4765
|
storageKey: string;
|
|
4481
4766
|
url: string;
|
|
4767
|
+
signedUrl: string | null;
|
|
4768
|
+
signedUrlExpiresAt: string | null;
|
|
4482
4769
|
cdn: boolean;
|
|
4483
4770
|
cdnUrl: string | null;
|
|
4484
4771
|
visibility: string;
|
|
@@ -4512,6 +4799,8 @@ export declare class BackstageClient {
|
|
|
4512
4799
|
storageBucket: string | null;
|
|
4513
4800
|
storageKey: string;
|
|
4514
4801
|
url: string;
|
|
4802
|
+
signedUrl: string | null;
|
|
4803
|
+
signedUrlExpiresAt: string | null;
|
|
4515
4804
|
cdn: boolean;
|
|
4516
4805
|
cdnUrl: string | null;
|
|
4517
4806
|
visibility: string;
|
|
@@ -4537,6 +4826,8 @@ export declare class BackstageClient {
|
|
|
4537
4826
|
storageBucket: string | null;
|
|
4538
4827
|
storageKey: string;
|
|
4539
4828
|
url: string;
|
|
4829
|
+
signedUrl: string | null;
|
|
4830
|
+
signedUrlExpiresAt: string | null;
|
|
4540
4831
|
cdn: boolean;
|
|
4541
4832
|
cdnUrl: string | null;
|
|
4542
4833
|
visibility: string;
|
|
@@ -4560,8 +4851,27 @@ export declare class BackstageClient {
|
|
|
4560
4851
|
hostname?: string;
|
|
4561
4852
|
arch?: string;
|
|
4562
4853
|
};
|
|
4563
|
-
}) => Promise<
|
|
4564
|
-
|
|
4854
|
+
}) => Promise<{
|
|
4855
|
+
pairingId: string;
|
|
4856
|
+
userCode: string;
|
|
4857
|
+
deviceCode: string;
|
|
4858
|
+
verificationUrl: string;
|
|
4859
|
+
verificationUrlComplete: string;
|
|
4860
|
+
expiresAt: string;
|
|
4861
|
+
pollIntervalSeconds: number;
|
|
4862
|
+
}>;
|
|
4863
|
+
getStatus: (pairingId: string) => Promise<{
|
|
4864
|
+
status: string;
|
|
4865
|
+
claimedBy?: {
|
|
4866
|
+
organisationId: string;
|
|
4867
|
+
organisationName?: string;
|
|
4868
|
+
location?: {
|
|
4869
|
+
id: string;
|
|
4870
|
+
name: string;
|
|
4871
|
+
};
|
|
4872
|
+
};
|
|
4873
|
+
grantSummary?: string;
|
|
4874
|
+
}>;
|
|
4565
4875
|
claim: (request: {
|
|
4566
4876
|
userCode: string;
|
|
4567
4877
|
name: string;
|
|
@@ -4571,23 +4881,64 @@ export declare class BackstageClient {
|
|
|
4571
4881
|
accountId: string;
|
|
4572
4882
|
roleId: string;
|
|
4573
4883
|
}[];
|
|
4574
|
-
}) => Promise<
|
|
4884
|
+
}) => Promise<{
|
|
4885
|
+
pairingId: string;
|
|
4886
|
+
status: string;
|
|
4887
|
+
deviceInfo: {
|
|
4888
|
+
type: string;
|
|
4889
|
+
name?: string;
|
|
4890
|
+
platform?: {
|
|
4891
|
+
[key: string]: unknown;
|
|
4892
|
+
};
|
|
4893
|
+
};
|
|
4894
|
+
}>;
|
|
4575
4895
|
confirm: (pairingId: string, request: {
|
|
4576
4896
|
deviceCode: string;
|
|
4577
|
-
}) => Promise<
|
|
4897
|
+
}) => Promise<{
|
|
4898
|
+
deviceId: string;
|
|
4899
|
+
deviceSecret: string;
|
|
4900
|
+
}>;
|
|
4578
4901
|
reject: (pairingId: string, request: {
|
|
4579
4902
|
deviceCode: string;
|
|
4580
|
-
}) => Promise<
|
|
4903
|
+
}) => Promise<string>;
|
|
4581
4904
|
};
|
|
4582
4905
|
deviceAuth: {
|
|
4583
4906
|
issueToken: (request: {
|
|
4584
4907
|
deviceId: string;
|
|
4585
4908
|
deviceSecret: string;
|
|
4586
|
-
}) => Promise<
|
|
4587
|
-
|
|
4909
|
+
}) => Promise<{
|
|
4910
|
+
token: string;
|
|
4911
|
+
expiresInSeconds: number;
|
|
4912
|
+
}>;
|
|
4913
|
+
jwks: () => Promise<{
|
|
4914
|
+
keys: {
|
|
4915
|
+
[key: string]: unknown;
|
|
4916
|
+
}[];
|
|
4917
|
+
version: number;
|
|
4918
|
+
}>;
|
|
4588
4919
|
};
|
|
4589
4920
|
deviceSelf: {
|
|
4590
|
-
getMe: () => Promise<
|
|
4921
|
+
getMe: () => Promise<{
|
|
4922
|
+
device: {
|
|
4923
|
+
id: string;
|
|
4924
|
+
name: string;
|
|
4925
|
+
type: string;
|
|
4926
|
+
organisationId: string;
|
|
4927
|
+
accountId: string;
|
|
4928
|
+
location: {
|
|
4929
|
+
id: string;
|
|
4930
|
+
name: string;
|
|
4931
|
+
} | null;
|
|
4932
|
+
};
|
|
4933
|
+
roles: {
|
|
4934
|
+
accountId: string;
|
|
4935
|
+
roleId: string;
|
|
4936
|
+
}[];
|
|
4937
|
+
config: {
|
|
4938
|
+
corsAllowlist: string[];
|
|
4939
|
+
localHostname: string | null;
|
|
4940
|
+
};
|
|
4941
|
+
}>;
|
|
4591
4942
|
heartbeat: (request: {
|
|
4592
4943
|
appVersion?: string;
|
|
4593
4944
|
localPort?: number;
|
|
@@ -4599,7 +4950,12 @@ export declare class BackstageClient {
|
|
|
4599
4950
|
clientKey: string;
|
|
4600
4951
|
status: Record<string, any>;
|
|
4601
4952
|
}[];
|
|
4602
|
-
}) => Promise<
|
|
4953
|
+
}) => Promise<{
|
|
4954
|
+
serverTime: string;
|
|
4955
|
+
commandsPending: number;
|
|
4956
|
+
certificateRenewalDue: boolean;
|
|
4957
|
+
jwksVersion: number;
|
|
4958
|
+
}>;
|
|
4603
4959
|
declarePeripherals: (request: {
|
|
4604
4960
|
peripherals: ({
|
|
4605
4961
|
clientKey: string;
|
|
@@ -4615,17 +4971,29 @@ export declare class BackstageClient {
|
|
|
4615
4971
|
};
|
|
4616
4972
|
provider?: string;
|
|
4617
4973
|
})[];
|
|
4618
|
-
}) => Promise<
|
|
4974
|
+
}) => Promise<{
|
|
4975
|
+
clientKey: string;
|
|
4976
|
+
deviceId: string;
|
|
4977
|
+
}[]>;
|
|
4619
4978
|
fetchCommands: (options?: {
|
|
4620
4979
|
wait?: number;
|
|
4621
|
-
}) => Promise<
|
|
4980
|
+
}) => Promise<{
|
|
4981
|
+
id: string;
|
|
4982
|
+
type: string;
|
|
4983
|
+
payload: {
|
|
4984
|
+
[key: string]: unknown;
|
|
4985
|
+
};
|
|
4986
|
+
peripheralId: string | null;
|
|
4987
|
+
expiresAt: string;
|
|
4988
|
+
createdAt: string;
|
|
4989
|
+
}[]>;
|
|
4622
4990
|
reportProgress: (commandId: string, request: {
|
|
4623
4991
|
progress: Record<string, any>;
|
|
4624
|
-
}) => Promise<
|
|
4992
|
+
}) => Promise<boolean>;
|
|
4625
4993
|
reportResult: (commandId: string, request: {
|
|
4626
4994
|
status: "completed" | "failed";
|
|
4627
4995
|
result?: Record<string, any>;
|
|
4628
|
-
}) => Promise<
|
|
4996
|
+
}) => Promise<string>;
|
|
4629
4997
|
ingestEvents: (request: {
|
|
4630
4998
|
events: {
|
|
4631
4999
|
id: string;
|
|
@@ -4633,80 +5001,392 @@ export declare class BackstageClient {
|
|
|
4633
5001
|
occurredAt: string;
|
|
4634
5002
|
payload?: Record<string, any>;
|
|
4635
5003
|
}[];
|
|
4636
|
-
}) => Promise<
|
|
4637
|
-
|
|
5004
|
+
}) => Promise<{
|
|
5005
|
+
id: string;
|
|
5006
|
+
outcome: "accepted" | "duplicate";
|
|
5007
|
+
}[]>;
|
|
5008
|
+
getCertificate: () => Promise<{
|
|
5009
|
+
hostname: string;
|
|
5010
|
+
certPem: string;
|
|
5011
|
+
privateKeyPem: string;
|
|
5012
|
+
notAfter: string;
|
|
5013
|
+
}>;
|
|
4638
5014
|
};
|
|
4639
5015
|
devices: {
|
|
4640
|
-
printers: () => Promise<
|
|
4641
|
-
|
|
4642
|
-
|
|
5016
|
+
printers: () => Promise<{
|
|
5017
|
+
id: string;
|
|
5018
|
+
name: string;
|
|
5019
|
+
location: {
|
|
5020
|
+
id: string;
|
|
5021
|
+
name: string;
|
|
5022
|
+
} | null;
|
|
5023
|
+
online: boolean;
|
|
5024
|
+
paperOut: boolean;
|
|
5025
|
+
detached: boolean;
|
|
5026
|
+
capabilities: {
|
|
5027
|
+
[key: string]: unknown;
|
|
5028
|
+
} | null;
|
|
5029
|
+
hostDeviceId: string | null;
|
|
5030
|
+
hostName: string | null;
|
|
5031
|
+
accountId: string;
|
|
5032
|
+
}[]>;
|
|
5033
|
+
mediaCatalog: () => Promise<{
|
|
5034
|
+
capabilities: {
|
|
5035
|
+
id: string;
|
|
5036
|
+
label: string;
|
|
5037
|
+
mediaKind: string;
|
|
5038
|
+
}[];
|
|
5039
|
+
media: {
|
|
5040
|
+
id: string;
|
|
5041
|
+
capability: string;
|
|
5042
|
+
label: string;
|
|
5043
|
+
widthMm: number;
|
|
5044
|
+
heightMm?: number;
|
|
5045
|
+
continuous: boolean;
|
|
5046
|
+
}[];
|
|
5047
|
+
}>;
|
|
5048
|
+
getCommand: (commandId: string) => Promise<{
|
|
5049
|
+
id: string;
|
|
5050
|
+
deviceId: string;
|
|
5051
|
+
peripheralId: string | null;
|
|
5052
|
+
type: string;
|
|
5053
|
+
status: string;
|
|
5054
|
+
payload: {
|
|
5055
|
+
[key: string]: unknown;
|
|
5056
|
+
};
|
|
5057
|
+
idempotencyKey: string | null;
|
|
5058
|
+
progress: {
|
|
5059
|
+
[key: string]: unknown;
|
|
5060
|
+
} | null;
|
|
5061
|
+
result: {
|
|
5062
|
+
[key: string]: unknown;
|
|
5063
|
+
} | null;
|
|
5064
|
+
createdBy: {
|
|
5065
|
+
type: string;
|
|
5066
|
+
id: string;
|
|
5067
|
+
} | null;
|
|
5068
|
+
expiresAt: string;
|
|
5069
|
+
createdAt: string;
|
|
5070
|
+
deliveredAt: string | null;
|
|
5071
|
+
completedAt: string | null;
|
|
5072
|
+
}>;
|
|
4643
5073
|
list: (options?: {
|
|
4644
5074
|
accountId?: string;
|
|
4645
5075
|
type?: string;
|
|
4646
5076
|
status?: "active" | "revoked";
|
|
4647
5077
|
connectivity?: "unknown" | "online" | "offline";
|
|
4648
5078
|
locationId?: string;
|
|
4649
|
-
}) => Promise<
|
|
4650
|
-
|
|
5079
|
+
}) => Promise<{
|
|
5080
|
+
id: string;
|
|
5081
|
+
name: string;
|
|
5082
|
+
type: string;
|
|
5083
|
+
status: string;
|
|
5084
|
+
connectivity: string;
|
|
5085
|
+
accountId: string;
|
|
5086
|
+
location: {
|
|
5087
|
+
id: string;
|
|
5088
|
+
name: string;
|
|
5089
|
+
} | null;
|
|
5090
|
+
hostDeviceId: string | null;
|
|
5091
|
+
attachment: string | null;
|
|
5092
|
+
clientKey: string | null;
|
|
5093
|
+
vendor: string | null;
|
|
5094
|
+
model: string | null;
|
|
5095
|
+
capabilities: {
|
|
5096
|
+
[key: string]: unknown;
|
|
5097
|
+
} | null;
|
|
5098
|
+
liveStatus: {
|
|
5099
|
+
[key: string]: unknown;
|
|
5100
|
+
} | null;
|
|
5101
|
+
platform: {
|
|
5102
|
+
[key: string]: unknown;
|
|
5103
|
+
} | null;
|
|
5104
|
+
appVersion: string | null;
|
|
5105
|
+
local: {
|
|
5106
|
+
hostname: string | null;
|
|
5107
|
+
port: number | null;
|
|
5108
|
+
} | null;
|
|
5109
|
+
lastSeenAt: string | null;
|
|
5110
|
+
online: boolean;
|
|
5111
|
+
createdAt: string;
|
|
5112
|
+
updatedAt: string;
|
|
5113
|
+
peripherals?: {
|
|
5114
|
+
id: string;
|
|
5115
|
+
name: string;
|
|
5116
|
+
type: string;
|
|
5117
|
+
}[];
|
|
5118
|
+
}[]>;
|
|
5119
|
+
get: (deviceId: string) => Promise<{
|
|
5120
|
+
id: string;
|
|
5121
|
+
name: string;
|
|
5122
|
+
type: string;
|
|
5123
|
+
status: string;
|
|
5124
|
+
connectivity: string;
|
|
5125
|
+
accountId: string;
|
|
5126
|
+
location: {
|
|
5127
|
+
id: string;
|
|
5128
|
+
name: string;
|
|
5129
|
+
} | null;
|
|
5130
|
+
hostDeviceId: string | null;
|
|
5131
|
+
attachment: string | null;
|
|
5132
|
+
clientKey: string | null;
|
|
5133
|
+
vendor: string | null;
|
|
5134
|
+
model: string | null;
|
|
5135
|
+
capabilities: {
|
|
5136
|
+
[key: string]: unknown;
|
|
5137
|
+
} | null;
|
|
5138
|
+
liveStatus: {
|
|
5139
|
+
[key: string]: unknown;
|
|
5140
|
+
} | null;
|
|
5141
|
+
platform: {
|
|
5142
|
+
[key: string]: unknown;
|
|
5143
|
+
} | null;
|
|
5144
|
+
appVersion: string | null;
|
|
5145
|
+
local: {
|
|
5146
|
+
hostname: string | null;
|
|
5147
|
+
port: number | null;
|
|
5148
|
+
} | null;
|
|
5149
|
+
lastSeenAt: string | null;
|
|
5150
|
+
online: boolean;
|
|
5151
|
+
createdAt: string;
|
|
5152
|
+
updatedAt: string;
|
|
5153
|
+
peripherals?: {
|
|
5154
|
+
id: string;
|
|
5155
|
+
name: string;
|
|
5156
|
+
type: string;
|
|
5157
|
+
}[];
|
|
5158
|
+
}>;
|
|
4651
5159
|
update: (deviceId: string, request: {
|
|
4652
5160
|
name?: string;
|
|
4653
5161
|
locationId?: any;
|
|
4654
|
-
}) => Promise<
|
|
4655
|
-
|
|
4656
|
-
|
|
5162
|
+
}) => Promise<{
|
|
5163
|
+
id: string;
|
|
5164
|
+
name: string;
|
|
5165
|
+
type: string;
|
|
5166
|
+
status: string;
|
|
5167
|
+
connectivity: string;
|
|
5168
|
+
accountId: string;
|
|
5169
|
+
location: {
|
|
5170
|
+
id: string;
|
|
5171
|
+
name: string;
|
|
5172
|
+
} | null;
|
|
5173
|
+
hostDeviceId: string | null;
|
|
5174
|
+
attachment: string | null;
|
|
5175
|
+
clientKey: string | null;
|
|
5176
|
+
vendor: string | null;
|
|
5177
|
+
model: string | null;
|
|
5178
|
+
capabilities: {
|
|
5179
|
+
[key: string]: unknown;
|
|
5180
|
+
} | null;
|
|
5181
|
+
liveStatus: {
|
|
5182
|
+
[key: string]: unknown;
|
|
5183
|
+
} | null;
|
|
5184
|
+
platform: {
|
|
5185
|
+
[key: string]: unknown;
|
|
5186
|
+
} | null;
|
|
5187
|
+
appVersion: string | null;
|
|
5188
|
+
local: {
|
|
5189
|
+
hostname: string | null;
|
|
5190
|
+
port: number | null;
|
|
5191
|
+
} | null;
|
|
5192
|
+
lastSeenAt: string | null;
|
|
5193
|
+
online: boolean;
|
|
5194
|
+
createdAt: string;
|
|
5195
|
+
updatedAt: string;
|
|
5196
|
+
peripherals?: {
|
|
5197
|
+
id: string;
|
|
5198
|
+
name: string;
|
|
5199
|
+
type: string;
|
|
5200
|
+
}[];
|
|
5201
|
+
}>;
|
|
5202
|
+
delete: (deviceId: string) => Promise<boolean>;
|
|
5203
|
+
revoke: (deviceId: string) => Promise<{
|
|
5204
|
+
id: string;
|
|
5205
|
+
name: string;
|
|
5206
|
+
type: string;
|
|
5207
|
+
status: string;
|
|
5208
|
+
connectivity: string;
|
|
5209
|
+
accountId: string;
|
|
5210
|
+
location: {
|
|
5211
|
+
id: string;
|
|
5212
|
+
name: string;
|
|
5213
|
+
} | null;
|
|
5214
|
+
hostDeviceId: string | null;
|
|
5215
|
+
attachment: string | null;
|
|
5216
|
+
clientKey: string | null;
|
|
5217
|
+
vendor: string | null;
|
|
5218
|
+
model: string | null;
|
|
5219
|
+
capabilities: {
|
|
5220
|
+
[key: string]: unknown;
|
|
5221
|
+
} | null;
|
|
5222
|
+
liveStatus: {
|
|
5223
|
+
[key: string]: unknown;
|
|
5224
|
+
} | null;
|
|
5225
|
+
platform: {
|
|
5226
|
+
[key: string]: unknown;
|
|
5227
|
+
} | null;
|
|
5228
|
+
appVersion: string | null;
|
|
5229
|
+
local: {
|
|
5230
|
+
hostname: string | null;
|
|
5231
|
+
port: number | null;
|
|
5232
|
+
} | null;
|
|
5233
|
+
lastSeenAt: string | null;
|
|
5234
|
+
online: boolean;
|
|
5235
|
+
createdAt: string;
|
|
5236
|
+
updatedAt: string;
|
|
5237
|
+
peripherals?: {
|
|
5238
|
+
id: string;
|
|
5239
|
+
name: string;
|
|
5240
|
+
type: string;
|
|
5241
|
+
}[];
|
|
5242
|
+
}>;
|
|
4657
5243
|
assignRoles: (deviceId: string, request: {
|
|
4658
5244
|
accountRoles: {
|
|
4659
5245
|
accountId: string;
|
|
4660
5246
|
roleId: string;
|
|
4661
5247
|
}[];
|
|
4662
|
-
}) => Promise<
|
|
5248
|
+
}) => Promise<{
|
|
5249
|
+
accountId: string;
|
|
5250
|
+
roleId: string;
|
|
5251
|
+
}[]>;
|
|
4663
5252
|
rotateCredential: (deviceId: string, request: {
|
|
4664
5253
|
graceSeconds?: number;
|
|
4665
|
-
}) => Promise<
|
|
5254
|
+
}) => Promise<{
|
|
5255
|
+
credentialId: string;
|
|
5256
|
+
deviceSecret: string;
|
|
5257
|
+
}>;
|
|
4666
5258
|
dispatchCommand: (deviceId: string, request: {
|
|
4667
5259
|
type: string;
|
|
4668
5260
|
payload?: Record<string, any>;
|
|
4669
5261
|
peripheralId?: string;
|
|
4670
5262
|
idempotencyKey?: string;
|
|
4671
|
-
}) => Promise<any>;
|
|
4672
|
-
listCommands: (deviceId: string) => Promise<any>;
|
|
4673
|
-
listEvents: (deviceId: string) => Promise<any>;
|
|
4674
|
-
mintLocalToken: (deviceId: string, request: {
|
|
4675
|
-
allowedCommandTypes?: string[];
|
|
4676
|
-
ttlSeconds?: number;
|
|
4677
|
-
accountIds?: string[];
|
|
4678
|
-
}) => Promise<any>;
|
|
4679
|
-
};
|
|
4680
|
-
locations: {
|
|
4681
|
-
create: (request: {
|
|
4682
|
-
accountId: string;
|
|
4683
|
-
name: string;
|
|
4684
|
-
description?: string;
|
|
4685
|
-
}) => Promise<any>;
|
|
4686
|
-
list: () => Promise<any>;
|
|
4687
|
-
get: (locationId: string) => Promise<any>;
|
|
4688
|
-
update: (locationId: string, request: {
|
|
4689
|
-
name?: string;
|
|
4690
|
-
description?: any;
|
|
4691
|
-
}) => Promise<any>;
|
|
4692
|
-
delete: (locationId: string) => Promise<any>;
|
|
4693
|
-
};
|
|
4694
|
-
reports: {
|
|
4695
|
-
summary: (options?: {
|
|
4696
|
-
eventId?: string;
|
|
4697
|
-
from?: string;
|
|
4698
|
-
to?: string;
|
|
4699
5263
|
}) => Promise<{
|
|
4700
|
-
|
|
4701
|
-
|
|
4702
|
-
|
|
4703
|
-
|
|
4704
|
-
|
|
4705
|
-
|
|
4706
|
-
|
|
4707
|
-
};
|
|
5264
|
+
id: string;
|
|
5265
|
+
deviceId: string;
|
|
5266
|
+
peripheralId: string | null;
|
|
5267
|
+
type: string;
|
|
5268
|
+
status: string;
|
|
5269
|
+
payload: {
|
|
5270
|
+
[key: string]: unknown;
|
|
4708
5271
|
};
|
|
4709
|
-
|
|
5272
|
+
idempotencyKey: string | null;
|
|
5273
|
+
progress: {
|
|
5274
|
+
[key: string]: unknown;
|
|
5275
|
+
} | null;
|
|
5276
|
+
result: {
|
|
5277
|
+
[key: string]: unknown;
|
|
5278
|
+
} | null;
|
|
5279
|
+
createdBy: {
|
|
5280
|
+
type: string;
|
|
5281
|
+
id: string;
|
|
5282
|
+
} | null;
|
|
5283
|
+
expiresAt: string;
|
|
5284
|
+
createdAt: string;
|
|
5285
|
+
deliveredAt: string | null;
|
|
5286
|
+
completedAt: string | null;
|
|
5287
|
+
}>;
|
|
5288
|
+
listCommands: (deviceId: string) => Promise<{
|
|
5289
|
+
id: string;
|
|
5290
|
+
deviceId: string;
|
|
5291
|
+
peripheralId: string | null;
|
|
5292
|
+
type: string;
|
|
5293
|
+
status: string;
|
|
5294
|
+
payload: {
|
|
5295
|
+
[key: string]: unknown;
|
|
5296
|
+
};
|
|
5297
|
+
idempotencyKey: string | null;
|
|
5298
|
+
progress: {
|
|
5299
|
+
[key: string]: unknown;
|
|
5300
|
+
} | null;
|
|
5301
|
+
result: {
|
|
5302
|
+
[key: string]: unknown;
|
|
5303
|
+
} | null;
|
|
5304
|
+
createdBy: {
|
|
5305
|
+
type: string;
|
|
5306
|
+
id: string;
|
|
5307
|
+
} | null;
|
|
5308
|
+
expiresAt: string;
|
|
5309
|
+
createdAt: string;
|
|
5310
|
+
deliveredAt: string | null;
|
|
5311
|
+
completedAt: string | null;
|
|
5312
|
+
}[]>;
|
|
5313
|
+
listEvents: (deviceId: string) => Promise<{
|
|
5314
|
+
id: string;
|
|
5315
|
+
type: string;
|
|
5316
|
+
payload: {
|
|
5317
|
+
[key: string]: unknown;
|
|
5318
|
+
};
|
|
5319
|
+
occurredAt: string;
|
|
5320
|
+
receivedAt: string;
|
|
5321
|
+
}[]>;
|
|
5322
|
+
mintLocalToken: (deviceId: string, request: {
|
|
5323
|
+
allowedCommandTypes?: string[];
|
|
5324
|
+
ttlSeconds?: number;
|
|
5325
|
+
accountIds?: string[];
|
|
5326
|
+
}) => Promise<{
|
|
5327
|
+
token: string;
|
|
5328
|
+
tokenId: string;
|
|
5329
|
+
expiresAt: string;
|
|
5330
|
+
}>;
|
|
5331
|
+
};
|
|
5332
|
+
locations: {
|
|
5333
|
+
create: (request: {
|
|
5334
|
+
accountId: string;
|
|
5335
|
+
name: string;
|
|
5336
|
+
description?: string;
|
|
5337
|
+
}) => Promise<{
|
|
5338
|
+
id: string;
|
|
5339
|
+
name: string;
|
|
5340
|
+
description: string | null;
|
|
5341
|
+
accountId: string;
|
|
5342
|
+
createdAt: string;
|
|
5343
|
+
updatedAt: string;
|
|
5344
|
+
}>;
|
|
5345
|
+
list: () => Promise<{
|
|
5346
|
+
id: string;
|
|
5347
|
+
name: string;
|
|
5348
|
+
description: string | null;
|
|
5349
|
+
accountId: string;
|
|
5350
|
+
createdAt: string;
|
|
5351
|
+
updatedAt: string;
|
|
5352
|
+
}[]>;
|
|
5353
|
+
get: (locationId: string) => Promise<{
|
|
5354
|
+
id: string;
|
|
5355
|
+
name: string;
|
|
5356
|
+
description: string | null;
|
|
5357
|
+
accountId: string;
|
|
5358
|
+
createdAt: string;
|
|
5359
|
+
updatedAt: string;
|
|
5360
|
+
}>;
|
|
5361
|
+
update: (locationId: string, request: {
|
|
5362
|
+
name?: string;
|
|
5363
|
+
description?: any;
|
|
5364
|
+
}) => Promise<{
|
|
5365
|
+
id: string;
|
|
5366
|
+
name: string;
|
|
5367
|
+
description: string | null;
|
|
5368
|
+
accountId: string;
|
|
5369
|
+
createdAt: string;
|
|
5370
|
+
updatedAt: string;
|
|
5371
|
+
}>;
|
|
5372
|
+
delete: (locationId: string) => Promise<boolean>;
|
|
5373
|
+
};
|
|
5374
|
+
reports: {
|
|
5375
|
+
summary: (options?: {
|
|
5376
|
+
eventId?: string;
|
|
5377
|
+
from?: string;
|
|
5378
|
+
to?: string;
|
|
5379
|
+
}) => Promise<{
|
|
5380
|
+
status: "success";
|
|
5381
|
+
data: {
|
|
5382
|
+
currencies: components["schemas"]["ReportCurrencyTotals"][];
|
|
5383
|
+
filters: {
|
|
5384
|
+
eventId?: string;
|
|
5385
|
+
from?: string;
|
|
5386
|
+
to?: string;
|
|
5387
|
+
};
|
|
5388
|
+
};
|
|
5389
|
+
}>;
|
|
4710
5390
|
timeseries: (options?: {
|
|
4711
5391
|
eventId?: string;
|
|
4712
5392
|
from?: string;
|
|
@@ -5063,31 +5743,160 @@ export declare class BackstageClient {
|
|
|
5063
5743
|
}>;
|
|
5064
5744
|
};
|
|
5065
5745
|
webhookEndpoints: {
|
|
5066
|
-
create: (request: CreateWebhookEndpoint) => Promise<
|
|
5746
|
+
create: (request: CreateWebhookEndpoint) => Promise<{
|
|
5747
|
+
endpoint: {
|
|
5748
|
+
id: string;
|
|
5749
|
+
accountId: string;
|
|
5750
|
+
url: string;
|
|
5751
|
+
description: string | null;
|
|
5752
|
+
eventTypes: string[];
|
|
5753
|
+
status: "enabled" | "disabled" | "auto_disabled";
|
|
5754
|
+
version: string;
|
|
5755
|
+
source: string;
|
|
5756
|
+
createdAt: string;
|
|
5757
|
+
updatedAt: string;
|
|
5758
|
+
};
|
|
5759
|
+
secret: string;
|
|
5760
|
+
}>;
|
|
5067
5761
|
list: (options?: {
|
|
5068
5762
|
accountId?: string;
|
|
5069
|
-
}) => Promise<
|
|
5070
|
-
|
|
5071
|
-
|
|
5072
|
-
|
|
5763
|
+
}) => Promise<{
|
|
5764
|
+
id: string;
|
|
5765
|
+
accountId: string;
|
|
5766
|
+
url: string;
|
|
5767
|
+
description: string | null;
|
|
5768
|
+
eventTypes: string[];
|
|
5769
|
+
status: "enabled" | "disabled" | "auto_disabled";
|
|
5770
|
+
version: string;
|
|
5771
|
+
source: string;
|
|
5772
|
+
createdAt: string;
|
|
5773
|
+
updatedAt: string;
|
|
5774
|
+
}[]>;
|
|
5775
|
+
get: (endpointId: string) => Promise<{
|
|
5776
|
+
id: string;
|
|
5777
|
+
accountId: string;
|
|
5778
|
+
url: string;
|
|
5779
|
+
description: string | null;
|
|
5780
|
+
eventTypes: string[];
|
|
5781
|
+
status: "enabled" | "disabled" | "auto_disabled";
|
|
5782
|
+
version: string;
|
|
5783
|
+
source: string;
|
|
5784
|
+
createdAt: string;
|
|
5785
|
+
updatedAt: string;
|
|
5786
|
+
}>;
|
|
5787
|
+
update: (endpointId: string, request: UpdateWebhookEndpoint) => Promise<{
|
|
5788
|
+
id: string;
|
|
5789
|
+
accountId: string;
|
|
5790
|
+
url: string;
|
|
5791
|
+
description: string | null;
|
|
5792
|
+
eventTypes: string[];
|
|
5793
|
+
status: "enabled" | "disabled" | "auto_disabled";
|
|
5794
|
+
version: string;
|
|
5795
|
+
source: string;
|
|
5796
|
+
createdAt: string;
|
|
5797
|
+
updatedAt: string;
|
|
5798
|
+
}>;
|
|
5799
|
+
delete: (endpointId: string) => Promise<boolean>;
|
|
5073
5800
|
test: (endpointId: string) => Promise<any>;
|
|
5074
5801
|
};
|
|
5075
5802
|
webhookDeliveries: {
|
|
5076
5803
|
list: (options?: {
|
|
5077
5804
|
endpointId?: string;
|
|
5078
5805
|
limit?: number;
|
|
5079
|
-
}) => Promise<
|
|
5080
|
-
|
|
5081
|
-
|
|
5806
|
+
}) => Promise<{
|
|
5807
|
+
id: string;
|
|
5808
|
+
endpointId: string;
|
|
5809
|
+
eventType: string;
|
|
5810
|
+
sourceEventId: string;
|
|
5811
|
+
status: "pending" | "succeeded" | "failed";
|
|
5812
|
+
attempts: number;
|
|
5813
|
+
responseStatus: number | null;
|
|
5814
|
+
error: string | null;
|
|
5815
|
+
nextAttemptAt: string | null;
|
|
5816
|
+
lastAttemptAt: string | null;
|
|
5817
|
+
deliveredAt: string | null;
|
|
5818
|
+
createdAt: string;
|
|
5819
|
+
}[]>;
|
|
5820
|
+
get: (deliveryId: string) => Promise<{
|
|
5821
|
+
id: string;
|
|
5822
|
+
endpointId: string;
|
|
5823
|
+
eventType: string;
|
|
5824
|
+
sourceEventId: string;
|
|
5825
|
+
status: "pending" | "succeeded" | "failed";
|
|
5826
|
+
attempts: number;
|
|
5827
|
+
responseStatus: number | null;
|
|
5828
|
+
error: string | null;
|
|
5829
|
+
nextAttemptAt: string | null;
|
|
5830
|
+
lastAttemptAt: string | null;
|
|
5831
|
+
deliveredAt: string | null;
|
|
5832
|
+
createdAt: string;
|
|
5833
|
+
}>;
|
|
5834
|
+
listInbound: () => Promise<{
|
|
5835
|
+
id: string;
|
|
5836
|
+
provider: string;
|
|
5837
|
+
eventType: string | null;
|
|
5838
|
+
normalisedType: string | null;
|
|
5839
|
+
organisationId: string | null;
|
|
5840
|
+
verified: boolean;
|
|
5841
|
+
status: "received" | "processed" | "failed";
|
|
5842
|
+
attempts: number;
|
|
5843
|
+
error: string | null;
|
|
5844
|
+
receivedAt: string;
|
|
5845
|
+
processedAt: string | null;
|
|
5846
|
+
}[]>;
|
|
5082
5847
|
};
|
|
5083
5848
|
webhookEventTypes: {
|
|
5084
|
-
list: () => Promise<
|
|
5849
|
+
list: () => Promise<{
|
|
5850
|
+
type: string;
|
|
5851
|
+
description: string;
|
|
5852
|
+
}[]>;
|
|
5085
5853
|
};
|
|
5086
5854
|
integrations: {
|
|
5087
|
-
list: () => Promise<
|
|
5088
|
-
|
|
5089
|
-
|
|
5090
|
-
|
|
5855
|
+
list: () => Promise<{
|
|
5856
|
+
integrations: {
|
|
5857
|
+
id: string;
|
|
5858
|
+
kind: "connected_app" | "provider";
|
|
5859
|
+
name: string;
|
|
5860
|
+
description: string;
|
|
5861
|
+
category: string;
|
|
5862
|
+
logoUri: string | null;
|
|
5863
|
+
available: boolean;
|
|
5864
|
+
status: "connected" | "configured" | "not_connected" | "coming_soon";
|
|
5865
|
+
scopes?: string[];
|
|
5866
|
+
lastUsedAt?: string | null;
|
|
5867
|
+
capability?: string;
|
|
5868
|
+
configResource?: string;
|
|
5869
|
+
}[];
|
|
5870
|
+
categories: {
|
|
5871
|
+
id: string;
|
|
5872
|
+
label: string;
|
|
5873
|
+
order: number;
|
|
5874
|
+
blurb: string;
|
|
5875
|
+
}[];
|
|
5876
|
+
}>;
|
|
5877
|
+
listConnectedApps: () => Promise<{
|
|
5878
|
+
clientId: string;
|
|
5879
|
+
scopes: string[];
|
|
5880
|
+
status: "connected" | "revoked";
|
|
5881
|
+
firstSeenAt: string;
|
|
5882
|
+
lastSeenAt: string;
|
|
5883
|
+
revokedAt: string | null;
|
|
5884
|
+
}[]>;
|
|
5885
|
+
get: (id: string) => Promise<{
|
|
5886
|
+
id: string;
|
|
5887
|
+
kind: "connected_app" | "provider";
|
|
5888
|
+
name: string;
|
|
5889
|
+
description: string;
|
|
5890
|
+
category: string;
|
|
5891
|
+
logoUri: string | null;
|
|
5892
|
+
available: boolean;
|
|
5893
|
+
status: "connected" | "configured" | "not_connected" | "coming_soon";
|
|
5894
|
+
scopes?: string[];
|
|
5895
|
+
lastUsedAt?: string | null;
|
|
5896
|
+
capability?: string;
|
|
5897
|
+
configResource?: string;
|
|
5898
|
+
}>;
|
|
5899
|
+
revokeConnection: (id: string) => Promise<boolean>;
|
|
5091
5900
|
};
|
|
5092
5901
|
clientVersions: {
|
|
5093
5902
|
list: (options?: {
|
|
@@ -5150,289 +5959,6 @@ export declare class BackstageClient {
|
|
|
5150
5959
|
payable: components["schemas"]["LedgerCounterpartyBalance"];
|
|
5151
5960
|
}>;
|
|
5152
5961
|
};
|
|
5153
|
-
sales: {
|
|
5154
|
-
resolveChannel: (options?: {
|
|
5155
|
-
domain?: string;
|
|
5156
|
-
key?: string;
|
|
5157
|
-
}) => Promise<{
|
|
5158
|
-
channel: components["schemas"]["SalesChannelSummary"];
|
|
5159
|
-
publishableKey: string | null;
|
|
5160
|
-
cacheVersion: string;
|
|
5161
|
-
}>;
|
|
5162
|
-
get: (eventId: string) => Promise<{
|
|
5163
|
-
id: string;
|
|
5164
|
-
name: string;
|
|
5165
|
-
subtitle: string | null;
|
|
5166
|
-
description: string | null;
|
|
5167
|
-
shortDescription: string | null;
|
|
5168
|
-
status: string;
|
|
5169
|
-
imageUrl: string | null;
|
|
5170
|
-
heroImageUrl: string | null;
|
|
5171
|
-
presentation: {
|
|
5172
|
-
heroLayout?: {
|
|
5173
|
-
type: "hero" | "cinema";
|
|
5174
|
-
size: "small" | "medium" | "large";
|
|
5175
|
-
};
|
|
5176
|
-
cinemaGradient?: {
|
|
5177
|
-
strength: 20 | 50 | 70;
|
|
5178
|
-
position: "bottom" | "center";
|
|
5179
|
-
};
|
|
5180
|
-
twoColumnSplit?: [number, number];
|
|
5181
|
-
navbar?: {
|
|
5182
|
-
transparent?: boolean;
|
|
5183
|
-
};
|
|
5184
|
-
buttonSize?: "small" | "medium" | "large";
|
|
5185
|
-
} | null;
|
|
5186
|
-
venueId: string | null;
|
|
5187
|
-
venueName: string | null;
|
|
5188
|
-
venueCity: string | null;
|
|
5189
|
-
priceFrom: number | null;
|
|
5190
|
-
currency: string | null;
|
|
5191
|
-
timezone: string;
|
|
5192
|
-
occurrences: {
|
|
5193
|
-
id: string;
|
|
5194
|
-
startsAt: string | null;
|
|
5195
|
-
endsAt: string | null;
|
|
5196
|
-
timezone: string;
|
|
5197
|
-
startDate: string;
|
|
5198
|
-
startTime: string;
|
|
5199
|
-
endDate: string;
|
|
5200
|
-
endTime: string;
|
|
5201
|
-
status: string;
|
|
5202
|
-
ticketTypes: {
|
|
5203
|
-
ticketTypeId: string;
|
|
5204
|
-
ticketTypeName: string;
|
|
5205
|
-
description: string | null;
|
|
5206
|
-
categoryId: string;
|
|
5207
|
-
categoryName: string;
|
|
5208
|
-
unitPrice: number;
|
|
5209
|
-
currency: string;
|
|
5210
|
-
}[];
|
|
5211
|
-
}[];
|
|
5212
|
-
}>;
|
|
5213
|
-
getTheme: () => Promise<{
|
|
5214
|
-
id: string;
|
|
5215
|
-
name: string;
|
|
5216
|
-
brand: {
|
|
5217
|
-
[key: string]: unknown;
|
|
5218
|
-
};
|
|
5219
|
-
colors: {
|
|
5220
|
-
[key: string]: unknown;
|
|
5221
|
-
};
|
|
5222
|
-
typography: {
|
|
5223
|
-
[key: string]: unknown;
|
|
5224
|
-
};
|
|
5225
|
-
shape: {
|
|
5226
|
-
[key: string]: unknown;
|
|
5227
|
-
};
|
|
5228
|
-
design?: {
|
|
5229
|
-
[key: string]: unknown;
|
|
5230
|
-
} | null;
|
|
5231
|
-
}>;
|
|
5232
|
-
};
|
|
5233
|
-
salesCustomerAuth: {
|
|
5234
|
-
magicLink: (request: {
|
|
5235
|
-
email?: string;
|
|
5236
|
-
phone?: string;
|
|
5237
|
-
}) => Promise<boolean>;
|
|
5238
|
-
};
|
|
5239
|
-
salesCustomerTokens: {
|
|
5240
|
-
create: (request: {
|
|
5241
|
-
proof: any;
|
|
5242
|
-
}) => Promise<{
|
|
5243
|
-
customerToken: string;
|
|
5244
|
-
expiresIn: number;
|
|
5245
|
-
customer: components["schemas"]["SalesCustomer"];
|
|
5246
|
-
}>;
|
|
5247
|
-
refresh: () => Promise<{
|
|
5248
|
-
customerToken: string;
|
|
5249
|
-
expiresIn: number;
|
|
5250
|
-
customer: components["schemas"]["SalesCustomer"];
|
|
5251
|
-
}>;
|
|
5252
|
-
};
|
|
5253
|
-
salesListings: {
|
|
5254
|
-
list: () => Promise<{
|
|
5255
|
-
channel: components["schemas"]["SalesChannelSummary"];
|
|
5256
|
-
listings: components["schemas"]["SalesListing"][];
|
|
5257
|
-
}>;
|
|
5258
|
-
};
|
|
5259
|
-
salesCarts: {
|
|
5260
|
-
create: (request: {
|
|
5261
|
-
metadata?: Record<string, any>;
|
|
5262
|
-
}) => Promise<{
|
|
5263
|
-
id: string;
|
|
5264
|
-
status: string;
|
|
5265
|
-
currency: string | null;
|
|
5266
|
-
expiresAt: string;
|
|
5267
|
-
orderId: string | null;
|
|
5268
|
-
items: components["schemas"]["SalesCartItem"][];
|
|
5269
|
-
itemsSubtotal: number;
|
|
5270
|
-
}>;
|
|
5271
|
-
get: (cartId: string) => Promise<{
|
|
5272
|
-
id: string;
|
|
5273
|
-
status: string;
|
|
5274
|
-
currency: string | null;
|
|
5275
|
-
expiresAt: string;
|
|
5276
|
-
orderId: string | null;
|
|
5277
|
-
items: components["schemas"]["SalesCartItem"][];
|
|
5278
|
-
itemsSubtotal: number;
|
|
5279
|
-
}>;
|
|
5280
|
-
addItem: (cartId: string, request: {
|
|
5281
|
-
eventOccurrenceId: string;
|
|
5282
|
-
categoryId: string;
|
|
5283
|
-
ticketTypeId: string;
|
|
5284
|
-
quantity?: number;
|
|
5285
|
-
eventLayoutAreaId?: string;
|
|
5286
|
-
eventLayoutSeatIds?: string[];
|
|
5287
|
-
}) => Promise<{
|
|
5288
|
-
id: string;
|
|
5289
|
-
status: string;
|
|
5290
|
-
currency: string | null;
|
|
5291
|
-
expiresAt: string;
|
|
5292
|
-
orderId: string | null;
|
|
5293
|
-
items: components["schemas"]["SalesCartItem"][];
|
|
5294
|
-
itemsSubtotal: number;
|
|
5295
|
-
}>;
|
|
5296
|
-
removeItem: (cartId: string, itemId: string) => Promise<{
|
|
5297
|
-
id: string;
|
|
5298
|
-
status: string;
|
|
5299
|
-
currency: string | null;
|
|
5300
|
-
expiresAt: string;
|
|
5301
|
-
orderId: string | null;
|
|
5302
|
-
items: components["schemas"]["SalesCartItem"][];
|
|
5303
|
-
itemsSubtotal: number;
|
|
5304
|
-
}>;
|
|
5305
|
-
checkout: (cartId: string, request: {
|
|
5306
|
-
customerNotes?: string;
|
|
5307
|
-
metadata?: Record<string, any>;
|
|
5308
|
-
customer?: {
|
|
5309
|
-
email: string;
|
|
5310
|
-
firstName?: string;
|
|
5311
|
-
lastName?: string;
|
|
5312
|
-
phone?: string;
|
|
5313
|
-
marketingConsent?: boolean;
|
|
5314
|
-
};
|
|
5315
|
-
}) => Promise<{
|
|
5316
|
-
cart: components["schemas"]["SalesCart"];
|
|
5317
|
-
order: components["schemas"]["SalesOrder"];
|
|
5318
|
-
orderAccessToken: string;
|
|
5319
|
-
}>;
|
|
5320
|
-
};
|
|
5321
|
-
salesMyOrders: {
|
|
5322
|
-
list: () => Promise<{
|
|
5323
|
-
id: string;
|
|
5324
|
-
orderNumber: string;
|
|
5325
|
-
status: string;
|
|
5326
|
-
paymentStatus: string;
|
|
5327
|
-
currency: string;
|
|
5328
|
-
items: components["schemas"]["SalesOrderItem"][];
|
|
5329
|
-
subtotal: number;
|
|
5330
|
-
totalFees: number;
|
|
5331
|
-
totalTax: number;
|
|
5332
|
-
total: number;
|
|
5333
|
-
tickets: components["schemas"]["SalesTicket"][];
|
|
5334
|
-
isTest: boolean;
|
|
5335
|
-
expiresAt: string | null;
|
|
5336
|
-
createdAt: string;
|
|
5337
|
-
}[]>;
|
|
5338
|
-
};
|
|
5339
|
-
salesOrders: {
|
|
5340
|
-
get: (orderId: string) => Promise<{
|
|
5341
|
-
id: string;
|
|
5342
|
-
orderNumber: string;
|
|
5343
|
-
status: string;
|
|
5344
|
-
paymentStatus: string;
|
|
5345
|
-
currency: string;
|
|
5346
|
-
items: components["schemas"]["SalesOrderItem"][];
|
|
5347
|
-
subtotal: number;
|
|
5348
|
-
totalFees: number;
|
|
5349
|
-
totalTax: number;
|
|
5350
|
-
total: number;
|
|
5351
|
-
tickets: components["schemas"]["SalesTicket"][];
|
|
5352
|
-
isTest: boolean;
|
|
5353
|
-
expiresAt: string | null;
|
|
5354
|
-
createdAt: string;
|
|
5355
|
-
}>;
|
|
5356
|
-
ticketPdf: (orderId: string, passId: string) => Promise<any>;
|
|
5357
|
-
};
|
|
5358
|
-
salesOrderPayments: {
|
|
5359
|
-
create: (orderId: string, request: {
|
|
5360
|
-
paymentType?: "online_card" | "online_bank_transfer" | "online_wallet";
|
|
5361
|
-
returnUrl?: string;
|
|
5362
|
-
}) => Promise<{
|
|
5363
|
-
id: string;
|
|
5364
|
-
orderId: string;
|
|
5365
|
-
status: string;
|
|
5366
|
-
paymentType: string;
|
|
5367
|
-
amount: number;
|
|
5368
|
-
currency: string;
|
|
5369
|
-
providerClientSecret: string | null;
|
|
5370
|
-
externalPaymentUrl: string | null;
|
|
5371
|
-
publishableKey: string | null;
|
|
5372
|
-
connectedAccountId: string | null;
|
|
5373
|
-
providerType: string | null;
|
|
5374
|
-
}>;
|
|
5375
|
-
confirmSandbox: (orderId: string, paymentId: string, request: {
|
|
5376
|
-
token?: string;
|
|
5377
|
-
}) => Promise<{
|
|
5378
|
-
paymentId: string;
|
|
5379
|
-
outcome: "succeeded" | "failed";
|
|
5380
|
-
ingestStatus: "received" | "duplicate";
|
|
5381
|
-
failureCode: string | null;
|
|
5382
|
-
failureMessage: string | null;
|
|
5383
|
-
}>;
|
|
5384
|
-
};
|
|
5385
|
-
salesRefundRequests: {
|
|
5386
|
-
create: (orderId: string, request: {
|
|
5387
|
-
type: "refund" | "exchange";
|
|
5388
|
-
reason?: string;
|
|
5389
|
-
}) => Promise<{
|
|
5390
|
-
id: string;
|
|
5391
|
-
orderId: string;
|
|
5392
|
-
type: string;
|
|
5393
|
-
status: string;
|
|
5394
|
-
reason: string | null;
|
|
5395
|
-
createdAt: string;
|
|
5396
|
-
}>;
|
|
5397
|
-
};
|
|
5398
|
-
salesCustomers: {
|
|
5399
|
-
create: (request: {
|
|
5400
|
-
email: string;
|
|
5401
|
-
firstName?: string;
|
|
5402
|
-
lastName?: string;
|
|
5403
|
-
phone?: string;
|
|
5404
|
-
marketingConsent?: boolean;
|
|
5405
|
-
}) => Promise<{
|
|
5406
|
-
id: string;
|
|
5407
|
-
email: string;
|
|
5408
|
-
firstName: string | null;
|
|
5409
|
-
lastName: string | null;
|
|
5410
|
-
}>;
|
|
5411
|
-
get: (customerId: string) => Promise<{
|
|
5412
|
-
id: string;
|
|
5413
|
-
email: string;
|
|
5414
|
-
firstName: string | null;
|
|
5415
|
-
lastName: string | null;
|
|
5416
|
-
}>;
|
|
5417
|
-
update: (customerId: string, request: {
|
|
5418
|
-
firstName?: string;
|
|
5419
|
-
lastName?: string;
|
|
5420
|
-
phone?: string;
|
|
5421
|
-
}) => Promise<{
|
|
5422
|
-
id: string;
|
|
5423
|
-
email: string;
|
|
5424
|
-
firstName: string | null;
|
|
5425
|
-
lastName: string | null;
|
|
5426
|
-
}>;
|
|
5427
|
-
};
|
|
5428
|
-
salesPresaleCodes: {
|
|
5429
|
-
redeem: (request: {
|
|
5430
|
-
code: string;
|
|
5431
|
-
}) => Promise<{
|
|
5432
|
-
benefit: string;
|
|
5433
|
-
alreadyHeld: boolean;
|
|
5434
|
-
}>;
|
|
5435
|
-
};
|
|
5436
5962
|
}
|
|
5437
5963
|
export {};
|
|
5438
5964
|
//# sourceMappingURL=client.d.ts.map
|