@izak0s/spacebring-api 5.4.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.
Files changed (5) hide show
  1. package/dist/index.cjs.map +1 -1
  2. package/dist/index.d.cts +82 -7
  3. package/dist/index.d.ts +82 -7
  4. package/dist/index.js.map +1 -1
  5. package/package.json +1 -1
package/dist/index.d.cts 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 flow type for the tier. */
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;
@@ -17523,7 +17578,17 @@ interface components {
17523
17578
  period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
17524
17579
  /** @description Recurring price for this tier in the location currency. */
17525
17580
  price: number;
17526
- /** @description How members may self-enroll, if applicable. */
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
+ */
17527
17592
  selfSignupType?: string;
17528
17593
  /** @description One-time fee charged when subscribing to this tier. */
17529
17594
  setupFee?: number;
@@ -17845,7 +17910,17 @@ interface components {
17845
17910
  period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
17846
17911
  /** @description Recurring price for this tier in the location currency. */
17847
17912
  price: number;
17848
- /** @description How members may self-enroll, if applicable. */
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
+ */
17849
17924
  selfSignupType?: string;
17850
17925
  /** @description One-time fee charged when subscribing to this tier. */
17851
17926
  setupFee?: number;
@@ -23803,7 +23878,7 @@ interface operations {
23803
23878
  getPlans: {
23804
23879
  parameters: {
23805
23880
  query?: {
23806
- /** @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. */
23807
23882
  entire?: string;
23808
23883
  /** @description Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
23809
23884
  limit?: number;
@@ -23811,7 +23886,7 @@ interface operations {
23811
23886
  locationRef?: string;
23812
23887
  /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
23813
23888
  nextPageToken?: string;
23814
- /** @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. */
23815
23890
  resourceRef?: string;
23816
23891
  };
23817
23892
  header?: {
@@ -26939,7 +27014,7 @@ interface GetRegistrationsQuery {
26939
27014
  type Plan = NonNullable<components["schemas"]["plan"]>;
26940
27015
  /** Query parameters for `sb.plans.list()`. */
26941
27016
  interface GetPlansQuery {
26942
- /** 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. */
26943
27018
  entire?: string;
26944
27019
  /** Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
26945
27020
  limit?: number;
@@ -26947,7 +27022,7 @@ interface GetPlansQuery {
26947
27022
  locationRef?: string;
26948
27023
  /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
26949
27024
  nextPageToken?: string;
26950
- /** 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. */
26951
27026
  resourceRef?: string;
26952
27027
  }
26953
27028
  /** Request body for `sb.plans.create()`. */
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 flow type for the tier. */
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;
@@ -17523,7 +17578,17 @@ interface components {
17523
17578
  period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
17524
17579
  /** @description Recurring price for this tier in the location currency. */
17525
17580
  price: number;
17526
- /** @description How members may self-enroll, if applicable. */
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
+ */
17527
17592
  selfSignupType?: string;
17528
17593
  /** @description One-time fee charged when subscribing to this tier. */
17529
17594
  setupFee?: number;
@@ -17845,7 +17910,17 @@ interface components {
17845
17910
  period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
17846
17911
  /** @description Recurring price for this tier in the location currency. */
17847
17912
  price: number;
17848
- /** @description How members may self-enroll, if applicable. */
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
+ */
17849
17924
  selfSignupType?: string;
17850
17925
  /** @description One-time fee charged when subscribing to this tier. */
17851
17926
  setupFee?: number;
@@ -23803,7 +23878,7 @@ interface operations {
23803
23878
  getPlans: {
23804
23879
  parameters: {
23805
23880
  query?: {
23806
- /** @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. */
23807
23882
  entire?: string;
23808
23883
  /** @description Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
23809
23884
  limit?: number;
@@ -23811,7 +23886,7 @@ interface operations {
23811
23886
  locationRef?: string;
23812
23887
  /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
23813
23888
  nextPageToken?: string;
23814
- /** @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. */
23815
23890
  resourceRef?: string;
23816
23891
  };
23817
23892
  header?: {
@@ -26939,7 +27014,7 @@ interface GetRegistrationsQuery {
26939
27014
  type Plan = NonNullable<components["schemas"]["plan"]>;
26940
27015
  /** Query parameters for `sb.plans.list()`. */
26941
27016
  interface GetPlansQuery {
26942
- /** 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. */
26943
27018
  entire?: string;
26944
27019
  /** Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
26945
27020
  limit?: number;
@@ -26947,7 +27022,7 @@ interface GetPlansQuery {
26947
27022
  locationRef?: string;
26948
27023
  /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
26949
27024
  nextPageToken?: string;
26950
- /** 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. */
26951
27026
  resourceRef?: string;
26952
27027
  }
26953
27028
  /** Request body for `sb.plans.create()`. */