@izak0s/spacebring-api 5.3.0 → 5.5.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.cjs.map +1 -1
- package/dist/index.d.cts +226 -13
- package/dist/index.d.ts +226 -13
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -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.
|
|
@@ -8961,7 +9006,17 @@ interface components {
|
|
|
8961
9006
|
};
|
|
8962
9007
|
/** @description Price of the tier. */
|
|
8963
9008
|
price: number;
|
|
8964
|
-
/** @description Self sign-up
|
|
9009
|
+
/** @description Self sign-up settings of the tier. */
|
|
9010
|
+
selfSignup: {
|
|
9011
|
+
/** @description Whether members may self-enroll into the tier. */
|
|
9012
|
+
enabled: boolean;
|
|
9013
|
+
/** @description Self sign-up flow type for the tier. */
|
|
9014
|
+
type: string;
|
|
9015
|
+
};
|
|
9016
|
+
/**
|
|
9017
|
+
* @deprecated
|
|
9018
|
+
* @description Deprecated. Use selfSignup.type instead. Self sign-up flow type for the tier.
|
|
9019
|
+
*/
|
|
8965
9020
|
selfSignupType?: string;
|
|
8966
9021
|
/** @description One-time setup fee for the tier. */
|
|
8967
9022
|
setupFee: number;
|
|
@@ -10643,7 +10698,10 @@ interface components {
|
|
|
10643
10698
|
* @enum {string}
|
|
10644
10699
|
*/
|
|
10645
10700
|
billingCycleAnchor: "any" | "day";
|
|
10646
|
-
/**
|
|
10701
|
+
/**
|
|
10702
|
+
* @deprecated
|
|
10703
|
+
* @description Company associated with this subscription. Deprecated — use customer instead.
|
|
10704
|
+
*/
|
|
10647
10705
|
company?: {
|
|
10648
10706
|
/**
|
|
10649
10707
|
* Format: date-time
|
|
@@ -10715,6 +10773,46 @@ interface components {
|
|
|
10715
10773
|
*/
|
|
10716
10774
|
startDate: string;
|
|
10717
10775
|
};
|
|
10776
|
+
/** @description Customer billed for this subscription. */
|
|
10777
|
+
customer: {
|
|
10778
|
+
/**
|
|
10779
|
+
* Format: uuid
|
|
10780
|
+
* @description Unique identifier of the customer.
|
|
10781
|
+
*/
|
|
10782
|
+
id: string;
|
|
10783
|
+
/** @description Company logo. */
|
|
10784
|
+
logo?: {
|
|
10785
|
+
/** @description Storage key of the company logo. */
|
|
10786
|
+
key: string;
|
|
10787
|
+
/** @description Public URL of the company logo. */
|
|
10788
|
+
url: string;
|
|
10789
|
+
};
|
|
10790
|
+
/** @description Logo URL resolved from the company website. */
|
|
10791
|
+
publicLogoUrl?: string;
|
|
10792
|
+
/** @description Display name of the company customer. */
|
|
10793
|
+
title?: string;
|
|
10794
|
+
/**
|
|
10795
|
+
* @description Whether the customer is a company or user.
|
|
10796
|
+
* @enum {string}
|
|
10797
|
+
*/
|
|
10798
|
+
type: "company" | "user";
|
|
10799
|
+
/** @description User associated with the customer. */
|
|
10800
|
+
user?: {
|
|
10801
|
+
/** @description User email address. */
|
|
10802
|
+
email?: string | null;
|
|
10803
|
+
/**
|
|
10804
|
+
* Format: uuid
|
|
10805
|
+
* @description Unique identifier of the user.
|
|
10806
|
+
*/
|
|
10807
|
+
id: string;
|
|
10808
|
+
/** @description User first name. */
|
|
10809
|
+
name?: string | null;
|
|
10810
|
+
/** @description User profile photo URL. */
|
|
10811
|
+
photoUrl?: string | null;
|
|
10812
|
+
/** @description User last name. */
|
|
10813
|
+
surname?: string | null;
|
|
10814
|
+
};
|
|
10815
|
+
};
|
|
10718
10816
|
/**
|
|
10719
10817
|
* Format: uuid
|
|
10720
10818
|
* @description ID of the customer billed for this subscription.
|
|
@@ -11080,7 +11178,10 @@ interface components {
|
|
|
11080
11178
|
subscriptionType: "company" | "user";
|
|
11081
11179
|
/** @description Timezone identifier for billing dates. */
|
|
11082
11180
|
timezoneId: string;
|
|
11083
|
-
/**
|
|
11181
|
+
/**
|
|
11182
|
+
* @deprecated
|
|
11183
|
+
* @description User associated with this subscription. Deprecated — use customer instead.
|
|
11184
|
+
*/
|
|
11084
11185
|
user?: {
|
|
11085
11186
|
/** @description User bio. */
|
|
11086
11187
|
about?: string | null;
|
|
@@ -11170,7 +11271,10 @@ interface components {
|
|
|
11170
11271
|
* @enum {string}
|
|
11171
11272
|
*/
|
|
11172
11273
|
billingCycleAnchor: "any" | "day";
|
|
11173
|
-
/**
|
|
11274
|
+
/**
|
|
11275
|
+
* @deprecated
|
|
11276
|
+
* @description Company associated with this subscription. Deprecated — use customer instead.
|
|
11277
|
+
*/
|
|
11174
11278
|
company?: {
|
|
11175
11279
|
/**
|
|
11176
11280
|
* Format: date-time
|
|
@@ -11242,6 +11346,46 @@ interface components {
|
|
|
11242
11346
|
*/
|
|
11243
11347
|
startDate: string;
|
|
11244
11348
|
};
|
|
11349
|
+
/** @description Customer billed for this subscription. */
|
|
11350
|
+
customer: {
|
|
11351
|
+
/**
|
|
11352
|
+
* Format: uuid
|
|
11353
|
+
* @description Unique identifier of the customer.
|
|
11354
|
+
*/
|
|
11355
|
+
id: string;
|
|
11356
|
+
/** @description Company logo. */
|
|
11357
|
+
logo?: {
|
|
11358
|
+
/** @description Storage key of the company logo. */
|
|
11359
|
+
key: string;
|
|
11360
|
+
/** @description Public URL of the company logo. */
|
|
11361
|
+
url: string;
|
|
11362
|
+
};
|
|
11363
|
+
/** @description Logo URL resolved from the company website. */
|
|
11364
|
+
publicLogoUrl?: string;
|
|
11365
|
+
/** @description Display name of the company customer. */
|
|
11366
|
+
title?: string;
|
|
11367
|
+
/**
|
|
11368
|
+
* @description Whether the customer is a company or user.
|
|
11369
|
+
* @enum {string}
|
|
11370
|
+
*/
|
|
11371
|
+
type: "company" | "user";
|
|
11372
|
+
/** @description User associated with the customer. */
|
|
11373
|
+
user?: {
|
|
11374
|
+
/** @description User email address. */
|
|
11375
|
+
email?: string | null;
|
|
11376
|
+
/**
|
|
11377
|
+
* Format: uuid
|
|
11378
|
+
* @description Unique identifier of the user.
|
|
11379
|
+
*/
|
|
11380
|
+
id: string;
|
|
11381
|
+
/** @description User first name. */
|
|
11382
|
+
name?: string | null;
|
|
11383
|
+
/** @description User profile photo URL. */
|
|
11384
|
+
photoUrl?: string | null;
|
|
11385
|
+
/** @description User last name. */
|
|
11386
|
+
surname?: string | null;
|
|
11387
|
+
};
|
|
11388
|
+
};
|
|
11245
11389
|
/**
|
|
11246
11390
|
* Format: uuid
|
|
11247
11391
|
* @description ID of the customer billed for this subscription.
|
|
@@ -11607,7 +11751,10 @@ interface components {
|
|
|
11607
11751
|
subscriptionType: "company" | "user";
|
|
11608
11752
|
/** @description Timezone identifier for billing dates. */
|
|
11609
11753
|
timezoneId: string;
|
|
11610
|
-
/**
|
|
11754
|
+
/**
|
|
11755
|
+
* @deprecated
|
|
11756
|
+
* @description User associated with this subscription. Deprecated — use customer instead.
|
|
11757
|
+
*/
|
|
11611
11758
|
user?: {
|
|
11612
11759
|
/** @description User bio. */
|
|
11613
11760
|
about?: string | null;
|
|
@@ -11698,7 +11845,10 @@ interface components {
|
|
|
11698
11845
|
* @enum {string}
|
|
11699
11846
|
*/
|
|
11700
11847
|
billingCycleAnchor: "any" | "day";
|
|
11701
|
-
/**
|
|
11848
|
+
/**
|
|
11849
|
+
* @deprecated
|
|
11850
|
+
* @description Company associated with this subscription. Deprecated — use customer instead.
|
|
11851
|
+
*/
|
|
11702
11852
|
company?: {
|
|
11703
11853
|
/**
|
|
11704
11854
|
* Format: date-time
|
|
@@ -11770,6 +11920,46 @@ interface components {
|
|
|
11770
11920
|
*/
|
|
11771
11921
|
startDate: string;
|
|
11772
11922
|
};
|
|
11923
|
+
/** @description Customer billed for this subscription. */
|
|
11924
|
+
customer: {
|
|
11925
|
+
/**
|
|
11926
|
+
* Format: uuid
|
|
11927
|
+
* @description Unique identifier of the customer.
|
|
11928
|
+
*/
|
|
11929
|
+
id: string;
|
|
11930
|
+
/** @description Company logo. */
|
|
11931
|
+
logo?: {
|
|
11932
|
+
/** @description Storage key of the company logo. */
|
|
11933
|
+
key: string;
|
|
11934
|
+
/** @description Public URL of the company logo. */
|
|
11935
|
+
url: string;
|
|
11936
|
+
};
|
|
11937
|
+
/** @description Logo URL resolved from the company website. */
|
|
11938
|
+
publicLogoUrl?: string;
|
|
11939
|
+
/** @description Display name of the company customer. */
|
|
11940
|
+
title?: string;
|
|
11941
|
+
/**
|
|
11942
|
+
* @description Whether the customer is a company or user.
|
|
11943
|
+
* @enum {string}
|
|
11944
|
+
*/
|
|
11945
|
+
type: "company" | "user";
|
|
11946
|
+
/** @description User associated with the customer. */
|
|
11947
|
+
user?: {
|
|
11948
|
+
/** @description User email address. */
|
|
11949
|
+
email?: string | null;
|
|
11950
|
+
/**
|
|
11951
|
+
* Format: uuid
|
|
11952
|
+
* @description Unique identifier of the user.
|
|
11953
|
+
*/
|
|
11954
|
+
id: string;
|
|
11955
|
+
/** @description User first name. */
|
|
11956
|
+
name?: string | null;
|
|
11957
|
+
/** @description User profile photo URL. */
|
|
11958
|
+
photoUrl?: string | null;
|
|
11959
|
+
/** @description User last name. */
|
|
11960
|
+
surname?: string | null;
|
|
11961
|
+
};
|
|
11962
|
+
};
|
|
11773
11963
|
/**
|
|
11774
11964
|
* Format: uuid
|
|
11775
11965
|
* @description ID of the customer billed for this subscription.
|
|
@@ -12135,7 +12325,10 @@ interface components {
|
|
|
12135
12325
|
subscriptionType: "company" | "user";
|
|
12136
12326
|
/** @description Timezone identifier for billing dates. */
|
|
12137
12327
|
timezoneId: string;
|
|
12138
|
-
/**
|
|
12328
|
+
/**
|
|
12329
|
+
* @deprecated
|
|
12330
|
+
* @description User associated with this subscription. Deprecated — use customer instead.
|
|
12331
|
+
*/
|
|
12139
12332
|
user?: {
|
|
12140
12333
|
/** @description User bio. */
|
|
12141
12334
|
about?: string | null;
|
|
@@ -17385,7 +17578,17 @@ interface components {
|
|
|
17385
17578
|
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
17386
17579
|
/** @description Recurring price for this tier in the location currency. */
|
|
17387
17580
|
price: number;
|
|
17388
|
-
/** @description
|
|
17581
|
+
/** @description Self sign-up settings of the tier. */
|
|
17582
|
+
selfSignup?: {
|
|
17583
|
+
/** @description Whether members may self-enroll into the tier. */
|
|
17584
|
+
enabled: boolean;
|
|
17585
|
+
/** @description Self sign-up flow type. */
|
|
17586
|
+
type: string;
|
|
17587
|
+
};
|
|
17588
|
+
/**
|
|
17589
|
+
* @deprecated
|
|
17590
|
+
* @description Deprecated. Use selfSignup.type instead. How members may self-enroll, if applicable.
|
|
17591
|
+
*/
|
|
17389
17592
|
selfSignupType?: string;
|
|
17390
17593
|
/** @description One-time fee charged when subscribing to this tier. */
|
|
17391
17594
|
setupFee?: number;
|
|
@@ -17707,7 +17910,17 @@ interface components {
|
|
|
17707
17910
|
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
17708
17911
|
/** @description Recurring price for this tier in the location currency. */
|
|
17709
17912
|
price: number;
|
|
17710
|
-
/** @description
|
|
17913
|
+
/** @description Self sign-up settings of the tier. */
|
|
17914
|
+
selfSignup?: {
|
|
17915
|
+
/** @description Whether members may self-enroll into the tier. */
|
|
17916
|
+
enabled: boolean;
|
|
17917
|
+
/** @description Self sign-up flow type. */
|
|
17918
|
+
type: string;
|
|
17919
|
+
};
|
|
17920
|
+
/**
|
|
17921
|
+
* @deprecated
|
|
17922
|
+
* @description Deprecated. Use selfSignup.type instead. How members may self-enroll, if applicable.
|
|
17923
|
+
*/
|
|
17711
17924
|
selfSignupType?: string;
|
|
17712
17925
|
/** @description One-time fee charged when subscribing to this tier. */
|
|
17713
17926
|
setupFee?: number;
|
|
@@ -23665,7 +23878,7 @@ interface operations {
|
|
|
23665
23878
|
getPlans: {
|
|
23666
23879
|
parameters: {
|
|
23667
23880
|
query?: {
|
|
23668
|
-
/** @description When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false. */
|
|
23881
|
+
/** @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. */
|
|
23669
23882
|
entire?: string;
|
|
23670
23883
|
/** @description Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
23671
23884
|
limit?: number;
|
|
@@ -23673,7 +23886,7 @@ interface operations {
|
|
|
23673
23886
|
locationRef?: string;
|
|
23674
23887
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
23675
23888
|
nextPageToken?: string;
|
|
23676
|
-
/** @description UUID of the resource whose tier plans to list. */
|
|
23889
|
+
/** @description Deprecated. Read plans.tiers from `GET /resources/v1/{resourceId}` instead. UUID of the resource whose tier plans to list. */
|
|
23677
23890
|
resourceRef?: string;
|
|
23678
23891
|
};
|
|
23679
23892
|
header?: {
|
|
@@ -26801,7 +27014,7 @@ interface GetRegistrationsQuery {
|
|
|
26801
27014
|
type Plan = NonNullable<components["schemas"]["plan"]>;
|
|
26802
27015
|
/** Query parameters for `sb.plans.list()`. */
|
|
26803
27016
|
interface GetPlansQuery {
|
|
26804
|
-
/** When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false. */
|
|
27017
|
+
/** @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. */
|
|
26805
27018
|
entire?: string;
|
|
26806
27019
|
/** Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
26807
27020
|
limit?: number;
|
|
@@ -26809,7 +27022,7 @@ interface GetPlansQuery {
|
|
|
26809
27022
|
locationRef?: string;
|
|
26810
27023
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
26811
27024
|
nextPageToken?: string;
|
|
26812
|
-
/** UUID of the resource whose tier plans to list. */
|
|
27025
|
+
/** @deprecated Read plans.tiers from `GET /resources/v1/{resourceId}` instead. UUID of the resource whose tier plans to list. */
|
|
26813
27026
|
resourceRef?: string;
|
|
26814
27027
|
}
|
|
26815
27028
|
/** Request body for `sb.plans.create()`. */
|