@izak0s/spacebring-api 1.1.0 → 1.3.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.ts CHANGED
@@ -1673,7 +1673,7 @@ interface paths {
1673
1673
  patch?: never;
1674
1674
  trace?: never;
1675
1675
  };
1676
- "/subscriptions/v1/{id}": {
1676
+ "/subscriptions/v1/{subscriptionId}": {
1677
1677
  parameters: {
1678
1678
  query?: never;
1679
1679
  header?: never;
@@ -1701,7 +1701,7 @@ interface paths {
1701
1701
  patch: operations["updateSubscription"];
1702
1702
  trace?: never;
1703
1703
  };
1704
- "/subscriptions/v1/{id}/items": {
1704
+ "/subscriptions/v1/{subscriptionId}/items": {
1705
1705
  parameters: {
1706
1706
  query?: never;
1707
1707
  header?: never;
@@ -1721,7 +1721,7 @@ interface paths {
1721
1721
  patch?: never;
1722
1722
  trace?: never;
1723
1723
  };
1724
- "/subscriptions/v1/{id}/items/{itemId}": {
1724
+ "/subscriptions/v1/{subscriptionId}/items/{itemId}": {
1725
1725
  parameters: {
1726
1726
  query?: never;
1727
1727
  header?: never;
@@ -2266,7 +2266,7 @@ interface components {
2266
2266
  * @description Exchange rate provider when auto-update is enabled.
2267
2267
  * @enum {string}
2268
2268
  */
2269
- provider?: "fastForex" | "nbu" | "bcra";
2269
+ provider?: "fastForex" | "nbu" | "bcra" | "nbg";
2270
2270
  };
2271
2271
  /** @description Pre-built query string for the next page of results. Contains all active filter parameters combined with the next page token, ready to append to the endpoint URL. */
2272
2272
  searchQueryNext: string;
@@ -8931,526 +8931,1578 @@ interface components {
8931
8931
  };
8932
8932
  };
8933
8933
  };
8934
- subscription: {
8935
- /** @description Whether pending items are added to the next invoice. */
8936
- addPendingItemsToInvoice: boolean;
8937
- /** @description Advance invoicing settings. */
8938
- advanceInvoicing: {
8939
- /** @description Number of days before renewal to issue an invoice. */
8940
- days: number;
8934
+ getSubscriptions: {
8935
+ /** @description Pagination token to fetch the next page of results. */
8936
+ nextPageToken?: string;
8937
+ /** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
8938
+ searchQueryNext?: string;
8939
+ /** @description List of subscriptions. */
8940
+ subscriptions: {
8941
+ /** @description Whether pending items are added to the next invoice. */
8942
+ addPendingItemsToInvoice: boolean;
8943
+ /** @description Advance invoicing settings. */
8944
+ advanceInvoicing: {
8945
+ /** @description Number of days before renewal to issue an invoice. */
8946
+ days: number;
8947
+ /**
8948
+ * @description Advance invoicing mode.
8949
+ * @enum {string}
8950
+ */
8951
+ type: "days" | "default";
8952
+ };
8953
+ /** @description Resource assignments for this subscription. */
8954
+ assignments: {
8955
+ /** @description Whether the assignment grants access to the entire resource. */
8956
+ entire?: boolean;
8957
+ /**
8958
+ * Format: uuid
8959
+ * @description Unique identifier of the assignment.
8960
+ */
8961
+ id: string;
8962
+ /** @description Assigned quantity. */
8963
+ quantity?: number;
8964
+ /** @description Assigned resource details. */
8965
+ resource: {
8966
+ /** @description Cover image URL of the assigned resource. */
8967
+ coverUrl?: string;
8968
+ /** @description Unique identifier of the assigned resource. */
8969
+ id: string;
8970
+ /** @description Display name of the assigned resource. */
8971
+ title: string;
8972
+ /** @description Resource type. */
8973
+ type: string;
8974
+ };
8975
+ /** @description Display title of the assignment. */
8976
+ title: string;
8977
+ }[];
8941
8978
  /**
8942
- * @description Advance invoicing mode.
8979
+ * @description Billing cycle anchor mode.
8943
8980
  * @enum {string}
8944
8981
  */
8945
- type: "days" | "default";
8946
- };
8947
- /** @description Resource assignments for this subscription. */
8948
- assignments: {
8949
- /** @description Whether the assignment grants access to the entire resource. */
8950
- entire?: boolean;
8951
- /**
8952
- * Format: uuid
8953
- * @description Unique identifier of the assignment.
8954
- */
8955
- id: string;
8956
- /** @description Assigned quantity. */
8957
- quantity?: number;
8958
- /** @description Assigned resource details. */
8959
- resource: {
8960
- /** @description Cover image URL of the assigned resource. */
8961
- coverUrl?: string;
8962
- /** @description Unique identifier of the assigned resource. */
8982
+ billingCycleAnchor: "any" | "day";
8983
+ /** @description Company associated with this subscription. */
8984
+ company?: {
8985
+ /**
8986
+ * Format: date-time
8987
+ * @description ISO timestamp of when the company was created.
8988
+ */
8989
+ createDate: string;
8990
+ /**
8991
+ * Format: uuid
8992
+ * @description Unique identifier of the company.
8993
+ */
8963
8994
  id: string;
8964
- /** @description Display name of the assigned resource. */
8995
+ /**
8996
+ * Format: uuid
8997
+ * @description ID of the location this company belongs to.
8998
+ */
8999
+ locationRef: string;
9000
+ /** @description Company logo. */
9001
+ logo?: {
9002
+ /** @description Storage key of the company logo. */
9003
+ key: string;
9004
+ /** @description Public URL of the company logo. */
9005
+ url: string;
9006
+ };
9007
+ /** @description Custom metadata for the company. */
9008
+ metadata?: {
9009
+ [key: string]: unknown;
9010
+ };
9011
+ /** @description Internal notes about the company. */
9012
+ notes?: string | null;
9013
+ /** @description Logo URL resolved from the company website. */
9014
+ publicLogoUrl?: string;
9015
+ /** @description Display name of the company. */
8965
9016
  title: string;
8966
- /** @description Resource type. */
8967
- type: string;
8968
9017
  };
8969
- /** @description Display title of the assignment. */
8970
- title: string;
8971
- }[];
8972
- /**
8973
- * @description Billing cycle anchor mode.
8974
- * @enum {string}
8975
- */
8976
- billingCycleAnchor: "any" | "day";
8977
- /** @description Company associated with this subscription. */
8978
- company?: {
8979
- /**
8980
- * Format: date-time
8981
- * @description ISO timestamp of when the company was created.
8982
- */
8983
- createDate: string;
8984
- /**
8985
- * Format: uuid
8986
- * @description Unique identifier of the company.
8987
- */
8988
- id: string;
8989
9018
  /**
8990
9019
  * Format: uuid
8991
- * @description ID of the location this company belongs to.
9020
+ * @description ID of the company this subscription belongs to.
8992
9021
  */
8993
- locationRef: string;
8994
- /** @description Company logo. */
8995
- logo?: {
8996
- /** @description Storage key of the company logo. */
8997
- key: string;
8998
- /** @description Public URL of the company logo. */
9022
+ companyRef?: string;
9023
+ /** @description Contract associated with this subscription. */
9024
+ contract?: {
9025
+ /**
9026
+ * Format: uuid
9027
+ * @description Unique identifier of the contract.
9028
+ */
9029
+ id: string;
9030
+ /** @description URL of the contract document. */
8999
9031
  url: string;
9000
9032
  };
9001
- /** @description Custom metadata for the company. */
9002
- metadata?: {
9003
- [key: string]: unknown;
9004
- };
9005
- /** @description Internal notes about the company. */
9006
- notes?: string | null;
9007
- /** @description Logo URL resolved from the company website. */
9008
- publicLogoUrl?: string;
9009
- /** @description Display name of the company. */
9010
- title: string;
9011
- };
9012
- /**
9013
- * Format: uuid
9014
- * @description ID of the company this subscription belongs to.
9015
- */
9016
- companyRef?: string;
9017
- /** @description Contract associated with this subscription. */
9018
- contract?: {
9019
- /**
9020
- * Format: uuid
9021
- * @description Unique identifier of the contract.
9022
- */
9023
- id: string;
9024
- /** @description URL of the contract document. */
9025
- url: string;
9026
- };
9027
- /**
9028
- * Format: date-time
9029
- * @description ISO timestamp of when the subscription was created.
9030
- */
9031
- createDate: string;
9032
- /** @description Total credits included in the subscription. */
9033
- credits: number;
9034
- /** @description Current billing interval. */
9035
- currentInterval?: {
9036
- /**
9037
- * Format: date-time
9038
- * @description ISO timestamp when the interval ends.
9039
- */
9040
- endDate: string;
9041
- /** @description Whether future interval items have been created. */
9042
- futureIntervalItemsCreated?: boolean;
9043
9033
  /**
9044
9034
  * Format: date-time
9045
- * @description ISO timestamp when the interval starts.
9035
+ * @description ISO timestamp of when the subscription was created.
9046
9036
  */
9047
- startDate: string;
9048
- };
9049
- /**
9050
- * Format: uuid
9051
- * @description ID of the customer billed for this subscription.
9052
- */
9053
- customerRef: string;
9054
- /** @description Total day passes included in the subscription. */
9055
- dayPasses: number;
9056
- /**
9057
- * Format: date-time
9058
- * @description ISO timestamp of when the subscription was deleted.
9059
- */
9060
- deleteDate?: string;
9061
- /**
9062
- * @deprecated
9063
- * @description Maximum synthetic discount percentages across items.
9064
- */
9065
- discounts?: {
9066
- /** @description Maximum discount percentage for credit packages across items. */
9067
- creditPackages: number;
9068
- /** @description Maximum discount percentage for desk bookings across items. */
9069
- desks: number;
9070
- /** @description Maximum discount percentage for equipment bookings across items. */
9071
- equipment: number;
9072
- /** @description Maximum discount percentage for event tickets across items. */
9073
- events: number;
9074
- /** @description Maximum discount percentage for room bookings across items. */
9075
- rooms: number;
9076
- /** @description Maximum discount percentage for shop products across items. */
9077
- shop: number;
9078
- };
9079
- /**
9080
- * Format: date-time
9081
- * @description ISO timestamp when the subscription ends.
9082
- */
9083
- endDate?: string;
9084
- /**
9085
- * Format: uuid
9086
- * @description Unique identifier of the subscription.
9087
- */
9088
- id: string;
9089
- /** @description Subscription line items. */
9090
- items: {
9091
- /** @description Whether the item syncs from its linked product. */
9092
- autoUpdateFromProduct: boolean;
9093
- /** @description Avigilon Alta access group reference. */
9094
- avigilonAltaGroupRef?: number | null;
9095
- /** @description Brivo access group reference. */
9096
- brivoGroupRef?: number | null;
9097
- /** @description Number of billing cycles in the commitment period. */
9098
- commitmentCycles?: number;
9037
+ createDate: string;
9038
+ /** @description Total credits included in the subscription. */
9039
+ credits: number;
9040
+ /** @description Current billing interval. */
9041
+ currentInterval?: {
9042
+ /**
9043
+ * Format: date-time
9044
+ * @description ISO timestamp when the interval ends.
9045
+ */
9046
+ endDate: string;
9047
+ /** @description Whether future interval items have been created. */
9048
+ futureIntervalItemsCreated?: boolean;
9049
+ /**
9050
+ * Format: date-time
9051
+ * @description ISO timestamp when the interval starts.
9052
+ */
9053
+ startDate: string;
9054
+ };
9099
9055
  /**
9100
- * Format: date-time
9101
- * @description ISO timestamp when the commitment period ends.
9056
+ * Format: uuid
9057
+ * @description ID of the customer billed for this subscription.
9102
9058
  */
9103
- commitmentEndDate?: string;
9104
- /** @description ID of the coupon applied to this item. */
9105
- couponRef?: string;
9059
+ customerRef: string;
9060
+ /** @description Total day passes included in the subscription. */
9061
+ dayPasses: number;
9106
9062
  /**
9107
9063
  * Format: date-time
9108
- * @description ISO timestamp of when the item was created.
9064
+ * @description ISO timestamp of when the subscription was deleted.
9109
9065
  */
9110
- createDate: string;
9111
- /** @description Credits included per billing cycle. */
9112
- credits: number;
9113
- /** @description Whether the item has a custom end date. */
9114
- customEnd: boolean;
9115
- /** @description Whether the item has a custom start date. */
9116
- customStart: boolean;
9117
- /** @description Custom tax settings for this item. */
9118
- customTax: {
9119
- /** @description Whether custom tax is enabled for this item. */
9120
- enabled: boolean;
9121
- /** @description Custom tax rate as a decimal. */
9122
- rate: number;
9123
- };
9124
- /** @description Day passes included per billing cycle. */
9125
- dayPasses: number;
9066
+ deleteDate?: string;
9126
9067
  /**
9127
9068
  * @deprecated
9128
- * @description Synthetic discount percentages by product type.
9069
+ * @description Maximum synthetic discount percentages across items.
9129
9070
  */
9130
9071
  discounts?: {
9131
- /** @description Discount percentage applied to credit packages. */
9072
+ /** @description Maximum discount percentage for credit packages across items. */
9132
9073
  creditPackages: number;
9133
- /** @description Discount percentage applied to desk bookings. */
9074
+ /** @description Maximum discount percentage for desk bookings across items. */
9134
9075
  desks: number;
9135
- /** @description Discount percentage applied to equipment bookings. */
9076
+ /** @description Maximum discount percentage for equipment bookings across items. */
9136
9077
  equipment: number;
9137
- /** @description Discount percentage applied to event tickets. */
9078
+ /** @description Maximum discount percentage for event tickets across items. */
9138
9079
  events: number;
9139
- /** @description Discount percentage applied to room bookings. */
9080
+ /** @description Maximum discount percentage for room bookings across items. */
9140
9081
  rooms: number;
9141
- /** @description Discount percentage applied to shop products. */
9082
+ /** @description Maximum discount percentage for shop products across items. */
9142
9083
  shop: number;
9143
9084
  };
9144
9085
  /**
9145
9086
  * Format: date-time
9146
- * @description ISO timestamp when the item ends.
9087
+ * @description ISO timestamp when the subscription ends.
9147
9088
  */
9148
9089
  endDate?: string;
9149
- /** @description Whether the end date is fixed and cannot shift with billing cycles. */
9150
- endFixed: boolean;
9151
- /** @description Whether the item grants access to the entire resource. */
9152
- entire?: boolean;
9153
- /** @description Resources with exclusive access. */
9154
- exclusiveAccess?: {
9155
- /** @description Resource IDs with exclusive access. */
9156
- resourceRefs: string[];
9157
- };
9158
- /** @description Ezeep Blue group reference. */
9159
- ezeepBlueGroupRef?: string | null;
9160
- /** @description Coupons granted to this item. */
9161
- grantedDiscounts: {
9162
- /** @description Granted coupon details. */
9163
- coupon: {
9164
- /** @description Fixed discount amount. */
9165
- amountOff?: number;
9166
- /** @description Currency code for amountOff. */
9167
- currencyCode?: string;
9168
- /** @description Whether the coupon applies to credit purchases. */
9169
- enabledForCredits?: boolean;
9090
+ /**
9091
+ * Format: uuid
9092
+ * @description Unique identifier of the subscription.
9093
+ */
9094
+ id: string;
9095
+ /** @description Subscription line items. */
9096
+ items: {
9097
+ /** @description Whether the item syncs from its linked product. */
9098
+ autoUpdateFromProduct: boolean;
9099
+ /** @description Avigilon Alta access group reference. */
9100
+ avigilonAltaGroupRef?: number | null;
9101
+ /** @description Brivo access group reference. */
9102
+ brivoGroupRef?: number | null;
9103
+ /** @description Number of billing cycles in the commitment period. */
9104
+ commitmentCycles?: number;
9105
+ /**
9106
+ * Format: date-time
9107
+ * @description ISO timestamp when the commitment period ends.
9108
+ */
9109
+ commitmentEndDate?: string;
9110
+ /** @description ID of the coupon applied to this item. */
9111
+ couponRef?: string;
9112
+ /**
9113
+ * Format: date-time
9114
+ * @description ISO timestamp of when the item was created.
9115
+ */
9116
+ createDate: string;
9117
+ /** @description Credits included per billing cycle. */
9118
+ credits: number;
9119
+ /** @description Whether the item has a custom end date. */
9120
+ customEnd: boolean;
9121
+ /** @description Whether the item has a custom start date. */
9122
+ customStart: boolean;
9123
+ /** @description Custom tax settings for this item. */
9124
+ customTax: {
9125
+ /** @description Whether custom tax is enabled for this item. */
9126
+ enabled: boolean;
9127
+ /** @description Custom tax rate as a decimal. */
9128
+ rate: number;
9129
+ };
9130
+ /** @description Day passes included per billing cycle. */
9131
+ dayPasses: number;
9132
+ /**
9133
+ * @deprecated
9134
+ * @description Synthetic discount percentages by product type.
9135
+ */
9136
+ discounts?: {
9137
+ /** @description Discount percentage applied to credit packages. */
9138
+ creditPackages: number;
9139
+ /** @description Discount percentage applied to desk bookings. */
9140
+ desks: number;
9141
+ /** @description Discount percentage applied to equipment bookings. */
9142
+ equipment: number;
9143
+ /** @description Discount percentage applied to event tickets. */
9144
+ events: number;
9145
+ /** @description Discount percentage applied to room bookings. */
9146
+ rooms: number;
9147
+ /** @description Discount percentage applied to shop products. */
9148
+ shop: number;
9149
+ };
9150
+ /**
9151
+ * Format: date-time
9152
+ * @description ISO timestamp when the item ends.
9153
+ */
9154
+ endDate?: string;
9155
+ /** @description Whether the end date is fixed and cannot shift with billing cycles. */
9156
+ endFixed: boolean;
9157
+ /** @description Whether the item grants access to the entire resource. */
9158
+ entire?: boolean;
9159
+ /** @description Resources with exclusive access. */
9160
+ exclusiveAccess?: {
9161
+ /** @description Resource IDs with exclusive access. */
9162
+ resourceRefs: string[];
9163
+ };
9164
+ /** @description Ezeep Blue group reference. */
9165
+ ezeepBlueGroupRef?: string | null;
9166
+ /** @description Coupons granted to this item. */
9167
+ grantedDiscounts: {
9168
+ /** @description Granted coupon details. */
9169
+ coupon: {
9170
+ /** @description Fixed discount amount. */
9171
+ amountOff?: number;
9172
+ /** @description Currency code for amountOff. */
9173
+ currencyCode?: string;
9174
+ /** @description Whether the coupon applies to credit purchases. */
9175
+ enabledForCredits?: boolean;
9176
+ /**
9177
+ * Format: uuid
9178
+ * @description Unique identifier of the coupon.
9179
+ */
9180
+ id: string;
9181
+ /** @description Item-level redemption limits. */
9182
+ limitedItems?: {
9183
+ /** @description Whether item-level limits are enabled. */
9184
+ enabled: boolean;
9185
+ /** @description Items the coupon applies to when limits are enabled. */
9186
+ values: {
9187
+ /**
9188
+ * Format: uuid
9189
+ * @description Unique identifier of the limited item.
9190
+ */
9191
+ id: string;
9192
+ /** @description Display name of the limited item. */
9193
+ title?: string;
9194
+ /**
9195
+ * @description Product type of the limited item.
9196
+ * @enum {string}
9197
+ */
9198
+ type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
9199
+ }[];
9200
+ };
9201
+ /** @description Redemption limits for the coupon. */
9202
+ limitedRedemption?: {
9203
+ /** @description Whether redemption limits are enabled. */
9204
+ enabled: boolean;
9205
+ /** @description Current redemption count. */
9206
+ usage: number;
9207
+ /** @description Maximum redemption count. */
9208
+ value: number;
9209
+ };
9210
+ /** @description Percentage discount. */
9211
+ percentOff?: number;
9212
+ /** @description Product types the coupon applies to. */
9213
+ productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
9214
+ };
9215
+ }[];
9216
+ /**
9217
+ * Format: uuid
9218
+ * @description Unique identifier of the subscription item.
9219
+ */
9220
+ id: string;
9221
+ /** @description Kisi access group reference. */
9222
+ kisiGroupRef?: number | null;
9223
+ /**
9224
+ * Format: uuid
9225
+ * @description ID of the product option linked to this item.
9226
+ */
9227
+ optionRef?: string;
9228
+ /** @description Linked plan details. */
9229
+ plan?: {
9170
9230
  /**
9171
9231
  * Format: uuid
9172
- * @description Unique identifier of the coupon.
9232
+ * @description Unique identifier of the plan.
9173
9233
  */
9174
9234
  id: string;
9175
- /** @description Item-level redemption limits. */
9176
- limitedItems?: {
9177
- /** @description Whether item-level limits are enabled. */
9178
- enabled: boolean;
9179
- /** @description Items the coupon applies to when limits are enabled. */
9180
- values: {
9181
- /**
9182
- * Format: uuid
9183
- * @description Unique identifier of the limited item.
9184
- */
9185
- id: string;
9186
- /** @description Display name of the limited item. */
9187
- title?: string;
9188
- /**
9189
- * @description Product type of the limited item.
9190
- * @enum {string}
9191
- */
9192
- type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
9193
- }[];
9194
- };
9195
- /** @description Redemption limits for the coupon. */
9196
- limitedRedemption?: {
9197
- /** @description Whether redemption limits are enabled. */
9198
- enabled: boolean;
9199
- /** @description Current redemption count. */
9200
- usage: number;
9201
- /** @description Maximum redemption count. */
9202
- value: number;
9203
- };
9204
- /** @description Percentage discount. */
9205
- percentOff?: number;
9206
- /** @description Product types the coupon applies to. */
9207
- productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
9235
+ /** @description Resource reference associated with the plan. */
9236
+ resourceRef?: string;
9237
+ /** @description Display name of the plan. */
9238
+ title: string;
9239
+ };
9240
+ /**
9241
+ * Format: uuid
9242
+ * @description ID of the linked plan.
9243
+ */
9244
+ planRef?: string;
9245
+ /** @description Price per billing cycle. */
9246
+ price: number;
9247
+ /**
9248
+ * Format: uuid
9249
+ * @description ID of the linked product.
9250
+ */
9251
+ productRef?: string;
9252
+ /** @description Quantity of this item. */
9253
+ quantity: number;
9254
+ /** @description Linked resource details. */
9255
+ resource?: {
9256
+ /**
9257
+ * Format: uuid
9258
+ * @description Unique identifier of the resource.
9259
+ */
9260
+ id: string;
9261
+ /** @description Cover image URL of the resource. */
9262
+ imageUrl?: string;
9263
+ /** @description Display name of the resource. */
9264
+ title: string;
9265
+ /** @description Resource type. */
9266
+ type: string;
9267
+ };
9268
+ /** @description Reference to the linked resource. */
9269
+ resourceRef?: string | null;
9270
+ /** @description Salto KS access group reference. */
9271
+ saltoksAccessGroupRef?: string | null;
9272
+ /** @description One-time setup fee for this item. */
9273
+ setupFee: number;
9274
+ /**
9275
+ * Format: date-time
9276
+ * @description ISO timestamp when the item starts.
9277
+ */
9278
+ startDate?: string;
9279
+ /** @description Whether the start date is fixed. */
9280
+ startFixed: boolean;
9281
+ /** @description Tapkey access group reference. */
9282
+ tapkeyGroupRef?: string | null;
9283
+ /** @description Linked tier details. */
9284
+ tier?: {
9285
+ /**
9286
+ * Format: uuid
9287
+ * @description Unique identifier of the tier.
9288
+ */
9289
+ id: string;
9290
+ /** @description Display name of the tier. */
9291
+ title: string;
9208
9292
  };
9293
+ /**
9294
+ * Format: uuid
9295
+ * @description ID of the linked tier.
9296
+ */
9297
+ tierRef?: string;
9298
+ /** @description Display title of the item. */
9299
+ title?: string | null;
9300
+ /**
9301
+ * @description Billing type of the item.
9302
+ * @enum {string}
9303
+ */
9304
+ type: "oneOff" | "recurring";
9209
9305
  }[];
9210
9306
  /**
9211
9307
  * Format: uuid
9212
- * @description Unique identifier of the subscription item.
9308
+ * @description ID of the location this subscription belongs to.
9213
9309
  */
9214
- id: string;
9215
- /** @description Kisi access group reference. */
9216
- kisiGroupRef?: number | null;
9310
+ locationRef: string;
9217
9311
  /**
9218
9312
  * Format: uuid
9219
- * @description ID of the product option linked to this item.
9313
+ * @description ID of the membership this subscription belongs to.
9220
9314
  */
9221
- optionRef?: string;
9222
- /** @description Linked plan details. */
9223
- plan?: {
9315
+ membershipRef?: string;
9316
+ /**
9317
+ * Format: uuid
9318
+ * @description ID of the network this subscription belongs to.
9319
+ */
9320
+ networkRef: string;
9321
+ /** @description Next billing interval. */
9322
+ nextInterval?: {
9224
9323
  /**
9225
- * Format: uuid
9226
- * @description Unique identifier of the plan.
9324
+ * Format: date-time
9325
+ * @description ISO timestamp when the next interval ends.
9227
9326
  */
9228
- id: string;
9229
- /** @description Resource reference associated with the plan. */
9230
- resourceRef?: string;
9231
- /** @description Display name of the plan. */
9232
- title: string;
9327
+ endDate?: string;
9328
+ /**
9329
+ * Format: date-time
9330
+ * @description ISO timestamp when the next interval starts.
9331
+ */
9332
+ startDate: string;
9233
9333
  };
9234
- /**
9235
- * Format: uuid
9236
- * @description ID of the linked plan.
9334
+ /** @description Payment collection pause settings. */
9335
+ pausePaymentCollection?: {
9336
+ /**
9337
+ * @description Behavior while payment collection is paused.
9338
+ * @enum {string}
9339
+ */
9340
+ behavior: "draft" | "void";
9341
+ /**
9342
+ * Format: date-time
9343
+ * @description ISO timestamp when payment collection was paused.
9344
+ */
9345
+ createDate: string;
9346
+ /**
9347
+ * Format: date-time
9348
+ * @description ISO timestamp when payment collection resumes.
9349
+ */
9350
+ resumesAt?: string;
9351
+ };
9352
+ /** @description Payment status for subscriptions created by the current user. */
9353
+ payment?: {
9354
+ /** @description Pending payment request details. */
9355
+ request?: {
9356
+ /**
9357
+ * Format: uuid
9358
+ * @description Unique identifier of the payment request.
9359
+ */
9360
+ id: string;
9361
+ /** @description URL to complete the payment. */
9362
+ url: string;
9363
+ };
9364
+ /** @description Payment status. */
9365
+ status: string;
9366
+ };
9367
+ /** @description Invoice payment settings by product type. */
9368
+ payWithInvoice: {
9369
+ /** @description Whether credit packages are invoiced. */
9370
+ creditPackages: boolean;
9371
+ /** @description Whether desk bookings are invoiced. */
9372
+ desks: boolean;
9373
+ /** @description Whether equipment bookings are invoiced. */
9374
+ equipment?: boolean;
9375
+ /** @description Whether events are invoiced. */
9376
+ events: boolean;
9377
+ /** @description Whether parking bookings are invoiced. */
9378
+ parking?: boolean;
9379
+ /** @description Whether room bookings are invoiced. */
9380
+ rooms: boolean;
9381
+ /** @description Whether shop purchases are invoiced. */
9382
+ shop: boolean;
9383
+ };
9384
+ /**
9385
+ * @description Billing period.
9386
+ * @enum {string}
9237
9387
  */
9238
- planRef?: string;
9239
- /** @description Price per billing cycle. */
9388
+ period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
9389
+ /** @description Total recurring price of the subscription. */
9240
9390
  price: number;
9241
9391
  /**
9242
- * Format: uuid
9243
- * @description ID of the linked product.
9392
+ * Format: date-time
9393
+ * @description ISO timestamp of when the subscription was purchased.
9244
9394
  */
9245
- productRef?: string;
9246
- /** @description Quantity of this item. */
9247
- quantity: number;
9248
- /** @description Linked resource details. */
9249
- resource?: {
9250
- /**
9251
- * Format: uuid
9252
- * @description Unique identifier of the resource.
9253
- */
9254
- id: string;
9255
- /** @description Cover image URL of the resource. */
9256
- imageUrl?: string;
9257
- /** @description Display name of the resource. */
9258
- title: string;
9259
- /** @description Resource type. */
9260
- type: string;
9261
- };
9262
- /** @description Reference to the linked resource. */
9263
- resourceRef?: string | null;
9264
- /** @description Salto KS access group reference. */
9265
- saltoksAccessGroupRef?: string | null;
9266
- /** @description One-time setup fee for this item. */
9267
- setupFee: number;
9395
+ purchaseDate?: string;
9268
9396
  /**
9269
9397
  * Format: date-time
9270
- * @description ISO timestamp when the item starts.
9398
+ * @description ISO timestamp when the subscription starts.
9271
9399
  */
9272
- startDate?: string;
9400
+ startDate: string;
9273
9401
  /** @description Whether the start date is fixed. */
9274
9402
  startFixed: boolean;
9275
- /** @description Tapkey access group reference. */
9276
- tapkeyGroupRef?: string | null;
9277
- /** @description Linked tier details. */
9278
- tier?: {
9403
+ /**
9404
+ * @description Subscription status.
9405
+ * @enum {string}
9406
+ */
9407
+ status: "active" | "scheduled" | "incomplete" | "incompleteExpired" | "canceled";
9408
+ /**
9409
+ * @description Whether the subscription belongs to a company or user.
9410
+ * @enum {string}
9411
+ */
9412
+ subscriptionType: "company" | "user";
9413
+ /** @description Timezone identifier for billing dates. */
9414
+ timezoneId: string;
9415
+ /** @description User associated with this subscription. */
9416
+ user?: {
9417
+ /** @description User bio. */
9418
+ about?: string | null;
9419
+ /** @description User email address. */
9420
+ email?: string | null;
9421
+ /**
9422
+ * Format: uuid
9423
+ * @description Unique identifier of the user.
9424
+ */
9425
+ id: string;
9426
+ /** @description User first name. */
9427
+ name?: string | null;
9428
+ /** @description User phone number. */
9429
+ phoneNumber?: string | null;
9430
+ /** @description User profile photo URL. */
9431
+ photoUrl?: string | null;
9432
+ /** @description User last name. */
9433
+ surname?: string | null;
9434
+ };
9435
+ /** @description User who created this subscription. */
9436
+ userCreator?: {
9437
+ /** @description User bio. */
9438
+ about?: string | null;
9439
+ /** @description User email address. */
9440
+ email?: string | null;
9441
+ /**
9442
+ * Format: uuid
9443
+ * @description Unique identifier of the user.
9444
+ */
9445
+ id: string;
9446
+ /** @description User first name. */
9447
+ name?: string | null;
9448
+ /** @description User phone number. */
9449
+ phoneNumber?: string | null;
9450
+ /** @description User profile photo URL. */
9451
+ photoUrl?: string | null;
9452
+ /** @description User last name. */
9453
+ surname?: string | null;
9454
+ };
9455
+ /**
9456
+ * Format: uuid
9457
+ * @description ID of the user associated with this subscription.
9458
+ */
9459
+ userRef?: string;
9460
+ }[];
9461
+ };
9462
+ subscription: {
9463
+ /** @description Whether pending items are added to the next invoice. */
9464
+ addPendingItemsToInvoice: boolean;
9465
+ /** @description Advance invoicing settings. */
9466
+ advanceInvoicing: {
9467
+ /** @description Number of days before renewal to issue an invoice. */
9468
+ days: number;
9469
+ /**
9470
+ * @description Advance invoicing mode.
9471
+ * @enum {string}
9472
+ */
9473
+ type: "days" | "default";
9474
+ };
9475
+ /** @description Resource assignments for this subscription. */
9476
+ assignments: {
9477
+ /** @description Whether the assignment grants access to the entire resource. */
9478
+ entire?: boolean;
9479
+ /**
9480
+ * Format: uuid
9481
+ * @description Unique identifier of the assignment.
9482
+ */
9483
+ id: string;
9484
+ /** @description Assigned quantity. */
9485
+ quantity?: number;
9486
+ /** @description Assigned resource details. */
9487
+ resource: {
9488
+ /** @description Cover image URL of the assigned resource. */
9489
+ coverUrl?: string;
9490
+ /** @description Unique identifier of the assigned resource. */
9491
+ id: string;
9492
+ /** @description Display name of the assigned resource. */
9493
+ title: string;
9494
+ /** @description Resource type. */
9495
+ type: string;
9496
+ };
9497
+ /** @description Display title of the assignment. */
9498
+ title: string;
9499
+ }[];
9500
+ /**
9501
+ * @description Billing cycle anchor mode.
9502
+ * @enum {string}
9503
+ */
9504
+ billingCycleAnchor: "any" | "day";
9505
+ /** @description Company associated with this subscription. */
9506
+ company?: {
9507
+ /**
9508
+ * Format: date-time
9509
+ * @description ISO timestamp of when the company was created.
9510
+ */
9511
+ createDate: string;
9512
+ /**
9513
+ * Format: uuid
9514
+ * @description Unique identifier of the company.
9515
+ */
9516
+ id: string;
9517
+ /**
9518
+ * Format: uuid
9519
+ * @description ID of the location this company belongs to.
9520
+ */
9521
+ locationRef: string;
9522
+ /** @description Company logo. */
9523
+ logo?: {
9524
+ /** @description Storage key of the company logo. */
9525
+ key: string;
9526
+ /** @description Public URL of the company logo. */
9527
+ url: string;
9528
+ };
9529
+ /** @description Custom metadata for the company. */
9530
+ metadata?: {
9531
+ [key: string]: unknown;
9532
+ };
9533
+ /** @description Internal notes about the company. */
9534
+ notes?: string | null;
9535
+ /** @description Logo URL resolved from the company website. */
9536
+ publicLogoUrl?: string;
9537
+ /** @description Display name of the company. */
9538
+ title: string;
9539
+ };
9540
+ /**
9541
+ * Format: uuid
9542
+ * @description ID of the company this subscription belongs to.
9543
+ */
9544
+ companyRef?: string;
9545
+ /** @description Contract associated with this subscription. */
9546
+ contract?: {
9547
+ /**
9548
+ * Format: uuid
9549
+ * @description Unique identifier of the contract.
9550
+ */
9551
+ id: string;
9552
+ /** @description URL of the contract document. */
9553
+ url: string;
9554
+ };
9555
+ /**
9556
+ * Format: date-time
9557
+ * @description ISO timestamp of when the subscription was created.
9558
+ */
9559
+ createDate: string;
9560
+ /** @description Total credits included in the subscription. */
9561
+ credits: number;
9562
+ /** @description Current billing interval. */
9563
+ currentInterval?: {
9564
+ /**
9565
+ * Format: date-time
9566
+ * @description ISO timestamp when the interval ends.
9567
+ */
9568
+ endDate: string;
9569
+ /** @description Whether future interval items have been created. */
9570
+ futureIntervalItemsCreated?: boolean;
9571
+ /**
9572
+ * Format: date-time
9573
+ * @description ISO timestamp when the interval starts.
9574
+ */
9575
+ startDate: string;
9576
+ };
9577
+ /**
9578
+ * Format: uuid
9579
+ * @description ID of the customer billed for this subscription.
9580
+ */
9581
+ customerRef: string;
9582
+ /** @description Total day passes included in the subscription. */
9583
+ dayPasses: number;
9584
+ /**
9585
+ * Format: date-time
9586
+ * @description ISO timestamp of when the subscription was deleted.
9587
+ */
9588
+ deleteDate?: string;
9589
+ /**
9590
+ * @deprecated
9591
+ * @description Maximum synthetic discount percentages across items.
9592
+ */
9593
+ discounts?: {
9594
+ /** @description Maximum discount percentage for credit packages across items. */
9595
+ creditPackages: number;
9596
+ /** @description Maximum discount percentage for desk bookings across items. */
9597
+ desks: number;
9598
+ /** @description Maximum discount percentage for equipment bookings across items. */
9599
+ equipment: number;
9600
+ /** @description Maximum discount percentage for event tickets across items. */
9601
+ events: number;
9602
+ /** @description Maximum discount percentage for room bookings across items. */
9603
+ rooms: number;
9604
+ /** @description Maximum discount percentage for shop products across items. */
9605
+ shop: number;
9606
+ };
9607
+ /**
9608
+ * Format: date-time
9609
+ * @description ISO timestamp when the subscription ends.
9610
+ */
9611
+ endDate?: string;
9612
+ /**
9613
+ * Format: uuid
9614
+ * @description Unique identifier of the subscription.
9615
+ */
9616
+ id: string;
9617
+ /** @description Subscription line items. */
9618
+ items: {
9619
+ /** @description Whether the item syncs from its linked product. */
9620
+ autoUpdateFromProduct: boolean;
9621
+ /** @description Avigilon Alta access group reference. */
9622
+ avigilonAltaGroupRef?: number | null;
9623
+ /** @description Brivo access group reference. */
9624
+ brivoGroupRef?: number | null;
9625
+ /** @description Number of billing cycles in the commitment period. */
9626
+ commitmentCycles?: number;
9627
+ /**
9628
+ * Format: date-time
9629
+ * @description ISO timestamp when the commitment period ends.
9630
+ */
9631
+ commitmentEndDate?: string;
9632
+ /** @description ID of the coupon applied to this item. */
9633
+ couponRef?: string;
9634
+ /**
9635
+ * Format: date-time
9636
+ * @description ISO timestamp of when the item was created.
9637
+ */
9638
+ createDate: string;
9639
+ /** @description Credits included per billing cycle. */
9640
+ credits: number;
9641
+ /** @description Whether the item has a custom end date. */
9642
+ customEnd: boolean;
9643
+ /** @description Whether the item has a custom start date. */
9644
+ customStart: boolean;
9645
+ /** @description Custom tax settings for this item. */
9646
+ customTax: {
9647
+ /** @description Whether custom tax is enabled for this item. */
9648
+ enabled: boolean;
9649
+ /** @description Custom tax rate as a decimal. */
9650
+ rate: number;
9651
+ };
9652
+ /** @description Day passes included per billing cycle. */
9653
+ dayPasses: number;
9654
+ /**
9655
+ * @deprecated
9656
+ * @description Synthetic discount percentages by product type.
9657
+ */
9658
+ discounts?: {
9659
+ /** @description Discount percentage applied to credit packages. */
9660
+ creditPackages: number;
9661
+ /** @description Discount percentage applied to desk bookings. */
9662
+ desks: number;
9663
+ /** @description Discount percentage applied to equipment bookings. */
9664
+ equipment: number;
9665
+ /** @description Discount percentage applied to event tickets. */
9666
+ events: number;
9667
+ /** @description Discount percentage applied to room bookings. */
9668
+ rooms: number;
9669
+ /** @description Discount percentage applied to shop products. */
9670
+ shop: number;
9671
+ };
9672
+ /**
9673
+ * Format: date-time
9674
+ * @description ISO timestamp when the item ends.
9675
+ */
9676
+ endDate?: string;
9677
+ /** @description Whether the end date is fixed and cannot shift with billing cycles. */
9678
+ endFixed: boolean;
9679
+ /** @description Whether the item grants access to the entire resource. */
9680
+ entire?: boolean;
9681
+ /** @description Resources with exclusive access. */
9682
+ exclusiveAccess?: {
9683
+ /** @description Resource IDs with exclusive access. */
9684
+ resourceRefs: string[];
9685
+ };
9686
+ /** @description Ezeep Blue group reference. */
9687
+ ezeepBlueGroupRef?: string | null;
9688
+ /** @description Coupons granted to this item. */
9689
+ grantedDiscounts: {
9690
+ /** @description Granted coupon details. */
9691
+ coupon: {
9692
+ /** @description Fixed discount amount. */
9693
+ amountOff?: number;
9694
+ /** @description Currency code for amountOff. */
9695
+ currencyCode?: string;
9696
+ /** @description Whether the coupon applies to credit purchases. */
9697
+ enabledForCredits?: boolean;
9698
+ /**
9699
+ * Format: uuid
9700
+ * @description Unique identifier of the coupon.
9701
+ */
9702
+ id: string;
9703
+ /** @description Item-level redemption limits. */
9704
+ limitedItems?: {
9705
+ /** @description Whether item-level limits are enabled. */
9706
+ enabled: boolean;
9707
+ /** @description Items the coupon applies to when limits are enabled. */
9708
+ values: {
9709
+ /**
9710
+ * Format: uuid
9711
+ * @description Unique identifier of the limited item.
9712
+ */
9713
+ id: string;
9714
+ /** @description Display name of the limited item. */
9715
+ title?: string;
9716
+ /**
9717
+ * @description Product type of the limited item.
9718
+ * @enum {string}
9719
+ */
9720
+ type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
9721
+ }[];
9722
+ };
9723
+ /** @description Redemption limits for the coupon. */
9724
+ limitedRedemption?: {
9725
+ /** @description Whether redemption limits are enabled. */
9726
+ enabled: boolean;
9727
+ /** @description Current redemption count. */
9728
+ usage: number;
9729
+ /** @description Maximum redemption count. */
9730
+ value: number;
9731
+ };
9732
+ /** @description Percentage discount. */
9733
+ percentOff?: number;
9734
+ /** @description Product types the coupon applies to. */
9735
+ productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
9736
+ };
9737
+ }[];
9738
+ /**
9739
+ * Format: uuid
9740
+ * @description Unique identifier of the subscription item.
9741
+ */
9742
+ id: string;
9743
+ /** @description Kisi access group reference. */
9744
+ kisiGroupRef?: number | null;
9745
+ /**
9746
+ * Format: uuid
9747
+ * @description ID of the product option linked to this item.
9748
+ */
9749
+ optionRef?: string;
9750
+ /** @description Linked plan details. */
9751
+ plan?: {
9752
+ /**
9753
+ * Format: uuid
9754
+ * @description Unique identifier of the plan.
9755
+ */
9756
+ id: string;
9757
+ /** @description Resource reference associated with the plan. */
9758
+ resourceRef?: string;
9759
+ /** @description Display name of the plan. */
9760
+ title: string;
9761
+ };
9762
+ /**
9763
+ * Format: uuid
9764
+ * @description ID of the linked plan.
9765
+ */
9766
+ planRef?: string;
9767
+ /** @description Price per billing cycle. */
9768
+ price: number;
9769
+ /**
9770
+ * Format: uuid
9771
+ * @description ID of the linked product.
9772
+ */
9773
+ productRef?: string;
9774
+ /** @description Quantity of this item. */
9775
+ quantity: number;
9776
+ /** @description Linked resource details. */
9777
+ resource?: {
9778
+ /**
9779
+ * Format: uuid
9780
+ * @description Unique identifier of the resource.
9781
+ */
9782
+ id: string;
9783
+ /** @description Cover image URL of the resource. */
9784
+ imageUrl?: string;
9785
+ /** @description Display name of the resource. */
9786
+ title: string;
9787
+ /** @description Resource type. */
9788
+ type: string;
9789
+ };
9790
+ /** @description Reference to the linked resource. */
9791
+ resourceRef?: string | null;
9792
+ /** @description Salto KS access group reference. */
9793
+ saltoksAccessGroupRef?: string | null;
9794
+ /** @description One-time setup fee for this item. */
9795
+ setupFee: number;
9796
+ /**
9797
+ * Format: date-time
9798
+ * @description ISO timestamp when the item starts.
9799
+ */
9800
+ startDate?: string;
9801
+ /** @description Whether the start date is fixed. */
9802
+ startFixed: boolean;
9803
+ /** @description Tapkey access group reference. */
9804
+ tapkeyGroupRef?: string | null;
9805
+ /** @description Linked tier details. */
9806
+ tier?: {
9807
+ /**
9808
+ * Format: uuid
9809
+ * @description Unique identifier of the tier.
9810
+ */
9811
+ id: string;
9812
+ /** @description Display name of the tier. */
9813
+ title: string;
9814
+ };
9815
+ /**
9816
+ * Format: uuid
9817
+ * @description ID of the linked tier.
9818
+ */
9819
+ tierRef?: string;
9820
+ /** @description Display title of the item. */
9821
+ title?: string | null;
9822
+ /**
9823
+ * @description Billing type of the item.
9824
+ * @enum {string}
9825
+ */
9826
+ type: "oneOff" | "recurring";
9827
+ }[];
9828
+ /**
9829
+ * Format: uuid
9830
+ * @description ID of the location this subscription belongs to.
9831
+ */
9832
+ locationRef: string;
9833
+ /**
9834
+ * Format: uuid
9835
+ * @description ID of the membership this subscription belongs to.
9836
+ */
9837
+ membershipRef?: string;
9838
+ /**
9839
+ * Format: uuid
9840
+ * @description ID of the network this subscription belongs to.
9841
+ */
9842
+ networkRef: string;
9843
+ /** @description Next billing interval. */
9844
+ nextInterval?: {
9845
+ /**
9846
+ * Format: date-time
9847
+ * @description ISO timestamp when the next interval ends.
9848
+ */
9849
+ endDate?: string;
9850
+ /**
9851
+ * Format: date-time
9852
+ * @description ISO timestamp when the next interval starts.
9853
+ */
9854
+ startDate: string;
9855
+ };
9856
+ /** @description Payment collection pause settings. */
9857
+ pausePaymentCollection?: {
9858
+ /**
9859
+ * @description Behavior while payment collection is paused.
9860
+ * @enum {string}
9861
+ */
9862
+ behavior: "draft" | "void";
9863
+ /**
9864
+ * Format: date-time
9865
+ * @description ISO timestamp when payment collection was paused.
9866
+ */
9867
+ createDate: string;
9868
+ /**
9869
+ * Format: date-time
9870
+ * @description ISO timestamp when payment collection resumes.
9871
+ */
9872
+ resumesAt?: string;
9873
+ };
9874
+ /** @description Payment status for subscriptions created by the current user. */
9875
+ payment?: {
9876
+ /** @description Pending payment request details. */
9877
+ request?: {
9878
+ /**
9879
+ * Format: uuid
9880
+ * @description Unique identifier of the payment request.
9881
+ */
9882
+ id: string;
9883
+ /** @description URL to complete the payment. */
9884
+ url: string;
9885
+ };
9886
+ /** @description Payment status. */
9887
+ status: string;
9888
+ };
9889
+ /** @description Invoice payment settings by product type. */
9890
+ payWithInvoice: {
9891
+ /** @description Whether credit packages are invoiced. */
9892
+ creditPackages: boolean;
9893
+ /** @description Whether desk bookings are invoiced. */
9894
+ desks: boolean;
9895
+ /** @description Whether equipment bookings are invoiced. */
9896
+ equipment?: boolean;
9897
+ /** @description Whether events are invoiced. */
9898
+ events: boolean;
9899
+ /** @description Whether parking bookings are invoiced. */
9900
+ parking?: boolean;
9901
+ /** @description Whether room bookings are invoiced. */
9902
+ rooms: boolean;
9903
+ /** @description Whether shop purchases are invoiced. */
9904
+ shop: boolean;
9905
+ };
9906
+ /**
9907
+ * @description Billing period.
9908
+ * @enum {string}
9909
+ */
9910
+ period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
9911
+ /** @description Total recurring price of the subscription. */
9912
+ price: number;
9913
+ /**
9914
+ * Format: date-time
9915
+ * @description ISO timestamp of when the subscription was purchased.
9916
+ */
9917
+ purchaseDate?: string;
9918
+ /**
9919
+ * Format: date-time
9920
+ * @description ISO timestamp when the subscription starts.
9921
+ */
9922
+ startDate: string;
9923
+ /** @description Whether the start date is fixed. */
9924
+ startFixed: boolean;
9925
+ /**
9926
+ * @description Subscription status.
9927
+ * @enum {string}
9928
+ */
9929
+ status: "active" | "scheduled" | "incomplete" | "incompleteExpired" | "canceled";
9930
+ /**
9931
+ * @description Whether the subscription belongs to a company or user.
9932
+ * @enum {string}
9933
+ */
9934
+ subscriptionType: "company" | "user";
9935
+ /** @description Timezone identifier for billing dates. */
9936
+ timezoneId: string;
9937
+ /** @description User associated with this subscription. */
9938
+ user?: {
9939
+ /** @description User bio. */
9940
+ about?: string | null;
9941
+ /** @description User email address. */
9942
+ email?: string | null;
9943
+ /**
9944
+ * Format: uuid
9945
+ * @description Unique identifier of the user.
9946
+ */
9947
+ id: string;
9948
+ /** @description User first name. */
9949
+ name?: string | null;
9950
+ /** @description User phone number. */
9951
+ phoneNumber?: string | null;
9952
+ /** @description User profile photo URL. */
9953
+ photoUrl?: string | null;
9954
+ /** @description User last name. */
9955
+ surname?: string | null;
9956
+ };
9957
+ /** @description User who created this subscription. */
9958
+ userCreator?: {
9959
+ /** @description User bio. */
9960
+ about?: string | null;
9961
+ /** @description User email address. */
9962
+ email?: string | null;
9963
+ /**
9964
+ * Format: uuid
9965
+ * @description Unique identifier of the user.
9966
+ */
9967
+ id: string;
9968
+ /** @description User first name. */
9969
+ name?: string | null;
9970
+ /** @description User phone number. */
9971
+ phoneNumber?: string | null;
9972
+ /** @description User profile photo URL. */
9973
+ photoUrl?: string | null;
9974
+ /** @description User last name. */
9975
+ surname?: string | null;
9976
+ };
9977
+ /**
9978
+ * Format: uuid
9979
+ * @description ID of the user associated with this subscription.
9980
+ */
9981
+ userRef?: string;
9982
+ };
9983
+ getSubscription: {
9984
+ /** @description The subscription. */
9985
+ subscription: {
9986
+ /** @description Whether pending items are added to the next invoice. */
9987
+ addPendingItemsToInvoice: boolean;
9988
+ /** @description Advance invoicing settings. */
9989
+ advanceInvoicing: {
9990
+ /** @description Number of days before renewal to issue an invoice. */
9991
+ days: number;
9992
+ /**
9993
+ * @description Advance invoicing mode.
9994
+ * @enum {string}
9995
+ */
9996
+ type: "days" | "default";
9997
+ };
9998
+ /** @description Resource assignments for this subscription. */
9999
+ assignments: {
10000
+ /** @description Whether the assignment grants access to the entire resource. */
10001
+ entire?: boolean;
10002
+ /**
10003
+ * Format: uuid
10004
+ * @description Unique identifier of the assignment.
10005
+ */
10006
+ id: string;
10007
+ /** @description Assigned quantity. */
10008
+ quantity?: number;
10009
+ /** @description Assigned resource details. */
10010
+ resource: {
10011
+ /** @description Cover image URL of the assigned resource. */
10012
+ coverUrl?: string;
10013
+ /** @description Unique identifier of the assigned resource. */
10014
+ id: string;
10015
+ /** @description Display name of the assigned resource. */
10016
+ title: string;
10017
+ /** @description Resource type. */
10018
+ type: string;
10019
+ };
10020
+ /** @description Display title of the assignment. */
10021
+ title: string;
10022
+ }[];
10023
+ /**
10024
+ * @description Billing cycle anchor mode.
10025
+ * @enum {string}
10026
+ */
10027
+ billingCycleAnchor: "any" | "day";
10028
+ /** @description Company associated with this subscription. */
10029
+ company?: {
10030
+ /**
10031
+ * Format: date-time
10032
+ * @description ISO timestamp of when the company was created.
10033
+ */
10034
+ createDate: string;
10035
+ /**
10036
+ * Format: uuid
10037
+ * @description Unique identifier of the company.
10038
+ */
10039
+ id: string;
10040
+ /**
10041
+ * Format: uuid
10042
+ * @description ID of the location this company belongs to.
10043
+ */
10044
+ locationRef: string;
10045
+ /** @description Company logo. */
10046
+ logo?: {
10047
+ /** @description Storage key of the company logo. */
10048
+ key: string;
10049
+ /** @description Public URL of the company logo. */
10050
+ url: string;
10051
+ };
10052
+ /** @description Custom metadata for the company. */
10053
+ metadata?: {
10054
+ [key: string]: unknown;
10055
+ };
10056
+ /** @description Internal notes about the company. */
10057
+ notes?: string | null;
10058
+ /** @description Logo URL resolved from the company website. */
10059
+ publicLogoUrl?: string;
10060
+ /** @description Display name of the company. */
10061
+ title: string;
10062
+ };
10063
+ /**
10064
+ * Format: uuid
10065
+ * @description ID of the company this subscription belongs to.
10066
+ */
10067
+ companyRef?: string;
10068
+ /** @description Contract associated with this subscription. */
10069
+ contract?: {
10070
+ /**
10071
+ * Format: uuid
10072
+ * @description Unique identifier of the contract.
10073
+ */
10074
+ id: string;
10075
+ /** @description URL of the contract document. */
10076
+ url: string;
10077
+ };
10078
+ /**
10079
+ * Format: date-time
10080
+ * @description ISO timestamp of when the subscription was created.
10081
+ */
10082
+ createDate: string;
10083
+ /** @description Total credits included in the subscription. */
10084
+ credits: number;
10085
+ /** @description Current billing interval. */
10086
+ currentInterval?: {
10087
+ /**
10088
+ * Format: date-time
10089
+ * @description ISO timestamp when the interval ends.
10090
+ */
10091
+ endDate: string;
10092
+ /** @description Whether future interval items have been created. */
10093
+ futureIntervalItemsCreated?: boolean;
10094
+ /**
10095
+ * Format: date-time
10096
+ * @description ISO timestamp when the interval starts.
10097
+ */
10098
+ startDate: string;
10099
+ };
10100
+ /**
10101
+ * Format: uuid
10102
+ * @description ID of the customer billed for this subscription.
10103
+ */
10104
+ customerRef: string;
10105
+ /** @description Total day passes included in the subscription. */
10106
+ dayPasses: number;
10107
+ /**
10108
+ * Format: date-time
10109
+ * @description ISO timestamp of when the subscription was deleted.
10110
+ */
10111
+ deleteDate?: string;
10112
+ /**
10113
+ * @deprecated
10114
+ * @description Maximum synthetic discount percentages across items.
10115
+ */
10116
+ discounts?: {
10117
+ /** @description Maximum discount percentage for credit packages across items. */
10118
+ creditPackages: number;
10119
+ /** @description Maximum discount percentage for desk bookings across items. */
10120
+ desks: number;
10121
+ /** @description Maximum discount percentage for equipment bookings across items. */
10122
+ equipment: number;
10123
+ /** @description Maximum discount percentage for event tickets across items. */
10124
+ events: number;
10125
+ /** @description Maximum discount percentage for room bookings across items. */
10126
+ rooms: number;
10127
+ /** @description Maximum discount percentage for shop products across items. */
10128
+ shop: number;
10129
+ };
10130
+ /**
10131
+ * Format: date-time
10132
+ * @description ISO timestamp when the subscription ends.
10133
+ */
10134
+ endDate?: string;
10135
+ /**
10136
+ * Format: uuid
10137
+ * @description Unique identifier of the subscription.
10138
+ */
10139
+ id: string;
10140
+ /** @description Subscription line items. */
10141
+ items: {
10142
+ /** @description Whether the item syncs from its linked product. */
10143
+ autoUpdateFromProduct: boolean;
10144
+ /** @description Avigilon Alta access group reference. */
10145
+ avigilonAltaGroupRef?: number | null;
10146
+ /** @description Brivo access group reference. */
10147
+ brivoGroupRef?: number | null;
10148
+ /** @description Number of billing cycles in the commitment period. */
10149
+ commitmentCycles?: number;
10150
+ /**
10151
+ * Format: date-time
10152
+ * @description ISO timestamp when the commitment period ends.
10153
+ */
10154
+ commitmentEndDate?: string;
10155
+ /** @description ID of the coupon applied to this item. */
10156
+ couponRef?: string;
10157
+ /**
10158
+ * Format: date-time
10159
+ * @description ISO timestamp of when the item was created.
10160
+ */
10161
+ createDate: string;
10162
+ /** @description Credits included per billing cycle. */
10163
+ credits: number;
10164
+ /** @description Whether the item has a custom end date. */
10165
+ customEnd: boolean;
10166
+ /** @description Whether the item has a custom start date. */
10167
+ customStart: boolean;
10168
+ /** @description Custom tax settings for this item. */
10169
+ customTax: {
10170
+ /** @description Whether custom tax is enabled for this item. */
10171
+ enabled: boolean;
10172
+ /** @description Custom tax rate as a decimal. */
10173
+ rate: number;
10174
+ };
10175
+ /** @description Day passes included per billing cycle. */
10176
+ dayPasses: number;
10177
+ /**
10178
+ * @deprecated
10179
+ * @description Synthetic discount percentages by product type.
10180
+ */
10181
+ discounts?: {
10182
+ /** @description Discount percentage applied to credit packages. */
10183
+ creditPackages: number;
10184
+ /** @description Discount percentage applied to desk bookings. */
10185
+ desks: number;
10186
+ /** @description Discount percentage applied to equipment bookings. */
10187
+ equipment: number;
10188
+ /** @description Discount percentage applied to event tickets. */
10189
+ events: number;
10190
+ /** @description Discount percentage applied to room bookings. */
10191
+ rooms: number;
10192
+ /** @description Discount percentage applied to shop products. */
10193
+ shop: number;
10194
+ };
10195
+ /**
10196
+ * Format: date-time
10197
+ * @description ISO timestamp when the item ends.
10198
+ */
10199
+ endDate?: string;
10200
+ /** @description Whether the end date is fixed and cannot shift with billing cycles. */
10201
+ endFixed: boolean;
10202
+ /** @description Whether the item grants access to the entire resource. */
10203
+ entire?: boolean;
10204
+ /** @description Resources with exclusive access. */
10205
+ exclusiveAccess?: {
10206
+ /** @description Resource IDs with exclusive access. */
10207
+ resourceRefs: string[];
10208
+ };
10209
+ /** @description Ezeep Blue group reference. */
10210
+ ezeepBlueGroupRef?: string | null;
10211
+ /** @description Coupons granted to this item. */
10212
+ grantedDiscounts: {
10213
+ /** @description Granted coupon details. */
10214
+ coupon: {
10215
+ /** @description Fixed discount amount. */
10216
+ amountOff?: number;
10217
+ /** @description Currency code for amountOff. */
10218
+ currencyCode?: string;
10219
+ /** @description Whether the coupon applies to credit purchases. */
10220
+ enabledForCredits?: boolean;
10221
+ /**
10222
+ * Format: uuid
10223
+ * @description Unique identifier of the coupon.
10224
+ */
10225
+ id: string;
10226
+ /** @description Item-level redemption limits. */
10227
+ limitedItems?: {
10228
+ /** @description Whether item-level limits are enabled. */
10229
+ enabled: boolean;
10230
+ /** @description Items the coupon applies to when limits are enabled. */
10231
+ values: {
10232
+ /**
10233
+ * Format: uuid
10234
+ * @description Unique identifier of the limited item.
10235
+ */
10236
+ id: string;
10237
+ /** @description Display name of the limited item. */
10238
+ title?: string;
10239
+ /**
10240
+ * @description Product type of the limited item.
10241
+ * @enum {string}
10242
+ */
10243
+ type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
10244
+ }[];
10245
+ };
10246
+ /** @description Redemption limits for the coupon. */
10247
+ limitedRedemption?: {
10248
+ /** @description Whether redemption limits are enabled. */
10249
+ enabled: boolean;
10250
+ /** @description Current redemption count. */
10251
+ usage: number;
10252
+ /** @description Maximum redemption count. */
10253
+ value: number;
10254
+ };
10255
+ /** @description Percentage discount. */
10256
+ percentOff?: number;
10257
+ /** @description Product types the coupon applies to. */
10258
+ productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
10259
+ };
10260
+ }[];
10261
+ /**
10262
+ * Format: uuid
10263
+ * @description Unique identifier of the subscription item.
10264
+ */
10265
+ id: string;
10266
+ /** @description Kisi access group reference. */
10267
+ kisiGroupRef?: number | null;
10268
+ /**
10269
+ * Format: uuid
10270
+ * @description ID of the product option linked to this item.
10271
+ */
10272
+ optionRef?: string;
10273
+ /** @description Linked plan details. */
10274
+ plan?: {
10275
+ /**
10276
+ * Format: uuid
10277
+ * @description Unique identifier of the plan.
10278
+ */
10279
+ id: string;
10280
+ /** @description Resource reference associated with the plan. */
10281
+ resourceRef?: string;
10282
+ /** @description Display name of the plan. */
10283
+ title: string;
10284
+ };
10285
+ /**
10286
+ * Format: uuid
10287
+ * @description ID of the linked plan.
10288
+ */
10289
+ planRef?: string;
10290
+ /** @description Price per billing cycle. */
10291
+ price: number;
10292
+ /**
10293
+ * Format: uuid
10294
+ * @description ID of the linked product.
10295
+ */
10296
+ productRef?: string;
10297
+ /** @description Quantity of this item. */
10298
+ quantity: number;
10299
+ /** @description Linked resource details. */
10300
+ resource?: {
10301
+ /**
10302
+ * Format: uuid
10303
+ * @description Unique identifier of the resource.
10304
+ */
10305
+ id: string;
10306
+ /** @description Cover image URL of the resource. */
10307
+ imageUrl?: string;
10308
+ /** @description Display name of the resource. */
10309
+ title: string;
10310
+ /** @description Resource type. */
10311
+ type: string;
10312
+ };
10313
+ /** @description Reference to the linked resource. */
10314
+ resourceRef?: string | null;
10315
+ /** @description Salto KS access group reference. */
10316
+ saltoksAccessGroupRef?: string | null;
10317
+ /** @description One-time setup fee for this item. */
10318
+ setupFee: number;
10319
+ /**
10320
+ * Format: date-time
10321
+ * @description ISO timestamp when the item starts.
10322
+ */
10323
+ startDate?: string;
10324
+ /** @description Whether the start date is fixed. */
10325
+ startFixed: boolean;
10326
+ /** @description Tapkey access group reference. */
10327
+ tapkeyGroupRef?: string | null;
10328
+ /** @description Linked tier details. */
10329
+ tier?: {
10330
+ /**
10331
+ * Format: uuid
10332
+ * @description Unique identifier of the tier.
10333
+ */
10334
+ id: string;
10335
+ /** @description Display name of the tier. */
10336
+ title: string;
10337
+ };
10338
+ /**
10339
+ * Format: uuid
10340
+ * @description ID of the linked tier.
10341
+ */
10342
+ tierRef?: string;
10343
+ /** @description Display title of the item. */
10344
+ title?: string | null;
9279
10345
  /**
9280
- * Format: uuid
9281
- * @description Unique identifier of the tier.
10346
+ * @description Billing type of the item.
10347
+ * @enum {string}
9282
10348
  */
9283
- id: string;
9284
- /** @description Display name of the tier. */
9285
- title: string;
9286
- };
10349
+ type: "oneOff" | "recurring";
10350
+ }[];
9287
10351
  /**
9288
10352
  * Format: uuid
9289
- * @description ID of the linked tier.
10353
+ * @description ID of the location this subscription belongs to.
9290
10354
  */
9291
- tierRef?: string;
9292
- /** @description Display title of the item. */
9293
- title?: string | null;
10355
+ locationRef: string;
9294
10356
  /**
9295
- * @description Billing type of the item.
10357
+ * Format: uuid
10358
+ * @description ID of the membership this subscription belongs to.
10359
+ */
10360
+ membershipRef?: string;
10361
+ /**
10362
+ * Format: uuid
10363
+ * @description ID of the network this subscription belongs to.
10364
+ */
10365
+ networkRef: string;
10366
+ /** @description Next billing interval. */
10367
+ nextInterval?: {
10368
+ /**
10369
+ * Format: date-time
10370
+ * @description ISO timestamp when the next interval ends.
10371
+ */
10372
+ endDate?: string;
10373
+ /**
10374
+ * Format: date-time
10375
+ * @description ISO timestamp when the next interval starts.
10376
+ */
10377
+ startDate: string;
10378
+ };
10379
+ /** @description Payment collection pause settings. */
10380
+ pausePaymentCollection?: {
10381
+ /**
10382
+ * @description Behavior while payment collection is paused.
10383
+ * @enum {string}
10384
+ */
10385
+ behavior: "draft" | "void";
10386
+ /**
10387
+ * Format: date-time
10388
+ * @description ISO timestamp when payment collection was paused.
10389
+ */
10390
+ createDate: string;
10391
+ /**
10392
+ * Format: date-time
10393
+ * @description ISO timestamp when payment collection resumes.
10394
+ */
10395
+ resumesAt?: string;
10396
+ };
10397
+ /** @description Payment status for subscriptions created by the current user. */
10398
+ payment?: {
10399
+ /** @description Pending payment request details. */
10400
+ request?: {
10401
+ /**
10402
+ * Format: uuid
10403
+ * @description Unique identifier of the payment request.
10404
+ */
10405
+ id: string;
10406
+ /** @description URL to complete the payment. */
10407
+ url: string;
10408
+ };
10409
+ /** @description Payment status. */
10410
+ status: string;
10411
+ };
10412
+ /** @description Invoice payment settings by product type. */
10413
+ payWithInvoice: {
10414
+ /** @description Whether credit packages are invoiced. */
10415
+ creditPackages: boolean;
10416
+ /** @description Whether desk bookings are invoiced. */
10417
+ desks: boolean;
10418
+ /** @description Whether equipment bookings are invoiced. */
10419
+ equipment?: boolean;
10420
+ /** @description Whether events are invoiced. */
10421
+ events: boolean;
10422
+ /** @description Whether parking bookings are invoiced. */
10423
+ parking?: boolean;
10424
+ /** @description Whether room bookings are invoiced. */
10425
+ rooms: boolean;
10426
+ /** @description Whether shop purchases are invoiced. */
10427
+ shop: boolean;
10428
+ };
10429
+ /**
10430
+ * @description Billing period.
9296
10431
  * @enum {string}
9297
10432
  */
9298
- type: "oneOff" | "recurring";
9299
- }[];
9300
- /**
9301
- * Format: uuid
9302
- * @description ID of the location this subscription belongs to.
9303
- */
9304
- locationRef: string;
9305
- /**
9306
- * Format: uuid
9307
- * @description ID of the membership this subscription belongs to.
9308
- */
9309
- membershipRef?: string;
9310
- /**
9311
- * Format: uuid
9312
- * @description ID of the network this subscription belongs to.
9313
- */
9314
- networkRef: string;
9315
- /** @description Next billing interval. */
9316
- nextInterval?: {
10433
+ period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
10434
+ /** @description Total recurring price of the subscription. */
10435
+ price: number;
9317
10436
  /**
9318
10437
  * Format: date-time
9319
- * @description ISO timestamp when the next interval ends.
10438
+ * @description ISO timestamp of when the subscription was purchased.
9320
10439
  */
9321
- endDate?: string;
10440
+ purchaseDate?: string;
9322
10441
  /**
9323
10442
  * Format: date-time
9324
- * @description ISO timestamp when the next interval starts.
10443
+ * @description ISO timestamp when the subscription starts.
9325
10444
  */
9326
10445
  startDate: string;
9327
- };
9328
- /** @description Payment collection pause settings. */
9329
- pausePaymentCollection?: {
10446
+ /** @description Whether the start date is fixed. */
10447
+ startFixed: boolean;
9330
10448
  /**
9331
- * @description Behavior while payment collection is paused.
10449
+ * @description Subscription status.
9332
10450
  * @enum {string}
9333
10451
  */
9334
- behavior: "draft" | "void";
9335
- /**
9336
- * Format: date-time
9337
- * @description ISO timestamp when payment collection was paused.
9338
- */
9339
- createDate: string;
10452
+ status: "active" | "scheduled" | "incomplete" | "incompleteExpired" | "canceled";
9340
10453
  /**
9341
- * Format: date-time
9342
- * @description ISO timestamp when payment collection resumes.
10454
+ * @description Whether the subscription belongs to a company or user.
10455
+ * @enum {string}
9343
10456
  */
9344
- resumesAt?: string;
9345
- };
9346
- /** @description Payment status for subscriptions created by the current user. */
9347
- payment?: {
9348
- /** @description Pending payment request details. */
9349
- request?: {
10457
+ subscriptionType: "company" | "user";
10458
+ /** @description Timezone identifier for billing dates. */
10459
+ timezoneId: string;
10460
+ /** @description User associated with this subscription. */
10461
+ user?: {
10462
+ /** @description User bio. */
10463
+ about?: string | null;
10464
+ /** @description User email address. */
10465
+ email?: string | null;
9350
10466
  /**
9351
10467
  * Format: uuid
9352
- * @description Unique identifier of the payment request.
10468
+ * @description Unique identifier of the user.
9353
10469
  */
9354
10470
  id: string;
9355
- /** @description URL to complete the payment. */
9356
- url: string;
10471
+ /** @description User first name. */
10472
+ name?: string | null;
10473
+ /** @description User phone number. */
10474
+ phoneNumber?: string | null;
10475
+ /** @description User profile photo URL. */
10476
+ photoUrl?: string | null;
10477
+ /** @description User last name. */
10478
+ surname?: string | null;
10479
+ };
10480
+ /** @description User who created this subscription. */
10481
+ userCreator?: {
10482
+ /** @description User bio. */
10483
+ about?: string | null;
10484
+ /** @description User email address. */
10485
+ email?: string | null;
10486
+ /**
10487
+ * Format: uuid
10488
+ * @description Unique identifier of the user.
10489
+ */
10490
+ id: string;
10491
+ /** @description User first name. */
10492
+ name?: string | null;
10493
+ /** @description User phone number. */
10494
+ phoneNumber?: string | null;
10495
+ /** @description User profile photo URL. */
10496
+ photoUrl?: string | null;
10497
+ /** @description User last name. */
10498
+ surname?: string | null;
9357
10499
  };
9358
- /** @description Payment status. */
9359
- status: string;
9360
- };
9361
- /** @description Invoice payment settings by product type. */
9362
- payWithInvoice: {
9363
- /** @description Whether credit packages are invoiced. */
9364
- creditPackages: boolean;
9365
- /** @description Whether desk bookings are invoiced. */
9366
- desks: boolean;
9367
- /** @description Whether equipment bookings are invoiced. */
9368
- equipment?: boolean;
9369
- /** @description Whether events are invoiced. */
9370
- events: boolean;
9371
- /** @description Whether parking bookings are invoiced. */
9372
- parking?: boolean;
9373
- /** @description Whether room bookings are invoiced. */
9374
- rooms: boolean;
9375
- /** @description Whether shop purchases are invoiced. */
9376
- shop: boolean;
9377
- };
9378
- /**
9379
- * @description Billing period.
9380
- * @enum {string}
9381
- */
9382
- period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
9383
- /** @description Total recurring price of the subscription. */
9384
- price: number;
9385
- /**
9386
- * Format: date-time
9387
- * @description ISO timestamp of when the subscription was purchased.
9388
- */
9389
- purchaseDate?: string;
9390
- /**
9391
- * Format: date-time
9392
- * @description ISO timestamp when the subscription starts.
9393
- */
9394
- startDate: string;
9395
- /** @description Whether the start date is fixed. */
9396
- startFixed: boolean;
9397
- /**
9398
- * @description Subscription status.
9399
- * @enum {string}
9400
- */
9401
- status: "active" | "scheduled" | "incomplete" | "incompleteExpired" | "canceled";
9402
- /**
9403
- * @description Whether the subscription belongs to a company or user.
9404
- * @enum {string}
9405
- */
9406
- subscriptionType: "company" | "user";
9407
- /** @description Timezone identifier for billing dates. */
9408
- timezoneId: string;
9409
- /** @description User associated with this subscription. */
9410
- user?: {
9411
- /** @description User bio. */
9412
- about?: string | null;
9413
- /** @description User email address. */
9414
- email?: string | null;
9415
- /**
9416
- * Format: uuid
9417
- * @description Unique identifier of the user.
9418
- */
9419
- id: string;
9420
- /** @description User first name. */
9421
- name?: string | null;
9422
- /** @description User phone number. */
9423
- phoneNumber?: string | null;
9424
- /** @description User profile photo URL. */
9425
- photoUrl?: string | null;
9426
- /** @description User last name. */
9427
- surname?: string | null;
9428
- };
9429
- /** @description User who created this subscription. */
9430
- userCreator?: {
9431
- /** @description User bio. */
9432
- about?: string | null;
9433
- /** @description User email address. */
9434
- email?: string | null;
9435
10500
  /**
9436
10501
  * Format: uuid
9437
- * @description Unique identifier of the user.
10502
+ * @description ID of the user associated with this subscription.
9438
10503
  */
9439
- id: string;
9440
- /** @description User first name. */
9441
- name?: string | null;
9442
- /** @description User phone number. */
9443
- phoneNumber?: string | null;
9444
- /** @description User profile photo URL. */
9445
- photoUrl?: string | null;
9446
- /** @description User last name. */
9447
- surname?: string | null;
10504
+ userRef?: string;
9448
10505
  };
9449
- /**
9450
- * Format: uuid
9451
- * @description ID of the user associated with this subscription.
9452
- */
9453
- userRef?: string;
9454
10506
  };
9455
10507
  ticket: {
9456
10508
  /**
@@ -10231,7 +11283,7 @@ interface components {
10231
11283
  * @description Exchange rate provider when auto-update is enabled.
10232
11284
  * @enum {string}
10233
11285
  */
10234
- provider: "fastForex" | "nbu" | "bcra";
11286
+ provider: "fastForex" | "nbu" | "bcra" | "nbg";
10235
11287
  } | {
10236
11288
  /** @description Exchange rate relative to the location main currency. */
10237
11289
  exchangeRate: number;
@@ -10248,7 +11300,7 @@ interface components {
10248
11300
  * @description Exchange rate provider when auto-update is enabled.
10249
11301
  * @enum {string}
10250
11302
  */
10251
- provider: "fastForex" | "nbu" | "bcra";
11303
+ provider: "fastForex" | "nbu" | "bcra" | "nbg";
10252
11304
  } | {
10253
11305
  /** @description Exchange rate relative to the location main currency. */
10254
11306
  exchangeRate: number;
@@ -14278,6 +15330,10 @@ interface operations {
14278
15330
  query?: {
14279
15331
  /** @description Deprecated. Use customerRef instead. UUID of the company whose invoices to list. */
14280
15332
  companyRef?: string;
15333
+ /** @description Filter invoices created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
15334
+ "createDate[gte]"?: string;
15335
+ /** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
15336
+ "createDate[lte]"?: string;
14281
15337
  /** @description UUID of the customer whose invoices to list. */
14282
15338
  customerRef?: string;
14283
15339
  /** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
@@ -18408,13 +19464,28 @@ interface operations {
18408
19464
  };
18409
19465
  getSubscriptions: {
18410
19466
  parameters: {
18411
- query: {
18412
- /** @description The id of the location. */
18413
- locationRef: string;
18414
- /** @description The number of items to return */
19467
+ query?: {
19468
+ /** @description UUID of the customer whose subscriptions to list. */
19469
+ customerRef?: string;
19470
+ /** @description Maximum number of subscriptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
18415
19471
  limit?: number;
18416
- /** @description Token to retrieve the next page of results. */
18417
- nextPageToken?: components["schemas"]["nextPageToken"];
19472
+ /** @description UUID of the location whose subscriptions to list. */
19473
+ locationRef?: string;
19474
+ /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
19475
+ nextPageToken?: string;
19476
+ /** @description Sort order for results. */
19477
+ order?: string;
19478
+ /**
19479
+ * @description Filter by subscription status. Comma-separated values, e.g. `active,scheduled`. Defaults to `active`, `scheduled`, and `incomplete` when omitted.
19480
+ *
19481
+ * Supported values:
19482
+ * - **active** — currently active
19483
+ * - **scheduled** — scheduled to start
19484
+ * - **incomplete** — pending setup or payment
19485
+ * - **incompleteExpired** — incomplete and expired
19486
+ * - **canceled** — canceled
19487
+ */
19488
+ status?: string;
18418
19489
  };
18419
19490
  header?: {
18420
19491
  /** @description The id of the network. Required when using bearer token authentication */
@@ -18431,11 +19502,7 @@ interface operations {
18431
19502
  [name: string]: unknown;
18432
19503
  };
18433
19504
  content: {
18434
- "application/json": {
18435
- nextPageToken?: components["schemas"]["nextPageToken"];
18436
- searchQueryNext?: components["schemas"]["searchQueryNext"];
18437
- subscriptions?: components["schemas"]["subscription"][];
18438
- };
19505
+ "application/json": components["schemas"]["getSubscriptions"];
18439
19506
  };
18440
19507
  };
18441
19508
  /** @description Bad Request */
@@ -18492,7 +19559,7 @@ interface operations {
18492
19559
  };
18493
19560
  path: {
18494
19561
  /** @description The id of the subscription. */
18495
- id: string;
19562
+ subscriptionId: string;
18496
19563
  };
18497
19564
  cookie?: never;
18498
19565
  };
@@ -18504,9 +19571,7 @@ interface operations {
18504
19571
  [name: string]: unknown;
18505
19572
  };
18506
19573
  content: {
18507
- "application/json": {
18508
- subscription?: components["schemas"]["subscription"];
18509
- };
19574
+ "application/json": components["schemas"]["getSubscription"];
18510
19575
  };
18511
19576
  };
18512
19577
  /** @description Bad Request */
@@ -18529,7 +19594,7 @@ interface operations {
18529
19594
  };
18530
19595
  path: {
18531
19596
  /** @description The id of the subscription. */
18532
- id: string;
19597
+ subscriptionId: string;
18533
19598
  };
18534
19599
  cookie?: never;
18535
19600
  };
@@ -18562,7 +19627,7 @@ interface operations {
18562
19627
  };
18563
19628
  path: {
18564
19629
  /** @description The id of the subscription. */
18565
- id: string;
19630
+ subscriptionId: string;
18566
19631
  };
18567
19632
  cookie?: never;
18568
19633
  };
@@ -18595,7 +19660,7 @@ interface operations {
18595
19660
  };
18596
19661
  path: {
18597
19662
  /** @description The id of the subscription. */
18598
- id: string;
19663
+ subscriptionId: string;
18599
19664
  };
18600
19665
  cookie?: never;
18601
19666
  };
@@ -18629,7 +19694,7 @@ interface operations {
18629
19694
  header?: never;
18630
19695
  path: {
18631
19696
  /** @description The id of the subscription. */
18632
- id: string;
19697
+ subscriptionId: string;
18633
19698
  /** @description The id of the subscription item. */
18634
19699
  itemId: string;
18635
19700
  };
@@ -18661,7 +19726,7 @@ interface operations {
18661
19726
  header?: never;
18662
19727
  path: {
18663
19728
  /** @description The id of the subscription. */
18664
- id: string;
19729
+ subscriptionId: string;
18665
19730
  /** @description The id of the subscription item. */
18666
19731
  itemId: string;
18667
19732
  };
@@ -19901,6 +20966,11 @@ interface SpacebringDefaults {
19901
20966
  /** Sent as the `spacebring-network-id` header where the API requires it. */
19902
20967
  networkId?: string;
19903
20968
  }
20969
+ /** Per-request options accepted by every generated facade method. */
20970
+ interface SpacebringRequestOptions {
20971
+ /** Aborts the request — including any pending retry wait — when triggered. */
20972
+ signal?: AbortSignal;
20973
+ }
19904
20974
 
19905
20975
  /** A Contact entity as returned by the Spacebring API. */
19906
20976
  type Contact = NonNullable<operations["getContact"]["responses"][200]["content"]["application/json"]["contact"]>;
@@ -20005,285 +21075,285 @@ type AltCurrency = NonNullable<operations["getAltCurrencies"]["responses"][200][
20005
21075
 
20006
21076
  declare function createResources(client: Client<paths>, defaults: SpacebringDefaults): {
20007
21077
  altCurrencies: {
20008
- list(query: operations["getAltCurrencies"]["parameters"]["query"]): Promise<operations["getAltCurrencies"]["responses"][200]["content"]["application/json"]>;
20009
- iterate(query: Omit<NonNullable<operations["getAltCurrencies"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<AltCurrency, void, undefined>;
20010
- create(body: NonNullable<operations["createAltCurrency"]["requestBody"]>["content"]["application/json"]): Promise<AltCurrency>;
20011
- update(id: string, body: NonNullable<operations["updateAltCurrency"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
20012
- delete(id: string): Promise<undefined>;
21078
+ list(query: operations["getAltCurrencies"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getAltCurrencies"]["responses"][200]["content"]["application/json"]>;
21079
+ iterate(query: Omit<NonNullable<operations["getAltCurrencies"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<AltCurrency, void, undefined>;
21080
+ create(body: NonNullable<operations["createAltCurrency"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<AltCurrency>;
21081
+ update(id: string, body: NonNullable<operations["updateAltCurrency"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
21082
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
20013
21083
  };
20014
21084
  benefits: {
20015
- list(query?: operations["getBenefits"]["parameters"]["query"]): Promise<operations["getBenefits"]["responses"][200]["content"]["application/json"]>;
20016
- iterate(query?: Omit<NonNullable<operations["getBenefits"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Benefit, void, undefined>;
20017
- get(benefitId: string): Promise<Benefit>;
20018
- create(body: NonNullable<operations["createBenefit"]["requestBody"]>["content"]["application/json"]): Promise<operations["createBenefit"]["responses"][201]["content"]["application/json"]>;
20019
- update(benefitId: string, body: NonNullable<operations["updateBenefit"]["requestBody"]>["content"]["application/json"]): Promise<Benefit>;
20020
- delete(benefitId: string): Promise<undefined>;
21085
+ list(query?: operations["getBenefits"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getBenefits"]["responses"][200]["content"]["application/json"]>;
21086
+ iterate(query?: Omit<NonNullable<operations["getBenefits"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Benefit, void, undefined>;
21087
+ get(benefitId: string, options?: SpacebringRequestOptions): Promise<Benefit>;
21088
+ create(body: NonNullable<operations["createBenefit"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<operations["createBenefit"]["responses"][201]["content"]["application/json"]>;
21089
+ update(benefitId: string, body: NonNullable<operations["updateBenefit"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Benefit>;
21090
+ delete(benefitId: string, options?: SpacebringRequestOptions): Promise<undefined>;
20021
21091
  applications: {
20022
- list(query?: operations["getBenefitApplications"]["parameters"]["query"]): Promise<operations["getBenefitApplications"]["responses"][200]["content"]["application/json"]>;
20023
- iterate(query?: Omit<NonNullable<operations["getBenefitApplications"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Application, void, undefined>;
20024
- get(benefitApplicationId: string): Promise<Application>;
20025
- create(body: NonNullable<operations["applyBenefit"]["requestBody"]>["content"]["application/json"]): Promise<Application>;
21092
+ list(query?: operations["getBenefitApplications"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getBenefitApplications"]["responses"][200]["content"]["application/json"]>;
21093
+ iterate(query?: Omit<NonNullable<operations["getBenefitApplications"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Application, void, undefined>;
21094
+ get(benefitApplicationId: string, options?: SpacebringRequestOptions): Promise<Application>;
21095
+ create(body: NonNullable<operations["applyBenefit"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Application>;
20026
21096
  };
20027
21097
  categories: {
20028
- list(query: operations["getBenefitCategories"]["parameters"]["query"]): Promise<BenefitCategory[]>;
20029
- get(categoryId: string): Promise<BenefitCategory>;
20030
- create(body: NonNullable<operations["createBenefitCategory"]["requestBody"]>["content"]["application/json"]): Promise<BenefitCategory>;
20031
- update(categoryId: string, body: NonNullable<operations["updateBenefitCategory"]["requestBody"]>["content"]["application/json"]): Promise<BenefitCategory>;
20032
- delete(categoryId: string): Promise<undefined>;
21098
+ list(query: operations["getBenefitCategories"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<BenefitCategory[]>;
21099
+ get(categoryId: string, options?: SpacebringRequestOptions): Promise<BenefitCategory>;
21100
+ create(body: NonNullable<operations["createBenefitCategory"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<BenefitCategory>;
21101
+ update(categoryId: string, body: NonNullable<operations["updateBenefitCategory"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<BenefitCategory>;
21102
+ delete(categoryId: string, options?: SpacebringRequestOptions): Promise<undefined>;
20033
21103
  };
20034
21104
  };
20035
21105
  billing: {
20036
21106
  creditNotes: {
20037
- list(query?: operations["getCreditNotes"]["parameters"]["query"]): Promise<operations["getCreditNotes"]["responses"][200]["content"]["application/json"]>;
20038
- iterate(query?: Omit<NonNullable<operations["getCreditNotes"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<CreditNote, void, undefined>;
20039
- get(id: string): Promise<CreditNote>;
20040
- create(body: NonNullable<operations["createCreditNote"]["requestBody"]>["content"]["application/json"]): Promise<CreditNote>;
20041
- update(id: string, body: NonNullable<operations["updateCreditNote"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
20042
- preview(body: NonNullable<operations["previewCreditNote"]["requestBody"]>["content"]["application/json"]): Promise<CreditNote>;
21107
+ list(query?: operations["getCreditNotes"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getCreditNotes"]["responses"][200]["content"]["application/json"]>;
21108
+ iterate(query?: Omit<NonNullable<operations["getCreditNotes"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CreditNote, void, undefined>;
21109
+ get(id: string, options?: SpacebringRequestOptions): Promise<CreditNote>;
21110
+ create(body: NonNullable<operations["createCreditNote"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<CreditNote>;
21111
+ update(id: string, body: NonNullable<operations["updateCreditNote"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
21112
+ preview(body: NonNullable<operations["previewCreditNote"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<CreditNote>;
20043
21113
  };
20044
21114
  invoices: {
20045
- list(query?: operations["getInvoices"]["parameters"]["query"]): Promise<operations["getInvoices"]["responses"][200]["content"]["application/json"]>;
20046
- iterate(query?: Omit<NonNullable<operations["getInvoices"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Invoice, void, undefined>;
20047
- get(invoiceId: string): Promise<Invoice>;
20048
- create(body: NonNullable<operations["createInvoice"]["requestBody"]>["content"]["application/json"]): Promise<Invoice>;
20049
- update(invoiceId: string, body: NonNullable<operations["updateInvoice"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
20050
- delete(invoiceId: string): Promise<undefined>;
20051
- cancelPayment(invoiceId: string): Promise<undefined>;
20052
- duplicate(invoiceId: string): Promise<Invoice>;
20053
- getItems(invoiceId: string): Promise<operations["getInvoiceItems"]["responses"][200]["content"]["application/json"]>;
20054
- getUpcoming(query?: operations["getUpcomingInvoice"]["parameters"]["query"]): Promise<operations["getUpcomingInvoice"]["responses"][200]["content"]["application/json"]>;
20055
- issue(invoiceId: string, body?: NonNullable<operations["issueInvoice"]["requestBody"]>["content"]["application/json"]): Promise<operations["issueInvoice"]["responses"][200]["content"]["application/json"]>;
20056
- pay(invoiceId: string, body: NonNullable<operations["payInvoice"]["requestBody"]>["content"]["application/json"]): Promise<operations["payInvoice"]["responses"][200]["content"]["application/json"]>;
20057
- resend(invoiceId: string): Promise<undefined>;
20058
- void(invoiceId: string): Promise<undefined>;
21115
+ list(query?: operations["getInvoices"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getInvoices"]["responses"][200]["content"]["application/json"]>;
21116
+ iterate(query?: Omit<NonNullable<operations["getInvoices"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Invoice, void, undefined>;
21117
+ get(invoiceId: string, options?: SpacebringRequestOptions): Promise<Invoice>;
21118
+ create(body: NonNullable<operations["createInvoice"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Invoice>;
21119
+ update(invoiceId: string, body: NonNullable<operations["updateInvoice"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
21120
+ delete(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
21121
+ cancelPayment(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
21122
+ duplicate(invoiceId: string, options?: SpacebringRequestOptions): Promise<Invoice>;
21123
+ getItems(invoiceId: string, options?: SpacebringRequestOptions): Promise<operations["getInvoiceItems"]["responses"][200]["content"]["application/json"]>;
21124
+ getUpcoming(query?: operations["getUpcomingInvoice"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getUpcomingInvoice"]["responses"][200]["content"]["application/json"]>;
21125
+ issue(invoiceId: string, body?: NonNullable<operations["issueInvoice"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<operations["issueInvoice"]["responses"][200]["content"]["application/json"]>;
21126
+ pay(invoiceId: string, body: NonNullable<operations["payInvoice"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<operations["payInvoice"]["responses"][200]["content"]["application/json"]>;
21127
+ resend(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
21128
+ void(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
20059
21129
  items: {
20060
- get(id: string): Promise<InvoiceItem>;
20061
- create(body: NonNullable<operations["createInvoiceItem"]["requestBody"]>["content"]["application/json"]): Promise<InvoiceItem>;
20062
- update(id: string, body: NonNullable<operations["updateInvoiceItem"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
20063
- delete(id: string): Promise<undefined>;
20064
- getUpcoming(query?: operations["getUpcomingInvoiceItems"]["parameters"]["query"]): Promise<InvoiceItem[]>;
21130
+ get(id: string, options?: SpacebringRequestOptions): Promise<InvoiceItem>;
21131
+ create(body: NonNullable<operations["createInvoiceItem"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<InvoiceItem>;
21132
+ update(id: string, body: NonNullable<operations["updateInvoiceItem"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
21133
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
21134
+ getUpcoming(query?: operations["getUpcomingInvoiceItems"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<InvoiceItem[]>;
20065
21135
  };
20066
21136
  };
20067
21137
  };
20068
21138
  community: {
20069
21139
  companies: {
20070
- list(query: operations["getCompanies"]["parameters"]["query"]): Promise<operations["getCompanies"]["responses"][200]["content"]["application/json"]>;
20071
- iterate(query: Omit<NonNullable<operations["getCompanies"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Company, void, undefined>;
20072
- get(id: string): Promise<Company>;
20073
- create(body: NonNullable<operations["createCompany"]["requestBody"]>["content"]["application/json"]): Promise<Company>;
20074
- update(id: string, body: NonNullable<operations["updateCompany"]["requestBody"]>["content"]["application/json"]): Promise<Company>;
21140
+ list(query: operations["getCompanies"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getCompanies"]["responses"][200]["content"]["application/json"]>;
21141
+ iterate(query: Omit<NonNullable<operations["getCompanies"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Company, void, undefined>;
21142
+ get(id: string, options?: SpacebringRequestOptions): Promise<Company>;
21143
+ create(body: NonNullable<operations["createCompany"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Company>;
21144
+ update(id: string, body: NonNullable<operations["updateCompany"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Company>;
20075
21145
  };
20076
21146
  memberships: {
20077
- list(query: operations["getMemberships"]["parameters"]["query"]): Promise<operations["getMemberships"]["responses"][200]["content"]["application/json"]>;
20078
- iterate(query: Omit<NonNullable<operations["getMemberships"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Membership, void, undefined>;
20079
- get(id: string): Promise<Membership>;
20080
- create(body: NonNullable<operations["createMembership"]["requestBody"]>["content"]["application/json"]): Promise<Membership>;
20081
- update(id: number, body: NonNullable<operations["updateMembership"]["requestBody"]>["content"]["application/json"]): Promise<Membership>;
20082
- delete(id: string): Promise<undefined>;
20083
- iterateDeleted(query: Omit<NonNullable<operations["getMembershipsDeleted"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Membership, void, undefined>;
20084
- listDeleted(query: operations["getMembershipsDeleted"]["parameters"]["query"]): Promise<operations["getMembershipsDeleted"]["responses"][200]["content"]["application/json"]>;
21147
+ list(query: operations["getMemberships"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getMemberships"]["responses"][200]["content"]["application/json"]>;
21148
+ iterate(query: Omit<NonNullable<operations["getMemberships"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Membership, void, undefined>;
21149
+ get(id: string, options?: SpacebringRequestOptions): Promise<Membership>;
21150
+ create(body: NonNullable<operations["createMembership"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Membership>;
21151
+ update(id: number, body: NonNullable<operations["updateMembership"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Membership>;
21152
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
21153
+ iterateDeleted(query: Omit<NonNullable<operations["getMembershipsDeleted"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Membership, void, undefined>;
21154
+ listDeleted(query: operations["getMembershipsDeleted"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getMembershipsDeleted"]["responses"][200]["content"]["application/json"]>;
20085
21155
  };
20086
21156
  };
20087
21157
  contracts: {
20088
- list(query?: operations["getContracts"]["parameters"]["query"]): Promise<operations["getContracts"]["responses"][200]["content"]["application/json"]>;
20089
- iterate(query?: Omit<NonNullable<operations["getContracts"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Contract, void, undefined>;
20090
- get(contractId: string): Promise<Contract>;
20091
- create(body: NonNullable<operations["createContract"]["requestBody"]>["content"]["application/json"]): Promise<Contract>;
20092
- delete(contractId: string): Promise<undefined>;
20093
- issue(contractId: string, body: NonNullable<operations["issueContract"]["requestBody"]>["content"]["application/json"]): Promise<Contract>;
20094
- terminate(contractId: string, body: NonNullable<operations["terminateContract"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
21158
+ list(query?: operations["getContracts"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getContracts"]["responses"][200]["content"]["application/json"]>;
21159
+ iterate(query?: Omit<NonNullable<operations["getContracts"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Contract, void, undefined>;
21160
+ get(contractId: string, options?: SpacebringRequestOptions): Promise<Contract>;
21161
+ create(body: NonNullable<operations["createContract"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Contract>;
21162
+ delete(contractId: string, options?: SpacebringRequestOptions): Promise<undefined>;
21163
+ issue(contractId: string, body: NonNullable<operations["issueContract"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Contract>;
21164
+ terminate(contractId: string, body: NonNullable<operations["terminateContract"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
20095
21165
  };
20096
21166
  discounts: {
20097
21167
  coupons: {
20098
- list(query: operations["getCoupons"]["parameters"]["query"]): Promise<operations["getCoupons"]["responses"][200]["content"]["application/json"]>;
20099
- iterate(query: Omit<NonNullable<operations["getCoupons"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Coupon, void, undefined>;
20100
- get(id: string): Promise<Coupon>;
20101
- create(body: NonNullable<operations["createCoupon"]["requestBody"]>["content"]["application/json"]): Promise<Coupon>;
20102
- update(id: string, body: NonNullable<operations["updateCoupon"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
20103
- delete(id: string): Promise<undefined>;
21168
+ list(query: operations["getCoupons"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getCoupons"]["responses"][200]["content"]["application/json"]>;
21169
+ iterate(query: Omit<NonNullable<operations["getCoupons"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Coupon, void, undefined>;
21170
+ get(id: string, options?: SpacebringRequestOptions): Promise<Coupon>;
21171
+ create(body: NonNullable<operations["createCoupon"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Coupon>;
21172
+ update(id: string, body: NonNullable<operations["updateCoupon"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
21173
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
20104
21174
  };
20105
21175
  promocodes: {
20106
- list(query?: operations["getPromocodes"]["parameters"]["query"]): Promise<Promocode[]>;
20107
- get(id: string): Promise<Promocode>;
20108
- create(body: NonNullable<operations["createPromocode"]["requestBody"]>["content"]["application/json"]): Promise<Promocode>;
20109
- archive(id: string): Promise<Promocode>;
21176
+ list(query?: operations["getPromocodes"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<Promocode[]>;
21177
+ get(id: string, options?: SpacebringRequestOptions): Promise<Promocode>;
21178
+ create(body: NonNullable<operations["createPromocode"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Promocode>;
21179
+ archive(id: string, options?: SpacebringRequestOptions): Promise<Promocode>;
20110
21180
  };
20111
21181
  redemptions: {
20112
- list(query?: operations["getDiscountRedemptions"]["parameters"]["query"]): Promise<operations["getDiscountRedemptions"]["responses"][200]["content"]["application/json"]>;
20113
- iterate(query?: Omit<NonNullable<operations["getDiscountRedemptions"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Redemption, void, undefined>;
21182
+ list(query?: operations["getDiscountRedemptions"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getDiscountRedemptions"]["responses"][200]["content"]["application/json"]>;
21183
+ iterate(query?: Omit<NonNullable<operations["getDiscountRedemptions"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Redemption, void, undefined>;
20114
21184
  };
20115
21185
  };
20116
21186
  events: {
20117
- list(query: operations["getEventsByOrganization"]["parameters"]["query"]): Promise<operations["getEventsByOrganization"]["responses"][200]["content"]["application/json"]>;
20118
- get(id: string): Promise<Event>;
20119
- create(body: NonNullable<operations["createEvent"]["requestBody"]>["content"]["application/json"]): Promise<Event>;
20120
- delete(id: string): Promise<undefined>;
20121
- cancel(id: string): Promise<Event>;
20122
- copy(id: string): Promise<Event>;
21187
+ list(query: operations["getEventsByOrganization"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getEventsByOrganization"]["responses"][200]["content"]["application/json"]>;
21188
+ get(id: string, options?: SpacebringRequestOptions): Promise<Event>;
21189
+ create(body: NonNullable<operations["createEvent"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Event>;
21190
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
21191
+ cancel(id: string, options?: SpacebringRequestOptions): Promise<Event>;
21192
+ copy(id: string, options?: SpacebringRequestOptions): Promise<Event>;
20123
21193
  tickets: {
20124
- list(query: operations["getEventTickets"]["parameters"]["query"]): Promise<operations["getEventTickets"]["responses"][200]["content"]["application/json"]>;
20125
- iterate(query: Omit<NonNullable<operations["getEventTickets"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<EventTicket, void, undefined>;
20126
- get(id: string): Promise<EventTicket>;
21194
+ list(query: operations["getEventTickets"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getEventTickets"]["responses"][200]["content"]["application/json"]>;
21195
+ iterate(query: Omit<NonNullable<operations["getEventTickets"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<EventTicket, void, undefined>;
21196
+ get(id: string, options?: SpacebringRequestOptions): Promise<EventTicket>;
20127
21197
  };
20128
21198
  };
20129
21199
  feed: {
20130
21200
  comments: {
20131
- create(body: NonNullable<operations["createFeedPostComment"]["requestBody"]>["content"]["application/json"]): Promise<FeedComment>;
20132
- delete(id: string): Promise<undefined>;
20133
- createLike(id: string): Promise<CommentLike>;
20134
- deleteLike(id: string): Promise<undefined>;
21201
+ create(body: NonNullable<operations["createFeedPostComment"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<FeedComment>;
21202
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
21203
+ createLike(id: string, options?: SpacebringRequestOptions): Promise<CommentLike>;
21204
+ deleteLike(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
20135
21205
  };
20136
21206
  posts: {
20137
- list(query: operations["getFeedPosts"]["parameters"]["query"]): Promise<operations["getFeedPosts"]["responses"][200]["content"]["application/json"]>;
20138
- iterate(query: Omit<NonNullable<operations["getFeedPosts"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Post, void, undefined>;
20139
- get(id: string): Promise<Post>;
20140
- create(body: NonNullable<operations["createFeedPost"]["requestBody"]>["content"]["application/json"]): Promise<Post>;
20141
- update(id: string, body: NonNullable<operations["updateFeedPost"]["requestBody"]>["content"]["application/json"]): Promise<Post>;
20142
- delete(id: string): Promise<undefined>;
20143
- createLike(id: string): Promise<PostLike>;
20144
- deleteLike(id: string): Promise<undefined>;
20145
- getComments(id: string): Promise<PostComment[]>;
20146
- getLikes(id: string): Promise<PostLike[]>;
21207
+ list(query: operations["getFeedPosts"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getFeedPosts"]["responses"][200]["content"]["application/json"]>;
21208
+ iterate(query: Omit<NonNullable<operations["getFeedPosts"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Post, void, undefined>;
21209
+ get(id: string, options?: SpacebringRequestOptions): Promise<Post>;
21210
+ create(body: NonNullable<operations["createFeedPost"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Post>;
21211
+ update(id: string, body: NonNullable<operations["updateFeedPost"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Post>;
21212
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
21213
+ createLike(id: string, options?: SpacebringRequestOptions): Promise<PostLike>;
21214
+ deleteLike(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
21215
+ getComments(id: string, options?: SpacebringRequestOptions): Promise<PostComment[]>;
21216
+ getLikes(id: string, options?: SpacebringRequestOptions): Promise<PostLike[]>;
20147
21217
  };
20148
21218
  };
20149
21219
  floors: {
20150
- list(query: operations["getFloors"]["parameters"]["query"]): Promise<operations["getFloors"]["responses"][200]["content"]["application/json"]>;
20151
- delete(id: string): Promise<undefined>;
21220
+ list(query: operations["getFloors"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getFloors"]["responses"][200]["content"]["application/json"]>;
21221
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
20152
21222
  };
20153
21223
  guides: {
20154
- list(query: operations["getGuides"]["parameters"]["query"]): Promise<operations["getGuides"]["responses"][200]["content"]["application/json"]>;
20155
- iterate(query: Omit<NonNullable<operations["getGuides"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Guide, void, undefined>;
20156
- get(guideId: string): Promise<Guide>;
20157
- create(body: NonNullable<operations["createGuide"]["requestBody"]>["content"]["application/json"]): Promise<Guide>;
20158
- update(guideId: string, body: NonNullable<operations["patchGuide"]["requestBody"]>["content"]["application/json"]): Promise<Guide>;
20159
- delete(guideId: string): Promise<undefined>;
21224
+ list(query: operations["getGuides"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getGuides"]["responses"][200]["content"]["application/json"]>;
21225
+ iterate(query: Omit<NonNullable<operations["getGuides"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Guide, void, undefined>;
21226
+ get(guideId: string, options?: SpacebringRequestOptions): Promise<Guide>;
21227
+ create(body: NonNullable<operations["createGuide"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Guide>;
21228
+ update(guideId: string, body: NonNullable<operations["patchGuide"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Guide>;
21229
+ delete(guideId: string, options?: SpacebringRequestOptions): Promise<undefined>;
20160
21230
  };
20161
21231
  locations: {
20162
- list(): Promise<Location[]>;
20163
- get(locationId: string): Promise<Location>;
21232
+ list(options?: SpacebringRequestOptions): Promise<Location[]>;
21233
+ get(locationId: string, options?: SpacebringRequestOptions): Promise<Location>;
20164
21234
  };
20165
21235
  networks: {
20166
- list(): Promise<Network[]>;
21236
+ list(options?: SpacebringRequestOptions): Promise<Network[]>;
20167
21237
  };
20168
21238
  plans: {
20169
- list(query?: operations["getPlans"]["parameters"]["query"]): Promise<operations["getPlans"]["responses"][200]["content"]["application/json"]>;
20170
- iterate(query?: Omit<NonNullable<operations["getPlans"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Plan, void, undefined>;
20171
- get(planId: string): Promise<Plan>;
20172
- create(body: NonNullable<operations["createPlan"]["requestBody"]>["content"]["application/json"]): Promise<Plan>;
20173
- update(planId: string, body: NonNullable<operations["updatePlan"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
20174
- delete(planId: string): Promise<undefined>;
21239
+ list(query?: operations["getPlans"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getPlans"]["responses"][200]["content"]["application/json"]>;
21240
+ iterate(query?: Omit<NonNullable<operations["getPlans"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Plan, void, undefined>;
21241
+ get(planId: string, options?: SpacebringRequestOptions): Promise<Plan>;
21242
+ create(body: NonNullable<operations["createPlan"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Plan>;
21243
+ update(planId: string, body: NonNullable<operations["updatePlan"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
21244
+ delete(planId: string, options?: SpacebringRequestOptions): Promise<undefined>;
20175
21245
  };
20176
21246
  registrations: {
20177
- list(query?: operations["getRegistrations"]["parameters"]["query"]): Promise<operations["getRegistrations"]["responses"][200]["content"]["application/json"]>;
20178
- iterate(query?: Omit<NonNullable<operations["getRegistrations"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Registration, void, undefined>;
21247
+ list(query?: operations["getRegistrations"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getRegistrations"]["responses"][200]["content"]["application/json"]>;
21248
+ iterate(query?: Omit<NonNullable<operations["getRegistrations"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Registration, void, undefined>;
20179
21249
  };
20180
21250
  resources: {
20181
- list(query: operations["getResources"]["parameters"]["query"]): Promise<operations["getResources"]["responses"][200]["content"]["application/json"]>;
20182
- iterate(query: Omit<NonNullable<operations["getResources"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Resource, void, undefined>;
20183
- get(id: string): Promise<Resource>;
20184
- create(body: NonNullable<operations["createResource"]["requestBody"]>["content"]["application/json"]): Promise<Resource>;
20185
- update(id: string, body: NonNullable<operations["patchResource"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
21251
+ list(query: operations["getResources"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getResources"]["responses"][200]["content"]["application/json"]>;
21252
+ iterate(query: Omit<NonNullable<operations["getResources"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Resource, void, undefined>;
21253
+ get(id: string, options?: SpacebringRequestOptions): Promise<Resource>;
21254
+ create(body: NonNullable<operations["createResource"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Resource>;
21255
+ update(id: string, body: NonNullable<operations["patchResource"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
20186
21256
  bookings: {
20187
- list(query?: operations["getBookings"]["parameters"]["query"]): Promise<operations["getBookings"]["responses"][200]["content"]["application/json"]>;
20188
- iterate(query?: Omit<NonNullable<operations["getBookings"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Booking, void, undefined>;
20189
- get(id: string): Promise<Booking>;
20190
- create(body: NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"]): Promise<Booking>;
20191
- delete(id: string): Promise<undefined>;
21257
+ list(query?: operations["getBookings"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getBookings"]["responses"][200]["content"]["application/json"]>;
21258
+ iterate(query?: Omit<NonNullable<operations["getBookings"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Booking, void, undefined>;
21259
+ get(id: string, options?: SpacebringRequestOptions): Promise<Booking>;
21260
+ create(body: NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Booking>;
21261
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
20192
21262
  };
20193
21263
  };
20194
21264
  shop: {
20195
21265
  categories: {
20196
- list(query: operations["getShopCategories"]["parameters"]["query"]): Promise<ShopCategory[]>;
20197
- get(categoryId: string): Promise<ShopCategory>;
20198
- create(body: NonNullable<operations["createShopCategory"]["requestBody"]>["content"]["application/json"]): Promise<ShopCategory>;
20199
- update(categoryId: string, body: NonNullable<operations["updateShopCategory"]["requestBody"]>["content"]["application/json"]): Promise<ShopCategory>;
20200
- delete(categoryId: string): Promise<undefined>;
21266
+ list(query: operations["getShopCategories"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<ShopCategory[]>;
21267
+ get(categoryId: string, options?: SpacebringRequestOptions): Promise<ShopCategory>;
21268
+ create(body: NonNullable<operations["createShopCategory"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<ShopCategory>;
21269
+ update(categoryId: string, body: NonNullable<operations["updateShopCategory"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<ShopCategory>;
21270
+ delete(categoryId: string, options?: SpacebringRequestOptions): Promise<undefined>;
20201
21271
  };
20202
21272
  orders: {
20203
- list(query?: operations["getOrders"]["parameters"]["query"]): Promise<operations["getOrders"]["responses"][200]["content"]["application/json"]>;
20204
- iterate(query?: Omit<NonNullable<operations["getOrders"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Order, void, undefined>;
20205
- get(orderId: string): Promise<Order>;
21273
+ list(query?: operations["getOrders"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getOrders"]["responses"][200]["content"]["application/json"]>;
21274
+ iterate(query?: Omit<NonNullable<operations["getOrders"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Order, void, undefined>;
21275
+ get(orderId: string, options?: SpacebringRequestOptions): Promise<Order>;
20206
21276
  };
20207
21277
  products: {
20208
- list(query?: operations["getProducts"]["parameters"]["query"]): Promise<operations["getProducts"]["responses"][200]["content"]["application/json"]>;
20209
- iterate(query?: Omit<NonNullable<operations["getProducts"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Product, void, undefined>;
20210
- get(productId: string): Promise<Product>;
20211
- create(body: NonNullable<operations["createProduct"]["requestBody"]>["content"]["application/json"]): Promise<Product>;
20212
- update(productId: string, body: NonNullable<operations["updateProduct"]["requestBody"]>["content"]["application/json"]): Promise<Product>;
20213
- delete(productId: string): Promise<undefined>;
21278
+ list(query?: operations["getProducts"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getProducts"]["responses"][200]["content"]["application/json"]>;
21279
+ iterate(query?: Omit<NonNullable<operations["getProducts"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Product, void, undefined>;
21280
+ get(productId: string, options?: SpacebringRequestOptions): Promise<Product>;
21281
+ create(body: NonNullable<operations["createProduct"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Product>;
21282
+ update(productId: string, body: NonNullable<operations["updateProduct"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Product>;
21283
+ delete(productId: string, options?: SpacebringRequestOptions): Promise<undefined>;
20214
21284
  };
20215
21285
  };
20216
21286
  subscriptions: {
20217
- list(query: operations["getSubscriptions"]["parameters"]["query"]): Promise<operations["getSubscriptions"]["responses"][200]["content"]["application/json"]>;
20218
- iterate(query: Omit<NonNullable<operations["getSubscriptions"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Subscription, void, undefined>;
20219
- get(id: string): Promise<Subscription>;
20220
- create(body: NonNullable<operations["createSubscription"]["requestBody"]>["content"]["application/json"]): Promise<Subscription>;
20221
- update(id: string, body: NonNullable<operations["updateSubscription"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
20222
- delete(id: string): Promise<undefined>;
20223
- createItem(id: string, body: NonNullable<operations["createSubscriptionItem"]["requestBody"]>["content"]["application/json"]): Promise<Subscription>;
20224
- deleteItem(id: string, itemId: string): Promise<undefined>;
20225
- updateItem(id: string, itemId: string, body: NonNullable<operations["updateSubscriptionItem"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
21287
+ list(query?: operations["getSubscriptions"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getSubscriptions"]["responses"][200]["content"]["application/json"]>;
21288
+ iterate(query?: Omit<NonNullable<operations["getSubscriptions"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Subscription, void, undefined>;
21289
+ get(subscriptionId: string, options?: SpacebringRequestOptions): Promise<Subscription>;
21290
+ create(body: NonNullable<operations["createSubscription"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Subscription>;
21291
+ update(subscriptionId: string, body: NonNullable<operations["updateSubscription"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
21292
+ delete(subscriptionId: string, options?: SpacebringRequestOptions): Promise<undefined>;
21293
+ createItem(subscriptionId: string, body: NonNullable<operations["createSubscriptionItem"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Subscription>;
21294
+ deleteItem(subscriptionId: string, itemId: string, options?: SpacebringRequestOptions): Promise<undefined>;
21295
+ updateItem(subscriptionId: string, itemId: string, body: NonNullable<operations["updateSubscriptionItem"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
20226
21296
  };
20227
21297
  support: {
20228
21298
  tickets: {
20229
- list(query: operations["getSupportTickets"]["parameters"]["query"]): Promise<operations["getSupportTickets"]["responses"][200]["content"]["application/json"]>;
20230
- iterate(query: Omit<NonNullable<operations["getSupportTickets"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<SupportTicket, void, undefined>;
20231
- get(id: string): Promise<operations["getSupportTicket"]["responses"][200]["content"]["application/json"]>;
20232
- create(body: NonNullable<operations["createSupportTicket"]["requestBody"]>["content"]["application/json"]): Promise<operations["createSupportTicket"]["responses"][201]["content"]["application/json"]>;
20233
- updateAssignee(id: string, body: NonNullable<operations["updateSupportTicketAssignee"]["requestBody"]>["content"]["application/json"]): Promise<operations["updateSupportTicketAssignee"]["responses"][200]["content"]["application/json"]>;
20234
- updateStatus(id: string, body: NonNullable<operations["updateSupportTicketStatus"]["requestBody"]>["content"]["application/json"]): Promise<operations["updateSupportTicketStatus"]["responses"][200]["content"]["application/json"]>;
20235
- updateType(id: string, body: NonNullable<operations["updateSupportTicketType"]["requestBody"]>["content"]["application/json"]): Promise<undefined>;
21299
+ list(query: operations["getSupportTickets"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getSupportTickets"]["responses"][200]["content"]["application/json"]>;
21300
+ iterate(query: Omit<NonNullable<operations["getSupportTickets"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<SupportTicket, void, undefined>;
21301
+ get(id: string, options?: SpacebringRequestOptions): Promise<operations["getSupportTicket"]["responses"][200]["content"]["application/json"]>;
21302
+ create(body: NonNullable<operations["createSupportTicket"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<operations["createSupportTicket"]["responses"][201]["content"]["application/json"]>;
21303
+ updateAssignee(id: string, body: NonNullable<operations["updateSupportTicketAssignee"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<operations["updateSupportTicketAssignee"]["responses"][200]["content"]["application/json"]>;
21304
+ updateStatus(id: string, body: NonNullable<operations["updateSupportTicketStatus"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<operations["updateSupportTicketStatus"]["responses"][200]["content"]["application/json"]>;
21305
+ updateType(id: string, body: NonNullable<operations["updateSupportTicketType"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<undefined>;
20236
21306
  comment: {
20237
- create(body: NonNullable<operations["createSupportTicketComment"]["requestBody"]>["content"]["application/json"]): Promise<Activity>;
20238
- delete(id: string): Promise<undefined>;
21307
+ create(body: NonNullable<operations["createSupportTicketComment"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Activity>;
21308
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
20239
21309
  };
20240
21310
  };
20241
21311
  };
20242
21312
  transactions: {
20243
21313
  balances: {
20244
- getCredits(id: string): Promise<Balance[]>;
20245
- getDayPasses(id: string): Promise<Balance[]>;
21314
+ getCredits(id: string, options?: SpacebringRequestOptions): Promise<Balance[]>;
21315
+ getDayPasses(id: string, options?: SpacebringRequestOptions): Promise<Balance[]>;
20246
21316
  };
20247
21317
  credits: {
20248
- list(query?: operations["getCreditsTransactions"]["parameters"]["query"]): Promise<operations["getCreditsTransactions"]["responses"][200]["content"]["application/json"]>;
20249
- iterate(query?: Omit<NonNullable<operations["getCreditsTransactions"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<CreditTransaction, void, undefined>;
20250
- create(body: NonNullable<operations["createCreditsTransaction"]["requestBody"]>["content"]["application/json"]): Promise<CreditTransaction>;
21318
+ list(query?: operations["getCreditsTransactions"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getCreditsTransactions"]["responses"][200]["content"]["application/json"]>;
21319
+ iterate(query?: Omit<NonNullable<operations["getCreditsTransactions"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CreditTransaction, void, undefined>;
21320
+ create(body: NonNullable<operations["createCreditsTransaction"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<CreditTransaction>;
20251
21321
  };
20252
21322
  dayPasses: {
20253
- list(query?: operations["getDayPassesTransactions"]["parameters"]["query"]): Promise<operations["getDayPassesTransactions"]["responses"][200]["content"]["application/json"]>;
20254
- iterate(query?: Omit<NonNullable<operations["getDayPassesTransactions"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<DayPassTransaction, void, undefined>;
20255
- create(body: NonNullable<operations["createDayPassesTransaction"]["requestBody"]>["content"]["application/json"]): Promise<DayPassTransaction>;
21323
+ list(query?: operations["getDayPassesTransactions"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getDayPassesTransactions"]["responses"][200]["content"]["application/json"]>;
21324
+ iterate(query?: Omit<NonNullable<operations["getDayPassesTransactions"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<DayPassTransaction, void, undefined>;
21325
+ create(body: NonNullable<operations["createDayPassesTransaction"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<DayPassTransaction>;
20256
21326
  };
20257
21327
  money: {
20258
- list(query: operations["getMoneyTransactions"]["parameters"]["query"]): Promise<operations["getMoneyTransactions"]["responses"][200]["content"]["application/json"]>;
20259
- iterate(query: Omit<NonNullable<operations["getMoneyTransactions"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<MoneyTransaction, void, undefined>;
20260
- get(id: string): Promise<MoneyTransaction>;
21328
+ list(query: operations["getMoneyTransactions"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getMoneyTransactions"]["responses"][200]["content"]["application/json"]>;
21329
+ iterate(query: Omit<NonNullable<operations["getMoneyTransactions"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<MoneyTransaction, void, undefined>;
21330
+ get(id: string, options?: SpacebringRequestOptions): Promise<MoneyTransaction>;
20261
21331
  };
20262
21332
  };
20263
21333
  visitors: {
20264
21334
  contacts: {
20265
- list(query: operations["getContacts"]["parameters"]["query"]): Promise<operations["getContacts"]["responses"][200]["content"]["application/json"]>;
20266
- iterate(query: Omit<NonNullable<operations["getContacts"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Contact, void, undefined>;
20267
- get(contactId: string): Promise<Contact>;
20268
- create(body: NonNullable<operations["createContact"]["requestBody"]>["content"]["application/json"]): Promise<Contact>;
21335
+ list(query: operations["getContacts"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getContacts"]["responses"][200]["content"]["application/json"]>;
21336
+ iterate(query: Omit<NonNullable<operations["getContacts"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Contact, void, undefined>;
21337
+ get(contactId: string, options?: SpacebringRequestOptions): Promise<Contact>;
21338
+ create(body: NonNullable<operations["createContact"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Contact>;
20269
21339
  };
20270
21340
  requests: {
20271
- list(query: operations["getRequests"]["parameters"]["query"]): Promise<operations["getRequests"]["responses"][200]["content"]["application/json"]>;
20272
- iterate(query: Omit<NonNullable<operations["getRequests"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<Request, void, undefined>;
20273
- get(id: string): Promise<Request>;
20274
- create(body: NonNullable<operations["createRequest"]["requestBody"]>["content"]["application/json"]): Promise<Request>;
20275
- approve(id: string): Promise<RequestVisit>;
20276
- reject(id: string): Promise<undefined>;
21341
+ list(query: operations["getRequests"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getRequests"]["responses"][200]["content"]["application/json"]>;
21342
+ iterate(query: Omit<NonNullable<operations["getRequests"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Request, void, undefined>;
21343
+ get(id: string, options?: SpacebringRequestOptions): Promise<Request>;
21344
+ create(body: NonNullable<operations["createRequest"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<Request>;
21345
+ approve(id: string, options?: SpacebringRequestOptions): Promise<RequestVisit>;
21346
+ reject(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
20277
21347
  };
20278
21348
  visits: {
20279
- list(query: operations["getVisits"]["parameters"]["query"]): Promise<operations["getVisits"]["responses"][200]["content"]["application/json"]>;
20280
- iterate(query: Omit<NonNullable<operations["getVisits"]["parameters"]["query"]>, "nextPageToken">): AsyncGenerator<VisitorVisit, void, undefined>;
20281
- get(id: string): Promise<VisitorVisit>;
20282
- create(body: NonNullable<operations["createVisit"]["requestBody"]>["content"]["application/json"]): Promise<VisitorVisit>;
20283
- update(id: string, body: NonNullable<operations["updateVisit"]["requestBody"]>["content"]["application/json"]): Promise<VisitorVisit>;
20284
- delete(id: string): Promise<undefined>;
20285
- checkIn(body: NonNullable<operations["checkInVisit"]["requestBody"]>["content"]["application/json"]): Promise<VisitorVisit>;
20286
- checkOut(body: NonNullable<operations["checkOutVisit"]["requestBody"]>["content"]["application/json"]): Promise<VisitorVisit>;
21349
+ list(query: operations["getVisits"]["parameters"]["query"], options?: SpacebringRequestOptions): Promise<operations["getVisits"]["responses"][200]["content"]["application/json"]>;
21350
+ iterate(query: Omit<NonNullable<operations["getVisits"]["parameters"]["query"]>, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<VisitorVisit, void, undefined>;
21351
+ get(id: string, options?: SpacebringRequestOptions): Promise<VisitorVisit>;
21352
+ create(body: NonNullable<operations["createVisit"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<VisitorVisit>;
21353
+ update(id: string, body: NonNullable<operations["updateVisit"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<VisitorVisit>;
21354
+ delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
21355
+ checkIn(body: NonNullable<operations["checkInVisit"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<VisitorVisit>;
21356
+ checkOut(body: NonNullable<operations["checkOutVisit"]["requestBody"]>["content"]["application/json"], options?: SpacebringRequestOptions): Promise<VisitorVisit>;
20287
21357
  };
20288
21358
  };
20289
21359
  };
@@ -20300,6 +21370,24 @@ interface SpacebringConfig {
20300
21370
  baseUrl?: string;
20301
21371
  /** Custom fetch implementation (testing, non-standard platforms). */
20302
21372
  fetch?: typeof globalThis.fetch;
21373
+ /**
21374
+ * How many times to retry a failed request. Retried: 429 rate limits
21375
+ * (any method — the API allows 10 requests/second and did not process the
21376
+ * request), plus 502/503/504 responses, network errors, and timeouts on
21377
+ * idempotent methods only (GET/HEAD/PUT/DELETE/OPTIONS — a gateway error
21378
+ * may have reached the API, so POSTs are never replayed). Waits per the
21379
+ * `Retry-After` header (seconds or HTTP-date), or with exponential backoff
21380
+ * when absent. Defaults to 3; 0 disables.
21381
+ */
21382
+ maxRetries?: number;
21383
+ /**
21384
+ * Timeout per request attempt in milliseconds (each retry attempt gets a
21385
+ * fresh budget). Timed-out attempts reject with a `TimeoutError` and are
21386
+ * retried like network errors. Off by default. Uses `AbortSignal.timeout`;
21387
+ * combining with a caller-supplied signal needs `AbortSignal.any`
21388
+ * (Node >= 20.3, all modern browsers/workers).
21389
+ */
21390
+ timeoutMs?: number;
20303
21391
  }
20304
21392
  interface Spacebring extends SpacebringResources {
20305
21393
  }
@@ -20318,7 +21406,14 @@ declare class SpacebringError extends Error {
20318
21406
  readonly status: number;
20319
21407
  /** Parsed error body returned by the API, if any. */
20320
21408
  readonly body: SpacebringErrorBody | undefined;
20321
- constructor(status: number, body?: unknown);
21409
+ /** The operation the request targeted, e.g. `GET /billing/invoices/v1/{invoiceId}`. */
21410
+ readonly operation: string | undefined;
21411
+ /** Full URL of the failed request, if known. */
21412
+ readonly url: string | undefined;
21413
+ constructor(status: number, body?: unknown, request?: {
21414
+ operation?: string;
21415
+ url?: string;
21416
+ });
20322
21417
  }
20323
21418
 
20324
- export { type Activity, type AltCurrency, type Application, type Balance, type Benefit, type BenefitCategory, type Booking, type CommentLike, type Company, type Contact, type Contract, type Coupon, type CreditNote, type CreditTransaction, type DayPassTransaction, type Event, type EventTicket, type FeedComment, type Guide, type Invoice, type InvoiceItem, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Plan, type Post, type PostComment, type PostLike, type Product, type Promocode, type Redemption, type Registration, type Request, type RequestVisit, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringResources, type Subscription, type SupportTicket, type VisitorVisit, type components, type operations, type paths };
21419
+ export { type Activity, type AltCurrency, type Application, type Balance, type Benefit, type BenefitCategory, type Booking, type CommentLike, type Company, type Contact, type Contract, type Coupon, type CreditNote, type CreditTransaction, type DayPassTransaction, type Event, type EventTicket, type FeedComment, type Guide, type Invoice, type InvoiceItem, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Plan, type Post, type PostComment, type PostLike, type Product, type Promocode, type Redemption, type Registration, type Request, type RequestVisit, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type VisitorVisit, type components, type operations, type paths };