@izak0s/spacebring-api 4.0.0 → 5.1.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/README.md +1 -1
- package/dist/index.cjs +21 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +457 -28
- package/dist/index.d.ts +457 -28
- package/dist/index.js +21 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2435,6 +2435,26 @@ interface paths {
|
|
|
2435
2435
|
patch?: never;
|
|
2436
2436
|
trace?: never;
|
|
2437
2437
|
};
|
|
2438
|
+
"/transactions/credits/scheduled/v1": {
|
|
2439
|
+
parameters: {
|
|
2440
|
+
query?: never;
|
|
2441
|
+
header?: never;
|
|
2442
|
+
path?: never;
|
|
2443
|
+
cookie?: never;
|
|
2444
|
+
};
|
|
2445
|
+
/**
|
|
2446
|
+
* Retrieve scheduled credits transactions
|
|
2447
|
+
* @description Retrieve scheduled credits transactions of a subscription or a customer. <h3>OAuth</h3>Required scopes: <code>transactions.readonly</code> or <code>transactions</code>
|
|
2448
|
+
*/
|
|
2449
|
+
get: operations["getScheduledCreditsTransactions"];
|
|
2450
|
+
put?: never;
|
|
2451
|
+
post?: never;
|
|
2452
|
+
delete?: never;
|
|
2453
|
+
options?: never;
|
|
2454
|
+
head?: never;
|
|
2455
|
+
patch?: never;
|
|
2456
|
+
trace?: never;
|
|
2457
|
+
};
|
|
2438
2458
|
"/transactions/credits/v1": {
|
|
2439
2459
|
parameters: {
|
|
2440
2460
|
query?: never;
|
|
@@ -3551,10 +3571,22 @@ interface components {
|
|
|
3551
3571
|
type: "company" | "user";
|
|
3552
3572
|
/** @description User details for membership customers. */
|
|
3553
3573
|
user?: {
|
|
3554
|
-
/**
|
|
3574
|
+
/** @description User bio. */
|
|
3575
|
+
about?: string | null;
|
|
3576
|
+
/** @description User email address. */
|
|
3577
|
+
email?: string | null;
|
|
3578
|
+
/**
|
|
3579
|
+
* Format: uuid
|
|
3580
|
+
* @description User ID.
|
|
3581
|
+
*/
|
|
3555
3582
|
id: string;
|
|
3583
|
+
/** @description First name. */
|
|
3556
3584
|
name?: string | null;
|
|
3585
|
+
/** @description Phone number. */
|
|
3586
|
+
phoneNumber?: string | null;
|
|
3587
|
+
/** @description Profile photo URL. */
|
|
3557
3588
|
photoUrl?: string | null;
|
|
3589
|
+
/** @description Last name. */
|
|
3558
3590
|
surname?: string | null;
|
|
3559
3591
|
};
|
|
3560
3592
|
};
|
|
@@ -3918,10 +3950,22 @@ interface components {
|
|
|
3918
3950
|
type: "company" | "user";
|
|
3919
3951
|
/** @description User details for membership customers. */
|
|
3920
3952
|
user?: {
|
|
3921
|
-
/**
|
|
3953
|
+
/** @description User bio. */
|
|
3954
|
+
about?: string | null;
|
|
3955
|
+
/** @description User email address. */
|
|
3956
|
+
email?: string | null;
|
|
3957
|
+
/**
|
|
3958
|
+
* Format: uuid
|
|
3959
|
+
* @description User ID.
|
|
3960
|
+
*/
|
|
3922
3961
|
id: string;
|
|
3962
|
+
/** @description First name. */
|
|
3923
3963
|
name?: string | null;
|
|
3964
|
+
/** @description Phone number. */
|
|
3965
|
+
phoneNumber?: string | null;
|
|
3966
|
+
/** @description Profile photo URL. */
|
|
3924
3967
|
photoUrl?: string | null;
|
|
3968
|
+
/** @description Last name. */
|
|
3925
3969
|
surname?: string | null;
|
|
3926
3970
|
};
|
|
3927
3971
|
};
|
|
@@ -4282,10 +4326,22 @@ interface components {
|
|
|
4282
4326
|
type: "company" | "user";
|
|
4283
4327
|
/** @description User details for membership customers. */
|
|
4284
4328
|
user?: {
|
|
4285
|
-
/**
|
|
4329
|
+
/** @description User bio. */
|
|
4330
|
+
about?: string | null;
|
|
4331
|
+
/** @description User email address. */
|
|
4332
|
+
email?: string | null;
|
|
4333
|
+
/**
|
|
4334
|
+
* Format: uuid
|
|
4335
|
+
* @description User ID.
|
|
4336
|
+
*/
|
|
4286
4337
|
id: string;
|
|
4338
|
+
/** @description First name. */
|
|
4287
4339
|
name?: string | null;
|
|
4340
|
+
/** @description Phone number. */
|
|
4341
|
+
phoneNumber?: string | null;
|
|
4342
|
+
/** @description Profile photo URL. */
|
|
4288
4343
|
photoUrl?: string | null;
|
|
4344
|
+
/** @description Last name. */
|
|
4289
4345
|
surname?: string | null;
|
|
4290
4346
|
};
|
|
4291
4347
|
};
|
|
@@ -5238,10 +5294,22 @@ interface components {
|
|
|
5238
5294
|
type: "company" | "user";
|
|
5239
5295
|
/** @description User details for membership customers. */
|
|
5240
5296
|
user?: {
|
|
5241
|
-
/**
|
|
5297
|
+
/** @description User bio. */
|
|
5298
|
+
about?: string | null;
|
|
5299
|
+
/** @description User email address. */
|
|
5300
|
+
email?: string | null;
|
|
5301
|
+
/**
|
|
5302
|
+
* Format: uuid
|
|
5303
|
+
* @description User ID.
|
|
5304
|
+
*/
|
|
5242
5305
|
id: string;
|
|
5306
|
+
/** @description First name. */
|
|
5243
5307
|
name?: string | null;
|
|
5308
|
+
/** @description Phone number. */
|
|
5309
|
+
phoneNumber?: string | null;
|
|
5310
|
+
/** @description Profile photo URL. */
|
|
5244
5311
|
photoUrl?: string | null;
|
|
5312
|
+
/** @description Last name. */
|
|
5245
5313
|
surname?: string | null;
|
|
5246
5314
|
};
|
|
5247
5315
|
};
|
|
@@ -5553,10 +5621,22 @@ interface components {
|
|
|
5553
5621
|
type: "company" | "user";
|
|
5554
5622
|
/** @description User details for membership customers. */
|
|
5555
5623
|
user?: {
|
|
5556
|
-
/**
|
|
5624
|
+
/** @description User bio. */
|
|
5625
|
+
about?: string | null;
|
|
5626
|
+
/** @description User email address. */
|
|
5627
|
+
email?: string | null;
|
|
5628
|
+
/**
|
|
5629
|
+
* Format: uuid
|
|
5630
|
+
* @description User ID.
|
|
5631
|
+
*/
|
|
5557
5632
|
id: string;
|
|
5633
|
+
/** @description First name. */
|
|
5558
5634
|
name?: string | null;
|
|
5635
|
+
/** @description Phone number. */
|
|
5636
|
+
phoneNumber?: string | null;
|
|
5637
|
+
/** @description Profile photo URL. */
|
|
5559
5638
|
photoUrl?: string | null;
|
|
5639
|
+
/** @description Last name. */
|
|
5560
5640
|
surname?: string | null;
|
|
5561
5641
|
};
|
|
5562
5642
|
};
|
|
@@ -12104,7 +12184,7 @@ interface components {
|
|
|
12104
12184
|
/** @description Whether the user is blocked. */
|
|
12105
12185
|
blocked?: boolean;
|
|
12106
12186
|
/** @description Email address when visible to the caller. */
|
|
12107
|
-
email?: string;
|
|
12187
|
+
email?: string | null;
|
|
12108
12188
|
/**
|
|
12109
12189
|
* Format: uuid
|
|
12110
12190
|
* @description Unique identifier of the user.
|
|
@@ -12113,7 +12193,7 @@ interface components {
|
|
|
12113
12193
|
/** @description First name of the user. */
|
|
12114
12194
|
name?: string | null;
|
|
12115
12195
|
/** @description Phone number when visible to the caller. */
|
|
12116
|
-
phoneNumber?: string;
|
|
12196
|
+
phoneNumber?: string | null;
|
|
12117
12197
|
/** @description Profile photo URL. */
|
|
12118
12198
|
photoUrl: string | null;
|
|
12119
12199
|
/** @description Surname of the user. */
|
|
@@ -12147,7 +12227,7 @@ interface components {
|
|
|
12147
12227
|
/** @description Whether the user is blocked. */
|
|
12148
12228
|
blocked?: boolean;
|
|
12149
12229
|
/** @description Email address when visible to the caller. */
|
|
12150
|
-
email?: string;
|
|
12230
|
+
email?: string | null;
|
|
12151
12231
|
/**
|
|
12152
12232
|
* Format: uuid
|
|
12153
12233
|
* @description Unique identifier of the user.
|
|
@@ -12156,7 +12236,7 @@ interface components {
|
|
|
12156
12236
|
/** @description First name of the user. */
|
|
12157
12237
|
name?: string | null;
|
|
12158
12238
|
/** @description Phone number when visible to the caller. */
|
|
12159
|
-
phoneNumber?: string;
|
|
12239
|
+
phoneNumber?: string | null;
|
|
12160
12240
|
/** @description Profile photo URL. */
|
|
12161
12241
|
photoUrl: string | null;
|
|
12162
12242
|
/** @description Surname of the user. */
|
|
@@ -12190,7 +12270,7 @@ interface components {
|
|
|
12190
12270
|
/** @description Whether the user is blocked. */
|
|
12191
12271
|
blocked?: boolean;
|
|
12192
12272
|
/** @description Email address when visible to the caller. */
|
|
12193
|
-
email?: string;
|
|
12273
|
+
email?: string | null;
|
|
12194
12274
|
/**
|
|
12195
12275
|
* Format: uuid
|
|
12196
12276
|
* @description Unique identifier of the user.
|
|
@@ -12199,7 +12279,7 @@ interface components {
|
|
|
12199
12279
|
/** @description First name of the user. */
|
|
12200
12280
|
name?: string | null;
|
|
12201
12281
|
/** @description Phone number when visible to the caller. */
|
|
12202
|
-
phoneNumber?: string;
|
|
12282
|
+
phoneNumber?: string | null;
|
|
12203
12283
|
/** @description Profile photo URL. */
|
|
12204
12284
|
photoUrl: string | null;
|
|
12205
12285
|
/** @description Surname of the user. */
|
|
@@ -12215,7 +12295,7 @@ interface components {
|
|
|
12215
12295
|
/** @description Whether the user is blocked. */
|
|
12216
12296
|
blocked?: boolean;
|
|
12217
12297
|
/** @description Email address when visible to the caller. */
|
|
12218
|
-
email?: string;
|
|
12298
|
+
email?: string | null;
|
|
12219
12299
|
/**
|
|
12220
12300
|
* Format: uuid
|
|
12221
12301
|
* @description Unique identifier of the user.
|
|
@@ -12224,7 +12304,7 @@ interface components {
|
|
|
12224
12304
|
/** @description First name of the user. */
|
|
12225
12305
|
name?: string | null;
|
|
12226
12306
|
/** @description Phone number when visible to the caller. */
|
|
12227
|
-
phoneNumber?: string;
|
|
12307
|
+
phoneNumber?: string | null;
|
|
12228
12308
|
/** @description Profile photo URL. */
|
|
12229
12309
|
photoUrl: string | null;
|
|
12230
12310
|
/** @description Surname of the user. */
|
|
@@ -12275,7 +12355,7 @@ interface components {
|
|
|
12275
12355
|
/** @description Whether the user is blocked. */
|
|
12276
12356
|
blocked?: boolean;
|
|
12277
12357
|
/** @description Email address when visible to the caller. */
|
|
12278
|
-
email?: string;
|
|
12358
|
+
email?: string | null;
|
|
12279
12359
|
/**
|
|
12280
12360
|
* Format: uuid
|
|
12281
12361
|
* @description Unique identifier of the user.
|
|
@@ -12284,7 +12364,7 @@ interface components {
|
|
|
12284
12364
|
/** @description First name of the user. */
|
|
12285
12365
|
name?: string | null;
|
|
12286
12366
|
/** @description Phone number when visible to the caller. */
|
|
12287
|
-
phoneNumber?: string;
|
|
12367
|
+
phoneNumber?: string | null;
|
|
12288
12368
|
/** @description Profile photo URL. */
|
|
12289
12369
|
photoUrl: string | null;
|
|
12290
12370
|
/** @description Surname of the user. */
|
|
@@ -12312,7 +12392,7 @@ interface components {
|
|
|
12312
12392
|
/** @description Whether the user is blocked. */
|
|
12313
12393
|
blocked?: boolean;
|
|
12314
12394
|
/** @description Email address when visible to the caller. */
|
|
12315
|
-
email?: string;
|
|
12395
|
+
email?: string | null;
|
|
12316
12396
|
/**
|
|
12317
12397
|
* Format: uuid
|
|
12318
12398
|
* @description Unique identifier of the user.
|
|
@@ -12321,7 +12401,7 @@ interface components {
|
|
|
12321
12401
|
/** @description First name of the user. */
|
|
12322
12402
|
name?: string | null;
|
|
12323
12403
|
/** @description Phone number when visible to the caller. */
|
|
12324
|
-
phoneNumber?: string;
|
|
12404
|
+
phoneNumber?: string | null;
|
|
12325
12405
|
/** @description Profile photo URL. */
|
|
12326
12406
|
photoUrl: string | null;
|
|
12327
12407
|
/** @description Surname of the user. */
|
|
@@ -12338,7 +12418,7 @@ interface components {
|
|
|
12338
12418
|
/** @description Whether the user is blocked. */
|
|
12339
12419
|
blocked?: boolean;
|
|
12340
12420
|
/** @description Email address when visible to the caller. */
|
|
12341
|
-
email?: string;
|
|
12421
|
+
email?: string | null;
|
|
12342
12422
|
/**
|
|
12343
12423
|
* Format: uuid
|
|
12344
12424
|
* @description Unique identifier of the user.
|
|
@@ -12347,7 +12427,7 @@ interface components {
|
|
|
12347
12427
|
/** @description First name of the user. */
|
|
12348
12428
|
name?: string | null;
|
|
12349
12429
|
/** @description Phone number when visible to the caller. */
|
|
12350
|
-
phoneNumber?: string;
|
|
12430
|
+
phoneNumber?: string | null;
|
|
12351
12431
|
/** @description Profile photo URL. */
|
|
12352
12432
|
photoUrl: string | null;
|
|
12353
12433
|
/** @description Surname of the user. */
|
|
@@ -12371,7 +12451,7 @@ interface components {
|
|
|
12371
12451
|
/** @description Whether the user is blocked. */
|
|
12372
12452
|
blocked?: boolean;
|
|
12373
12453
|
/** @description Email address when visible to the caller. */
|
|
12374
|
-
email?: string;
|
|
12454
|
+
email?: string | null;
|
|
12375
12455
|
/**
|
|
12376
12456
|
* Format: uuid
|
|
12377
12457
|
* @description Unique identifier of the user.
|
|
@@ -12380,7 +12460,7 @@ interface components {
|
|
|
12380
12460
|
/** @description First name of the user. */
|
|
12381
12461
|
name?: string | null;
|
|
12382
12462
|
/** @description Phone number when visible to the caller. */
|
|
12383
|
-
phoneNumber?: string;
|
|
12463
|
+
phoneNumber?: string | null;
|
|
12384
12464
|
/** @description Profile photo URL. */
|
|
12385
12465
|
photoUrl: string | null;
|
|
12386
12466
|
/** @description Surname of the user. */
|
|
@@ -12420,7 +12500,7 @@ interface components {
|
|
|
12420
12500
|
/** @description Whether the user is blocked. */
|
|
12421
12501
|
blocked?: boolean;
|
|
12422
12502
|
/** @description Email address when visible to the caller. */
|
|
12423
|
-
email?: string;
|
|
12503
|
+
email?: string | null;
|
|
12424
12504
|
/**
|
|
12425
12505
|
* Format: uuid
|
|
12426
12506
|
* @description Unique identifier of the user.
|
|
@@ -12429,7 +12509,7 @@ interface components {
|
|
|
12429
12509
|
/** @description First name of the user. */
|
|
12430
12510
|
name?: string | null;
|
|
12431
12511
|
/** @description Phone number when visible to the caller. */
|
|
12432
|
-
phoneNumber?: string;
|
|
12512
|
+
phoneNumber?: string | null;
|
|
12433
12513
|
/** @description Profile photo URL. */
|
|
12434
12514
|
photoUrl: string | null;
|
|
12435
12515
|
/** @description Surname of the user. */
|
|
@@ -12447,6 +12527,286 @@ interface components {
|
|
|
12447
12527
|
*/
|
|
12448
12528
|
type: "assigneeUpdated" | "comment" | "statusUpdated" | "ticketCreated";
|
|
12449
12529
|
};
|
|
12530
|
+
getScheduledCreditsTransactions: {
|
|
12531
|
+
/** @description Pagination token to fetch the next page of results. Returned when more results exist. */
|
|
12532
|
+
nextPageToken?: string;
|
|
12533
|
+
/** @description List of scheduled credits transactions. */
|
|
12534
|
+
scheduledTransactions: {
|
|
12535
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
12536
|
+
amount: number;
|
|
12537
|
+
/**
|
|
12538
|
+
* @deprecated
|
|
12539
|
+
* @description Deprecated. Use product instead.
|
|
12540
|
+
*/
|
|
12541
|
+
booking?: {
|
|
12542
|
+
/**
|
|
12543
|
+
* Format: uuid
|
|
12544
|
+
* @description Booking id.
|
|
12545
|
+
*/
|
|
12546
|
+
id: string;
|
|
12547
|
+
/** @description Booked resource. */
|
|
12548
|
+
resource: {
|
|
12549
|
+
/**
|
|
12550
|
+
* Format: uuid
|
|
12551
|
+
* @description Resource id.
|
|
12552
|
+
*/
|
|
12553
|
+
id: string;
|
|
12554
|
+
/** @description Resource title. */
|
|
12555
|
+
title: string;
|
|
12556
|
+
};
|
|
12557
|
+
};
|
|
12558
|
+
/**
|
|
12559
|
+
* @deprecated
|
|
12560
|
+
* @description Deprecated. Use customer instead.
|
|
12561
|
+
*/
|
|
12562
|
+
company?: {
|
|
12563
|
+
/**
|
|
12564
|
+
* Format: date-time
|
|
12565
|
+
* @description ISO timestamp of company creation.
|
|
12566
|
+
*/
|
|
12567
|
+
createDate: string;
|
|
12568
|
+
/**
|
|
12569
|
+
* Format: uuid
|
|
12570
|
+
* @description Company id.
|
|
12571
|
+
*/
|
|
12572
|
+
id: string;
|
|
12573
|
+
/**
|
|
12574
|
+
* Format: uuid
|
|
12575
|
+
* @description Location id.
|
|
12576
|
+
*/
|
|
12577
|
+
locationRef: string;
|
|
12578
|
+
/** @description Company logo. */
|
|
12579
|
+
logo?: {
|
|
12580
|
+
/** @description Storage key of the company logo. */
|
|
12581
|
+
key: string;
|
|
12582
|
+
/** @description Public URL of the company logo. */
|
|
12583
|
+
url: string;
|
|
12584
|
+
};
|
|
12585
|
+
/** @description Company metadata. */
|
|
12586
|
+
metadata?: {
|
|
12587
|
+
[key: string]: unknown;
|
|
12588
|
+
};
|
|
12589
|
+
/** @description Internal notes. */
|
|
12590
|
+
notes?: string;
|
|
12591
|
+
/** @description Public logo URL derived from the company website. */
|
|
12592
|
+
publicLogoUrl?: string;
|
|
12593
|
+
/**
|
|
12594
|
+
* Format: uuid
|
|
12595
|
+
* @description Primary subscription id.
|
|
12596
|
+
*/
|
|
12597
|
+
subscriptionRef: string | null;
|
|
12598
|
+
/** @description Company name. */
|
|
12599
|
+
title: string;
|
|
12600
|
+
};
|
|
12601
|
+
/**
|
|
12602
|
+
* Format: uuid
|
|
12603
|
+
* @deprecated
|
|
12604
|
+
* @description Deprecated. Use customer instead.
|
|
12605
|
+
*/
|
|
12606
|
+
companyRef?: string;
|
|
12607
|
+
/**
|
|
12608
|
+
* Format: date-time
|
|
12609
|
+
* @description ISO timestamp of when the scheduled transaction was created.
|
|
12610
|
+
*/
|
|
12611
|
+
createDate: string;
|
|
12612
|
+
/** @description Customer associated with this scheduled transaction. */
|
|
12613
|
+
customer: {
|
|
12614
|
+
/**
|
|
12615
|
+
* Format: uuid
|
|
12616
|
+
* @description ID of the company or membership.
|
|
12617
|
+
*/
|
|
12618
|
+
id: string;
|
|
12619
|
+
/** @description Company logo. */
|
|
12620
|
+
logo?: {
|
|
12621
|
+
key: string;
|
|
12622
|
+
url: string;
|
|
12623
|
+
};
|
|
12624
|
+
/** @description Company name. */
|
|
12625
|
+
title?: string;
|
|
12626
|
+
/**
|
|
12627
|
+
* @description Whether the customer is a company or a user.
|
|
12628
|
+
* @enum {string}
|
|
12629
|
+
*/
|
|
12630
|
+
type: "company" | "user";
|
|
12631
|
+
/** @description User details for membership customers. */
|
|
12632
|
+
user?: {
|
|
12633
|
+
about?: string | null;
|
|
12634
|
+
email?: string | null;
|
|
12635
|
+
/** Format: uuid */
|
|
12636
|
+
id: string;
|
|
12637
|
+
name?: string | null;
|
|
12638
|
+
phoneNumber?: string | null;
|
|
12639
|
+
photoUrl?: string | null;
|
|
12640
|
+
surname?: string | null;
|
|
12641
|
+
};
|
|
12642
|
+
};
|
|
12643
|
+
/** @description Discounts applied to the scheduled transaction. */
|
|
12644
|
+
discounts?: {
|
|
12645
|
+
/** @description Applied coupon. */
|
|
12646
|
+
coupon: {
|
|
12647
|
+
/** @description Fixed amount discount. */
|
|
12648
|
+
amountOff?: number;
|
|
12649
|
+
/** @description Currency of the fixed amount discount. */
|
|
12650
|
+
currencyCode?: string;
|
|
12651
|
+
/** @description Coupon id. */
|
|
12652
|
+
id: string;
|
|
12653
|
+
/** @description Percentage discount. */
|
|
12654
|
+
percentOff?: number;
|
|
12655
|
+
/** @description Product types the coupon applies to. */
|
|
12656
|
+
productTypes?: string[];
|
|
12657
|
+
/** @description Coupon type. */
|
|
12658
|
+
type: string;
|
|
12659
|
+
};
|
|
12660
|
+
/** @description Promocode the coupon was applied with. */
|
|
12661
|
+
promocode?: {
|
|
12662
|
+
/** @description Promocode. */
|
|
12663
|
+
code: string;
|
|
12664
|
+
/** @description Promocode expiration date. */
|
|
12665
|
+
expiration?: string;
|
|
12666
|
+
/**
|
|
12667
|
+
* Format: uuid
|
|
12668
|
+
* @description Promocode id.
|
|
12669
|
+
*/
|
|
12670
|
+
id: string;
|
|
12671
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
12672
|
+
limitByFirstPurchase?: boolean;
|
|
12673
|
+
};
|
|
12674
|
+
/**
|
|
12675
|
+
* Format: uuid
|
|
12676
|
+
* @description ID of the subscription this discount is associated with.
|
|
12677
|
+
*/
|
|
12678
|
+
subscriptionId?: string;
|
|
12679
|
+
}[];
|
|
12680
|
+
/**
|
|
12681
|
+
* Format: uuid
|
|
12682
|
+
* @description Unique identifier of the scheduled transaction.
|
|
12683
|
+
*/
|
|
12684
|
+
id: string;
|
|
12685
|
+
/**
|
|
12686
|
+
* Format: uuid
|
|
12687
|
+
* @description ID of the organization (location).
|
|
12688
|
+
*/
|
|
12689
|
+
locationRef: string;
|
|
12690
|
+
/**
|
|
12691
|
+
* Format: uuid
|
|
12692
|
+
* @deprecated
|
|
12693
|
+
* @description Deprecated. Use customer instead.
|
|
12694
|
+
*/
|
|
12695
|
+
membershipRef?: string;
|
|
12696
|
+
/**
|
|
12697
|
+
* Format: uuid
|
|
12698
|
+
* @deprecated
|
|
12699
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12700
|
+
*/
|
|
12701
|
+
membershipRefCreator?: string;
|
|
12702
|
+
/**
|
|
12703
|
+
* Format: uuid
|
|
12704
|
+
* @description ID of the network.
|
|
12705
|
+
*/
|
|
12706
|
+
networkRef: string;
|
|
12707
|
+
/** @description Product details. */
|
|
12708
|
+
product?: {
|
|
12709
|
+
/**
|
|
12710
|
+
* Format: uuid
|
|
12711
|
+
* @description ID of the associated booking.
|
|
12712
|
+
*/
|
|
12713
|
+
bookingRef?: string;
|
|
12714
|
+
/** @description Display title of the product. */
|
|
12715
|
+
title: string;
|
|
12716
|
+
/**
|
|
12717
|
+
* @description Product type.
|
|
12718
|
+
* @enum {string}
|
|
12719
|
+
*/
|
|
12720
|
+
type: "booking";
|
|
12721
|
+
};
|
|
12722
|
+
/**
|
|
12723
|
+
* Format: date-time
|
|
12724
|
+
* @description ISO timestamp of when the scheduled transaction was resolved into a credits transaction.
|
|
12725
|
+
*/
|
|
12726
|
+
resolveDate?: string;
|
|
12727
|
+
/**
|
|
12728
|
+
* Format: date-time
|
|
12729
|
+
* @description Date when the transaction is scheduled to resolve, anchored to the subscription interval the booking falls into.
|
|
12730
|
+
*/
|
|
12731
|
+
scheduleDate: string;
|
|
12732
|
+
/** @description Transaction status. */
|
|
12733
|
+
status: string;
|
|
12734
|
+
/** @description Timezone of the subscription. */
|
|
12735
|
+
timezoneId: string;
|
|
12736
|
+
/**
|
|
12737
|
+
* @description Scheduled credits transaction type.
|
|
12738
|
+
* @enum {string}
|
|
12739
|
+
*/
|
|
12740
|
+
type: "booking";
|
|
12741
|
+
/**
|
|
12742
|
+
* @deprecated
|
|
12743
|
+
* @description Deprecated. Use userOwner instead.
|
|
12744
|
+
*/
|
|
12745
|
+
user?: {
|
|
12746
|
+
about?: string | null;
|
|
12747
|
+
email?: string | null;
|
|
12748
|
+
/** Format: uuid */
|
|
12749
|
+
id: string;
|
|
12750
|
+
name?: string | null;
|
|
12751
|
+
phoneNumber?: string | null;
|
|
12752
|
+
photoUrl?: string | null;
|
|
12753
|
+
surname?: string | null;
|
|
12754
|
+
};
|
|
12755
|
+
/** @description User who created the transaction. */
|
|
12756
|
+
userCreatedBy?: {
|
|
12757
|
+
about?: string | null;
|
|
12758
|
+
email?: string | null;
|
|
12759
|
+
/** Format: uuid */
|
|
12760
|
+
id: string;
|
|
12761
|
+
name?: string | null;
|
|
12762
|
+
phoneNumber?: string | null;
|
|
12763
|
+
photoUrl?: string | null;
|
|
12764
|
+
surname?: string | null;
|
|
12765
|
+
};
|
|
12766
|
+
/**
|
|
12767
|
+
* @deprecated
|
|
12768
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12769
|
+
*/
|
|
12770
|
+
userCreator?: {
|
|
12771
|
+
about?: string | null;
|
|
12772
|
+
email?: string | null;
|
|
12773
|
+
/** Format: uuid */
|
|
12774
|
+
id: string;
|
|
12775
|
+
name?: string | null;
|
|
12776
|
+
phoneNumber?: string | null;
|
|
12777
|
+
photoUrl?: string | null;
|
|
12778
|
+
surname?: string | null;
|
|
12779
|
+
};
|
|
12780
|
+
/**
|
|
12781
|
+
* @deprecated
|
|
12782
|
+
* @description Deprecated. Use customer.user instead.
|
|
12783
|
+
*/
|
|
12784
|
+
userOwner?: {
|
|
12785
|
+
about?: string | null;
|
|
12786
|
+
email?: string | null;
|
|
12787
|
+
/** Format: uuid */
|
|
12788
|
+
id: string;
|
|
12789
|
+
name?: string | null;
|
|
12790
|
+
phoneNumber?: string | null;
|
|
12791
|
+
photoUrl?: string | null;
|
|
12792
|
+
surname?: string | null;
|
|
12793
|
+
};
|
|
12794
|
+
/**
|
|
12795
|
+
* Format: uuid
|
|
12796
|
+
* @deprecated
|
|
12797
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12798
|
+
*/
|
|
12799
|
+
userRefCreator?: string;
|
|
12800
|
+
/**
|
|
12801
|
+
* Format: uuid
|
|
12802
|
+
* @deprecated
|
|
12803
|
+
* @description Deprecated. Use customer.user instead.
|
|
12804
|
+
*/
|
|
12805
|
+
userRefOwner?: string;
|
|
12806
|
+
}[];
|
|
12807
|
+
/** @description Query string with nextPageToken and the request filter to fetch the next page of results. Returned when more results exist. */
|
|
12808
|
+
searchQueryNext?: string;
|
|
12809
|
+
};
|
|
12450
12810
|
getCreditsTransactions: {
|
|
12451
12811
|
/** @description Pagination token to fetch the next page of results. */
|
|
12452
12812
|
nextPageToken?: string;
|
|
@@ -14857,6 +15217,11 @@ interface components {
|
|
|
14857
15217
|
* @description ISO timestamp when the visitor checked in.
|
|
14858
15218
|
*/
|
|
14859
15219
|
checkInDate?: string;
|
|
15220
|
+
/**
|
|
15221
|
+
* Format: uuid
|
|
15222
|
+
* @description ID of the check-in created for the visit.
|
|
15223
|
+
*/
|
|
15224
|
+
checkInRef?: string;
|
|
14860
15225
|
/**
|
|
14861
15226
|
* Format: date-time
|
|
14862
15227
|
* @description ISO timestamp when the visitor checked out.
|
|
@@ -17406,6 +17771,8 @@ interface components {
|
|
|
17406
17771
|
* @description The id of membership owner.
|
|
17407
17772
|
*/
|
|
17408
17773
|
membershipRefOwner?: string;
|
|
17774
|
+
/** @description Number of seats to reserve. Required for desk and office resources. */
|
|
17775
|
+
seats?: number;
|
|
17409
17776
|
};
|
|
17410
17777
|
};
|
|
17411
17778
|
};
|
|
@@ -24897,6 +25264,47 @@ interface operations {
|
|
|
24897
25264
|
};
|
|
24898
25265
|
};
|
|
24899
25266
|
};
|
|
25267
|
+
getScheduledCreditsTransactions: {
|
|
25268
|
+
parameters: {
|
|
25269
|
+
query?: {
|
|
25270
|
+
/** @description UUID of the company or membership whose scheduled credits transactions to list. */
|
|
25271
|
+
customerRef?: string;
|
|
25272
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
25273
|
+
limit?: number;
|
|
25274
|
+
/** @description Token to retrieve the next page of results. */
|
|
25275
|
+
nextPageToken?: string;
|
|
25276
|
+
/** @description UUID of the subscription whose scheduled credits transactions to list. */
|
|
25277
|
+
subscriptionRef?: string;
|
|
25278
|
+
};
|
|
25279
|
+
header?: {
|
|
25280
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
25281
|
+
"spacebring-network-id"?: string;
|
|
25282
|
+
};
|
|
25283
|
+
path?: never;
|
|
25284
|
+
cookie?: never;
|
|
25285
|
+
};
|
|
25286
|
+
requestBody?: never;
|
|
25287
|
+
responses: {
|
|
25288
|
+
/** @description OK */
|
|
25289
|
+
200: {
|
|
25290
|
+
headers: {
|
|
25291
|
+
[name: string]: unknown;
|
|
25292
|
+
};
|
|
25293
|
+
content: {
|
|
25294
|
+
"application/json": components["schemas"]["getScheduledCreditsTransactions"];
|
|
25295
|
+
};
|
|
25296
|
+
};
|
|
25297
|
+
/** @description Bad Request */
|
|
25298
|
+
400: {
|
|
25299
|
+
headers: {
|
|
25300
|
+
[name: string]: unknown;
|
|
25301
|
+
};
|
|
25302
|
+
content: {
|
|
25303
|
+
"application/json": components["schemas"]["responseError"];
|
|
25304
|
+
};
|
|
25305
|
+
};
|
|
25306
|
+
};
|
|
25307
|
+
};
|
|
24900
25308
|
getCreditsTransactions: {
|
|
24901
25309
|
parameters: {
|
|
24902
25310
|
query?: {
|
|
@@ -26020,14 +26428,16 @@ type UpdateVisitBody = NonNullable<NonNullable<operations["updateVisit"]["reques
|
|
|
26020
26428
|
|
|
26021
26429
|
/** A Balance entity as returned by the Spacebring API. */
|
|
26022
26430
|
type Balance = NonNullable<components["schemas"]["balance"]>;
|
|
26431
|
+
/** A CreditScheduledTransaction entity as returned by the Spacebring API. */
|
|
26432
|
+
type CreditScheduledTransaction = NonNullable<operations["getScheduledCreditsTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
26023
26433
|
/** A CreditTransaction entity as returned by the Spacebring API. */
|
|
26024
26434
|
type CreditTransaction = NonNullable<components["schemas"]["transactionCredits"]>;
|
|
26435
|
+
/** A DayPassScheduledTransaction entity as returned by the Spacebring API. */
|
|
26436
|
+
type DayPassScheduledTransaction = NonNullable<operations["getScheduledDayPassesTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
26025
26437
|
/** A DayPassTransaction entity as returned by the Spacebring API. */
|
|
26026
26438
|
type DayPassTransaction = NonNullable<components["schemas"]["transactionDayPasses"]>;
|
|
26027
26439
|
/** A MoneyTransaction entity as returned by the Spacebring API. */
|
|
26028
26440
|
type MoneyTransaction = NonNullable<components["schemas"]["transaction"]>;
|
|
26029
|
-
/** A ScheduledTransaction entity as returned by the Spacebring API. */
|
|
26030
|
-
type ScheduledTransaction = NonNullable<operations["getScheduledDayPassesTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
26031
26441
|
/** Query parameters for `sb.transactions.credits.list()`. */
|
|
26032
26442
|
interface GetCreditsTransactionsQuery {
|
|
26033
26443
|
/** @deprecated Use customerRef instead. The id of the company to get transactions for. */
|
|
@@ -26090,6 +26500,17 @@ interface GetMoneyTransactionsQuery {
|
|
|
26090
26500
|
/** Token to retrieve the next page of results. */
|
|
26091
26501
|
nextPageToken?: string;
|
|
26092
26502
|
}
|
|
26503
|
+
/** Query parameters for `sb.transactions.credits.scheduled.list()`. */
|
|
26504
|
+
interface GetScheduledCreditsTransactionsQuery {
|
|
26505
|
+
/** UUID of the company or membership whose scheduled credits transactions to list. */
|
|
26506
|
+
customerRef?: string;
|
|
26507
|
+
/** Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
26508
|
+
limit?: number;
|
|
26509
|
+
/** Token to retrieve the next page of results. */
|
|
26510
|
+
nextPageToken?: string;
|
|
26511
|
+
/** UUID of the subscription whose scheduled credits transactions to list. */
|
|
26512
|
+
subscriptionRef?: string;
|
|
26513
|
+
}
|
|
26093
26514
|
/** Query parameters for `sb.transactions.dayPasses.scheduled.list()`. */
|
|
26094
26515
|
interface GetScheduledDayPassesTransactionsQuery {
|
|
26095
26516
|
/** UUID of the company or membership whose scheduled day pass transactions to list. */
|
|
@@ -27189,6 +27610,14 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
27189
27610
|
iterate(query?: Omit<GetCreditsTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CreditTransaction, void, undefined>;
|
|
27190
27611
|
get(id: string, options?: SpacebringRequestOptions): Promise<CreditTransaction>;
|
|
27191
27612
|
create(transaction: CreateCreditsTransactionBody, options?: SpacebringRequestOptions): Promise<CreditTransaction>;
|
|
27613
|
+
scheduled: {
|
|
27614
|
+
list(query?: GetScheduledCreditsTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
27615
|
+
nextPageToken?: string;
|
|
27616
|
+
scheduledTransactions: CreditScheduledTransaction[];
|
|
27617
|
+
searchQueryNext?: string;
|
|
27618
|
+
}>;
|
|
27619
|
+
iterate(query?: Omit<GetScheduledCreditsTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CreditScheduledTransaction, void, undefined>;
|
|
27620
|
+
};
|
|
27192
27621
|
};
|
|
27193
27622
|
dayPasses: {
|
|
27194
27623
|
list(query?: GetDayPassesTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
@@ -27202,10 +27631,10 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
27202
27631
|
scheduled: {
|
|
27203
27632
|
list(query?: GetScheduledDayPassesTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
27204
27633
|
nextPageToken?: string;
|
|
27205
|
-
scheduledTransactions:
|
|
27634
|
+
scheduledTransactions: DayPassScheduledTransaction[];
|
|
27206
27635
|
searchQueryNext?: string;
|
|
27207
27636
|
}>;
|
|
27208
|
-
iterate(query?: Omit<GetScheduledDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<
|
|
27637
|
+
iterate(query?: Omit<GetScheduledDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<DayPassScheduledTransaction, void, undefined>;
|
|
27209
27638
|
};
|
|
27210
27639
|
};
|
|
27211
27640
|
money: {
|
|
@@ -27315,4 +27744,4 @@ declare class SpacebringError extends Error {
|
|
|
27315
27744
|
});
|
|
27316
27745
|
}
|
|
27317
27746
|
|
|
27318
|
-
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditTransaction, type DayPassTransaction, type Event, type EventTicket, type GetAltCurrenciesQuery, type GetAssignmentsQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type
|
|
27747
|
+
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type Event, type EventTicket, type GetAltCurrenciesQuery, type GetAssignmentsQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetScheduledCreditsTransactionsQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type Template, type TerminateContractBody, type UpcomingItem, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateContractBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateEventBody, type UpdateEventTicketBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };
|