@izak0s/spacebring-api 1.4.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +946 -179
- package/dist/index.d.ts +946 -179
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -4297,6 +4297,295 @@ interface components {
|
|
|
4297
4297
|
*/
|
|
4298
4298
|
transactionRef: string;
|
|
4299
4299
|
};
|
|
4300
|
+
getCreditNotes: {
|
|
4301
|
+
/** @description List of credit notes. */
|
|
4302
|
+
creditNotes: {
|
|
4303
|
+
/** @description Amounts in the base currency. */
|
|
4304
|
+
baseAmounts: {
|
|
4305
|
+
/** @description ISO currency code. */
|
|
4306
|
+
currencyCode: string;
|
|
4307
|
+
/**
|
|
4308
|
+
* @deprecated
|
|
4309
|
+
* @description Deprecated.
|
|
4310
|
+
*/
|
|
4311
|
+
grossAmount: number;
|
|
4312
|
+
/** @description Post-payment credit amount in major units. */
|
|
4313
|
+
postPaymentAmount: number;
|
|
4314
|
+
/** @description Pre-payment credit amount in major units. */
|
|
4315
|
+
prePaymentAmount: number;
|
|
4316
|
+
/** @description Subtotal in major units. */
|
|
4317
|
+
subtotalAmount: number;
|
|
4318
|
+
/** @description Subtotal excluding tax in major units. */
|
|
4319
|
+
subtotalAmountExcludingTax: number;
|
|
4320
|
+
/** @description Tax breakdown. */
|
|
4321
|
+
taxes: {
|
|
4322
|
+
/** @description Tax amount in major units. */
|
|
4323
|
+
amount: number;
|
|
4324
|
+
/** @description Whether tax is included in the price. */
|
|
4325
|
+
inclusive: boolean;
|
|
4326
|
+
/** @description Tax rate as a decimal. */
|
|
4327
|
+
rate: number;
|
|
4328
|
+
/** @description Amount subject to tax in major units. */
|
|
4329
|
+
taxableAmount: number;
|
|
4330
|
+
}[];
|
|
4331
|
+
/** @description Total in major units. */
|
|
4332
|
+
totalAmount: number;
|
|
4333
|
+
/** @description Total excluding tax in major units. */
|
|
4334
|
+
totalExcludingTaxAmount: number;
|
|
4335
|
+
};
|
|
4336
|
+
/**
|
|
4337
|
+
* Format: date-time
|
|
4338
|
+
* @description ISO timestamp of when the credit note was created.
|
|
4339
|
+
*/
|
|
4340
|
+
createDate: string;
|
|
4341
|
+
/** @description Amount credited to customer balance in major units. */
|
|
4342
|
+
creditAmount?: number;
|
|
4343
|
+
/** @description ISO currency code (from base or alt currency). */
|
|
4344
|
+
currencyCode: string;
|
|
4345
|
+
/** @description Effective date in YYYY-MM-DD format. */
|
|
4346
|
+
effectiveDate?: string;
|
|
4347
|
+
/**
|
|
4348
|
+
* @deprecated
|
|
4349
|
+
* @description Deprecated.
|
|
4350
|
+
*/
|
|
4351
|
+
grossAmount: number;
|
|
4352
|
+
/**
|
|
4353
|
+
* Format: uuid
|
|
4354
|
+
* @description Unique identifier of the credit note.
|
|
4355
|
+
*/
|
|
4356
|
+
id: string;
|
|
4357
|
+
/** @description Internal memo (visible to admins only). */
|
|
4358
|
+
internalNote?: string;
|
|
4359
|
+
/**
|
|
4360
|
+
* Format: uuid
|
|
4361
|
+
* @description ID of the invoice being credited.
|
|
4362
|
+
*/
|
|
4363
|
+
invoiceRef: string;
|
|
4364
|
+
/** @description Credit note line items. */
|
|
4365
|
+
lines: {
|
|
4366
|
+
/** @description Amounts in the base currency. */
|
|
4367
|
+
baseAmounts: {
|
|
4368
|
+
/** @description ISO currency code. */
|
|
4369
|
+
currencyCode: string;
|
|
4370
|
+
/** @description Discount deduction in major units. */
|
|
4371
|
+
discountedAmount: number;
|
|
4372
|
+
/** @description Tax details. */
|
|
4373
|
+
tax?: {
|
|
4374
|
+
/** @description Tax amount in major units. */
|
|
4375
|
+
amount: number;
|
|
4376
|
+
/** @description Whether tax is included in the price. */
|
|
4377
|
+
inclusive: boolean;
|
|
4378
|
+
/** @description Tax rate as a decimal. */
|
|
4379
|
+
rate: number;
|
|
4380
|
+
/** @description Amount subject to tax in major units. */
|
|
4381
|
+
taxableAmount: number;
|
|
4382
|
+
};
|
|
4383
|
+
/** @description Total in major units. */
|
|
4384
|
+
totalAmount: number;
|
|
4385
|
+
/** @description Total excluding tax in major units. */
|
|
4386
|
+
totalExcludingTaxAmount: number;
|
|
4387
|
+
/** @description Unit price in major units. */
|
|
4388
|
+
unitAmount?: number;
|
|
4389
|
+
/** @description Unit price excluding tax in major units. */
|
|
4390
|
+
unitExcludingTaxAmount?: number;
|
|
4391
|
+
};
|
|
4392
|
+
/**
|
|
4393
|
+
* Format: date-time
|
|
4394
|
+
* @description ISO timestamp of line item creation.
|
|
4395
|
+
*/
|
|
4396
|
+
createDate: string;
|
|
4397
|
+
/** @description ISO currency code. */
|
|
4398
|
+
currencyCode: string;
|
|
4399
|
+
/** @description Discount deduction in major units. */
|
|
4400
|
+
discountedAmount: number;
|
|
4401
|
+
/** @description Applied discounts. */
|
|
4402
|
+
discounts?: {
|
|
4403
|
+
/** @description Coupon applied. */
|
|
4404
|
+
coupon: {
|
|
4405
|
+
/** @description Fixed discount amount in major units. */
|
|
4406
|
+
amountOff?: number;
|
|
4407
|
+
/** @description Currency code for amountOff. */
|
|
4408
|
+
currencyCode?: string;
|
|
4409
|
+
/** @description Discount duration type. */
|
|
4410
|
+
duration?: string;
|
|
4411
|
+
/** @description Number of months the discount applies. */
|
|
4412
|
+
durationInMonths?: number;
|
|
4413
|
+
/**
|
|
4414
|
+
* Format: uuid
|
|
4415
|
+
* @description Coupon ID.
|
|
4416
|
+
*/
|
|
4417
|
+
id?: string;
|
|
4418
|
+
/** @description Percentage discount. */
|
|
4419
|
+
percentOff?: number;
|
|
4420
|
+
/** @description Coupon type. */
|
|
4421
|
+
type?: string;
|
|
4422
|
+
};
|
|
4423
|
+
/** @description Promocode applied. */
|
|
4424
|
+
promocode?: {
|
|
4425
|
+
code: string;
|
|
4426
|
+
/** Format: date-time */
|
|
4427
|
+
expiration?: string;
|
|
4428
|
+
/** Format: uuid */
|
|
4429
|
+
id: string;
|
|
4430
|
+
limitByFirstPurchase?: boolean;
|
|
4431
|
+
};
|
|
4432
|
+
/**
|
|
4433
|
+
* Format: uuid
|
|
4434
|
+
* @description Associated subscription ID.
|
|
4435
|
+
*/
|
|
4436
|
+
subscriptionId?: string;
|
|
4437
|
+
}[];
|
|
4438
|
+
/**
|
|
4439
|
+
* Format: uuid
|
|
4440
|
+
* @description Unique identifier of the line item.
|
|
4441
|
+
*/
|
|
4442
|
+
id: string;
|
|
4443
|
+
/**
|
|
4444
|
+
* Format: uuid
|
|
4445
|
+
* @description ID of the original invoice item.
|
|
4446
|
+
*/
|
|
4447
|
+
invoiceItemRef: string;
|
|
4448
|
+
/**
|
|
4449
|
+
* Format: uuid
|
|
4450
|
+
* @description ID of the invoice.
|
|
4451
|
+
*/
|
|
4452
|
+
invoiceRef: string;
|
|
4453
|
+
/**
|
|
4454
|
+
* Format: uuid
|
|
4455
|
+
* @description ID of the organization (location).
|
|
4456
|
+
*/
|
|
4457
|
+
locationRef: string;
|
|
4458
|
+
/**
|
|
4459
|
+
* Format: uuid
|
|
4460
|
+
* @description ID of the network.
|
|
4461
|
+
*/
|
|
4462
|
+
networkRef: string;
|
|
4463
|
+
/** @description Quantity refunded. */
|
|
4464
|
+
quantity?: number;
|
|
4465
|
+
/** @description Tax details. */
|
|
4466
|
+
tax?: {
|
|
4467
|
+
/** @description Tax amount in major units. */
|
|
4468
|
+
amount: number;
|
|
4469
|
+
/** @description Whether tax is included in the price. */
|
|
4470
|
+
inclusive: boolean;
|
|
4471
|
+
/** @description Tax rate as a decimal. */
|
|
4472
|
+
rate: number;
|
|
4473
|
+
/** @description Amount subject to tax in major units. */
|
|
4474
|
+
taxableAmount: number;
|
|
4475
|
+
};
|
|
4476
|
+
/** @description Total in major units. */
|
|
4477
|
+
totalAmount: number;
|
|
4478
|
+
/** @description Total excluding tax in major units. */
|
|
4479
|
+
totalExcludingTaxAmount: number;
|
|
4480
|
+
/** @description Unit price in major units. */
|
|
4481
|
+
unitAmount?: number;
|
|
4482
|
+
/** @description Unit price excluding tax in major units. */
|
|
4483
|
+
unitExcludingTaxAmount?: number;
|
|
4484
|
+
/**
|
|
4485
|
+
* Format: date-time
|
|
4486
|
+
* @description ISO timestamp of last update.
|
|
4487
|
+
*/
|
|
4488
|
+
updateDate: string;
|
|
4489
|
+
}[];
|
|
4490
|
+
/**
|
|
4491
|
+
* Format: uuid
|
|
4492
|
+
* @description ID of the organization (location).
|
|
4493
|
+
*/
|
|
4494
|
+
locationRef: string;
|
|
4495
|
+
/**
|
|
4496
|
+
* Format: uuid
|
|
4497
|
+
* @description ID of the network.
|
|
4498
|
+
*/
|
|
4499
|
+
networkRef: string;
|
|
4500
|
+
/** @description Credit note number. */
|
|
4501
|
+
number?: number;
|
|
4502
|
+
/** @description Out-of-band refund amount in major units. */
|
|
4503
|
+
outOfBandAmount?: number;
|
|
4504
|
+
/** @description URL to download the credit note PDF. */
|
|
4505
|
+
pdfUrl: string;
|
|
4506
|
+
/** @description Post-payment credit amount in major units. */
|
|
4507
|
+
postPaymentAmount: number;
|
|
4508
|
+
/** @description Pre-payment credit amount in major units. */
|
|
4509
|
+
prePaymentAmount: number;
|
|
4510
|
+
/**
|
|
4511
|
+
* @description Reason for the credit note.
|
|
4512
|
+
* @enum {string}
|
|
4513
|
+
*/
|
|
4514
|
+
reason: "duplicate" | "orderChange" | "productUnsatisfactory" | "fraudulent" | "other";
|
|
4515
|
+
/** @description Refunds associated with this credit note. */
|
|
4516
|
+
refunds?: {
|
|
4517
|
+
/** @description Refund amount in major units. */
|
|
4518
|
+
amount: number;
|
|
4519
|
+
/** @description ISO currency code. */
|
|
4520
|
+
currencyCode: string;
|
|
4521
|
+
/**
|
|
4522
|
+
* Format: uuid
|
|
4523
|
+
* @description Unique identifier of the refund.
|
|
4524
|
+
*/
|
|
4525
|
+
id: string;
|
|
4526
|
+
/** @description Refund payment method. */
|
|
4527
|
+
method?: {
|
|
4528
|
+
/** @description Payment method label. */
|
|
4529
|
+
label?: string;
|
|
4530
|
+
/**
|
|
4531
|
+
* @description Payment method type.
|
|
4532
|
+
* @enum {string}
|
|
4533
|
+
*/
|
|
4534
|
+
type: "external" | "paymentGateway";
|
|
4535
|
+
};
|
|
4536
|
+
/**
|
|
4537
|
+
* Format: uuid
|
|
4538
|
+
* @description ID of the transaction being refunded.
|
|
4539
|
+
*/
|
|
4540
|
+
transactionRef: string;
|
|
4541
|
+
}[];
|
|
4542
|
+
/**
|
|
4543
|
+
* @description Credit note status.
|
|
4544
|
+
* @enum {string}
|
|
4545
|
+
*/
|
|
4546
|
+
status: "issued" | "voided";
|
|
4547
|
+
/** @description Subtotal in major units. */
|
|
4548
|
+
subtotalAmount: number;
|
|
4549
|
+
/** @description Subtotal excluding tax in major units. */
|
|
4550
|
+
subtotalAmountExcludingTax: number;
|
|
4551
|
+
/** @description Tax breakdown. */
|
|
4552
|
+
taxes: {
|
|
4553
|
+
/** @description Tax amount in major units. */
|
|
4554
|
+
amount: number;
|
|
4555
|
+
/** @description Whether tax is included in the price. */
|
|
4556
|
+
inclusive: boolean;
|
|
4557
|
+
/** @description Tax rate as a decimal. */
|
|
4558
|
+
rate: number;
|
|
4559
|
+
/** @description Amount subject to tax in major units. */
|
|
4560
|
+
taxableAmount: number;
|
|
4561
|
+
}[];
|
|
4562
|
+
/** @description Credit note title. */
|
|
4563
|
+
title: string;
|
|
4564
|
+
/** @description Total in major units. */
|
|
4565
|
+
totalAmount: number;
|
|
4566
|
+
/** @description Total excluding tax in major units. */
|
|
4567
|
+
totalExcludingTaxAmount: number;
|
|
4568
|
+
/**
|
|
4569
|
+
* @description Credit note type.
|
|
4570
|
+
* @enum {string}
|
|
4571
|
+
*/
|
|
4572
|
+
type: "prePayment" | "postPayment" | "mixed";
|
|
4573
|
+
/**
|
|
4574
|
+
* Format: date-time
|
|
4575
|
+
* @description ISO timestamp of last update.
|
|
4576
|
+
*/
|
|
4577
|
+
updateDate: string;
|
|
4578
|
+
/**
|
|
4579
|
+
* Format: date-time
|
|
4580
|
+
* @description ISO timestamp of when the credit note was voided.
|
|
4581
|
+
*/
|
|
4582
|
+
voidDate?: string;
|
|
4583
|
+
}[];
|
|
4584
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
4585
|
+
nextPageToken?: string;
|
|
4586
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
4587
|
+
searchQueryNext?: string;
|
|
4588
|
+
};
|
|
4300
4589
|
creditNote: {
|
|
4301
4590
|
/** @description Amounts in the base currency. */
|
|
4302
4591
|
baseAmounts: {
|
|
@@ -10835,149 +11124,616 @@ interface components {
|
|
|
10835
11124
|
id?: string;
|
|
10836
11125
|
title?: string;
|
|
10837
11126
|
};
|
|
10838
|
-
};
|
|
10839
|
-
company?: components["schemas"]["company"];
|
|
10840
|
-
/** Format: uuid */
|
|
10841
|
-
companyRef?: string;
|
|
10842
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10843
|
-
/** @description The memo of the transaction. */
|
|
10844
|
-
description?: string;
|
|
10845
|
-
/** Format: uuid */
|
|
10846
|
-
id?: string;
|
|
10847
|
-
expiringAmount?: number;
|
|
10848
|
-
/** Format: uuid */
|
|
10849
|
-
locationRef?: string;
|
|
10850
|
-
/** Format: uuid */
|
|
10851
|
-
membershipRefCreator?: string;
|
|
10852
|
-
/** Format: uuid */
|
|
10853
|
-
membershipRef?: string;
|
|
10854
|
-
order?: {
|
|
10855
|
-
/** Format: uuid */
|
|
10856
|
-
id?: string;
|
|
10857
|
-
option?: {
|
|
11127
|
+
};
|
|
11128
|
+
company?: components["schemas"]["company"];
|
|
11129
|
+
/** Format: uuid */
|
|
11130
|
+
companyRef?: string;
|
|
11131
|
+
createDate?: components["schemas"]["dateSchema"];
|
|
11132
|
+
/** @description The memo of the transaction. */
|
|
11133
|
+
description?: string;
|
|
11134
|
+
/** Format: uuid */
|
|
11135
|
+
id?: string;
|
|
11136
|
+
expiringAmount?: number;
|
|
11137
|
+
/** Format: uuid */
|
|
11138
|
+
locationRef?: string;
|
|
11139
|
+
/** Format: uuid */
|
|
11140
|
+
membershipRefCreator?: string;
|
|
11141
|
+
/** Format: uuid */
|
|
11142
|
+
membershipRef?: string;
|
|
11143
|
+
order?: {
|
|
11144
|
+
/** Format: uuid */
|
|
11145
|
+
id?: string;
|
|
11146
|
+
option?: {
|
|
11147
|
+
/** Format: uuid */
|
|
11148
|
+
id?: string;
|
|
11149
|
+
name?: string;
|
|
11150
|
+
};
|
|
11151
|
+
product?: {
|
|
11152
|
+
/** Format: uuid */
|
|
11153
|
+
id?: string;
|
|
11154
|
+
title?: string;
|
|
11155
|
+
};
|
|
11156
|
+
};
|
|
11157
|
+
permanentAmount?: number;
|
|
11158
|
+
refund?: {
|
|
11159
|
+
amount?: number;
|
|
11160
|
+
createDate?: components["schemas"]["dateSchema"];
|
|
11161
|
+
};
|
|
11162
|
+
/** @enum {string} */
|
|
11163
|
+
status?: "canceled" | "failed" | "succeeded";
|
|
11164
|
+
ticket?: {
|
|
11165
|
+
createDate?: components["schemas"]["dateSchema"];
|
|
11166
|
+
event?: {
|
|
11167
|
+
endDate?: components["schemas"]["dateSchema"];
|
|
11168
|
+
/** Format: uuid */
|
|
11169
|
+
id?: string;
|
|
11170
|
+
startDate?: components["schemas"]["dateSchema"];
|
|
11171
|
+
title?: string;
|
|
11172
|
+
};
|
|
11173
|
+
/** Format: uuid */
|
|
11174
|
+
id?: string;
|
|
11175
|
+
};
|
|
11176
|
+
/** @enum {string} */
|
|
11177
|
+
type?: "booking" | "chargeExpiringCredits" | "chargePermanentCredits" | "creditPackage" | "eventTicket" | "order" | "refund" | "subscriptionExpiration" | "subscriptionRenewal" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
11178
|
+
userCreator?: components["schemas"]["user"];
|
|
11179
|
+
userOwner?: components["schemas"]["user"];
|
|
11180
|
+
/** Format: uuid */
|
|
11181
|
+
userRefCreator?: string;
|
|
11182
|
+
/** Format: uuid */
|
|
11183
|
+
userRefOwner?: string;
|
|
11184
|
+
};
|
|
11185
|
+
transactionCredits: {
|
|
11186
|
+
amount?: number;
|
|
11187
|
+
company?: components["schemas"]["company"];
|
|
11188
|
+
/** Format: uuid */
|
|
11189
|
+
companyRef?: string;
|
|
11190
|
+
createDate?: components["schemas"]["dateSchema"];
|
|
11191
|
+
/** @description The memo of the transaction. */
|
|
11192
|
+
description?: string;
|
|
11193
|
+
/** Format: uuid */
|
|
11194
|
+
id?: string;
|
|
11195
|
+
/** Format: uuid */
|
|
11196
|
+
locationRef?: string;
|
|
11197
|
+
/** Format: uuid */
|
|
11198
|
+
membershipRef?: string;
|
|
11199
|
+
/** Format: uuid */
|
|
11200
|
+
membershipRefCreator?: string;
|
|
11201
|
+
/** @enum {string} */
|
|
11202
|
+
status?: "canceled" | "failed" | "succeeded";
|
|
11203
|
+
/** @enum {string} */
|
|
11204
|
+
type?: "chargeExpiringCredits" | "chargePermanentCredits" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
11205
|
+
userCreator?: components["schemas"]["user"];
|
|
11206
|
+
userOwner?: components["schemas"]["user"];
|
|
11207
|
+
/** Format: uuid */
|
|
11208
|
+
userRef?: string;
|
|
11209
|
+
/** Format: uuid */
|
|
11210
|
+
userRefCreator?: string;
|
|
11211
|
+
};
|
|
11212
|
+
getDayPassesTransactions: {
|
|
11213
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
11214
|
+
nextPageToken?: string;
|
|
11215
|
+
/** @description List of day pass transactions. */
|
|
11216
|
+
transactions: {
|
|
11217
|
+
/** @description Total day pass amount (absolute sum of expiring and permanent). */
|
|
11218
|
+
amount: number;
|
|
11219
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
11220
|
+
amounts: {
|
|
11221
|
+
/** @description Amount deducted from this balance bucket. */
|
|
11222
|
+
amount: number;
|
|
11223
|
+
/**
|
|
11224
|
+
* Format: date-time
|
|
11225
|
+
* @description Expiration date for expiring balances.
|
|
11226
|
+
*/
|
|
11227
|
+
expirationDate?: string;
|
|
11228
|
+
/**
|
|
11229
|
+
* Format: uuid
|
|
11230
|
+
* @description Subscription associated with expiring balances.
|
|
11231
|
+
*/
|
|
11232
|
+
subscriptionRef?: string;
|
|
11233
|
+
/**
|
|
11234
|
+
* @description Balance bucket type.
|
|
11235
|
+
* @enum {string}
|
|
11236
|
+
*/
|
|
11237
|
+
type: "expiring" | "permanent";
|
|
11238
|
+
}[];
|
|
11239
|
+
/**
|
|
11240
|
+
* @deprecated
|
|
11241
|
+
* @description Deprecated. Use product instead.
|
|
11242
|
+
*/
|
|
11243
|
+
booking?: {
|
|
11244
|
+
/**
|
|
11245
|
+
* Format: uuid
|
|
11246
|
+
* @description Booking id.
|
|
11247
|
+
*/
|
|
11248
|
+
id: string;
|
|
11249
|
+
/** @description Booked resource. */
|
|
11250
|
+
resource: {
|
|
11251
|
+
/**
|
|
11252
|
+
* Format: uuid
|
|
11253
|
+
* @description Resource id.
|
|
11254
|
+
*/
|
|
11255
|
+
id: string;
|
|
11256
|
+
/** @description Resource title. */
|
|
11257
|
+
title: string;
|
|
11258
|
+
};
|
|
11259
|
+
};
|
|
11260
|
+
/**
|
|
11261
|
+
* @deprecated
|
|
11262
|
+
* @description Deprecated. Use customer instead.
|
|
11263
|
+
*/
|
|
11264
|
+
company?: {
|
|
11265
|
+
/**
|
|
11266
|
+
* Format: date-time
|
|
11267
|
+
* @description ISO timestamp of company creation.
|
|
11268
|
+
*/
|
|
11269
|
+
createDate: string;
|
|
11270
|
+
/**
|
|
11271
|
+
* Format: uuid
|
|
11272
|
+
* @description Company id.
|
|
11273
|
+
*/
|
|
11274
|
+
id: string;
|
|
11275
|
+
/**
|
|
11276
|
+
* Format: uuid
|
|
11277
|
+
* @description Location id.
|
|
11278
|
+
*/
|
|
11279
|
+
locationRef: string;
|
|
11280
|
+
/** @description Company logo. */
|
|
11281
|
+
logo?: {
|
|
11282
|
+
/** @description Storage key of the company logo. */
|
|
11283
|
+
key: string;
|
|
11284
|
+
/** @description Public URL of the company logo. */
|
|
11285
|
+
url: string;
|
|
11286
|
+
};
|
|
11287
|
+
/** @description Company metadata. */
|
|
11288
|
+
metadata?: {
|
|
11289
|
+
[key: string]: unknown;
|
|
11290
|
+
};
|
|
11291
|
+
/** @description Internal notes. */
|
|
11292
|
+
notes?: string;
|
|
11293
|
+
/** @description Public logo URL derived from the company website. */
|
|
11294
|
+
publicLogoUrl?: string;
|
|
11295
|
+
/**
|
|
11296
|
+
* Format: uuid
|
|
11297
|
+
* @description Primary subscription id.
|
|
11298
|
+
*/
|
|
11299
|
+
subscriptionRef: string | null;
|
|
11300
|
+
/** @description Company name. */
|
|
11301
|
+
title: string;
|
|
11302
|
+
};
|
|
11303
|
+
/**
|
|
11304
|
+
* Format: uuid
|
|
11305
|
+
* @deprecated
|
|
11306
|
+
* @description Deprecated. Use customer instead.
|
|
11307
|
+
*/
|
|
11308
|
+
companyRef?: string;
|
|
11309
|
+
/**
|
|
11310
|
+
* Format: date-time
|
|
11311
|
+
* @description ISO timestamp of when the transaction was created.
|
|
11312
|
+
*/
|
|
11313
|
+
createDate: string;
|
|
11314
|
+
/** @description Customer associated with this transaction. */
|
|
11315
|
+
customer: {
|
|
11316
|
+
/**
|
|
11317
|
+
* Format: uuid
|
|
11318
|
+
* @description ID of the company or membership.
|
|
11319
|
+
*/
|
|
11320
|
+
id: string;
|
|
11321
|
+
/** @description Company logo. */
|
|
11322
|
+
logo?: {
|
|
11323
|
+
key: string;
|
|
11324
|
+
url: string;
|
|
11325
|
+
};
|
|
11326
|
+
/** @description Company name. */
|
|
11327
|
+
title?: string;
|
|
11328
|
+
/**
|
|
11329
|
+
* @description Whether the customer is a company or a user.
|
|
11330
|
+
* @enum {string}
|
|
11331
|
+
*/
|
|
11332
|
+
type: "company" | "user";
|
|
11333
|
+
/** @description User details for membership customers. */
|
|
11334
|
+
user?: {
|
|
11335
|
+
about?: string | null;
|
|
11336
|
+
email?: string | null;
|
|
11337
|
+
/** Format: uuid */
|
|
11338
|
+
id: string;
|
|
11339
|
+
name?: string | null;
|
|
11340
|
+
phoneNumber?: string | null;
|
|
11341
|
+
photoUrl?: string | null;
|
|
11342
|
+
surname?: string | null;
|
|
11343
|
+
};
|
|
11344
|
+
};
|
|
11345
|
+
/** @description Transaction description. */
|
|
11346
|
+
description?: string;
|
|
11347
|
+
/**
|
|
11348
|
+
* Format: uuid
|
|
11349
|
+
* @description Unique identifier of the transaction.
|
|
11350
|
+
*/
|
|
11351
|
+
id: string;
|
|
11352
|
+
/**
|
|
11353
|
+
* Format: uuid
|
|
11354
|
+
* @description ID of the organization (location).
|
|
11355
|
+
*/
|
|
11356
|
+
locationRef: string;
|
|
11357
|
+
/**
|
|
11358
|
+
* Format: uuid
|
|
11359
|
+
* @deprecated
|
|
11360
|
+
* @description Deprecated. Use customer instead.
|
|
11361
|
+
*/
|
|
11362
|
+
membershipRef?: string;
|
|
11363
|
+
/**
|
|
11364
|
+
* Format: uuid
|
|
11365
|
+
* @deprecated
|
|
11366
|
+
* @description Deprecated. Use userCreator instead.
|
|
11367
|
+
*/
|
|
11368
|
+
membershipRefCreator?: string;
|
|
11369
|
+
/**
|
|
11370
|
+
* Format: uuid
|
|
11371
|
+
* @description ID of the network.
|
|
11372
|
+
*/
|
|
11373
|
+
networkRef: string;
|
|
11374
|
+
/** @description Product details. */
|
|
11375
|
+
product?: {
|
|
11376
|
+
/**
|
|
11377
|
+
* Format: uuid
|
|
11378
|
+
* @description ID of the associated booking.
|
|
11379
|
+
*/
|
|
11380
|
+
bookingRef?: string;
|
|
11381
|
+
/** @description Display title of the product. */
|
|
11382
|
+
title: string;
|
|
11383
|
+
/**
|
|
11384
|
+
* @description Product type.
|
|
11385
|
+
* @enum {string}
|
|
11386
|
+
*/
|
|
11387
|
+
type: "booking";
|
|
11388
|
+
};
|
|
11389
|
+
/**
|
|
11390
|
+
* @deprecated
|
|
11391
|
+
* @description Deprecated.
|
|
11392
|
+
*/
|
|
11393
|
+
refund?: {
|
|
11394
|
+
/** @description Refunded expiring amount. */
|
|
11395
|
+
amount: number;
|
|
11396
|
+
/**
|
|
11397
|
+
* Format: date-time
|
|
11398
|
+
* @description Refund creation timestamp.
|
|
11399
|
+
*/
|
|
11400
|
+
createDate: string;
|
|
11401
|
+
};
|
|
11402
|
+
/** @description Transaction status. */
|
|
11403
|
+
status: string;
|
|
11404
|
+
/**
|
|
11405
|
+
* @description Day pass transaction type.
|
|
11406
|
+
* @enum {string}
|
|
11407
|
+
*/
|
|
11408
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "expiration" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
11409
|
+
/**
|
|
11410
|
+
* @deprecated
|
|
11411
|
+
* @description Deprecated. Use userOwner instead.
|
|
11412
|
+
*/
|
|
11413
|
+
user?: {
|
|
11414
|
+
about?: string | null;
|
|
11415
|
+
email?: string | null;
|
|
11416
|
+
/** Format: uuid */
|
|
11417
|
+
id: string;
|
|
11418
|
+
name?: string | null;
|
|
11419
|
+
phoneNumber?: string | null;
|
|
11420
|
+
photoUrl?: string | null;
|
|
11421
|
+
surname?: string | null;
|
|
11422
|
+
};
|
|
11423
|
+
/** @description User who created the transaction. */
|
|
11424
|
+
userCreatedBy?: {
|
|
11425
|
+
about?: string | null;
|
|
11426
|
+
email?: string | null;
|
|
11427
|
+
/** Format: uuid */
|
|
11428
|
+
id: string;
|
|
11429
|
+
name?: string | null;
|
|
11430
|
+
phoneNumber?: string | null;
|
|
11431
|
+
photoUrl?: string | null;
|
|
11432
|
+
surname?: string | null;
|
|
11433
|
+
};
|
|
11434
|
+
/**
|
|
11435
|
+
* @deprecated
|
|
11436
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
11437
|
+
*/
|
|
11438
|
+
userCreator?: {
|
|
11439
|
+
about?: string | null;
|
|
11440
|
+
email?: string | null;
|
|
11441
|
+
/** Format: uuid */
|
|
11442
|
+
id: string;
|
|
11443
|
+
name?: string | null;
|
|
11444
|
+
phoneNumber?: string | null;
|
|
11445
|
+
photoUrl?: string | null;
|
|
11446
|
+
surname?: string | null;
|
|
11447
|
+
};
|
|
11448
|
+
/**
|
|
11449
|
+
* @deprecated
|
|
11450
|
+
* @description Deprecated. Use customer.user instead.
|
|
11451
|
+
*/
|
|
11452
|
+
userOwner?: {
|
|
11453
|
+
about?: string | null;
|
|
11454
|
+
email?: string | null;
|
|
11455
|
+
/** Format: uuid */
|
|
11456
|
+
id: string;
|
|
11457
|
+
name?: string | null;
|
|
11458
|
+
phoneNumber?: string | null;
|
|
11459
|
+
photoUrl?: string | null;
|
|
11460
|
+
surname?: string | null;
|
|
11461
|
+
};
|
|
11462
|
+
/**
|
|
11463
|
+
* Format: uuid
|
|
11464
|
+
* @deprecated
|
|
11465
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
11466
|
+
*/
|
|
11467
|
+
userRefCreator?: string;
|
|
11468
|
+
/**
|
|
11469
|
+
* Format: uuid
|
|
11470
|
+
* @deprecated
|
|
11471
|
+
* @description Deprecated. Use customer.user instead.
|
|
11472
|
+
*/
|
|
11473
|
+
userRefOwner?: string;
|
|
11474
|
+
}[];
|
|
11475
|
+
};
|
|
11476
|
+
createDayPassesTransaction: {
|
|
11477
|
+
/** @description The created day passes transaction. */
|
|
11478
|
+
transaction: {
|
|
11479
|
+
/** @description Total day pass amount (absolute sum of expiring and permanent). */
|
|
11480
|
+
amount: number;
|
|
11481
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
11482
|
+
amounts: {
|
|
11483
|
+
/** @description Amount deducted from this balance bucket. */
|
|
11484
|
+
amount: number;
|
|
11485
|
+
/**
|
|
11486
|
+
* Format: date-time
|
|
11487
|
+
* @description Expiration date for expiring balances.
|
|
11488
|
+
*/
|
|
11489
|
+
expirationDate?: string;
|
|
11490
|
+
/**
|
|
11491
|
+
* Format: uuid
|
|
11492
|
+
* @description Subscription associated with expiring balances.
|
|
11493
|
+
*/
|
|
11494
|
+
subscriptionRef?: string;
|
|
11495
|
+
/**
|
|
11496
|
+
* @description Balance bucket type.
|
|
11497
|
+
* @enum {string}
|
|
11498
|
+
*/
|
|
11499
|
+
type: "expiring" | "permanent";
|
|
11500
|
+
}[];
|
|
11501
|
+
/**
|
|
11502
|
+
* @deprecated
|
|
11503
|
+
* @description Deprecated. Use product instead.
|
|
11504
|
+
*/
|
|
11505
|
+
booking?: {
|
|
11506
|
+
/**
|
|
11507
|
+
* Format: uuid
|
|
11508
|
+
* @description Booking id.
|
|
11509
|
+
*/
|
|
11510
|
+
id: string;
|
|
11511
|
+
/** @description Booked resource. */
|
|
11512
|
+
resource: {
|
|
11513
|
+
/**
|
|
11514
|
+
* Format: uuid
|
|
11515
|
+
* @description Resource id.
|
|
11516
|
+
*/
|
|
11517
|
+
id: string;
|
|
11518
|
+
/** @description Resource title. */
|
|
11519
|
+
title: string;
|
|
11520
|
+
};
|
|
11521
|
+
};
|
|
11522
|
+
/**
|
|
11523
|
+
* @deprecated
|
|
11524
|
+
* @description Deprecated. Use customer instead.
|
|
11525
|
+
*/
|
|
11526
|
+
company?: {
|
|
11527
|
+
/**
|
|
11528
|
+
* Format: date-time
|
|
11529
|
+
* @description ISO timestamp of company creation.
|
|
11530
|
+
*/
|
|
11531
|
+
createDate: string;
|
|
11532
|
+
/**
|
|
11533
|
+
* Format: uuid
|
|
11534
|
+
* @description Company id.
|
|
11535
|
+
*/
|
|
11536
|
+
id: string;
|
|
11537
|
+
/**
|
|
11538
|
+
* Format: uuid
|
|
11539
|
+
* @description Location id.
|
|
11540
|
+
*/
|
|
11541
|
+
locationRef: string;
|
|
11542
|
+
/** @description Company logo. */
|
|
11543
|
+
logo?: {
|
|
11544
|
+
/** @description Storage key of the company logo. */
|
|
11545
|
+
key: string;
|
|
11546
|
+
/** @description Public URL of the company logo. */
|
|
11547
|
+
url: string;
|
|
11548
|
+
};
|
|
11549
|
+
/** @description Company metadata. */
|
|
11550
|
+
metadata?: {
|
|
11551
|
+
[key: string]: unknown;
|
|
11552
|
+
};
|
|
11553
|
+
/** @description Internal notes. */
|
|
11554
|
+
notes?: string;
|
|
11555
|
+
/** @description Public logo URL derived from the company website. */
|
|
11556
|
+
publicLogoUrl?: string;
|
|
11557
|
+
/**
|
|
11558
|
+
* Format: uuid
|
|
11559
|
+
* @description Primary subscription id.
|
|
11560
|
+
*/
|
|
11561
|
+
subscriptionRef: string | null;
|
|
11562
|
+
/** @description Company name. */
|
|
11563
|
+
title: string;
|
|
11564
|
+
};
|
|
11565
|
+
/**
|
|
11566
|
+
* Format: uuid
|
|
11567
|
+
* @deprecated
|
|
11568
|
+
* @description Deprecated. Use customer instead.
|
|
11569
|
+
*/
|
|
11570
|
+
companyRef?: string;
|
|
11571
|
+
/**
|
|
11572
|
+
* Format: date-time
|
|
11573
|
+
* @description ISO timestamp of when the transaction was created.
|
|
11574
|
+
*/
|
|
11575
|
+
createDate: string;
|
|
11576
|
+
/** @description Customer associated with this transaction. */
|
|
11577
|
+
customer: {
|
|
11578
|
+
/**
|
|
11579
|
+
* Format: uuid
|
|
11580
|
+
* @description ID of the company or membership.
|
|
11581
|
+
*/
|
|
11582
|
+
id: string;
|
|
11583
|
+
/** @description Company logo. */
|
|
11584
|
+
logo?: {
|
|
11585
|
+
key: string;
|
|
11586
|
+
url: string;
|
|
11587
|
+
};
|
|
11588
|
+
/** @description Company name. */
|
|
11589
|
+
title?: string;
|
|
11590
|
+
/**
|
|
11591
|
+
* @description Whether the customer is a company or a user.
|
|
11592
|
+
* @enum {string}
|
|
11593
|
+
*/
|
|
11594
|
+
type: "company" | "user";
|
|
11595
|
+
/** @description User details for membership customers. */
|
|
11596
|
+
user?: {
|
|
11597
|
+
about?: string | null;
|
|
11598
|
+
email?: string | null;
|
|
11599
|
+
/** Format: uuid */
|
|
11600
|
+
id: string;
|
|
11601
|
+
name?: string | null;
|
|
11602
|
+
phoneNumber?: string | null;
|
|
11603
|
+
photoUrl?: string | null;
|
|
11604
|
+
surname?: string | null;
|
|
11605
|
+
};
|
|
11606
|
+
};
|
|
11607
|
+
/** @description Transaction description. */
|
|
11608
|
+
description?: string;
|
|
11609
|
+
/**
|
|
11610
|
+
* Format: uuid
|
|
11611
|
+
* @description Unique identifier of the transaction.
|
|
11612
|
+
*/
|
|
11613
|
+
id: string;
|
|
11614
|
+
/**
|
|
11615
|
+
* Format: uuid
|
|
11616
|
+
* @description ID of the organization (location).
|
|
11617
|
+
*/
|
|
11618
|
+
locationRef: string;
|
|
11619
|
+
/**
|
|
11620
|
+
* Format: uuid
|
|
11621
|
+
* @deprecated
|
|
11622
|
+
* @description Deprecated. Use customer instead.
|
|
11623
|
+
*/
|
|
11624
|
+
membershipRef?: string;
|
|
11625
|
+
/**
|
|
11626
|
+
* Format: uuid
|
|
11627
|
+
* @deprecated
|
|
11628
|
+
* @description Deprecated. Use userCreator instead.
|
|
11629
|
+
*/
|
|
11630
|
+
membershipRefCreator?: string;
|
|
11631
|
+
/**
|
|
11632
|
+
* Format: uuid
|
|
11633
|
+
* @description ID of the network.
|
|
11634
|
+
*/
|
|
11635
|
+
networkRef: string;
|
|
11636
|
+
/** @description Product details. */
|
|
11637
|
+
product?: {
|
|
11638
|
+
/**
|
|
11639
|
+
* Format: uuid
|
|
11640
|
+
* @description ID of the associated booking.
|
|
11641
|
+
*/
|
|
11642
|
+
bookingRef?: string;
|
|
11643
|
+
/** @description Display title of the product. */
|
|
11644
|
+
title: string;
|
|
11645
|
+
/**
|
|
11646
|
+
* @description Product type.
|
|
11647
|
+
* @enum {string}
|
|
11648
|
+
*/
|
|
11649
|
+
type: "booking";
|
|
11650
|
+
};
|
|
11651
|
+
/**
|
|
11652
|
+
* @deprecated
|
|
11653
|
+
* @description Deprecated.
|
|
11654
|
+
*/
|
|
11655
|
+
refund?: {
|
|
11656
|
+
/** @description Refunded expiring amount. */
|
|
11657
|
+
amount: number;
|
|
11658
|
+
/**
|
|
11659
|
+
* Format: date-time
|
|
11660
|
+
* @description Refund creation timestamp.
|
|
11661
|
+
*/
|
|
11662
|
+
createDate: string;
|
|
11663
|
+
};
|
|
11664
|
+
/** @description Transaction status. */
|
|
11665
|
+
status: string;
|
|
11666
|
+
/**
|
|
11667
|
+
* @description Day pass transaction type.
|
|
11668
|
+
* @enum {string}
|
|
11669
|
+
*/
|
|
11670
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "expiration" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
11671
|
+
/**
|
|
11672
|
+
* @deprecated
|
|
11673
|
+
* @description Deprecated. Use userOwner instead.
|
|
11674
|
+
*/
|
|
11675
|
+
user?: {
|
|
11676
|
+
about?: string | null;
|
|
11677
|
+
email?: string | null;
|
|
10858
11678
|
/** Format: uuid */
|
|
10859
|
-
id
|
|
10860
|
-
name?: string;
|
|
11679
|
+
id: string;
|
|
11680
|
+
name?: string | null;
|
|
11681
|
+
phoneNumber?: string | null;
|
|
11682
|
+
photoUrl?: string | null;
|
|
11683
|
+
surname?: string | null;
|
|
10861
11684
|
};
|
|
10862
|
-
|
|
11685
|
+
/** @description User who created the transaction. */
|
|
11686
|
+
userCreatedBy?: {
|
|
11687
|
+
about?: string | null;
|
|
11688
|
+
email?: string | null;
|
|
10863
11689
|
/** Format: uuid */
|
|
10864
|
-
id
|
|
10865
|
-
|
|
11690
|
+
id: string;
|
|
11691
|
+
name?: string | null;
|
|
11692
|
+
phoneNumber?: string | null;
|
|
11693
|
+
photoUrl?: string | null;
|
|
11694
|
+
surname?: string | null;
|
|
10866
11695
|
};
|
|
10867
|
-
|
|
10868
|
-
|
|
10869
|
-
|
|
10870
|
-
|
|
10871
|
-
|
|
10872
|
-
|
|
10873
|
-
|
|
10874
|
-
status?: "canceled" | "failed" | "succeeded";
|
|
10875
|
-
ticket?: {
|
|
10876
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10877
|
-
event?: {
|
|
10878
|
-
endDate?: components["schemas"]["dateSchema"];
|
|
11696
|
+
/**
|
|
11697
|
+
* @deprecated
|
|
11698
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
11699
|
+
*/
|
|
11700
|
+
userCreator?: {
|
|
11701
|
+
about?: string | null;
|
|
11702
|
+
email?: string | null;
|
|
10879
11703
|
/** Format: uuid */
|
|
10880
|
-
id
|
|
10881
|
-
|
|
10882
|
-
|
|
11704
|
+
id: string;
|
|
11705
|
+
name?: string | null;
|
|
11706
|
+
phoneNumber?: string | null;
|
|
11707
|
+
photoUrl?: string | null;
|
|
11708
|
+
surname?: string | null;
|
|
10883
11709
|
};
|
|
10884
|
-
/**
|
|
10885
|
-
|
|
10886
|
-
|
|
10887
|
-
|
|
10888
|
-
|
|
10889
|
-
|
|
10890
|
-
|
|
10891
|
-
/** Format: uuid */
|
|
10892
|
-
userRefCreator?: string;
|
|
10893
|
-
/** Format: uuid */
|
|
10894
|
-
userRefOwner?: string;
|
|
10895
|
-
};
|
|
10896
|
-
transactionCredits: {
|
|
10897
|
-
amount?: number;
|
|
10898
|
-
company?: components["schemas"]["company"];
|
|
10899
|
-
/** Format: uuid */
|
|
10900
|
-
companyRef?: string;
|
|
10901
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10902
|
-
/** @description The memo of the transaction. */
|
|
10903
|
-
description?: string;
|
|
10904
|
-
/** Format: uuid */
|
|
10905
|
-
id?: string;
|
|
10906
|
-
/** Format: uuid */
|
|
10907
|
-
locationRef?: string;
|
|
10908
|
-
/** Format: uuid */
|
|
10909
|
-
membershipRef?: string;
|
|
10910
|
-
/** Format: uuid */
|
|
10911
|
-
membershipRefCreator?: string;
|
|
10912
|
-
/** @enum {string} */
|
|
10913
|
-
status?: "canceled" | "failed" | "succeeded";
|
|
10914
|
-
/** @enum {string} */
|
|
10915
|
-
type?: "chargeExpiringCredits" | "chargePermanentCredits" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
10916
|
-
userCreator?: components["schemas"]["user"];
|
|
10917
|
-
userOwner?: components["schemas"]["user"];
|
|
10918
|
-
/** Format: uuid */
|
|
10919
|
-
userRef?: string;
|
|
10920
|
-
/** Format: uuid */
|
|
10921
|
-
userRefCreator?: string;
|
|
10922
|
-
};
|
|
10923
|
-
transactionDayPassesExpanded: {
|
|
10924
|
-
amount?: number;
|
|
10925
|
-
booking?: {
|
|
10926
|
-
/** Format: uuid */
|
|
10927
|
-
id?: string;
|
|
10928
|
-
resource?: {
|
|
11710
|
+
/**
|
|
11711
|
+
* @deprecated
|
|
11712
|
+
* @description Deprecated. Use customer.user instead.
|
|
11713
|
+
*/
|
|
11714
|
+
userOwner?: {
|
|
11715
|
+
about?: string | null;
|
|
11716
|
+
email?: string | null;
|
|
10929
11717
|
/** Format: uuid */
|
|
10930
|
-
id
|
|
10931
|
-
|
|
11718
|
+
id: string;
|
|
11719
|
+
name?: string | null;
|
|
11720
|
+
phoneNumber?: string | null;
|
|
11721
|
+
photoUrl?: string | null;
|
|
11722
|
+
surname?: string | null;
|
|
10932
11723
|
};
|
|
11724
|
+
/**
|
|
11725
|
+
* Format: uuid
|
|
11726
|
+
* @deprecated
|
|
11727
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
11728
|
+
*/
|
|
11729
|
+
userRefCreator?: string;
|
|
11730
|
+
/**
|
|
11731
|
+
* Format: uuid
|
|
11732
|
+
* @deprecated
|
|
11733
|
+
* @description Deprecated. Use customer.user instead.
|
|
11734
|
+
*/
|
|
11735
|
+
userRefOwner?: string;
|
|
10933
11736
|
};
|
|
10934
|
-
company?: components["schemas"]["company"];
|
|
10935
|
-
/** Format: uuid */
|
|
10936
|
-
companyRef?: string;
|
|
10937
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10938
|
-
/** Format: uuid */
|
|
10939
|
-
id?: string;
|
|
10940
|
-
/** Format: uuid */
|
|
10941
|
-
locationRef?: string;
|
|
10942
|
-
/** Format: uuid */
|
|
10943
|
-
membershipRefCreator?: string;
|
|
10944
|
-
/** Format: uuid */
|
|
10945
|
-
membershipRefOwner?: string;
|
|
10946
|
-
refund?: {
|
|
10947
|
-
amount?: number;
|
|
10948
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10949
|
-
};
|
|
10950
|
-
/** @enum {string} */
|
|
10951
|
-
type?: "booking" | "chargeExpiringDayPasses" | "chargePermanentDayPasses" | "refund" | "subscriptionExpiration" | "subscriptionRenewal" | "transferExpiringDayPasses" | "transferPermanentDayPasses";
|
|
10952
|
-
userCreator?: components["schemas"]["user"];
|
|
10953
|
-
userOwner?: components["schemas"]["user"];
|
|
10954
|
-
/** Format: uuid */
|
|
10955
|
-
userRefCreator?: string;
|
|
10956
|
-
/** Format: uuid */
|
|
10957
|
-
userRefOwner?: string;
|
|
10958
|
-
};
|
|
10959
|
-
transactionDayPasses: {
|
|
10960
|
-
amount?: number;
|
|
10961
|
-
company?: components["schemas"]["company"];
|
|
10962
|
-
/** Format: uuid */
|
|
10963
|
-
companyRef?: string;
|
|
10964
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10965
|
-
description?: string;
|
|
10966
|
-
/** Format: uuid */
|
|
10967
|
-
id?: string;
|
|
10968
|
-
/** Format: uuid */
|
|
10969
|
-
locationRef?: string;
|
|
10970
|
-
/** Format: uuid */
|
|
10971
|
-
membershipRef?: string;
|
|
10972
|
-
/** Format: uuid */
|
|
10973
|
-
membershipRefCreator?: string;
|
|
10974
|
-
/** @enum {string} */
|
|
10975
|
-
type?: "chargeExpiringDayPasses" | "chargePermanentDayPasses" | "transferExpiringDayPasses" | "transferPermanentDayPasses";
|
|
10976
|
-
user?: components["schemas"]["user"];
|
|
10977
|
-
/** Format: uuid */
|
|
10978
|
-
userRef?: string;
|
|
10979
|
-
/** Format: uuid */
|
|
10980
|
-
userRefCreator?: string;
|
|
10981
11737
|
};
|
|
10982
11738
|
transaction: {
|
|
10983
11739
|
amount?: number;
|
|
@@ -14578,27 +15334,40 @@ interface components {
|
|
|
14578
15334
|
content: {
|
|
14579
15335
|
"application/json": {
|
|
14580
15336
|
transaction: {
|
|
15337
|
+
/** @description Day pass amount. Must be greater than zero. */
|
|
14581
15338
|
amount: number;
|
|
14582
15339
|
/**
|
|
14583
15340
|
* Format: uuid
|
|
14584
|
-
* @
|
|
15341
|
+
* @deprecated
|
|
15342
|
+
* @description Deprecated. Use customerRef instead.
|
|
14585
15343
|
*/
|
|
14586
15344
|
companyRef?: string;
|
|
14587
|
-
/**
|
|
15345
|
+
/**
|
|
15346
|
+
* Format: uuid
|
|
15347
|
+
* @description The company or membership id to charge or transfer day passes to or from.
|
|
15348
|
+
*/
|
|
15349
|
+
customerRef?: string;
|
|
15350
|
+
/** @description Description of the transaction. */
|
|
14588
15351
|
description?: string;
|
|
15352
|
+
/** @description Expiration date for expiring day passes. */
|
|
15353
|
+
expirationDate?: string;
|
|
14589
15354
|
/**
|
|
14590
15355
|
* Format: uuid
|
|
14591
|
-
* @description The location id where to create
|
|
15356
|
+
* @description The location id where to create the transaction.
|
|
14592
15357
|
*/
|
|
14593
15358
|
locationRef: string;
|
|
14594
15359
|
/**
|
|
14595
15360
|
* Format: uuid
|
|
14596
|
-
* @
|
|
15361
|
+
* @deprecated
|
|
15362
|
+
* @description Deprecated. Use customerRef instead.
|
|
14597
15363
|
*/
|
|
14598
15364
|
membershipRef?: string;
|
|
14599
|
-
/**
|
|
14600
|
-
|
|
14601
|
-
|
|
15365
|
+
/**
|
|
15366
|
+
* @description Transaction type. chargeExpiringDayPasses, chargePermanentDayPasses, transferExpiringDayPasses, and transferPermanentDayPasses are deprecated; use adminCharge or adminAllocation instead.
|
|
15367
|
+
* @enum {string}
|
|
15368
|
+
*/
|
|
15369
|
+
type: "adminAllocation" | "adminCharge" | "chargeExpiringDayPasses" | "chargePermanentDayPasses" | "transferExpiringDayPasses" | "transferPermanentDayPasses";
|
|
15370
|
+
};
|
|
14602
15371
|
};
|
|
14603
15372
|
};
|
|
14604
15373
|
};
|
|
@@ -15999,14 +16768,26 @@ interface operations {
|
|
|
15999
16768
|
getCreditNotes: {
|
|
16000
16769
|
parameters: {
|
|
16001
16770
|
query?: {
|
|
16002
|
-
/** @description
|
|
16771
|
+
/** @description Filter credit notes created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
|
|
16772
|
+
"createDate[gte]"?: string;
|
|
16773
|
+
/** @description Filter credit notes created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
16774
|
+
"createDate[lte]"?: string;
|
|
16775
|
+
/** @description UUID of the invoice whose credit notes to list. */
|
|
16003
16776
|
invoiceRef?: string;
|
|
16004
|
-
/** @description
|
|
16005
|
-
locationRef?: string;
|
|
16006
|
-
/** @description The maximum number of items to return (max 100, default 25) */
|
|
16777
|
+
/** @description Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
16007
16778
|
limit?: number;
|
|
16008
|
-
/** @description
|
|
16009
|
-
|
|
16779
|
+
/** @description UUID of the location whose credit notes to list. */
|
|
16780
|
+
locationRef?: string;
|
|
16781
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
16782
|
+
nextPageToken?: string;
|
|
16783
|
+
/**
|
|
16784
|
+
* @description Filter by credit note status. Comma-separated values, e.g. `issued,voided`.
|
|
16785
|
+
*
|
|
16786
|
+
* Supported values:
|
|
16787
|
+
* - **issued** — active credit note
|
|
16788
|
+
* - **voided** — cancelled and no longer valid
|
|
16789
|
+
*/
|
|
16790
|
+
status?: string;
|
|
16010
16791
|
};
|
|
16011
16792
|
header?: {
|
|
16012
16793
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -16023,11 +16804,7 @@ interface operations {
|
|
|
16023
16804
|
[name: string]: unknown;
|
|
16024
16805
|
};
|
|
16025
16806
|
content: {
|
|
16026
|
-
"application/json":
|
|
16027
|
-
creditNotes?: components["schemas"]["creditNote"][];
|
|
16028
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
16029
|
-
searchQueryNext?: components["schemas"]["searchQueryNext"];
|
|
16030
|
-
};
|
|
16807
|
+
"application/json": components["schemas"]["getCreditNotes"];
|
|
16031
16808
|
};
|
|
16032
16809
|
};
|
|
16033
16810
|
/** @description Bad Request */
|
|
@@ -20148,29 +20925,24 @@ interface operations {
|
|
|
20148
20925
|
getDayPassesTransactions: {
|
|
20149
20926
|
parameters: {
|
|
20150
20927
|
query?: {
|
|
20151
|
-
/** @description The
|
|
20928
|
+
/** @description Deprecated. Use customerRef instead. The id of the company to get transactions for. */
|
|
20929
|
+
companyRef?: string;
|
|
20930
|
+
/** @description Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
20931
|
+
"createDate[gte]"?: string;
|
|
20932
|
+
/** @description Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
20933
|
+
"createDate[lte]"?: string;
|
|
20934
|
+
/** @description UUID of the company or membership whose day pass transactions to list. */
|
|
20935
|
+
customerRef?: string;
|
|
20936
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
20152
20937
|
limit?: number;
|
|
20153
|
-
/** @description
|
|
20154
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
20155
|
-
/** @description The date filter of items. */
|
|
20156
|
-
createDate?: {
|
|
20157
|
-
/**
|
|
20158
|
-
* Format: date-time
|
|
20159
|
-
* @description Get transactions with less createDate. Example: createDate[lte]=2021-05-21T10:00:00Z
|
|
20160
|
-
*/
|
|
20161
|
-
lte?: string;
|
|
20162
|
-
/**
|
|
20163
|
-
* Format: date-time
|
|
20164
|
-
* @description Get transactions with greater createDate. Example: createDate[gte]=2021-05-21T10:00:00Z
|
|
20165
|
-
*/
|
|
20166
|
-
gte?: string;
|
|
20167
|
-
};
|
|
20168
|
-
/** @description The id of the location to get transactions for */
|
|
20938
|
+
/** @description UUID of the location whose day pass transactions to list. */
|
|
20169
20939
|
locationRef?: string;
|
|
20170
|
-
/** @description The id of the membership to get transactions for */
|
|
20940
|
+
/** @description Deprecated. Use customerRef instead. The id of the membership to get transactions for. */
|
|
20171
20941
|
membershipRef?: string;
|
|
20172
|
-
/** @description
|
|
20173
|
-
|
|
20942
|
+
/** @description Token to retrieve the next page of results. */
|
|
20943
|
+
nextPageToken?: string;
|
|
20944
|
+
/** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
|
|
20945
|
+
type?: string;
|
|
20174
20946
|
};
|
|
20175
20947
|
header?: {
|
|
20176
20948
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -20187,10 +20959,7 @@ interface operations {
|
|
|
20187
20959
|
[name: string]: unknown;
|
|
20188
20960
|
};
|
|
20189
20961
|
content: {
|
|
20190
|
-
"application/json":
|
|
20191
|
-
transactions?: components["schemas"]["transactionDayPassesExpanded"][];
|
|
20192
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
20193
|
-
};
|
|
20962
|
+
"application/json": components["schemas"]["getDayPassesTransactions"];
|
|
20194
20963
|
};
|
|
20195
20964
|
};
|
|
20196
20965
|
/** @description Bad Request */
|
|
@@ -20222,9 +20991,7 @@ interface operations {
|
|
|
20222
20991
|
[name: string]: unknown;
|
|
20223
20992
|
};
|
|
20224
20993
|
content: {
|
|
20225
|
-
"application/json":
|
|
20226
|
-
transaction?: components["schemas"]["transactionDayPasses"];
|
|
20227
|
-
};
|
|
20994
|
+
"application/json": components["schemas"]["createDayPassesTransaction"];
|
|
20228
20995
|
};
|
|
20229
20996
|
};
|
|
20230
20997
|
/** @description Bad Request */
|