@izak0s/spacebring-api 16.5.0 → 16.7.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 (5) hide show
  1. package/dist/index.cjs.map +1 -1
  2. package/dist/index.d.cts +139 -31
  3. package/dist/index.d.ts +139 -31
  4. package/dist/index.js.map +1 -1
  5. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -3456,9 +3456,9 @@ interface components {
3456
3456
  };
3457
3457
  /**
3458
3458
  * Format: uuid
3459
- * @description ID of the benefit category this benefit belongs to.
3459
+ * @description ID of the benefit category this benefit belongs to, or null when the benefit has no category.
3460
3460
  */
3461
- categoryRef: string;
3461
+ categoryRef: string | null;
3462
3462
  /**
3463
3463
  * Format: date-time
3464
3464
  * @description ISO timestamp of when the benefit was created.
@@ -3537,9 +3537,9 @@ interface components {
3537
3537
  };
3538
3538
  /**
3539
3539
  * Format: uuid
3540
- * @description ID of the benefit category this benefit belongs to.
3540
+ * @description ID of the benefit category this benefit belongs to, or null when the benefit has no category.
3541
3541
  */
3542
- categoryRef: string;
3542
+ categoryRef: string | null;
3543
3543
  /**
3544
3544
  * Format: date-time
3545
3545
  * @description ISO timestamp of when the benefit was created.
@@ -3615,9 +3615,9 @@ interface components {
3615
3615
  };
3616
3616
  /**
3617
3617
  * Format: uuid
3618
- * @description ID of the benefit category this benefit belongs to.
3618
+ * @description ID of the benefit category this benefit belongs to, or null when the benefit has no category.
3619
3619
  */
3620
- categoryRef: string;
3620
+ categoryRef: string | null;
3621
3621
  /**
3622
3622
  * Format: date-time
3623
3623
  * @description ISO timestamp of when the benefit was created.
@@ -9963,6 +9963,8 @@ interface components {
9963
9963
  * @description Deprecated. Use resources instead.
9964
9964
  */
9965
9965
  bookings?: boolean;
9966
+ /** @description Whether the admin can manage campaigns. */
9967
+ campaigns?: boolean;
9966
9968
  /** @description Whether the admin can manage customers. */
9967
9969
  customers: boolean;
9968
9970
  /** @description Whether the admin can manage events. */
@@ -9980,6 +9982,64 @@ interface components {
9980
9982
  /** @description Whether the admin can access support tools. */
9981
9983
  support: boolean;
9982
9984
  };
9985
+ /** @description Access level of the admin in each area of the locations in locationPermissions: none hides the area, read shows it without changes, and write manages it. Included whenever locationPermissions is. */
9986
+ locationPermissionLevels?: {
9987
+ /**
9988
+ * @description Access level of the admin in the analytics area.
9989
+ * @enum {string}
9990
+ */
9991
+ analytics: "none" | "read";
9992
+ /**
9993
+ * @description Access level of the admin in the benefits area.
9994
+ * @enum {string}
9995
+ */
9996
+ benefits: "none" | "read" | "write";
9997
+ /**
9998
+ * @description Access level of the admin in the billing area.
9999
+ * @enum {string}
10000
+ */
10001
+ billing: "none" | "read" | "write";
10002
+ /**
10003
+ * @description Access level of the admin in the campaigns area.
10004
+ * @enum {string}
10005
+ */
10006
+ campaigns: "none" | "read" | "write";
10007
+ /**
10008
+ * @description Access level of the admin in the customers area.
10009
+ * @enum {string}
10010
+ */
10011
+ customers: "none" | "read" | "write";
10012
+ /**
10013
+ * @description Access level of the admin in the events area.
10014
+ * @enum {string}
10015
+ */
10016
+ events: "none" | "read" | "write";
10017
+ /**
10018
+ * @description Access level of the admin in the feed area.
10019
+ * @enum {string}
10020
+ */
10021
+ feed: "none" | "read" | "write";
10022
+ /**
10023
+ * @description Access level of the admin in the resources area.
10024
+ * @enum {string}
10025
+ */
10026
+ resources: "none" | "read" | "write";
10027
+ /**
10028
+ * @description Access level of the admin in the settings area.
10029
+ * @enum {string}
10030
+ */
10031
+ settings: "none" | "write";
10032
+ /**
10033
+ * @description Access level of the admin in the shop area.
10034
+ * @enum {string}
10035
+ */
10036
+ shop: "none" | "read" | "write";
10037
+ /**
10038
+ * @description Access level of the admin in the support area.
10039
+ * @enum {string}
10040
+ */
10041
+ support: "none" | "read" | "write";
10042
+ };
9983
10043
  /**
9984
10044
  * @description Role of the user in the network.
9985
10045
  * @enum {string}
@@ -10187,6 +10247,18 @@ interface components {
10187
10247
  enabled: boolean;
10188
10248
  /** @description How many minutes before it starts a booking of the resource has to be made. */
10189
10249
  minNotice?: number;
10250
+ /** @description Booking window for nonmembers. A booking of a nonmember follows it instead of the booking window above while it is enabled, even when that one is off. */
10251
+ public: {
10252
+ /**
10253
+ * @description How far ahead nonmembers can book the resource.
10254
+ * @enum {string}
10255
+ */
10256
+ bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
10257
+ /** @description Whether bookings of nonmembers follow a separate booking window. */
10258
+ enabled: boolean;
10259
+ /** @description How many minutes before it starts a booking of a nonmember has to be made. */
10260
+ minNotice?: number;
10261
+ };
10190
10262
  };
10191
10263
  /** @description Brivo access group reference. */
10192
10264
  brivoGroupRef?: number | null;
@@ -10910,6 +10982,18 @@ interface components {
10910
10982
  enabled: boolean;
10911
10983
  /** @description How many minutes before it starts a booking of the resource has to be made. */
10912
10984
  minNotice?: number;
10985
+ /** @description Booking window for nonmembers. A booking of a nonmember follows it instead of the booking window above while it is enabled, even when that one is off. */
10986
+ public: {
10987
+ /**
10988
+ * @description How far ahead nonmembers can book the resource.
10989
+ * @enum {string}
10990
+ */
10991
+ bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
10992
+ /** @description Whether bookings of nonmembers follow a separate booking window. */
10993
+ enabled: boolean;
10994
+ /** @description How many minutes before it starts a booking of a nonmember has to be made. */
10995
+ minNotice?: number;
10996
+ };
10913
10997
  };
10914
10998
  /** @description Brivo access group reference. */
10915
10999
  brivoGroupRef?: number | null;
@@ -14158,9 +14242,9 @@ interface components {
14158
14242
  products: {
14159
14243
  /**
14160
14244
  * Format: uuid
14161
- * @description ID of the category this product belongs to.
14245
+ * @description ID of the category this product belongs to, or null when the product has no category.
14162
14246
  */
14163
- categoryRef: string;
14247
+ categoryRef: string | null;
14164
14248
  /**
14165
14249
  * Format: date-time
14166
14250
  * @description ISO timestamp of when the product was created.
@@ -14290,9 +14374,9 @@ interface components {
14290
14374
  product: {
14291
14375
  /**
14292
14376
  * Format: uuid
14293
- * @description ID of the category this product belongs to.
14377
+ * @description ID of the category this product belongs to, or null when the product has no category.
14294
14378
  */
14295
- categoryRef: string;
14379
+ categoryRef: string | null;
14296
14380
  /**
14297
14381
  * Format: date-time
14298
14382
  * @description ISO timestamp of when the product was created.
@@ -14421,9 +14505,9 @@ interface components {
14421
14505
  product: {
14422
14506
  /**
14423
14507
  * Format: uuid
14424
- * @description ID of the category this product belongs to.
14508
+ * @description ID of the category this product belongs to, or null when the product has no category.
14425
14509
  */
14426
- categoryRef: string;
14510
+ categoryRef: string | null;
14427
14511
  /**
14428
14512
  * Format: date-time
14429
14513
  * @description ISO timestamp of when the product was created.
@@ -20940,7 +21024,7 @@ interface components {
20940
21024
  */
20941
21025
  type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
20942
21026
  };
20943
- /** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
21027
+ /** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. The link stops working 190 days after it was issued, whether or not the transaction is fetched again. Fetching the transaction 180 days or more after the link was issued returns a new one, so fetch the transaction again for the current link rather than storing it. */
20944
21028
  receiptPdfUrl?: string;
20945
21029
  /**
20946
21030
  * @deprecated
@@ -21660,7 +21744,7 @@ interface components {
21660
21744
  */
21661
21745
  type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
21662
21746
  };
21663
- /** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
21747
+ /** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. The link stops working 190 days after it was issued, whether or not the transaction is fetched again. Fetching the transaction 180 days or more after the link was issued returns a new one, so fetch the transaction again for the current link rather than storing it. */
21664
21748
  receiptPdfUrl?: string;
21665
21749
  /**
21666
21750
  * @deprecated
@@ -22380,7 +22464,7 @@ interface components {
22380
22464
  */
22381
22465
  type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
22382
22466
  };
22383
- /** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
22467
+ /** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. The link stops working 190 days after it was issued, whether or not the transaction is fetched again. Fetching the transaction 180 days or more after the link was issued returns a new one, so fetch the transaction again for the current link rather than storing it. */
22384
22468
  receiptPdfUrl?: string;
22385
22469
  /**
22386
22470
  * @deprecated
@@ -22965,9 +23049,9 @@ interface components {
22965
23049
  };
22966
23050
  /**
22967
23051
  * Format: uuid
22968
- * @description ID of the benefit category this benefit belongs to.
23052
+ * @description ID of the benefit category this benefit belongs to. Omit or send null to leave the benefit without a category.
22969
23053
  */
22970
- categoryRef: string;
23054
+ categoryRef?: string | null;
22971
23055
  /**
22972
23056
  * @description Full description of the benefit.
22973
23057
  * @default
@@ -23055,9 +23139,9 @@ interface components {
23055
23139
  };
23056
23140
  /**
23057
23141
  * Format: uuid
23058
- * @description ID of the benefit category this benefit belongs to.
23142
+ * @description ID of the benefit category this benefit belongs to. Omit or send null to leave the benefit without a category.
23059
23143
  */
23060
- categoryRef: string;
23144
+ categoryRef?: string | null;
23061
23145
  /**
23062
23146
  * @description Full description of the benefit.
23063
23147
  * @default
@@ -23119,9 +23203,9 @@ interface components {
23119
23203
  };
23120
23204
  /**
23121
23205
  * Format: uuid
23122
- * @description ID of the benefit category this benefit belongs to.
23206
+ * @description ID of the benefit category this benefit belongs to. Send null to remove the benefit from its category.
23123
23207
  */
23124
- categoryRef?: string;
23208
+ categoryRef?: string | null;
23125
23209
  /** @description Full description of the benefit. */
23126
23210
  description?: string;
23127
23211
  /** @description Whether the benefit is highlighted in listings. */
@@ -25121,6 +25205,18 @@ interface components {
25121
25205
  enabled: boolean;
25122
25206
  /** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
25123
25207
  minNotice?: number;
25208
+ /** @description Booking window for nonmembers. A booking of a nonmember follows it instead of the booking window above while it is enabled, even when that one is off. */
25209
+ public?: {
25210
+ /**
25211
+ * @description How far ahead nonmembers can book the resource. Required while enabled is true.
25212
+ * @enum {string}
25213
+ */
25214
+ bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
25215
+ /** @description Whether bookings of nonmembers follow a separate booking window. While it is false, they follow the booking window above. */
25216
+ enabled: boolean;
25217
+ /** @description How many minutes before it starts a booking of a nonmember has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
25218
+ minNotice?: number;
25219
+ };
25124
25220
  };
25125
25221
  /** @description Brivo access group reference. */
25126
25222
  brivoGroupRef?: number | null;
@@ -25628,6 +25724,18 @@ interface components {
25628
25724
  enabled: boolean;
25629
25725
  /** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
25630
25726
  minNotice?: number;
25727
+ /** @description Booking window for nonmembers. A booking of a nonmember follows it instead of the booking window above while it is enabled, even when that one is off. */
25728
+ public?: {
25729
+ /**
25730
+ * @description How far ahead nonmembers can book the resource. Required while enabled is true.
25731
+ * @enum {string}
25732
+ */
25733
+ bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
25734
+ /** @description Whether bookings of nonmembers follow a separate booking window. While it is false, they follow the booking window above. */
25735
+ enabled: boolean;
25736
+ /** @description How many minutes before it starts a booking of a nonmember has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
25737
+ minNotice?: number;
25738
+ };
25631
25739
  };
25632
25740
  /** @description Brivo access group reference. */
25633
25741
  brivoGroupRef?: number | null;
@@ -26230,9 +26338,9 @@ interface components {
26230
26338
  product: {
26231
26339
  /**
26232
26340
  * Format: uuid
26233
- * @description ID of the category this product belongs to.
26341
+ * @description ID of the category this product belongs to. Omit or send null to leave the product without a category.
26234
26342
  */
26235
- categoryRef: string;
26343
+ categoryRef?: string | null;
26236
26344
  /**
26237
26345
  * @description Product description.
26238
26346
  * @default
@@ -26371,9 +26479,9 @@ interface components {
26371
26479
  product: {
26372
26480
  /**
26373
26481
  * Format: uuid
26374
- * @description ID of the category this product belongs to.
26482
+ * @description ID of the category this product belongs to. Omit or send null to leave the product without a category.
26375
26483
  */
26376
- categoryRef: string;
26484
+ categoryRef?: string | null;
26377
26485
  /**
26378
26486
  * @description Product description.
26379
26487
  * @default
@@ -26510,9 +26618,9 @@ interface components {
26510
26618
  product: {
26511
26619
  /**
26512
26620
  * Format: uuid
26513
- * @description ID of the category this product belongs to.
26621
+ * @description ID of the category this product belongs to. Send null to remove the product from its category.
26514
26622
  */
26515
- categoryRef?: string;
26623
+ categoryRef?: string | null;
26516
26624
  /** @description Product description. */
26517
26625
  description?: string;
26518
26626
  /** @description Whether the product is featured. */
@@ -28385,7 +28493,7 @@ interface operations {
28385
28493
  query?: {
28386
28494
  /** @description UUID of the benefit. */
28387
28495
  benefitRef?: string;
28388
- /** @description Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
28496
+ /** @description Filter by the category of the benefit applied for: the IDs of benefit categories, or none for benefits without a category. Comma-separated, one or more UUIDs or "none". */
28389
28497
  categoryRef?: string;
28390
28498
  /** @description Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
28391
28499
  "createDate[gte]"?: string;
@@ -34583,7 +34691,7 @@ interface operations {
34583
34691
  getOrders: {
34584
34692
  parameters: {
34585
34693
  query?: {
34586
- /** @description Filter by the shop categories of the products in the order. Comma-separated, one or more UUIDs. */
34694
+ /** @description Filter by the shop categories of the products in the order. Use none for products without a category. Comma-separated, one or more UUIDs or "none". */
34587
34695
  categoryRef?: string;
34588
34696
  /** @description Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
34589
34697
  "createDate[gte]"?: string;
@@ -36773,7 +36881,7 @@ type ProductMedia = NonNullable<operations["createProductMedia"]["responses"][20
36773
36881
  type ShopCategory = NonNullable<components["schemas"]["shopCategory"]>;
36774
36882
  /** Query parameters for `sb.shop.orders.list()`. */
36775
36883
  interface GetOrdersQuery {
36776
- /** Filter by the shop categories of the products in the order. Comma-separated, one or more UUIDs. */
36884
+ /** Filter by the shop categories of the products in the order. Use none for products without a category. Comma-separated, one or more UUIDs or "none". */
36777
36885
  categoryRef?: string;
36778
36886
  /** Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
36779
36887
  "createDate[gte]"?: string;
@@ -37427,7 +37535,7 @@ type BenefitMedia = NonNullable<operations["createBenefitMedia"]["responses"][20
37427
37535
  interface GetBenefitApplicationsQuery {
37428
37536
  /** UUID of the benefit. */
37429
37537
  benefitRef?: string;
37430
- /** Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
37538
+ /** Filter by the category of the benefit applied for: the IDs of benefit categories, or none for benefits without a category. Comma-separated, one or more UUIDs or "none". */
37431
37539
  categoryRef?: string;
37432
37540
  /** Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
37433
37541
  "createDate[gte]"?: string;