@ticketlayer/backstage 2.0.0 → 2.2.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.
Files changed (10) hide show
  1. package/dist/client.d.ts +239 -7
  2. package/dist/client.d.ts.map +1 -1
  3. package/dist/client.js +104 -0
  4. package/dist/generated/types.d.ts +1984 -198
  5. package/dist/generated/types.d.ts.map +1 -1
  6. package/dist/index.d.ts +17 -0
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/version.d.ts +1 -1
  9. package/dist/version.js +1 -1
  10. package/package.json +1 -1
package/dist/client.d.ts CHANGED
@@ -5,6 +5,7 @@ type CreateAiTopupRequest = components['schemas']['CreateAiTopupRequest'];
5
5
  type CreatePurchaseRequest = components['schemas']['CreatePurchaseRequest'];
6
6
  type CreateRoleRequest = components['schemas']['CreateRoleRequest'];
7
7
  type CreateSubscriptionRequest = components['schemas']['CreateSubscriptionRequest'];
8
+ type CreateTagDefinitionRequest = components['schemas']['CreateTagDefinitionRequest'];
8
9
  type CreateUserInvitationRequest = components['schemas']['CreateUserInvitationRequest'];
9
10
  type CreateWebhookEndpoint = components['schemas']['CreateWebhookEndpoint'];
10
11
  type GrantSalesChannelAccessRequest = components['schemas']['GrantSalesChannelAccessRequest'];
@@ -17,6 +18,7 @@ type UpdateAutoTopupRequest = components['schemas']['UpdateAutoTopupRequest'];
17
18
  type UpdateIdentityProviderRequest = components['schemas']['UpdateIdentityProviderRequest'];
18
19
  type UpdateOrganisationRequest = components['schemas']['UpdateOrganisationRequest'];
19
20
  type UpdateRoleRequest = components['schemas']['UpdateRoleRequest'];
21
+ type UpdateTagDefinitionRequest = components['schemas']['UpdateTagDefinitionRequest'];
20
22
  type UpdateUserAccountRolesRequest = components['schemas']['UpdateUserAccountRolesRequest'];
21
23
  type UpdateWebhookEndpoint = components['schemas']['UpdateWebhookEndpoint'];
22
24
  type ValidateLayoutChangesRequest = components['schemas']['ValidateLayoutChangesRequest'];
@@ -220,6 +222,7 @@ export declare class BackstageClient {
220
222
  name: string;
221
223
  slug: string;
222
224
  plan: string;
225
+ template: string | null;
223
226
  apiVersion: string;
224
227
  };
225
228
  owner: {
@@ -764,6 +767,50 @@ export declare class BackstageClient {
764
767
  }>;
765
768
  };
766
769
  events: ((eventId: string) => {
770
+ offers: {
771
+ get: (options?: {
772
+ occurrenceId?: string;
773
+ at?: string;
774
+ customerId?: string;
775
+ code?: string;
776
+ presaleCode?: string;
777
+ quantity?: string;
778
+ cartId?: string;
779
+ view?: "buyer" | "staff";
780
+ }) => Promise<{
781
+ event: {
782
+ id: string;
783
+ name: string;
784
+ timezone: string;
785
+ };
786
+ channel: {
787
+ id: string;
788
+ slug: string;
789
+ name: string;
790
+ };
791
+ context: {
792
+ at: string;
793
+ view: "buyer" | "staff";
794
+ customerId: string | null;
795
+ code: string | null;
796
+ codeApplied: boolean;
797
+ quantity: number;
798
+ cartId: string | null;
799
+ };
800
+ summary: {
801
+ state: "on_sale" | "not_yet_on_sale" | "off_sale" | "sold_out" | "locked" | "hidden" | null;
802
+ currency: string | null;
803
+ from: number | null;
804
+ to: number | null;
805
+ };
806
+ limits: {
807
+ minPerOrder: number;
808
+ maxPerOrder: number;
809
+ maxOrderValue: number;
810
+ };
811
+ occurrences: components["schemas"]["OccurrenceOffers"][];
812
+ }>;
813
+ };
767
814
  occurrences: {
768
815
  create: (request: {
769
816
  startDate: string;
@@ -863,12 +910,21 @@ export declare class BackstageClient {
863
910
  description?: string;
864
911
  status?: "draft" | "active" | "archived";
865
912
  parentPriceSchemeId?: string;
913
+ currency?: "GBP" | "USD" | "EUR" | "AUD" | "CAD";
866
914
  ticketPrices?: ({
867
915
  categoryId: string;
868
916
  typeId: string;
869
917
  price: number;
870
918
  currency?: "GBP" | "USD" | "EUR" | "AUD" | "CAD";
919
+ tags?: string[];
871
920
  })[];
921
+ channelPrices?: {
922
+ categoryId: string;
923
+ typeId: string;
924
+ channelId: string;
925
+ price: number;
926
+ tags?: string[];
927
+ }[];
872
928
  }) => Promise<{
873
929
  id: string;
874
930
  organisationId: string;
@@ -878,7 +934,9 @@ export declare class BackstageClient {
878
934
  description?: string;
879
935
  status: "draft" | "active" | "archived";
880
936
  parentPriceSchemeId?: string;
937
+ currency: "GBP" | "USD" | "EUR" | "AUD" | "CAD" | null;
881
938
  ticketPrices: components["schemas"]["TicketPrice"][];
939
+ channelPrices: components["schemas"]["ChannelPrice"][];
882
940
  isDeleted: boolean;
883
941
  createdAt: string;
884
942
  updatedAt: string;
@@ -892,7 +950,9 @@ export declare class BackstageClient {
892
950
  description?: string;
893
951
  status: "draft" | "active" | "archived";
894
952
  parentPriceSchemeId?: string;
953
+ currency: "GBP" | "USD" | "EUR" | "AUD" | "CAD" | null;
895
954
  ticketPrices: components["schemas"]["TicketPrice"][];
955
+ channelPrices: components["schemas"]["ChannelPrice"][];
896
956
  isDeleted: boolean;
897
957
  createdAt: string;
898
958
  updatedAt: string;
@@ -906,7 +966,9 @@ export declare class BackstageClient {
906
966
  description?: string;
907
967
  status: "draft" | "active" | "archived";
908
968
  parentPriceSchemeId?: string;
969
+ currency: "GBP" | "USD" | "EUR" | "AUD" | "CAD" | null;
909
970
  ticketPrices: components["schemas"]["TicketPrice"][];
971
+ channelPrices: components["schemas"]["ChannelPrice"][];
910
972
  isDeleted: boolean;
911
973
  createdAt: string;
912
974
  updatedAt: string;
@@ -915,12 +977,21 @@ export declare class BackstageClient {
915
977
  name?: string;
916
978
  description?: any;
917
979
  status?: "draft" | "active" | "archived";
980
+ currency?: "GBP" | "USD" | "EUR" | "AUD" | "CAD";
918
981
  ticketPrices?: ({
919
982
  categoryId: string;
920
983
  typeId: string;
921
984
  price: number;
922
985
  currency?: "GBP" | "USD" | "EUR" | "AUD" | "CAD";
986
+ tags?: string[];
923
987
  })[];
988
+ channelPrices?: {
989
+ categoryId: string;
990
+ typeId: string;
991
+ channelId: string;
992
+ price: number;
993
+ tags?: string[];
994
+ }[];
924
995
  }) => Promise<{
925
996
  id: string;
926
997
  organisationId: string;
@@ -930,7 +1001,9 @@ export declare class BackstageClient {
930
1001
  description?: string;
931
1002
  status: "draft" | "active" | "archived";
932
1003
  parentPriceSchemeId?: string;
1004
+ currency: "GBP" | "USD" | "EUR" | "AUD" | "CAD" | null;
933
1005
  ticketPrices: components["schemas"]["TicketPrice"][];
1006
+ channelPrices: components["schemas"]["ChannelPrice"][];
934
1007
  isDeleted: boolean;
935
1008
  createdAt: string;
936
1009
  updatedAt: string;
@@ -955,9 +1028,9 @@ export declare class BackstageClient {
955
1028
  venueName?: any;
956
1029
  timezone?: string;
957
1030
  rules?: {
958
- discoverable?: components["schemas"]["ListingRule"];
959
- visible?: components["schemas"]["ListingRule"];
960
- sellable?: components["schemas"]["ListingRule"];
1031
+ discoverable?: components["schemas"]["ListingRuleInput"];
1032
+ visible?: components["schemas"]["ListingRuleInput"];
1033
+ sellable?: components["schemas"]["ListingRuleInput"];
961
1034
  };
962
1035
  tags?: string[];
963
1036
  ticketTypes?: {
@@ -965,6 +1038,7 @@ export declare class BackstageClient {
965
1038
  name: string;
966
1039
  description?: string;
967
1040
  displayOrder: number;
1041
+ tags?: string[];
968
1042
  }[];
969
1043
  layout?: {
970
1044
  categories?: {
@@ -990,11 +1064,20 @@ export declare class BackstageClient {
990
1064
  organisationId: string;
991
1065
  accountId: string;
992
1066
  name: string;
1067
+ subtitle: string | null;
993
1068
  description?: string;
1069
+ shortDescription: string | null;
994
1070
  status: "draft" | "published" | "on_sale" | "sold_out" | "completed" | "cancelled";
1071
+ images: components["schemas"]["EventImages"];
1072
+ imageUrl: string | null;
1073
+ heroImageUrl: string | null;
1074
+ presentation: components["schemas"]["EventPresentation"];
995
1075
  venueId?: string;
1076
+ venueName: string | null;
996
1077
  timezone: string;
997
1078
  rules: components["schemas"]["ListingRules"];
1079
+ ticketTypes: components["schemas"]["EventTicketType"][];
1080
+ defaultPriceSchemeId: string | null;
998
1081
  occurrenceCount: number;
999
1082
  ticketCount: number;
1000
1083
  productCount: number;
@@ -1002,6 +1085,7 @@ export declare class BackstageClient {
1002
1085
  isDeleted: boolean;
1003
1086
  createdAt: string;
1004
1087
  updatedAt: string;
1088
+ contentUpdatedAt: string;
1005
1089
  createdBy?: string;
1006
1090
  }>;
1007
1091
  list: (options?: {
@@ -1009,15 +1093,20 @@ export declare class BackstageClient {
1009
1093
  status?: "draft" | "published" | "on_sale" | "sold_out" | "completed" | "cancelled";
1010
1094
  venueId?: string;
1011
1095
  accountId?: string;
1096
+ updatedSince?: string;
1097
+ cursor?: string;
1098
+ include?: ("occurrences" | "venue" | "prices")[];
1099
+ visibility?: "discoverable" | "visible";
1012
1100
  expand?: string;
1013
1101
  page?: string;
1014
1102
  limit?: string;
1015
1103
  }) => Promise<{
1016
1104
  events: components["schemas"]["EventInChannel"][];
1017
- pagination: components["schemas"]["Pagination"];
1105
+ pagination: components["schemas"]["EventListPagination"];
1018
1106
  channel: components["schemas"]["ChannelContext"];
1019
1107
  }>;
1020
1108
  get: (id: string, options?: {
1109
+ include?: ("occurrences" | "venue" | "prices")[];
1021
1110
  expand?: string;
1022
1111
  }) => Promise<{
1023
1112
  event: components["schemas"]["EventInChannel"];
@@ -1036,9 +1125,9 @@ export declare class BackstageClient {
1036
1125
  venueName?: any;
1037
1126
  timezone?: string;
1038
1127
  rules?: {
1039
- discoverable?: components["schemas"]["ListingRule"];
1040
- visible?: components["schemas"]["ListingRule"];
1041
- sellable?: components["schemas"]["ListingRule"];
1128
+ discoverable?: components["schemas"]["ListingRuleInput"];
1129
+ visible?: components["schemas"]["ListingRuleInput"];
1130
+ sellable?: components["schemas"]["ListingRuleInput"];
1042
1131
  };
1043
1132
  tags?: string[];
1044
1133
  ticketTypes?: {
@@ -1046,6 +1135,7 @@ export declare class BackstageClient {
1046
1135
  name: string;
1047
1136
  description?: string;
1048
1137
  displayOrder: number;
1138
+ tags?: string[];
1049
1139
  }[];
1050
1140
  layout?: {
1051
1141
  categories?: {
@@ -1071,11 +1161,20 @@ export declare class BackstageClient {
1071
1161
  organisationId: string;
1072
1162
  accountId: string;
1073
1163
  name: string;
1164
+ subtitle: string | null;
1074
1165
  description?: string;
1166
+ shortDescription: string | null;
1075
1167
  status: "draft" | "published" | "on_sale" | "sold_out" | "completed" | "cancelled";
1168
+ images: components["schemas"]["EventImages"];
1169
+ imageUrl: string | null;
1170
+ heroImageUrl: string | null;
1171
+ presentation: components["schemas"]["EventPresentation"];
1076
1172
  venueId?: string;
1173
+ venueName: string | null;
1077
1174
  timezone: string;
1078
1175
  rules: components["schemas"]["ListingRules"];
1176
+ ticketTypes: components["schemas"]["EventTicketType"][];
1177
+ defaultPriceSchemeId: string | null;
1079
1178
  occurrenceCount: number;
1080
1179
  ticketCount: number;
1081
1180
  productCount: number;
@@ -1083,6 +1182,7 @@ export declare class BackstageClient {
1083
1182
  isDeleted: boolean;
1084
1183
  createdAt: string;
1085
1184
  updatedAt: string;
1185
+ contentUpdatedAt: string;
1086
1186
  createdBy?: string;
1087
1187
  }>;
1088
1188
  delete: (id: string) => Promise<{
@@ -2358,6 +2458,61 @@ export declare class BackstageClient {
2358
2458
  createdAt: string;
2359
2459
  updatedAt: string;
2360
2460
  }>;
2461
+ listTags: (customerId: string, options?: {
2462
+ includeRevoked?: "true" | "false";
2463
+ }) => Promise<{
2464
+ id: string;
2465
+ customerId: string;
2466
+ tag: string;
2467
+ tagDefinitionId: string | null;
2468
+ source: "manual" | "membership" | "import" | "presale";
2469
+ expiresAt: string | null;
2470
+ revokedAt: string | null;
2471
+ revokedBy: string | null;
2472
+ grantedBy: string | null;
2473
+ metadata: {
2474
+ [key: string]: unknown;
2475
+ } | null;
2476
+ createdAt: string;
2477
+ updatedAt: string;
2478
+ }[]>;
2479
+ grantTag: (customerId: string, request: {
2480
+ tag: string;
2481
+ source?: "manual" | "membership" | "import";
2482
+ expiresAt?: any;
2483
+ metadata?: Record<string, any>;
2484
+ }) => Promise<{
2485
+ id: string;
2486
+ customerId: string;
2487
+ tag: string;
2488
+ tagDefinitionId: string | null;
2489
+ source: "manual" | "membership" | "import" | "presale";
2490
+ expiresAt: string | null;
2491
+ revokedAt: string | null;
2492
+ revokedBy: string | null;
2493
+ grantedBy: string | null;
2494
+ metadata: {
2495
+ [key: string]: unknown;
2496
+ } | null;
2497
+ createdAt: string;
2498
+ updatedAt: string;
2499
+ }>;
2500
+ revokeTag: (customerId: string, customerTagId: string) => Promise<{
2501
+ id: string;
2502
+ customerId: string;
2503
+ tag: string;
2504
+ tagDefinitionId: string | null;
2505
+ source: "manual" | "membership" | "import" | "presale";
2506
+ expiresAt: string | null;
2507
+ revokedAt: string | null;
2508
+ revokedBy: string | null;
2509
+ grantedBy: string | null;
2510
+ metadata: {
2511
+ [key: string]: unknown;
2512
+ } | null;
2513
+ createdAt: string;
2514
+ updatedAt: string;
2515
+ }>;
2361
2516
  listBenefits: (customerId: string, options?: {
2362
2517
  includeRevoked?: "true" | "false";
2363
2518
  }) => Promise<{
@@ -4204,6 +4359,77 @@ export declare class BackstageClient {
4204
4359
  design: components["schemas"]["ThemeDesign"];
4205
4360
  }>;
4206
4361
  };
4362
+ tags: {
4363
+ list: (options?: {
4364
+ kind?: components["schemas"]["TagKind"];
4365
+ appliesTo?: components["schemas"]["TagTarget"];
4366
+ includeArchived?: "true" | "false";
4367
+ }) => Promise<{
4368
+ id: string;
4369
+ slug: string;
4370
+ label: string;
4371
+ description: string | null;
4372
+ kind: components["schemas"]["TagKind"];
4373
+ appliesTo: components["schemas"]["TagTarget"][];
4374
+ grantableBy: components["schemas"]["TagGrantor"][];
4375
+ autoDefined: boolean;
4376
+ archivedAt: string | null;
4377
+ createdAt: string;
4378
+ updatedAt: string;
4379
+ }[]>;
4380
+ create: (request: CreateTagDefinitionRequest) => Promise<{
4381
+ id: string;
4382
+ slug: string;
4383
+ label: string;
4384
+ description: string | null;
4385
+ kind: components["schemas"]["TagKind"];
4386
+ appliesTo: components["schemas"]["TagTarget"][];
4387
+ grantableBy: components["schemas"]["TagGrantor"][];
4388
+ autoDefined: boolean;
4389
+ archivedAt: string | null;
4390
+ createdAt: string;
4391
+ updatedAt: string;
4392
+ }>;
4393
+ get: (id: string) => Promise<{
4394
+ id: string;
4395
+ slug: string;
4396
+ label: string;
4397
+ description: string | null;
4398
+ kind: components["schemas"]["TagKind"];
4399
+ appliesTo: components["schemas"]["TagTarget"][];
4400
+ grantableBy: components["schemas"]["TagGrantor"][];
4401
+ autoDefined: boolean;
4402
+ archivedAt: string | null;
4403
+ createdAt: string;
4404
+ updatedAt: string;
4405
+ }>;
4406
+ update: (id: string, request: UpdateTagDefinitionRequest) => Promise<{
4407
+ id: string;
4408
+ slug: string;
4409
+ label: string;
4410
+ description: string | null;
4411
+ kind: components["schemas"]["TagKind"];
4412
+ appliesTo: components["schemas"]["TagTarget"][];
4413
+ grantableBy: components["schemas"]["TagGrantor"][];
4414
+ autoDefined: boolean;
4415
+ archivedAt: string | null;
4416
+ createdAt: string;
4417
+ updatedAt: string;
4418
+ }>;
4419
+ archive: (id: string) => Promise<{
4420
+ id: string;
4421
+ slug: string;
4422
+ label: string;
4423
+ description: string | null;
4424
+ kind: components["schemas"]["TagKind"];
4425
+ appliesTo: components["schemas"]["TagTarget"][];
4426
+ grantableBy: components["schemas"]["TagGrantor"][];
4427
+ autoDefined: boolean;
4428
+ archivedAt: string | null;
4429
+ createdAt: string;
4430
+ updatedAt: string;
4431
+ }>;
4432
+ };
4207
4433
  passes: (passeId: string) => {
4208
4434
  entitlements: {
4209
4435
  redeem: (barcode: string, request: {
@@ -4738,6 +4964,8 @@ export declare class BackstageClient {
4738
4964
  storageBucket: string | null;
4739
4965
  storageKey: string;
4740
4966
  url: string;
4967
+ signedUrl: string | null;
4968
+ signedUrlExpiresAt: string | null;
4741
4969
  cdn: boolean;
4742
4970
  cdnUrl: string | null;
4743
4971
  visibility: string;
@@ -4771,6 +4999,8 @@ export declare class BackstageClient {
4771
4999
  storageBucket: string | null;
4772
5000
  storageKey: string;
4773
5001
  url: string;
5002
+ signedUrl: string | null;
5003
+ signedUrlExpiresAt: string | null;
4774
5004
  cdn: boolean;
4775
5005
  cdnUrl: string | null;
4776
5006
  visibility: string;
@@ -4796,6 +5026,8 @@ export declare class BackstageClient {
4796
5026
  storageBucket: string | null;
4797
5027
  storageKey: string;
4798
5028
  url: string;
5029
+ signedUrl: string | null;
5030
+ signedUrlExpiresAt: string | null;
4799
5031
  cdn: boolean;
4800
5032
  cdnUrl: string | null;
4801
5033
  visibility: string;