@izak0s/spacebring-api 16.6.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 +86 -28
  3. package/dist/index.d.ts +86 -28
  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.
@@ -9982,6 +9982,64 @@ interface components {
9982
9982
  /** @description Whether the admin can access support tools. */
9983
9983
  support: boolean;
9984
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
+ };
9985
10043
  /**
9986
10044
  * @description Role of the user in the network.
9987
10045
  * @enum {string}
@@ -14184,9 +14242,9 @@ interface components {
14184
14242
  products: {
14185
14243
  /**
14186
14244
  * Format: uuid
14187
- * @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.
14188
14246
  */
14189
- categoryRef: string;
14247
+ categoryRef: string | null;
14190
14248
  /**
14191
14249
  * Format: date-time
14192
14250
  * @description ISO timestamp of when the product was created.
@@ -14316,9 +14374,9 @@ interface components {
14316
14374
  product: {
14317
14375
  /**
14318
14376
  * Format: uuid
14319
- * @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.
14320
14378
  */
14321
- categoryRef: string;
14379
+ categoryRef: string | null;
14322
14380
  /**
14323
14381
  * Format: date-time
14324
14382
  * @description ISO timestamp of when the product was created.
@@ -14447,9 +14505,9 @@ interface components {
14447
14505
  product: {
14448
14506
  /**
14449
14507
  * Format: uuid
14450
- * @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.
14451
14509
  */
14452
- categoryRef: string;
14510
+ categoryRef: string | null;
14453
14511
  /**
14454
14512
  * Format: date-time
14455
14513
  * @description ISO timestamp of when the product was created.
@@ -22991,9 +23049,9 @@ interface components {
22991
23049
  };
22992
23050
  /**
22993
23051
  * Format: uuid
22994
- * @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.
22995
23053
  */
22996
- categoryRef: string;
23054
+ categoryRef?: string | null;
22997
23055
  /**
22998
23056
  * @description Full description of the benefit.
22999
23057
  * @default
@@ -23081,9 +23139,9 @@ interface components {
23081
23139
  };
23082
23140
  /**
23083
23141
  * Format: uuid
23084
- * @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.
23085
23143
  */
23086
- categoryRef: string;
23144
+ categoryRef?: string | null;
23087
23145
  /**
23088
23146
  * @description Full description of the benefit.
23089
23147
  * @default
@@ -23145,9 +23203,9 @@ interface components {
23145
23203
  };
23146
23204
  /**
23147
23205
  * Format: uuid
23148
- * @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.
23149
23207
  */
23150
- categoryRef?: string;
23208
+ categoryRef?: string | null;
23151
23209
  /** @description Full description of the benefit. */
23152
23210
  description?: string;
23153
23211
  /** @description Whether the benefit is highlighted in listings. */
@@ -26280,9 +26338,9 @@ interface components {
26280
26338
  product: {
26281
26339
  /**
26282
26340
  * Format: uuid
26283
- * @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.
26284
26342
  */
26285
- categoryRef: string;
26343
+ categoryRef?: string | null;
26286
26344
  /**
26287
26345
  * @description Product description.
26288
26346
  * @default
@@ -26421,9 +26479,9 @@ interface components {
26421
26479
  product: {
26422
26480
  /**
26423
26481
  * Format: uuid
26424
- * @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.
26425
26483
  */
26426
- categoryRef: string;
26484
+ categoryRef?: string | null;
26427
26485
  /**
26428
26486
  * @description Product description.
26429
26487
  * @default
@@ -26560,9 +26618,9 @@ interface components {
26560
26618
  product: {
26561
26619
  /**
26562
26620
  * Format: uuid
26563
- * @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.
26564
26622
  */
26565
- categoryRef?: string;
26623
+ categoryRef?: string | null;
26566
26624
  /** @description Product description. */
26567
26625
  description?: string;
26568
26626
  /** @description Whether the product is featured. */
@@ -28435,7 +28493,7 @@ interface operations {
28435
28493
  query?: {
28436
28494
  /** @description UUID of the benefit. */
28437
28495
  benefitRef?: string;
28438
- /** @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". */
28439
28497
  categoryRef?: string;
28440
28498
  /** @description Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
28441
28499
  "createDate[gte]"?: string;
@@ -34633,7 +34691,7 @@ interface operations {
34633
34691
  getOrders: {
34634
34692
  parameters: {
34635
34693
  query?: {
34636
- /** @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". */
34637
34695
  categoryRef?: string;
34638
34696
  /** @description Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
34639
34697
  "createDate[gte]"?: string;
@@ -36823,7 +36881,7 @@ type ProductMedia = NonNullable<operations["createProductMedia"]["responses"][20
36823
36881
  type ShopCategory = NonNullable<components["schemas"]["shopCategory"]>;
36824
36882
  /** Query parameters for `sb.shop.orders.list()`. */
36825
36883
  interface GetOrdersQuery {
36826
- /** 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". */
36827
36885
  categoryRef?: string;
36828
36886
  /** Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
36829
36887
  "createDate[gte]"?: string;
@@ -37477,7 +37535,7 @@ type BenefitMedia = NonNullable<operations["createBenefitMedia"]["responses"][20
37477
37535
  interface GetBenefitApplicationsQuery {
37478
37536
  /** UUID of the benefit. */
37479
37537
  benefitRef?: string;
37480
- /** 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". */
37481
37539
  categoryRef?: string;
37482
37540
  /** Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
37483
37541
  "createDate[gte]"?: string;
package/dist/index.d.ts 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.
@@ -9982,6 +9982,64 @@ interface components {
9982
9982
  /** @description Whether the admin can access support tools. */
9983
9983
  support: boolean;
9984
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
+ };
9985
10043
  /**
9986
10044
  * @description Role of the user in the network.
9987
10045
  * @enum {string}
@@ -14184,9 +14242,9 @@ interface components {
14184
14242
  products: {
14185
14243
  /**
14186
14244
  * Format: uuid
14187
- * @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.
14188
14246
  */
14189
- categoryRef: string;
14247
+ categoryRef: string | null;
14190
14248
  /**
14191
14249
  * Format: date-time
14192
14250
  * @description ISO timestamp of when the product was created.
@@ -14316,9 +14374,9 @@ interface components {
14316
14374
  product: {
14317
14375
  /**
14318
14376
  * Format: uuid
14319
- * @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.
14320
14378
  */
14321
- categoryRef: string;
14379
+ categoryRef: string | null;
14322
14380
  /**
14323
14381
  * Format: date-time
14324
14382
  * @description ISO timestamp of when the product was created.
@@ -14447,9 +14505,9 @@ interface components {
14447
14505
  product: {
14448
14506
  /**
14449
14507
  * Format: uuid
14450
- * @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.
14451
14509
  */
14452
- categoryRef: string;
14510
+ categoryRef: string | null;
14453
14511
  /**
14454
14512
  * Format: date-time
14455
14513
  * @description ISO timestamp of when the product was created.
@@ -22991,9 +23049,9 @@ interface components {
22991
23049
  };
22992
23050
  /**
22993
23051
  * Format: uuid
22994
- * @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.
22995
23053
  */
22996
- categoryRef: string;
23054
+ categoryRef?: string | null;
22997
23055
  /**
22998
23056
  * @description Full description of the benefit.
22999
23057
  * @default
@@ -23081,9 +23139,9 @@ interface components {
23081
23139
  };
23082
23140
  /**
23083
23141
  * Format: uuid
23084
- * @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.
23085
23143
  */
23086
- categoryRef: string;
23144
+ categoryRef?: string | null;
23087
23145
  /**
23088
23146
  * @description Full description of the benefit.
23089
23147
  * @default
@@ -23145,9 +23203,9 @@ interface components {
23145
23203
  };
23146
23204
  /**
23147
23205
  * Format: uuid
23148
- * @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.
23149
23207
  */
23150
- categoryRef?: string;
23208
+ categoryRef?: string | null;
23151
23209
  /** @description Full description of the benefit. */
23152
23210
  description?: string;
23153
23211
  /** @description Whether the benefit is highlighted in listings. */
@@ -26280,9 +26338,9 @@ interface components {
26280
26338
  product: {
26281
26339
  /**
26282
26340
  * Format: uuid
26283
- * @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.
26284
26342
  */
26285
- categoryRef: string;
26343
+ categoryRef?: string | null;
26286
26344
  /**
26287
26345
  * @description Product description.
26288
26346
  * @default
@@ -26421,9 +26479,9 @@ interface components {
26421
26479
  product: {
26422
26480
  /**
26423
26481
  * Format: uuid
26424
- * @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.
26425
26483
  */
26426
- categoryRef: string;
26484
+ categoryRef?: string | null;
26427
26485
  /**
26428
26486
  * @description Product description.
26429
26487
  * @default
@@ -26560,9 +26618,9 @@ interface components {
26560
26618
  product: {
26561
26619
  /**
26562
26620
  * Format: uuid
26563
- * @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.
26564
26622
  */
26565
- categoryRef?: string;
26623
+ categoryRef?: string | null;
26566
26624
  /** @description Product description. */
26567
26625
  description?: string;
26568
26626
  /** @description Whether the product is featured. */
@@ -28435,7 +28493,7 @@ interface operations {
28435
28493
  query?: {
28436
28494
  /** @description UUID of the benefit. */
28437
28495
  benefitRef?: string;
28438
- /** @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". */
28439
28497
  categoryRef?: string;
28440
28498
  /** @description Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
28441
28499
  "createDate[gte]"?: string;
@@ -34633,7 +34691,7 @@ interface operations {
34633
34691
  getOrders: {
34634
34692
  parameters: {
34635
34693
  query?: {
34636
- /** @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". */
34637
34695
  categoryRef?: string;
34638
34696
  /** @description Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
34639
34697
  "createDate[gte]"?: string;
@@ -36823,7 +36881,7 @@ type ProductMedia = NonNullable<operations["createProductMedia"]["responses"][20
36823
36881
  type ShopCategory = NonNullable<components["schemas"]["shopCategory"]>;
36824
36882
  /** Query parameters for `sb.shop.orders.list()`. */
36825
36883
  interface GetOrdersQuery {
36826
- /** 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". */
36827
36885
  categoryRef?: string;
36828
36886
  /** Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
36829
36887
  "createDate[gte]"?: string;
@@ -37477,7 +37535,7 @@ type BenefitMedia = NonNullable<operations["createBenefitMedia"]["responses"][20
37477
37535
  interface GetBenefitApplicationsQuery {
37478
37536
  /** UUID of the benefit. */
37479
37537
  benefitRef?: string;
37480
- /** 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". */
37481
37539
  categoryRef?: string;
37482
37540
  /** Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
37483
37541
  "createDate[gte]"?: string;