@izak0s/spacebring-api 1.3.1 → 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 +957 -182
- package/dist/index.d.ts +957 -182
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -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" | "nbg";
|
|
2269
|
+
provider?: "fastForex" | "nbu" | "bcra" | "nbg" | "bcch";
|
|
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;
|
|
@@ -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: {
|
|
@@ -7511,7 +7800,13 @@ interface components {
|
|
|
7511
7800
|
memo?: string;
|
|
7512
7801
|
/** Format: uuid */
|
|
7513
7802
|
membershipRefOwner?: string;
|
|
7803
|
+
/**
|
|
7804
|
+
* @deprecated
|
|
7805
|
+
* @description Deprecated. Use `payments` instead.
|
|
7806
|
+
*/
|
|
7514
7807
|
payment?: components["schemas"]["payment"];
|
|
7808
|
+
/** @description Booking payments. Multiple entries when the booking has several ledger transactions. */
|
|
7809
|
+
payments?: components["schemas"]["payment"][];
|
|
7515
7810
|
/** Format: uuid */
|
|
7516
7811
|
resourceRef?: string;
|
|
7517
7812
|
seats?: number;
|
|
@@ -10829,149 +11124,616 @@ interface components {
|
|
|
10829
11124
|
id?: string;
|
|
10830
11125
|
title?: string;
|
|
10831
11126
|
};
|
|
10832
|
-
};
|
|
10833
|
-
company?: components["schemas"]["company"];
|
|
10834
|
-
/** Format: uuid */
|
|
10835
|
-
companyRef?: string;
|
|
10836
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10837
|
-
/** @description The memo of the transaction. */
|
|
10838
|
-
description?: string;
|
|
10839
|
-
/** Format: uuid */
|
|
10840
|
-
id?: string;
|
|
10841
|
-
expiringAmount?: number;
|
|
10842
|
-
/** Format: uuid */
|
|
10843
|
-
locationRef?: string;
|
|
10844
|
-
/** Format: uuid */
|
|
10845
|
-
membershipRefCreator?: string;
|
|
10846
|
-
/** Format: uuid */
|
|
10847
|
-
membershipRef?: string;
|
|
10848
|
-
order?: {
|
|
10849
|
-
/** Format: uuid */
|
|
10850
|
-
id?: string;
|
|
10851
|
-
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;
|
|
10852
11678
|
/** Format: uuid */
|
|
10853
|
-
id
|
|
10854
|
-
name?: string;
|
|
11679
|
+
id: string;
|
|
11680
|
+
name?: string | null;
|
|
11681
|
+
phoneNumber?: string | null;
|
|
11682
|
+
photoUrl?: string | null;
|
|
11683
|
+
surname?: string | null;
|
|
10855
11684
|
};
|
|
10856
|
-
|
|
11685
|
+
/** @description User who created the transaction. */
|
|
11686
|
+
userCreatedBy?: {
|
|
11687
|
+
about?: string | null;
|
|
11688
|
+
email?: string | null;
|
|
10857
11689
|
/** Format: uuid */
|
|
10858
|
-
id
|
|
10859
|
-
|
|
11690
|
+
id: string;
|
|
11691
|
+
name?: string | null;
|
|
11692
|
+
phoneNumber?: string | null;
|
|
11693
|
+
photoUrl?: string | null;
|
|
11694
|
+
surname?: string | null;
|
|
10860
11695
|
};
|
|
10861
|
-
|
|
10862
|
-
|
|
10863
|
-
|
|
10864
|
-
|
|
10865
|
-
|
|
10866
|
-
|
|
10867
|
-
|
|
10868
|
-
status?: "canceled" | "failed" | "succeeded";
|
|
10869
|
-
ticket?: {
|
|
10870
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10871
|
-
event?: {
|
|
10872
|
-
endDate?: components["schemas"]["dateSchema"];
|
|
11696
|
+
/**
|
|
11697
|
+
* @deprecated
|
|
11698
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
11699
|
+
*/
|
|
11700
|
+
userCreator?: {
|
|
11701
|
+
about?: string | null;
|
|
11702
|
+
email?: string | null;
|
|
10873
11703
|
/** Format: uuid */
|
|
10874
|
-
id
|
|
10875
|
-
|
|
10876
|
-
|
|
11704
|
+
id: string;
|
|
11705
|
+
name?: string | null;
|
|
11706
|
+
phoneNumber?: string | null;
|
|
11707
|
+
photoUrl?: string | null;
|
|
11708
|
+
surname?: string | null;
|
|
10877
11709
|
};
|
|
10878
|
-
/**
|
|
10879
|
-
|
|
10880
|
-
|
|
10881
|
-
|
|
10882
|
-
|
|
10883
|
-
|
|
10884
|
-
|
|
10885
|
-
/** Format: uuid */
|
|
10886
|
-
userRefCreator?: string;
|
|
10887
|
-
/** Format: uuid */
|
|
10888
|
-
userRefOwner?: string;
|
|
10889
|
-
};
|
|
10890
|
-
transactionCredits: {
|
|
10891
|
-
amount?: number;
|
|
10892
|
-
company?: components["schemas"]["company"];
|
|
10893
|
-
/** Format: uuid */
|
|
10894
|
-
companyRef?: string;
|
|
10895
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10896
|
-
/** @description The memo of the transaction. */
|
|
10897
|
-
description?: string;
|
|
10898
|
-
/** Format: uuid */
|
|
10899
|
-
id?: string;
|
|
10900
|
-
/** Format: uuid */
|
|
10901
|
-
locationRef?: string;
|
|
10902
|
-
/** Format: uuid */
|
|
10903
|
-
membershipRef?: string;
|
|
10904
|
-
/** Format: uuid */
|
|
10905
|
-
membershipRefCreator?: string;
|
|
10906
|
-
/** @enum {string} */
|
|
10907
|
-
status?: "canceled" | "failed" | "succeeded";
|
|
10908
|
-
/** @enum {string} */
|
|
10909
|
-
type?: "chargeExpiringCredits" | "chargePermanentCredits" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
10910
|
-
userCreator?: components["schemas"]["user"];
|
|
10911
|
-
userOwner?: components["schemas"]["user"];
|
|
10912
|
-
/** Format: uuid */
|
|
10913
|
-
userRef?: string;
|
|
10914
|
-
/** Format: uuid */
|
|
10915
|
-
userRefCreator?: string;
|
|
10916
|
-
};
|
|
10917
|
-
transactionDayPassesExpanded: {
|
|
10918
|
-
amount?: number;
|
|
10919
|
-
booking?: {
|
|
10920
|
-
/** Format: uuid */
|
|
10921
|
-
id?: string;
|
|
10922
|
-
resource?: {
|
|
11710
|
+
/**
|
|
11711
|
+
* @deprecated
|
|
11712
|
+
* @description Deprecated. Use customer.user instead.
|
|
11713
|
+
*/
|
|
11714
|
+
userOwner?: {
|
|
11715
|
+
about?: string | null;
|
|
11716
|
+
email?: string | null;
|
|
10923
11717
|
/** Format: uuid */
|
|
10924
|
-
id
|
|
10925
|
-
|
|
11718
|
+
id: string;
|
|
11719
|
+
name?: string | null;
|
|
11720
|
+
phoneNumber?: string | null;
|
|
11721
|
+
photoUrl?: string | null;
|
|
11722
|
+
surname?: string | null;
|
|
10926
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;
|
|
10927
11736
|
};
|
|
10928
|
-
company?: components["schemas"]["company"];
|
|
10929
|
-
/** Format: uuid */
|
|
10930
|
-
companyRef?: string;
|
|
10931
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10932
|
-
/** Format: uuid */
|
|
10933
|
-
id?: string;
|
|
10934
|
-
/** Format: uuid */
|
|
10935
|
-
locationRef?: string;
|
|
10936
|
-
/** Format: uuid */
|
|
10937
|
-
membershipRefCreator?: string;
|
|
10938
|
-
/** Format: uuid */
|
|
10939
|
-
membershipRefOwner?: string;
|
|
10940
|
-
refund?: {
|
|
10941
|
-
amount?: number;
|
|
10942
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10943
|
-
};
|
|
10944
|
-
/** @enum {string} */
|
|
10945
|
-
type?: "booking" | "chargeExpiringDayPasses" | "chargePermanentDayPasses" | "refund" | "subscriptionExpiration" | "subscriptionRenewal" | "transferExpiringDayPasses" | "transferPermanentDayPasses";
|
|
10946
|
-
userCreator?: components["schemas"]["user"];
|
|
10947
|
-
userOwner?: components["schemas"]["user"];
|
|
10948
|
-
/** Format: uuid */
|
|
10949
|
-
userRefCreator?: string;
|
|
10950
|
-
/** Format: uuid */
|
|
10951
|
-
userRefOwner?: string;
|
|
10952
|
-
};
|
|
10953
|
-
transactionDayPasses: {
|
|
10954
|
-
amount?: number;
|
|
10955
|
-
company?: components["schemas"]["company"];
|
|
10956
|
-
/** Format: uuid */
|
|
10957
|
-
companyRef?: string;
|
|
10958
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
10959
|
-
description?: string;
|
|
10960
|
-
/** Format: uuid */
|
|
10961
|
-
id?: string;
|
|
10962
|
-
/** Format: uuid */
|
|
10963
|
-
locationRef?: string;
|
|
10964
|
-
/** Format: uuid */
|
|
10965
|
-
membershipRef?: string;
|
|
10966
|
-
/** Format: uuid */
|
|
10967
|
-
membershipRefCreator?: string;
|
|
10968
|
-
/** @enum {string} */
|
|
10969
|
-
type?: "chargeExpiringDayPasses" | "chargePermanentDayPasses" | "transferExpiringDayPasses" | "transferPermanentDayPasses";
|
|
10970
|
-
user?: components["schemas"]["user"];
|
|
10971
|
-
/** Format: uuid */
|
|
10972
|
-
userRef?: string;
|
|
10973
|
-
/** Format: uuid */
|
|
10974
|
-
userRefCreator?: string;
|
|
10975
11737
|
};
|
|
10976
11738
|
transaction: {
|
|
10977
11739
|
amount?: number;
|
|
@@ -11283,7 +12045,7 @@ interface components {
|
|
|
11283
12045
|
* @description Exchange rate provider when auto-update is enabled.
|
|
11284
12046
|
* @enum {string}
|
|
11285
12047
|
*/
|
|
11286
|
-
provider: "fastForex" | "nbu" | "bcra" | "nbg";
|
|
12048
|
+
provider: "fastForex" | "nbu" | "bcra" | "nbg" | "bcch";
|
|
11287
12049
|
} | {
|
|
11288
12050
|
/** @description Exchange rate relative to the location main currency. */
|
|
11289
12051
|
exchangeRate: number;
|
|
@@ -11300,7 +12062,7 @@ interface components {
|
|
|
11300
12062
|
* @description Exchange rate provider when auto-update is enabled.
|
|
11301
12063
|
* @enum {string}
|
|
11302
12064
|
*/
|
|
11303
|
-
provider: "fastForex" | "nbu" | "bcra" | "nbg";
|
|
12065
|
+
provider: "fastForex" | "nbu" | "bcra" | "nbg" | "bcch";
|
|
11304
12066
|
} | {
|
|
11305
12067
|
/** @description Exchange rate relative to the location main currency. */
|
|
11306
12068
|
exchangeRate: number;
|
|
@@ -14572,27 +15334,40 @@ interface components {
|
|
|
14572
15334
|
content: {
|
|
14573
15335
|
"application/json": {
|
|
14574
15336
|
transaction: {
|
|
15337
|
+
/** @description Day pass amount. Must be greater than zero. */
|
|
14575
15338
|
amount: number;
|
|
14576
15339
|
/**
|
|
14577
15340
|
* Format: uuid
|
|
14578
|
-
* @
|
|
15341
|
+
* @deprecated
|
|
15342
|
+
* @description Deprecated. Use customerRef instead.
|
|
14579
15343
|
*/
|
|
14580
15344
|
companyRef?: string;
|
|
14581
|
-
/**
|
|
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. */
|
|
14582
15351
|
description?: string;
|
|
15352
|
+
/** @description Expiration date for expiring day passes. */
|
|
15353
|
+
expirationDate?: string;
|
|
14583
15354
|
/**
|
|
14584
15355
|
* Format: uuid
|
|
14585
|
-
* @description The location id where to create
|
|
15356
|
+
* @description The location id where to create the transaction.
|
|
14586
15357
|
*/
|
|
14587
15358
|
locationRef: string;
|
|
14588
15359
|
/**
|
|
14589
15360
|
* Format: uuid
|
|
14590
|
-
* @
|
|
15361
|
+
* @deprecated
|
|
15362
|
+
* @description Deprecated. Use customerRef instead.
|
|
14591
15363
|
*/
|
|
14592
15364
|
membershipRef?: string;
|
|
14593
|
-
/**
|
|
14594
|
-
|
|
14595
|
-
|
|
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
|
+
};
|
|
14596
15371
|
};
|
|
14597
15372
|
};
|
|
14598
15373
|
};
|
|
@@ -15993,14 +16768,26 @@ interface operations {
|
|
|
15993
16768
|
getCreditNotes: {
|
|
15994
16769
|
parameters: {
|
|
15995
16770
|
query?: {
|
|
15996
|
-
/** @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. */
|
|
15997
16776
|
invoiceRef?: string;
|
|
15998
|
-
/** @description
|
|
15999
|
-
locationRef?: string;
|
|
16000
|
-
/** @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. */
|
|
16001
16778
|
limit?: number;
|
|
16002
|
-
/** @description
|
|
16003
|
-
|
|
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;
|
|
16004
16791
|
};
|
|
16005
16792
|
header?: {
|
|
16006
16793
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -16017,11 +16804,7 @@ interface operations {
|
|
|
16017
16804
|
[name: string]: unknown;
|
|
16018
16805
|
};
|
|
16019
16806
|
content: {
|
|
16020
|
-
"application/json":
|
|
16021
|
-
creditNotes?: components["schemas"]["creditNote"][];
|
|
16022
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
16023
|
-
searchQueryNext?: components["schemas"]["searchQueryNext"];
|
|
16024
|
-
};
|
|
16807
|
+
"application/json": components["schemas"]["getCreditNotes"];
|
|
16025
16808
|
};
|
|
16026
16809
|
};
|
|
16027
16810
|
/** @description Bad Request */
|
|
@@ -19385,6 +20168,8 @@ interface operations {
|
|
|
19385
20168
|
locationRef?: string;
|
|
19386
20169
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
19387
20170
|
nextPageToken?: string;
|
|
20171
|
+
/** @description Comma-separated product UUIDs used to filter orders, e.g. `uuid1,uuid2`. */
|
|
20172
|
+
productRef?: string;
|
|
19388
20173
|
/**
|
|
19389
20174
|
* @description Filter by order status. Comma-separated values, e.g. `new,inProgress`. Defaults to `new`, `inProgress`, and `completed` when omitted.
|
|
19390
20175
|
*
|
|
@@ -20140,29 +20925,24 @@ interface operations {
|
|
|
20140
20925
|
getDayPassesTransactions: {
|
|
20141
20926
|
parameters: {
|
|
20142
20927
|
query?: {
|
|
20143
|
-
/** @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. */
|
|
20144
20937
|
limit?: number;
|
|
20145
|
-
/** @description
|
|
20146
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
20147
|
-
/** @description The date filter of items. */
|
|
20148
|
-
createDate?: {
|
|
20149
|
-
/**
|
|
20150
|
-
* Format: date-time
|
|
20151
|
-
* @description Get transactions with less createDate. Example: createDate[lte]=2021-05-21T10:00:00Z
|
|
20152
|
-
*/
|
|
20153
|
-
lte?: string;
|
|
20154
|
-
/**
|
|
20155
|
-
* Format: date-time
|
|
20156
|
-
* @description Get transactions with greater createDate. Example: createDate[gte]=2021-05-21T10:00:00Z
|
|
20157
|
-
*/
|
|
20158
|
-
gte?: string;
|
|
20159
|
-
};
|
|
20160
|
-
/** @description The id of the location to get transactions for */
|
|
20938
|
+
/** @description UUID of the location whose day pass transactions to list. */
|
|
20161
20939
|
locationRef?: string;
|
|
20162
|
-
/** @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. */
|
|
20163
20941
|
membershipRef?: string;
|
|
20164
|
-
/** @description
|
|
20165
|
-
|
|
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;
|
|
20166
20946
|
};
|
|
20167
20947
|
header?: {
|
|
20168
20948
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -20179,10 +20959,7 @@ interface operations {
|
|
|
20179
20959
|
[name: string]: unknown;
|
|
20180
20960
|
};
|
|
20181
20961
|
content: {
|
|
20182
|
-
"application/json":
|
|
20183
|
-
transactions?: components["schemas"]["transactionDayPassesExpanded"][];
|
|
20184
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
20185
|
-
};
|
|
20962
|
+
"application/json": components["schemas"]["getDayPassesTransactions"];
|
|
20186
20963
|
};
|
|
20187
20964
|
};
|
|
20188
20965
|
/** @description Bad Request */
|
|
@@ -20214,9 +20991,7 @@ interface operations {
|
|
|
20214
20991
|
[name: string]: unknown;
|
|
20215
20992
|
};
|
|
20216
20993
|
content: {
|
|
20217
|
-
"application/json":
|
|
20218
|
-
transaction?: components["schemas"]["transactionDayPasses"];
|
|
20219
|
-
};
|
|
20994
|
+
"application/json": components["schemas"]["createDayPassesTransaction"];
|
|
20220
20995
|
};
|
|
20221
20996
|
};
|
|
20222
20997
|
/** @description Bad Request */
|