@izak0s/spacebring-api 5.4.0 → 5.6.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 +128 -29
  3. package/dist/index.d.ts +128 -29
  4. package/dist/index.js.map +1 -1
  5. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -3050,10 +3050,10 @@ interface components {
3050
3050
  */
3051
3051
  updateDate?: string;
3052
3052
  /**
3053
- * @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
3053
+ * @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
3054
3054
  * @enum {string}
3055
3055
  */
3056
- visibility: "public" | "admins" | "members" | "networkMembers";
3056
+ visibility: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
3057
3057
  }[];
3058
3058
  /** @description Pagination token to fetch the next page of results. */
3059
3059
  nextPageToken?: string;
@@ -3130,10 +3130,10 @@ interface components {
3130
3130
  */
3131
3131
  updateDate?: string;
3132
3132
  /**
3133
- * @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
3133
+ * @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
3134
3134
  * @enum {string}
3135
3135
  */
3136
- visibility: "public" | "admins" | "members" | "networkMembers";
3136
+ visibility: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
3137
3137
  };
3138
3138
  getBenefit: {
3139
3139
  /** @description The benefit. */
@@ -3207,10 +3207,10 @@ interface components {
3207
3207
  */
3208
3208
  updateDate?: string;
3209
3209
  /**
3210
- * @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
3210
+ * @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
3211
3211
  * @enum {string}
3212
3212
  */
3213
- visibility: "public" | "admins" | "members" | "networkMembers";
3213
+ visibility: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
3214
3214
  };
3215
3215
  };
3216
3216
  getBenefitApplications: {
@@ -3613,6 +3613,19 @@ interface components {
3613
3613
  * @description Payment due date.
3614
3614
  */
3615
3615
  dueDate?: string;
3616
+ /** @description Location billing address. */
3617
+ locationAddress?: {
3618
+ city: string;
3619
+ countryCode: string | null;
3620
+ line1: string;
3621
+ line2: string;
3622
+ postalCode: string;
3623
+ state: string;
3624
+ };
3625
+ /** @description Location legal name. */
3626
+ locationName?: string;
3627
+ /** @description Location tax ID. */
3628
+ locationTaxId?: string;
3616
3629
  /** @description Number of days until payment is due. */
3617
3630
  dueDays?: number;
3618
3631
  /**
@@ -3620,6 +3633,8 @@ interface components {
3620
3633
  * @enum {string}
3621
3634
  */
3622
3635
  dueType?: "date" | "days" | "default";
3636
+ /** @description URL of the public invoice page, where the invoice can be viewed, downloaded and paid without signing in (issued invoices only). */
3637
+ hostedInvoiceUrl?: string;
3623
3638
  /**
3624
3639
  * Format: uuid
3625
3640
  * @description Unique identifier of the invoice.
@@ -3997,6 +4012,19 @@ interface components {
3997
4012
  * @description Payment due date.
3998
4013
  */
3999
4014
  dueDate?: string;
4015
+ /** @description Location billing address. */
4016
+ locationAddress?: {
4017
+ city: string;
4018
+ countryCode: string | null;
4019
+ line1: string;
4020
+ line2: string;
4021
+ postalCode: string;
4022
+ state: string;
4023
+ };
4024
+ /** @description Location legal name. */
4025
+ locationName?: string;
4026
+ /** @description Location tax ID. */
4027
+ locationTaxId?: string;
4000
4028
  /** @description Number of days until payment is due. */
4001
4029
  dueDays?: number;
4002
4030
  /**
@@ -4004,6 +4032,8 @@ interface components {
4004
4032
  * @enum {string}
4005
4033
  */
4006
4034
  dueType?: "date" | "days" | "default";
4035
+ /** @description URL of the public invoice page, where the invoice can be viewed, downloaded and paid without signing in (issued invoices only). */
4036
+ hostedInvoiceUrl?: string;
4007
4037
  /**
4008
4038
  * Format: uuid
4009
4039
  * @description Unique identifier of the invoice.
@@ -4378,6 +4408,19 @@ interface components {
4378
4408
  * @description Payment due date.
4379
4409
  */
4380
4410
  dueDate?: string;
4411
+ /** @description Location billing address. */
4412
+ locationAddress?: {
4413
+ city: string;
4414
+ countryCode: string | null;
4415
+ line1: string;
4416
+ line2: string;
4417
+ postalCode: string;
4418
+ state: string;
4419
+ };
4420
+ /** @description Location legal name. */
4421
+ locationName?: string;
4422
+ /** @description Location tax ID. */
4423
+ locationTaxId?: string;
4381
4424
  /** @description Number of days until payment is due. */
4382
4425
  dueDays?: number;
4383
4426
  /**
@@ -4385,6 +4428,8 @@ interface components {
4385
4428
  * @enum {string}
4386
4429
  */
4387
4430
  dueType?: "date" | "days" | "default";
4431
+ /** @description URL of the public invoice page, where the invoice can be viewed, downloaded and paid without signing in (issued invoices only). */
4432
+ hostedInvoiceUrl?: string;
4388
4433
  /**
4389
4434
  * Format: uuid
4390
4435
  * @description Unique identifier of the invoice.
@@ -8015,8 +8060,10 @@ interface components {
8015
8060
  /** @description Discount percentage for shop products. */
8016
8061
  shop: number;
8017
8062
  };
8018
- /** @description Resources exclusively available to members on this plan. */
8063
+ /** @description Resources and benefits exclusively available to members on this plan. */
8019
8064
  exclusiveAccess: {
8065
+ /** @description Benefit IDs with exclusive access for this plan. */
8066
+ benefitRefs: string[];
8020
8067
  /** @description Resource IDs with exclusive access for this plan. */
8021
8068
  resourceRefs: string[];
8022
8069
  };
@@ -8184,8 +8231,10 @@ interface components {
8184
8231
  /** @description Discount percentage for shop products. */
8185
8232
  shop: number;
8186
8233
  };
8187
- /** @description Resources exclusively available to members on this plan. */
8234
+ /** @description Resources and benefits exclusively available to members on this plan. */
8188
8235
  exclusiveAccess: {
8236
+ /** @description Benefit IDs with exclusive access for this plan. */
8237
+ benefitRefs: string[];
8189
8238
  /** @description Resource IDs with exclusive access for this plan. */
8190
8239
  resourceRefs: string[];
8191
8240
  };
@@ -8352,8 +8401,10 @@ interface components {
8352
8401
  /** @description Discount percentage for shop products. */
8353
8402
  shop: number;
8354
8403
  };
8355
- /** @description Resources exclusively available to members on this plan. */
8404
+ /** @description Resources and benefits exclusively available to members on this plan. */
8356
8405
  exclusiveAccess: {
8406
+ /** @description Benefit IDs with exclusive access for this plan. */
8407
+ benefitRefs: string[];
8357
8408
  /** @description Resource IDs with exclusive access for this plan. */
8358
8409
  resourceRefs: string[];
8359
8410
  };
@@ -8961,7 +9012,17 @@ interface components {
8961
9012
  };
8962
9013
  /** @description Price of the tier. */
8963
9014
  price: number;
8964
- /** @description Self sign-up flow type for the tier. */
9015
+ /** @description Self sign-up settings of the tier. */
9016
+ selfSignup: {
9017
+ /** @description Whether members may self-enroll into the tier. */
9018
+ enabled: boolean;
9019
+ /** @description Self sign-up flow type for the tier. */
9020
+ type: string;
9021
+ };
9022
+ /**
9023
+ * @deprecated
9024
+ * @description Deprecated. Use selfSignup.type instead. Self sign-up flow type for the tier.
9025
+ */
8965
9026
  selfSignupType?: string;
8966
9027
  /** @description One-time setup fee for the tier. */
8967
9028
  setupFee: number;
@@ -10862,8 +10923,10 @@ interface components {
10862
10923
  endFixed: boolean;
10863
10924
  /** @description Whether the item grants access to the entire resource. */
10864
10925
  entire?: boolean;
10865
- /** @description Resources with exclusive access. */
10926
+ /** @description Resources and benefits with exclusive access. */
10866
10927
  exclusiveAccess?: {
10928
+ /** @description Benefit IDs with exclusive access. */
10929
+ benefitRefs: string[];
10867
10930
  /** @description Resource IDs with exclusive access. */
10868
10931
  resourceRefs: string[];
10869
10932
  };
@@ -11435,8 +11498,10 @@ interface components {
11435
11498
  endFixed: boolean;
11436
11499
  /** @description Whether the item grants access to the entire resource. */
11437
11500
  entire?: boolean;
11438
- /** @description Resources with exclusive access. */
11501
+ /** @description Resources and benefits with exclusive access. */
11439
11502
  exclusiveAccess?: {
11503
+ /** @description Benefit IDs with exclusive access. */
11504
+ benefitRefs: string[];
11440
11505
  /** @description Resource IDs with exclusive access. */
11441
11506
  resourceRefs: string[];
11442
11507
  };
@@ -12009,8 +12074,10 @@ interface components {
12009
12074
  endFixed: boolean;
12010
12075
  /** @description Whether the item grants access to the entire resource. */
12011
12076
  entire?: boolean;
12012
- /** @description Resources with exclusive access. */
12077
+ /** @description Resources and benefits with exclusive access. */
12013
12078
  exclusiveAccess?: {
12079
+ /** @description Benefit IDs with exclusive access. */
12080
+ benefitRefs: string[];
12014
12081
  /** @description Resource IDs with exclusive access. */
12015
12082
  resourceRefs: string[];
12016
12083
  };
@@ -15644,11 +15711,11 @@ interface components {
15644
15711
  /** @description Display name of the benefit. */
15645
15712
  title: string;
15646
15713
  /**
15647
- * @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
15714
+ * @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
15648
15715
  * @default public
15649
15716
  * @enum {string}
15650
15717
  */
15651
- visibility?: "public" | "admins" | "members" | "networkMembers";
15718
+ visibility?: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
15652
15719
  };
15653
15720
  };
15654
15721
  };
@@ -15729,11 +15796,11 @@ interface components {
15729
15796
  /** @description Display name of the benefit. */
15730
15797
  title: string;
15731
15798
  /**
15732
- * @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
15799
+ * @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
15733
15800
  * @default public
15734
15801
  * @enum {string}
15735
15802
  */
15736
- visibility?: "public" | "admins" | "members" | "networkMembers";
15803
+ visibility?: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
15737
15804
  };
15738
15805
  };
15739
15806
  };
@@ -17093,12 +17160,14 @@ interface components {
17093
17160
  shop?: number;
17094
17161
  };
17095
17162
  /**
17096
- * @description Resources exclusively available to members on this plan.
17163
+ * @description Resources and benefits exclusively available to members on this plan.
17097
17164
  * @default {
17098
17165
  * "resourceRefs": []
17099
17166
  * }
17100
17167
  */
17101
17168
  exclusiveAccess?: {
17169
+ /** @description Benefit IDs with exclusive access for this plan. */
17170
+ benefitRefs?: string[];
17102
17171
  /** @description Resource IDs with exclusive access for this plan. */
17103
17172
  resourceRefs: string[];
17104
17173
  };
@@ -17247,12 +17316,14 @@ interface components {
17247
17316
  shop: number;
17248
17317
  };
17249
17318
  /**
17250
- * @description Resources exclusively available to members on this plan.
17319
+ * @description Resources and benefits exclusively available to members on this plan.
17251
17320
  * @default {
17252
17321
  * "resourceRefs": []
17253
17322
  * }
17254
17323
  */
17255
17324
  exclusiveAccess?: {
17325
+ /** @description Benefit IDs with exclusive access for this plan. */
17326
+ benefitRefs?: string[];
17256
17327
  /** @description Resource IDs with exclusive access for this plan. */
17257
17328
  resourceRefs: string[];
17258
17329
  };
@@ -17523,7 +17594,17 @@ interface components {
17523
17594
  period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
17524
17595
  /** @description Recurring price for this tier in the location currency. */
17525
17596
  price: number;
17526
- /** @description How members may self-enroll, if applicable. */
17597
+ /** @description Self sign-up settings of the tier. */
17598
+ selfSignup?: {
17599
+ /** @description Whether members may self-enroll into the tier. */
17600
+ enabled: boolean;
17601
+ /** @description Self sign-up flow type. */
17602
+ type: string;
17603
+ };
17604
+ /**
17605
+ * @deprecated
17606
+ * @description Deprecated. Use selfSignup.type instead. How members may self-enroll, if applicable.
17607
+ */
17527
17608
  selfSignupType?: string;
17528
17609
  /** @description One-time fee charged when subscribing to this tier. */
17529
17610
  setupFee?: number;
@@ -17845,7 +17926,17 @@ interface components {
17845
17926
  period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
17846
17927
  /** @description Recurring price for this tier in the location currency. */
17847
17928
  price: number;
17848
- /** @description How members may self-enroll, if applicable. */
17929
+ /** @description Self sign-up settings of the tier. */
17930
+ selfSignup?: {
17931
+ /** @description Whether members may self-enroll into the tier. */
17932
+ enabled: boolean;
17933
+ /** @description Self sign-up flow type. */
17934
+ type: string;
17935
+ };
17936
+ /**
17937
+ * @deprecated
17938
+ * @description Deprecated. Use selfSignup.type instead. How members may self-enroll, if applicable.
17939
+ */
17849
17940
  selfSignupType?: string;
17850
17941
  /** @description One-time fee charged when subscribing to this tier. */
17851
17942
  setupFee?: number;
@@ -18384,8 +18475,10 @@ interface components {
18384
18475
  endDate?: string;
18385
18476
  /** @description Whether the item grants access to the entire resource. */
18386
18477
  entire?: boolean;
18387
- /** @description Resources with exclusive access. */
18478
+ /** @description Resources and benefits with exclusive access. */
18388
18479
  exclusiveAccess?: {
18480
+ /** @description Benefit IDs with exclusive access. */
18481
+ benefitRefs?: string[];
18389
18482
  /** @description Resource IDs with exclusive access. */
18390
18483
  resourceRefs?: string[];
18391
18484
  };
@@ -18574,8 +18667,10 @@ interface components {
18574
18667
  endDate?: string;
18575
18668
  /** @description Whether the item grants access to the entire resource. */
18576
18669
  entire?: boolean;
18577
- /** @description Resources with exclusive access. */
18670
+ /** @description Resources and benefits with exclusive access. */
18578
18671
  exclusiveAccess?: {
18672
+ /** @description Benefit IDs with exclusive access. */
18673
+ benefitRefs?: string[];
18579
18674
  /** @description Resource IDs with exclusive access. */
18580
18675
  resourceRefs?: string[];
18581
18676
  };
@@ -18763,8 +18858,10 @@ interface components {
18763
18858
  endDate?: string;
18764
18859
  /** @description Whether the item grants access to the entire resource. */
18765
18860
  entire?: boolean;
18766
- /** @description Resources with exclusive access. */
18861
+ /** @description Resources and benefits with exclusive access. */
18767
18862
  exclusiveAccess?: {
18863
+ /** @description Benefit IDs with exclusive access. */
18864
+ benefitRefs?: string[];
18768
18865
  /** @description Resource IDs with exclusive access. */
18769
18866
  resourceRefs?: string[];
18770
18867
  };
@@ -18911,8 +19008,10 @@ interface components {
18911
19008
  endDate?: string;
18912
19009
  /** @description Whether the item grants access to the entire resource. */
18913
19010
  entire?: boolean;
18914
- /** @description Resources with exclusive access. */
19011
+ /** @description Resources and benefits with exclusive access. */
18915
19012
  exclusiveAccess?: {
19013
+ /** @description Benefit IDs with exclusive access. */
19014
+ benefitRefs?: string[];
18916
19015
  /** @description Resource IDs with exclusive access. */
18917
19016
  resourceRefs?: string[];
18918
19017
  };
@@ -23803,7 +23902,7 @@ interface operations {
23803
23902
  getPlans: {
23804
23903
  parameters: {
23805
23904
  query?: {
23806
- /** @description When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false. */
23905
+ /** @description Deprecated. Only applies together with resourceRef. Filter the plans.tiers of `GET /resources/v1/{resourceId}` by their entire field instead. When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false. */
23807
23906
  entire?: string;
23808
23907
  /** @description Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
23809
23908
  limit?: number;
@@ -23811,7 +23910,7 @@ interface operations {
23811
23910
  locationRef?: string;
23812
23911
  /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
23813
23912
  nextPageToken?: string;
23814
- /** @description UUID of the resource whose tier plans to list. */
23913
+ /** @description Deprecated. Read plans.tiers from `GET /resources/v1/{resourceId}` instead. UUID of the resource whose tier plans to list. */
23815
23914
  resourceRef?: string;
23816
23915
  };
23817
23916
  header?: {
@@ -26939,7 +27038,7 @@ interface GetRegistrationsQuery {
26939
27038
  type Plan = NonNullable<components["schemas"]["plan"]>;
26940
27039
  /** Query parameters for `sb.plans.list()`. */
26941
27040
  interface GetPlansQuery {
26942
- /** When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false. */
27041
+ /** @deprecated Only applies together with resourceRef. Filter the plans.tiers of `GET /resources/v1/{resourceId}` by their entire field instead. When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false. */
26943
27042
  entire?: string;
26944
27043
  /** Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
26945
27044
  limit?: number;
@@ -26947,7 +27046,7 @@ interface GetPlansQuery {
26947
27046
  locationRef?: string;
26948
27047
  /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
26949
27048
  nextPageToken?: string;
26950
- /** UUID of the resource whose tier plans to list. */
27049
+ /** @deprecated Read plans.tiers from `GET /resources/v1/{resourceId}` instead. UUID of the resource whose tier plans to list. */
26951
27050
  resourceRef?: string;
26952
27051
  }
26953
27052
  /** Request body for `sb.plans.create()`. */