@izak0s/spacebring-api 11.4.0 → 12.0.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/index.d.cts CHANGED
@@ -3343,6 +3343,7 @@ interface components {
3343
3343
  * @enum {string}
3344
3344
  */
3345
3345
  buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
3346
+ /** @description Confirmation email settings for applications. */
3346
3347
  confirmationEmail: {
3347
3348
  /** @description Whether a confirmation email is sent after applying. */
3348
3349
  enabled: boolean;
@@ -3371,7 +3372,7 @@ interface components {
3371
3372
  * @description Unique identifier of the benefit.
3372
3373
  */
3373
3374
  id: string;
3374
- /** @description Auto-detected language of the description. */
3375
+ /** @description Auto-detected language of the description. Empty when there is no description. */
3375
3376
  locale: string;
3376
3377
  /**
3377
3378
  * Format: uuid
@@ -3423,6 +3424,7 @@ interface components {
3423
3424
  * @enum {string}
3424
3425
  */
3425
3426
  buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
3427
+ /** @description Confirmation email settings for applications. */
3426
3428
  confirmationEmail: {
3427
3429
  /** @description Whether a confirmation email is sent after applying. */
3428
3430
  enabled: boolean;
@@ -3451,7 +3453,7 @@ interface components {
3451
3453
  * @description Unique identifier of the benefit.
3452
3454
  */
3453
3455
  id: string;
3454
- /** @description Auto-detected language of the description. */
3456
+ /** @description Auto-detected language of the description. Empty when there is no description. */
3455
3457
  locale: string;
3456
3458
  /**
3457
3459
  * Format: uuid
@@ -3500,6 +3502,7 @@ interface components {
3500
3502
  * @enum {string}
3501
3503
  */
3502
3504
  buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
3505
+ /** @description Confirmation email settings for applications. */
3503
3506
  confirmationEmail: {
3504
3507
  /** @description Whether a confirmation email is sent after applying. */
3505
3508
  enabled: boolean;
@@ -3528,7 +3531,7 @@ interface components {
3528
3531
  * @description Unique identifier of the benefit.
3529
3532
  */
3530
3533
  id: string;
3531
- /** @description Auto-detected language of the description. */
3534
+ /** @description Auto-detected language of the description. Empty when there is no description. */
3532
3535
  locale: string;
3533
3536
  /**
3534
3537
  * Format: uuid
@@ -8326,7 +8329,7 @@ interface components {
8326
8329
  };
8327
8330
  post: {
8328
8331
  /** @description Number of comments on the post. */
8329
- comments: number;
8332
+ comments?: number | null;
8330
8333
  /**
8331
8334
  * Format: date-time
8332
8335
  * @description ISO timestamp of when the post was created.
@@ -8345,7 +8348,7 @@ interface components {
8345
8348
  /** @description Whether the current user has liked the post. */
8346
8349
  liked?: boolean;
8347
8350
  /** @description Number of likes on the post. */
8348
- likes: number;
8351
+ likes?: number | null;
8349
8352
  /** @description Detected language locale of the post text. */
8350
8353
  locale?: string;
8351
8354
  /**
@@ -8356,20 +8359,20 @@ interface components {
8356
8359
  /** @description Media files attached to the post. */
8357
8360
  media: {
8358
8361
  /** @description Image height in pixels. */
8359
- height: number;
8362
+ height?: number | null;
8360
8363
  /**
8361
8364
  * Format: uuid
8362
8365
  * @description Unique identifier of the media item.
8363
8366
  */
8364
- id: string;
8367
+ id?: string | null;
8365
8368
  /** @description Storage key of the media file. */
8366
8369
  key: string;
8367
8370
  /** @description MIME type of the media file. */
8368
- mime: string;
8371
+ mime?: string | null;
8369
8372
  /** @description Public URL of the media file. */
8370
- url: string;
8373
+ url?: string | null;
8371
8374
  /** @description Image width in pixels. */
8372
- width: number;
8375
+ width?: number | null;
8373
8376
  }[];
8374
8377
  /** @description Membership of the post author. */
8375
8378
  membership: {
@@ -8377,7 +8380,7 @@ interface components {
8377
8380
  * Format: uuid
8378
8381
  * @description Unique identifier of the membership.
8379
8382
  */
8380
- id: string;
8383
+ id?: string | null;
8381
8384
  /** @description User associated with the membership. */
8382
8385
  user?: {
8383
8386
  /** @description User bio. */
@@ -8408,7 +8411,7 @@ interface components {
8408
8411
  * Format: uuid
8409
8412
  * @description ID of the membership that created the post.
8410
8413
  */
8411
- membershipRef: string;
8414
+ membershipRef?: string | null;
8412
8415
  /** @description Open Graph metadata for link previews. */
8413
8416
  og?: {
8414
8417
  /** @description Open Graph description. */
@@ -8420,12 +8423,12 @@ interface components {
8420
8423
  /** @description Open Graph type. */
8421
8424
  type?: string | null;
8422
8425
  /** @description Open Graph URL. */
8423
- url: string;
8426
+ url?: string | null;
8424
8427
  /** @description Open Graph video URL. */
8425
8428
  videoUrl?: string | null;
8426
8429
  };
8427
8430
  /** @description Whether the post is pinned. */
8428
- pinned: boolean;
8431
+ pinned?: boolean | null;
8429
8432
  /** @description Post text content. */
8430
8433
  text?: string;
8431
8434
  /** @description User who created the post. */
@@ -8468,14 +8471,14 @@ interface components {
8468
8471
  /** @description Whether the current user has liked the comment. */
8469
8472
  liked?: boolean;
8470
8473
  /** @description Number of likes on the comment. */
8471
- likes: number;
8474
+ likes?: number | null;
8472
8475
  /** @description Membership of the comment author. */
8473
8476
  membership: {
8474
8477
  /**
8475
8478
  * Format: uuid
8476
8479
  * @description Unique identifier of the membership.
8477
8480
  */
8478
- id: string;
8481
+ id?: string | null;
8479
8482
  /** @description User associated with the membership. */
8480
8483
  user?: {
8481
8484
  /**
@@ -8503,8 +8506,8 @@ interface components {
8503
8506
  * @description Unique identifier of the mention.
8504
8507
  */
8505
8508
  id: string;
8506
- /** @description Mention value. */
8507
- value: string;
8509
+ /** @description Full name of the mentioned user. Absent when the users service no longer knows the user. */
8510
+ value?: string;
8508
8511
  }[];
8509
8512
  /**
8510
8513
  * Format: uuid
@@ -8534,14 +8537,14 @@ interface components {
8534
8537
  * Format: uuid
8535
8538
  * @description Unique identifier of the like.
8536
8539
  */
8537
- id: string;
8540
+ id?: string | null;
8538
8541
  /** @description Membership of the user who liked. */
8539
8542
  membership: {
8540
8543
  /**
8541
8544
  * Format: uuid
8542
8545
  * @description Unique identifier of the membership.
8543
8546
  */
8544
- id: string;
8547
+ id?: string | null;
8545
8548
  /** @description User associated with the membership. */
8546
8549
  user?: {
8547
8550
  /**
@@ -9015,9 +9018,9 @@ interface components {
9015
9018
  duration?: number;
9016
9019
  /**
9017
9020
  * Format: uuid
9018
- * @description Unique identifier of the grant.
9021
+ * @description Unique identifier of the grant. Absent on grants of packages created before grants had IDs.
9019
9022
  */
9020
- id: string;
9023
+ id?: string;
9021
9024
  /**
9022
9025
  * @description Type of balance this grant provides.
9023
9026
  * @enum {string}
@@ -9077,9 +9080,9 @@ interface components {
9077
9080
  duration?: number;
9078
9081
  /**
9079
9082
  * Format: uuid
9080
- * @description Unique identifier of the grant.
9083
+ * @description Unique identifier of the grant. Absent on grants of packages created before grants had IDs.
9081
9084
  */
9082
- id: string;
9085
+ id?: string;
9083
9086
  /**
9084
9087
  * @description Type of balance this grant provides.
9085
9088
  * @enum {string}
@@ -9672,7 +9675,7 @@ interface components {
9672
9675
  * @description ISO timestamp of when the user was last seen in the network.
9673
9676
  */
9674
9677
  lastSeenDate?: string;
9675
- /** @description Location-scoped admin permissions. Included only for owners or when viewing the current user's registration. */
9678
+ /** @description Location-scoped admin permissions. Included only for owners and super admins or when viewing the current user's registration. */
9676
9679
  locationPermissions?: {
9677
9680
  /** @description Whether the admin can manage other admins. */
9678
9681
  admins: boolean;
@@ -9707,7 +9710,7 @@ interface components {
9707
9710
  * @description Role of the user in the network.
9708
9711
  * @enum {string}
9709
9712
  */
9710
- role?: "owner" | "admin" | "member";
9713
+ role?: "owner" | "superAdmin" | "admin" | "member";
9711
9714
  /** @description ISO timestamp or date when terms consent was given. */
9712
9715
  termsConsentDate?: string;
9713
9716
  /**
@@ -27529,7 +27532,7 @@ interface operations {
27529
27532
  query?: {
27530
27533
  /** @description UUID of the benefit. */
27531
27534
  benefitRef?: string;
27532
- /** @description Comma-separated benefit category UUIDs, e.g. `uuid1,uuid2`. */
27535
+ /** @description Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
27533
27536
  categoryRef?: string;
27534
27537
  /** @description Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
27535
27538
  "createDate[gte]"?: string;
@@ -29333,16 +29336,7 @@ interface operations {
29333
29336
  nextPageToken?: string;
29334
29337
  /** @description Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search. */
29335
29338
  q?: string;
29336
- /**
29337
- * @description Filter by contract status. Comma-separated values, e.g. `draft,issued`.
29338
- *
29339
- * Supported values:
29340
- * - **draft** — created but not sent
29341
- * - **issued** — sent, awaiting signature
29342
- * - **signed** — active
29343
- * - **declined** — rejected
29344
- * - **terminated** — cancelled after signing
29345
- */
29339
+ /** @description Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
29346
29340
  status?: string;
29347
29341
  };
29348
29342
  header?: {
@@ -33429,20 +33423,11 @@ interface operations {
33429
33423
  locationRef?: string;
33430
33424
  /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
33431
33425
  nextPageToken?: string;
33432
- /** @description Sort order for results. */
33426
+ /** @description Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions; defaults to createDate:desc. */
33433
33427
  order?: string;
33434
- /** @description UUID of the plan to filter subscriptions by. */
33428
+ /** @description UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
33435
33429
  planRef?: string;
33436
- /**
33437
- * @description Filter by subscription status. Comma-separated values, e.g. `active,scheduled`. Defaults to `active`, `scheduled`, and `incomplete` when omitted.
33438
- *
33439
- * Supported values:
33440
- * - **active** — currently active
33441
- * - **scheduled** — scheduled to start
33442
- * - **incomplete** — pending setup or payment
33443
- * - **incompleteExpired** — incomplete and expired
33444
- * - **canceled** — canceled
33445
- */
33430
+ /** @description Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
33446
33431
  status?: string;
33447
33432
  };
33448
33433
  header?: {
@@ -35502,18 +35487,11 @@ interface GetSubscriptionsQuery {
35502
35487
  locationRef?: string;
35503
35488
  /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
35504
35489
  nextPageToken?: string;
35505
- /** Sort order for results. */
35490
+ /** Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions; defaults to createDate:desc. */
35506
35491
  order?: string;
35507
- /** UUID of the plan to filter subscriptions by. */
35492
+ /** UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
35508
35493
  planRef?: string;
35509
- /** Filter by subscription status. Comma-separated values, e.g. `active,scheduled`. Defaults to `active`, `scheduled`, and `incomplete` when omitted.
35510
-
35511
- Supported values:
35512
- - **active** — currently active
35513
- - **scheduled** — scheduled to start
35514
- - **incomplete** — pending setup or payment
35515
- - **incompleteExpired** — incomplete and expired
35516
- - **canceled** — canceled */
35494
+ /** Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
35517
35495
  status?: string;
35518
35496
  }
35519
35497
  /** Request body for `sb.subscriptions.create()`. */
@@ -35924,14 +35902,7 @@ interface GetContractsQuery {
35924
35902
  nextPageToken?: string;
35925
35903
  /** Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search. */
35926
35904
  q?: string;
35927
- /** Filter by contract status. Comma-separated values, e.g. `draft,issued`.
35928
-
35929
- Supported values:
35930
- - **draft** — created but not sent
35931
- - **issued** — sent, awaiting signature
35932
- - **signed** — active
35933
- - **declined** — rejected
35934
- - **terminated** — cancelled after signing */
35905
+ /** Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
35935
35906
  status?: string;
35936
35907
  }
35937
35908
  /** Query parameters for `sb.contracts.templates.list()`. */
@@ -36186,7 +36157,7 @@ type BenefitMedia = NonNullable<operations["createBenefitMedia"]["responses"][20
36186
36157
  interface GetBenefitApplicationsQuery {
36187
36158
  /** UUID of the benefit. */
36188
36159
  benefitRef?: string;
36189
- /** Comma-separated benefit category UUIDs, e.g. `uuid1,uuid2`. */
36160
+ /** Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
36190
36161
  categoryRef?: string;
36191
36162
  /** Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
36192
36163
  "createDate[gte]"?: string;
package/dist/index.d.ts CHANGED
@@ -3343,6 +3343,7 @@ interface components {
3343
3343
  * @enum {string}
3344
3344
  */
3345
3345
  buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
3346
+ /** @description Confirmation email settings for applications. */
3346
3347
  confirmationEmail: {
3347
3348
  /** @description Whether a confirmation email is sent after applying. */
3348
3349
  enabled: boolean;
@@ -3371,7 +3372,7 @@ interface components {
3371
3372
  * @description Unique identifier of the benefit.
3372
3373
  */
3373
3374
  id: string;
3374
- /** @description Auto-detected language of the description. */
3375
+ /** @description Auto-detected language of the description. Empty when there is no description. */
3375
3376
  locale: string;
3376
3377
  /**
3377
3378
  * Format: uuid
@@ -3423,6 +3424,7 @@ interface components {
3423
3424
  * @enum {string}
3424
3425
  */
3425
3426
  buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
3427
+ /** @description Confirmation email settings for applications. */
3426
3428
  confirmationEmail: {
3427
3429
  /** @description Whether a confirmation email is sent after applying. */
3428
3430
  enabled: boolean;
@@ -3451,7 +3453,7 @@ interface components {
3451
3453
  * @description Unique identifier of the benefit.
3452
3454
  */
3453
3455
  id: string;
3454
- /** @description Auto-detected language of the description. */
3456
+ /** @description Auto-detected language of the description. Empty when there is no description. */
3455
3457
  locale: string;
3456
3458
  /**
3457
3459
  * Format: uuid
@@ -3500,6 +3502,7 @@ interface components {
3500
3502
  * @enum {string}
3501
3503
  */
3502
3504
  buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
3505
+ /** @description Confirmation email settings for applications. */
3503
3506
  confirmationEmail: {
3504
3507
  /** @description Whether a confirmation email is sent after applying. */
3505
3508
  enabled: boolean;
@@ -3528,7 +3531,7 @@ interface components {
3528
3531
  * @description Unique identifier of the benefit.
3529
3532
  */
3530
3533
  id: string;
3531
- /** @description Auto-detected language of the description. */
3534
+ /** @description Auto-detected language of the description. Empty when there is no description. */
3532
3535
  locale: string;
3533
3536
  /**
3534
3537
  * Format: uuid
@@ -8326,7 +8329,7 @@ interface components {
8326
8329
  };
8327
8330
  post: {
8328
8331
  /** @description Number of comments on the post. */
8329
- comments: number;
8332
+ comments?: number | null;
8330
8333
  /**
8331
8334
  * Format: date-time
8332
8335
  * @description ISO timestamp of when the post was created.
@@ -8345,7 +8348,7 @@ interface components {
8345
8348
  /** @description Whether the current user has liked the post. */
8346
8349
  liked?: boolean;
8347
8350
  /** @description Number of likes on the post. */
8348
- likes: number;
8351
+ likes?: number | null;
8349
8352
  /** @description Detected language locale of the post text. */
8350
8353
  locale?: string;
8351
8354
  /**
@@ -8356,20 +8359,20 @@ interface components {
8356
8359
  /** @description Media files attached to the post. */
8357
8360
  media: {
8358
8361
  /** @description Image height in pixels. */
8359
- height: number;
8362
+ height?: number | null;
8360
8363
  /**
8361
8364
  * Format: uuid
8362
8365
  * @description Unique identifier of the media item.
8363
8366
  */
8364
- id: string;
8367
+ id?: string | null;
8365
8368
  /** @description Storage key of the media file. */
8366
8369
  key: string;
8367
8370
  /** @description MIME type of the media file. */
8368
- mime: string;
8371
+ mime?: string | null;
8369
8372
  /** @description Public URL of the media file. */
8370
- url: string;
8373
+ url?: string | null;
8371
8374
  /** @description Image width in pixels. */
8372
- width: number;
8375
+ width?: number | null;
8373
8376
  }[];
8374
8377
  /** @description Membership of the post author. */
8375
8378
  membership: {
@@ -8377,7 +8380,7 @@ interface components {
8377
8380
  * Format: uuid
8378
8381
  * @description Unique identifier of the membership.
8379
8382
  */
8380
- id: string;
8383
+ id?: string | null;
8381
8384
  /** @description User associated with the membership. */
8382
8385
  user?: {
8383
8386
  /** @description User bio. */
@@ -8408,7 +8411,7 @@ interface components {
8408
8411
  * Format: uuid
8409
8412
  * @description ID of the membership that created the post.
8410
8413
  */
8411
- membershipRef: string;
8414
+ membershipRef?: string | null;
8412
8415
  /** @description Open Graph metadata for link previews. */
8413
8416
  og?: {
8414
8417
  /** @description Open Graph description. */
@@ -8420,12 +8423,12 @@ interface components {
8420
8423
  /** @description Open Graph type. */
8421
8424
  type?: string | null;
8422
8425
  /** @description Open Graph URL. */
8423
- url: string;
8426
+ url?: string | null;
8424
8427
  /** @description Open Graph video URL. */
8425
8428
  videoUrl?: string | null;
8426
8429
  };
8427
8430
  /** @description Whether the post is pinned. */
8428
- pinned: boolean;
8431
+ pinned?: boolean | null;
8429
8432
  /** @description Post text content. */
8430
8433
  text?: string;
8431
8434
  /** @description User who created the post. */
@@ -8468,14 +8471,14 @@ interface components {
8468
8471
  /** @description Whether the current user has liked the comment. */
8469
8472
  liked?: boolean;
8470
8473
  /** @description Number of likes on the comment. */
8471
- likes: number;
8474
+ likes?: number | null;
8472
8475
  /** @description Membership of the comment author. */
8473
8476
  membership: {
8474
8477
  /**
8475
8478
  * Format: uuid
8476
8479
  * @description Unique identifier of the membership.
8477
8480
  */
8478
- id: string;
8481
+ id?: string | null;
8479
8482
  /** @description User associated with the membership. */
8480
8483
  user?: {
8481
8484
  /**
@@ -8503,8 +8506,8 @@ interface components {
8503
8506
  * @description Unique identifier of the mention.
8504
8507
  */
8505
8508
  id: string;
8506
- /** @description Mention value. */
8507
- value: string;
8509
+ /** @description Full name of the mentioned user. Absent when the users service no longer knows the user. */
8510
+ value?: string;
8508
8511
  }[];
8509
8512
  /**
8510
8513
  * Format: uuid
@@ -8534,14 +8537,14 @@ interface components {
8534
8537
  * Format: uuid
8535
8538
  * @description Unique identifier of the like.
8536
8539
  */
8537
- id: string;
8540
+ id?: string | null;
8538
8541
  /** @description Membership of the user who liked. */
8539
8542
  membership: {
8540
8543
  /**
8541
8544
  * Format: uuid
8542
8545
  * @description Unique identifier of the membership.
8543
8546
  */
8544
- id: string;
8547
+ id?: string | null;
8545
8548
  /** @description User associated with the membership. */
8546
8549
  user?: {
8547
8550
  /**
@@ -9015,9 +9018,9 @@ interface components {
9015
9018
  duration?: number;
9016
9019
  /**
9017
9020
  * Format: uuid
9018
- * @description Unique identifier of the grant.
9021
+ * @description Unique identifier of the grant. Absent on grants of packages created before grants had IDs.
9019
9022
  */
9020
- id: string;
9023
+ id?: string;
9021
9024
  /**
9022
9025
  * @description Type of balance this grant provides.
9023
9026
  * @enum {string}
@@ -9077,9 +9080,9 @@ interface components {
9077
9080
  duration?: number;
9078
9081
  /**
9079
9082
  * Format: uuid
9080
- * @description Unique identifier of the grant.
9083
+ * @description Unique identifier of the grant. Absent on grants of packages created before grants had IDs.
9081
9084
  */
9082
- id: string;
9085
+ id?: string;
9083
9086
  /**
9084
9087
  * @description Type of balance this grant provides.
9085
9088
  * @enum {string}
@@ -9672,7 +9675,7 @@ interface components {
9672
9675
  * @description ISO timestamp of when the user was last seen in the network.
9673
9676
  */
9674
9677
  lastSeenDate?: string;
9675
- /** @description Location-scoped admin permissions. Included only for owners or when viewing the current user's registration. */
9678
+ /** @description Location-scoped admin permissions. Included only for owners and super admins or when viewing the current user's registration. */
9676
9679
  locationPermissions?: {
9677
9680
  /** @description Whether the admin can manage other admins. */
9678
9681
  admins: boolean;
@@ -9707,7 +9710,7 @@ interface components {
9707
9710
  * @description Role of the user in the network.
9708
9711
  * @enum {string}
9709
9712
  */
9710
- role?: "owner" | "admin" | "member";
9713
+ role?: "owner" | "superAdmin" | "admin" | "member";
9711
9714
  /** @description ISO timestamp or date when terms consent was given. */
9712
9715
  termsConsentDate?: string;
9713
9716
  /**
@@ -27529,7 +27532,7 @@ interface operations {
27529
27532
  query?: {
27530
27533
  /** @description UUID of the benefit. */
27531
27534
  benefitRef?: string;
27532
- /** @description Comma-separated benefit category UUIDs, e.g. `uuid1,uuid2`. */
27535
+ /** @description Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
27533
27536
  categoryRef?: string;
27534
27537
  /** @description Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
27535
27538
  "createDate[gte]"?: string;
@@ -29333,16 +29336,7 @@ interface operations {
29333
29336
  nextPageToken?: string;
29334
29337
  /** @description Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search. */
29335
29338
  q?: string;
29336
- /**
29337
- * @description Filter by contract status. Comma-separated values, e.g. `draft,issued`.
29338
- *
29339
- * Supported values:
29340
- * - **draft** — created but not sent
29341
- * - **issued** — sent, awaiting signature
29342
- * - **signed** — active
29343
- * - **declined** — rejected
29344
- * - **terminated** — cancelled after signing
29345
- */
29339
+ /** @description Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
29346
29340
  status?: string;
29347
29341
  };
29348
29342
  header?: {
@@ -33429,20 +33423,11 @@ interface operations {
33429
33423
  locationRef?: string;
33430
33424
  /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
33431
33425
  nextPageToken?: string;
33432
- /** @description Sort order for results. */
33426
+ /** @description Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions; defaults to createDate:desc. */
33433
33427
  order?: string;
33434
- /** @description UUID of the plan to filter subscriptions by. */
33428
+ /** @description UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
33435
33429
  planRef?: string;
33436
- /**
33437
- * @description Filter by subscription status. Comma-separated values, e.g. `active,scheduled`. Defaults to `active`, `scheduled`, and `incomplete` when omitted.
33438
- *
33439
- * Supported values:
33440
- * - **active** — currently active
33441
- * - **scheduled** — scheduled to start
33442
- * - **incomplete** — pending setup or payment
33443
- * - **incompleteExpired** — incomplete and expired
33444
- * - **canceled** — canceled
33445
- */
33430
+ /** @description Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
33446
33431
  status?: string;
33447
33432
  };
33448
33433
  header?: {
@@ -35502,18 +35487,11 @@ interface GetSubscriptionsQuery {
35502
35487
  locationRef?: string;
35503
35488
  /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
35504
35489
  nextPageToken?: string;
35505
- /** Sort order for results. */
35490
+ /** Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions; defaults to createDate:desc. */
35506
35491
  order?: string;
35507
- /** UUID of the plan to filter subscriptions by. */
35492
+ /** UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
35508
35493
  planRef?: string;
35509
- /** Filter by subscription status. Comma-separated values, e.g. `active,scheduled`. Defaults to `active`, `scheduled`, and `incomplete` when omitted.
35510
-
35511
- Supported values:
35512
- - **active** — currently active
35513
- - **scheduled** — scheduled to start
35514
- - **incomplete** — pending setup or payment
35515
- - **incompleteExpired** — incomplete and expired
35516
- - **canceled** — canceled */
35494
+ /** Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
35517
35495
  status?: string;
35518
35496
  }
35519
35497
  /** Request body for `sb.subscriptions.create()`. */
@@ -35924,14 +35902,7 @@ interface GetContractsQuery {
35924
35902
  nextPageToken?: string;
35925
35903
  /** Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search. */
35926
35904
  q?: string;
35927
- /** Filter by contract status. Comma-separated values, e.g. `draft,issued`.
35928
-
35929
- Supported values:
35930
- - **draft** — created but not sent
35931
- - **issued** — sent, awaiting signature
35932
- - **signed** — active
35933
- - **declined** — rejected
35934
- - **terminated** — cancelled after signing */
35905
+ /** Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
35935
35906
  status?: string;
35936
35907
  }
35937
35908
  /** Query parameters for `sb.contracts.templates.list()`. */
@@ -36186,7 +36157,7 @@ type BenefitMedia = NonNullable<operations["createBenefitMedia"]["responses"][20
36186
36157
  interface GetBenefitApplicationsQuery {
36187
36158
  /** UUID of the benefit. */
36188
36159
  benefitRef?: string;
36189
- /** Comma-separated benefit category UUIDs, e.g. `uuid1,uuid2`. */
36160
+ /** Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
36190
36161
  categoryRef?: string;
36191
36162
  /** Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
36192
36163
  "createDate[gte]"?: string;