@izak0s/spacebring-api 16.2.0 → 16.4.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.cjs +7 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +44 -34
- package/dist/index.d.ts +44 -34
- package/dist/index.js +7 -7
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -524,7 +524,7 @@ interface paths {
|
|
|
524
524
|
};
|
|
525
525
|
/**
|
|
526
526
|
* Retrieve invoices
|
|
527
|
-
* @description Retrieve
|
|
527
|
+
* @description Retrieve the invoices of a customer, a location, or the whole network when neither customerRef nor locationRef is set. An administrator limited to some locations needs customerRef or locationRef. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
528
528
|
*/
|
|
529
529
|
get: operations["getInvoices"];
|
|
530
530
|
put?: never;
|
|
@@ -696,7 +696,7 @@ interface paths {
|
|
|
696
696
|
};
|
|
697
697
|
/**
|
|
698
698
|
* List invoice items
|
|
699
|
-
* @description List invoice items filtered by customer, location, invoice, type, status, pending, or date range. Pass invoiceRef for the items of one invoice; they page like the rest of the list. The createDate filter matches when the item was created; the status and issueDate filters match the invoice the item is on, so they return only items connected to an invoice. Pending items are not on an invoice and not part of a subscription: pass pending=true with customerRef for one customer's pending items, or with locationRef for every pending item at a location. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
699
|
+
* @description List invoice items filtered by customer, location, invoice, type, status, pending, or date range. Pass invoiceRef for the items of one invoice; they page like the rest of the list. The createDate filter matches when the item was created; the status and issueDate filters match the invoice the item is on, so they return only items connected to an invoice. Pending items are not on an invoice and not part of a subscription: pass pending=true with customerRef for one customer's pending items, or with locationRef for every pending item at a location. Without customerRef, invoiceRef or locationRef, lists the items of the whole network; an administrator limited to some locations needs one of them. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
700
700
|
*/
|
|
701
701
|
get: operations["listInvoiceItems"];
|
|
702
702
|
put?: never;
|
|
@@ -789,7 +789,7 @@ interface paths {
|
|
|
789
789
|
};
|
|
790
790
|
/**
|
|
791
791
|
* Retrieve credit notes
|
|
792
|
-
* @description Retrieve
|
|
792
|
+
* @description Retrieve the credit notes of an invoice, a location, or the whole network when neither invoiceRef nor locationRef is set. An administrator limited to some locations needs invoiceRef or locationRef. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
793
793
|
*/
|
|
794
794
|
get: operations["getCreditNotes"];
|
|
795
795
|
put?: never;
|
|
@@ -923,7 +923,7 @@ interface paths {
|
|
|
923
923
|
put?: never;
|
|
924
924
|
/**
|
|
925
925
|
* Check in
|
|
926
|
-
* @description Record an arrival for a booking, an event ticket, a visit, or a member's subscription. Identify what to check in with its check-in id, with the location and a six-digit code, or with the location and a customer ref to check a member in without a code. With bearer token authentication, the user must be an administrator of the location. <h3>OAuth</h3>Required scopes: <code>checkIns</code>
|
|
926
|
+
* @description Record an arrival for a booking, an event ticket, a visit, or a member's subscription. Identify what to check in with its check-in id, with the location and a six-digit code, or with the location and a customer ref to check a member in without a code. Add a past check-in date to a customer ref to record an arrival nobody checked the member in for: the member stays checked in until they check out, or, with a check-out date too, the check-in is created as checked out, without the events and webhooks of a live arrival. With bearer token authentication, the user must be an administrator of the location. <h3>OAuth</h3>Required scopes: <code>checkIns</code>
|
|
927
927
|
*/
|
|
928
928
|
post: operations["checkIn"];
|
|
929
929
|
delete?: never;
|
|
@@ -6639,10 +6639,10 @@ interface components {
|
|
|
6639
6639
|
*/
|
|
6640
6640
|
checkInDate?: string;
|
|
6641
6641
|
/**
|
|
6642
|
-
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6642
|
+
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in from the admin app, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6643
6643
|
* @enum {string}
|
|
6644
6644
|
*/
|
|
6645
|
-
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6645
|
+
checkInMethod?: "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6646
6646
|
/**
|
|
6647
6647
|
* Format: uuid
|
|
6648
6648
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6654,10 +6654,10 @@ interface components {
|
|
|
6654
6654
|
*/
|
|
6655
6655
|
checkOutDate?: string;
|
|
6656
6656
|
/**
|
|
6657
|
-
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6657
|
+
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in with its check-out date from the admin app, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6658
6658
|
* @enum {string}
|
|
6659
6659
|
*/
|
|
6660
|
-
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6660
|
+
checkOutMethod?: "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6661
6661
|
/** @description Confirmation code of the check-in. */
|
|
6662
6662
|
code?: string;
|
|
6663
6663
|
/**
|
|
@@ -6779,10 +6779,10 @@ interface components {
|
|
|
6779
6779
|
*/
|
|
6780
6780
|
checkInDate?: string;
|
|
6781
6781
|
/**
|
|
6782
|
-
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6782
|
+
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in from the admin app, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6783
6783
|
* @enum {string}
|
|
6784
6784
|
*/
|
|
6785
|
-
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6785
|
+
checkInMethod?: "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6786
6786
|
/**
|
|
6787
6787
|
* Format: uuid
|
|
6788
6788
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6794,10 +6794,10 @@ interface components {
|
|
|
6794
6794
|
*/
|
|
6795
6795
|
checkOutDate?: string;
|
|
6796
6796
|
/**
|
|
6797
|
-
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6797
|
+
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in with its check-out date from the admin app, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6798
6798
|
* @enum {string}
|
|
6799
6799
|
*/
|
|
6800
|
-
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6800
|
+
checkOutMethod?: "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6801
6801
|
/** @description Confirmation code of the check-in. */
|
|
6802
6802
|
code?: string;
|
|
6803
6803
|
/**
|
|
@@ -22838,12 +22838,12 @@ interface components {
|
|
|
22838
22838
|
*/
|
|
22839
22839
|
locationRef: string;
|
|
22840
22840
|
/** @description Exchange rate relative to the location main currency. Pass either exchangeRate or provider, never both. */
|
|
22841
|
-
exchangeRate?: number;
|
|
22841
|
+
exchangeRate?: number | null;
|
|
22842
22842
|
/**
|
|
22843
22843
|
* @description Exchange rate provider when auto-update is enabled. Pass either provider or exchangeRate, never both.
|
|
22844
|
-
* @enum {string}
|
|
22844
|
+
* @enum {string|null}
|
|
22845
22845
|
*/
|
|
22846
|
-
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
|
|
22846
|
+
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb" | null;
|
|
22847
22847
|
};
|
|
22848
22848
|
};
|
|
22849
22849
|
};
|
|
@@ -22854,12 +22854,12 @@ interface components {
|
|
|
22854
22854
|
/** @description Alt currency fields to update */
|
|
22855
22855
|
altCurrency: {
|
|
22856
22856
|
/** @description Exchange rate relative to the location main currency. Pass either exchangeRate or provider, never both. */
|
|
22857
|
-
exchangeRate?: number;
|
|
22857
|
+
exchangeRate?: number | null;
|
|
22858
22858
|
/**
|
|
22859
22859
|
* @description Exchange rate provider when auto-update is enabled. Pass either provider or exchangeRate, never both.
|
|
22860
|
-
* @enum {string}
|
|
22860
|
+
* @enum {string|null}
|
|
22861
22861
|
*/
|
|
22862
|
-
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
|
|
22862
|
+
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb" | null;
|
|
22863
22863
|
};
|
|
22864
22864
|
};
|
|
22865
22865
|
};
|
|
@@ -23589,6 +23589,16 @@ interface components {
|
|
|
23589
23589
|
* @description UUID of the location the code was issued in. Required when the check-in is resolved by its code or a customer ref.
|
|
23590
23590
|
*/
|
|
23591
23591
|
locationRef?: string;
|
|
23592
|
+
/**
|
|
23593
|
+
* Format: date-time
|
|
23594
|
+
* @description ISO timestamp of a past arrival to record for the member in customerRef, such as a visit nobody checked them in for. Without checkOutDate the member stays checked in until they check out.
|
|
23595
|
+
*/
|
|
23596
|
+
checkInDate?: string;
|
|
23597
|
+
/**
|
|
23598
|
+
* Format: date-time
|
|
23599
|
+
* @description ISO timestamp of when the member left, which creates the check-in as checked out. Requires checkInDate and must be in the past.
|
|
23600
|
+
*/
|
|
23601
|
+
checkOutDate?: string;
|
|
23592
23602
|
/**
|
|
23593
23603
|
* Format: uuid
|
|
23594
23604
|
* @description ID of a member to check in on their subscription without a code. Only administrators of the location can check a member in this way.
|
|
@@ -25128,7 +25138,7 @@ interface components {
|
|
|
25128
25138
|
tiers: {
|
|
25129
25139
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25130
25140
|
flatAmount: number;
|
|
25131
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25141
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25132
25142
|
from: number;
|
|
25133
25143
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25134
25144
|
unitAmount: number;
|
|
@@ -25192,7 +25202,7 @@ interface components {
|
|
|
25192
25202
|
tiers: {
|
|
25193
25203
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25194
25204
|
flatAmount: number;
|
|
25195
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25205
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25196
25206
|
from: number;
|
|
25197
25207
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25198
25208
|
unitAmount: number;
|
|
@@ -25320,7 +25330,7 @@ interface components {
|
|
|
25320
25330
|
tiers: {
|
|
25321
25331
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25322
25332
|
flatAmount: number;
|
|
25323
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25333
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25324
25334
|
from: number;
|
|
25325
25335
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25326
25336
|
unitAmount: number;
|
|
@@ -25349,7 +25359,7 @@ interface components {
|
|
|
25349
25359
|
tiers: {
|
|
25350
25360
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25351
25361
|
flatAmount: number;
|
|
25352
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25362
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25353
25363
|
from: number;
|
|
25354
25364
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25355
25365
|
unitAmount: number;
|
|
@@ -25635,7 +25645,7 @@ interface components {
|
|
|
25635
25645
|
tiers: {
|
|
25636
25646
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25637
25647
|
flatAmount: number;
|
|
25638
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25648
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25639
25649
|
from: number;
|
|
25640
25650
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25641
25651
|
unitAmount: number;
|
|
@@ -25694,7 +25704,7 @@ interface components {
|
|
|
25694
25704
|
tiers: {
|
|
25695
25705
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25696
25706
|
flatAmount: number;
|
|
25697
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25707
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25698
25708
|
from: number;
|
|
25699
25709
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25700
25710
|
unitAmount: number;
|
|
@@ -25822,7 +25832,7 @@ interface components {
|
|
|
25822
25832
|
tiers: {
|
|
25823
25833
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25824
25834
|
flatAmount: number;
|
|
25825
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25835
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25826
25836
|
from: number;
|
|
25827
25837
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25828
25838
|
unitAmount: number;
|
|
@@ -25851,7 +25861,7 @@ interface components {
|
|
|
25851
25861
|
tiers: {
|
|
25852
25862
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25853
25863
|
flatAmount: number;
|
|
25854
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25864
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25855
25865
|
from: number;
|
|
25856
25866
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25857
25867
|
unitAmount: number;
|
|
@@ -28475,7 +28485,7 @@ interface operations {
|
|
|
28475
28485
|
"createDate[gte]"?: string;
|
|
28476
28486
|
/** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
28477
28487
|
"createDate[lte]"?: string;
|
|
28478
|
-
/** @description UUID of the customer whose invoices to list. */
|
|
28488
|
+
/** @description UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
28479
28489
|
customerRef?: string;
|
|
28480
28490
|
/** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
28481
28491
|
"issueDate[gte]"?: string;
|
|
@@ -28489,7 +28499,7 @@ interface operations {
|
|
|
28489
28499
|
membershipRef?: string;
|
|
28490
28500
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28491
28501
|
nextPageToken?: string;
|
|
28492
|
-
/** @description Case-insensitive search by invoice code or number.
|
|
28502
|
+
/** @description Case-insensitive search by invoice code or number. */
|
|
28493
28503
|
q?: string;
|
|
28494
28504
|
/** @description Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
28495
28505
|
status?: string;
|
|
@@ -28885,7 +28895,7 @@ interface operations {
|
|
|
28885
28895
|
"issueDate[lte]"?: string;
|
|
28886
28896
|
/** @description Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28887
28897
|
limit?: number;
|
|
28888
|
-
/** @description UUID of the location whose invoice items to list. */
|
|
28898
|
+
/** @description UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
28889
28899
|
locationRef?: string;
|
|
28890
28900
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28891
28901
|
nextPageToken?: string;
|
|
@@ -29155,7 +29165,7 @@ interface operations {
|
|
|
29155
29165
|
invoiceRef?: string;
|
|
29156
29166
|
/** @description Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29157
29167
|
limit?: number;
|
|
29158
|
-
/** @description UUID of the location whose credit notes to list. */
|
|
29168
|
+
/** @description UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
29159
29169
|
locationRef?: string;
|
|
29160
29170
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
29161
29171
|
nextPageToken?: string;
|
|
@@ -37271,7 +37281,7 @@ interface GetCreditNotesQuery {
|
|
|
37271
37281
|
invoiceRef?: string;
|
|
37272
37282
|
/** Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37273
37283
|
limit?: number;
|
|
37274
|
-
/** UUID of the location whose credit notes to list. */
|
|
37284
|
+
/** UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
37275
37285
|
locationRef?: string;
|
|
37276
37286
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37277
37287
|
nextPageToken?: string;
|
|
@@ -37286,7 +37296,7 @@ interface GetInvoicesQuery {
|
|
|
37286
37296
|
"createDate[gte]"?: string;
|
|
37287
37297
|
/** Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
37288
37298
|
"createDate[lte]"?: string;
|
|
37289
|
-
/** UUID of the customer whose invoices to list. */
|
|
37299
|
+
/** UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
37290
37300
|
customerRef?: string;
|
|
37291
37301
|
/** Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
37292
37302
|
"issueDate[gte]"?: string;
|
|
@@ -37300,7 +37310,7 @@ interface GetInvoicesQuery {
|
|
|
37300
37310
|
membershipRef?: string;
|
|
37301
37311
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37302
37312
|
nextPageToken?: string;
|
|
37303
|
-
/** Case-insensitive search by invoice code or number.
|
|
37313
|
+
/** Case-insensitive search by invoice code or number. */
|
|
37304
37314
|
q?: string;
|
|
37305
37315
|
/** Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
37306
37316
|
status?: string;
|
|
@@ -37333,7 +37343,7 @@ interface ListInvoiceItemsQuery {
|
|
|
37333
37343
|
"issueDate[lte]"?: string;
|
|
37334
37344
|
/** Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37335
37345
|
limit?: number;
|
|
37336
|
-
/** UUID of the location whose invoice items to list. */
|
|
37346
|
+
/** UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
37337
37347
|
locationRef?: string;
|
|
37338
37348
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37339
37349
|
nextPageToken?: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -524,7 +524,7 @@ interface paths {
|
|
|
524
524
|
};
|
|
525
525
|
/**
|
|
526
526
|
* Retrieve invoices
|
|
527
|
-
* @description Retrieve
|
|
527
|
+
* @description Retrieve the invoices of a customer, a location, or the whole network when neither customerRef nor locationRef is set. An administrator limited to some locations needs customerRef or locationRef. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
528
528
|
*/
|
|
529
529
|
get: operations["getInvoices"];
|
|
530
530
|
put?: never;
|
|
@@ -696,7 +696,7 @@ interface paths {
|
|
|
696
696
|
};
|
|
697
697
|
/**
|
|
698
698
|
* List invoice items
|
|
699
|
-
* @description List invoice items filtered by customer, location, invoice, type, status, pending, or date range. Pass invoiceRef for the items of one invoice; they page like the rest of the list. The createDate filter matches when the item was created; the status and issueDate filters match the invoice the item is on, so they return only items connected to an invoice. Pending items are not on an invoice and not part of a subscription: pass pending=true with customerRef for one customer's pending items, or with locationRef for every pending item at a location. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
699
|
+
* @description List invoice items filtered by customer, location, invoice, type, status, pending, or date range. Pass invoiceRef for the items of one invoice; they page like the rest of the list. The createDate filter matches when the item was created; the status and issueDate filters match the invoice the item is on, so they return only items connected to an invoice. Pending items are not on an invoice and not part of a subscription: pass pending=true with customerRef for one customer's pending items, or with locationRef for every pending item at a location. Without customerRef, invoiceRef or locationRef, lists the items of the whole network; an administrator limited to some locations needs one of them. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
700
700
|
*/
|
|
701
701
|
get: operations["listInvoiceItems"];
|
|
702
702
|
put?: never;
|
|
@@ -789,7 +789,7 @@ interface paths {
|
|
|
789
789
|
};
|
|
790
790
|
/**
|
|
791
791
|
* Retrieve credit notes
|
|
792
|
-
* @description Retrieve
|
|
792
|
+
* @description Retrieve the credit notes of an invoice, a location, or the whole network when neither invoiceRef nor locationRef is set. An administrator limited to some locations needs invoiceRef or locationRef. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
793
793
|
*/
|
|
794
794
|
get: operations["getCreditNotes"];
|
|
795
795
|
put?: never;
|
|
@@ -923,7 +923,7 @@ interface paths {
|
|
|
923
923
|
put?: never;
|
|
924
924
|
/**
|
|
925
925
|
* Check in
|
|
926
|
-
* @description Record an arrival for a booking, an event ticket, a visit, or a member's subscription. Identify what to check in with its check-in id, with the location and a six-digit code, or with the location and a customer ref to check a member in without a code. With bearer token authentication, the user must be an administrator of the location. <h3>OAuth</h3>Required scopes: <code>checkIns</code>
|
|
926
|
+
* @description Record an arrival for a booking, an event ticket, a visit, or a member's subscription. Identify what to check in with its check-in id, with the location and a six-digit code, or with the location and a customer ref to check a member in without a code. Add a past check-in date to a customer ref to record an arrival nobody checked the member in for: the member stays checked in until they check out, or, with a check-out date too, the check-in is created as checked out, without the events and webhooks of a live arrival. With bearer token authentication, the user must be an administrator of the location. <h3>OAuth</h3>Required scopes: <code>checkIns</code>
|
|
927
927
|
*/
|
|
928
928
|
post: operations["checkIn"];
|
|
929
929
|
delete?: never;
|
|
@@ -6639,10 +6639,10 @@ interface components {
|
|
|
6639
6639
|
*/
|
|
6640
6640
|
checkInDate?: string;
|
|
6641
6641
|
/**
|
|
6642
|
-
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6642
|
+
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in from the admin app, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6643
6643
|
* @enum {string}
|
|
6644
6644
|
*/
|
|
6645
|
-
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6645
|
+
checkInMethod?: "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6646
6646
|
/**
|
|
6647
6647
|
* Format: uuid
|
|
6648
6648
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6654,10 +6654,10 @@ interface components {
|
|
|
6654
6654
|
*/
|
|
6655
6655
|
checkOutDate?: string;
|
|
6656
6656
|
/**
|
|
6657
|
-
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6657
|
+
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in with its check-out date from the admin app, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6658
6658
|
* @enum {string}
|
|
6659
6659
|
*/
|
|
6660
|
-
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6660
|
+
checkOutMethod?: "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6661
6661
|
/** @description Confirmation code of the check-in. */
|
|
6662
6662
|
code?: string;
|
|
6663
6663
|
/**
|
|
@@ -6779,10 +6779,10 @@ interface components {
|
|
|
6779
6779
|
*/
|
|
6780
6780
|
checkInDate?: string;
|
|
6781
6781
|
/**
|
|
6782
|
-
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6782
|
+
* @description How the customer was checked in: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in from the admin app, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6783
6783
|
* @enum {string}
|
|
6784
6784
|
*/
|
|
6785
|
-
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6785
|
+
checkInMethod?: "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6786
6786
|
/**
|
|
6787
6787
|
* Format: uuid
|
|
6788
6788
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6794,10 +6794,10 @@ interface components {
|
|
|
6794
6794
|
*/
|
|
6795
6795
|
checkOutDate?: string;
|
|
6796
6796
|
/**
|
|
6797
|
-
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6797
|
+
* @description How the customer was checked out: 'reception' with their code on the Reception app, 'manual' by an administrator, 'backdated' by an administrator adding a past check-in with its check-out date from the admin app, 'automatic' by the automatic check-out, 'agent' by the AI agent, and 'api' through the API. Absent while the customer is checked in, and on check-ins made before methods were recorded.
|
|
6798
6798
|
* @enum {string}
|
|
6799
6799
|
*/
|
|
6800
|
-
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6800
|
+
checkOutMethod?: "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6801
6801
|
/** @description Confirmation code of the check-in. */
|
|
6802
6802
|
code?: string;
|
|
6803
6803
|
/**
|
|
@@ -22838,12 +22838,12 @@ interface components {
|
|
|
22838
22838
|
*/
|
|
22839
22839
|
locationRef: string;
|
|
22840
22840
|
/** @description Exchange rate relative to the location main currency. Pass either exchangeRate or provider, never both. */
|
|
22841
|
-
exchangeRate?: number;
|
|
22841
|
+
exchangeRate?: number | null;
|
|
22842
22842
|
/**
|
|
22843
22843
|
* @description Exchange rate provider when auto-update is enabled. Pass either provider or exchangeRate, never both.
|
|
22844
|
-
* @enum {string}
|
|
22844
|
+
* @enum {string|null}
|
|
22845
22845
|
*/
|
|
22846
|
-
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
|
|
22846
|
+
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb" | null;
|
|
22847
22847
|
};
|
|
22848
22848
|
};
|
|
22849
22849
|
};
|
|
@@ -22854,12 +22854,12 @@ interface components {
|
|
|
22854
22854
|
/** @description Alt currency fields to update */
|
|
22855
22855
|
altCurrency: {
|
|
22856
22856
|
/** @description Exchange rate relative to the location main currency. Pass either exchangeRate or provider, never both. */
|
|
22857
|
-
exchangeRate?: number;
|
|
22857
|
+
exchangeRate?: number | null;
|
|
22858
22858
|
/**
|
|
22859
22859
|
* @description Exchange rate provider when auto-update is enabled. Pass either provider or exchangeRate, never both.
|
|
22860
|
-
* @enum {string}
|
|
22860
|
+
* @enum {string|null}
|
|
22861
22861
|
*/
|
|
22862
|
-
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
|
|
22862
|
+
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb" | null;
|
|
22863
22863
|
};
|
|
22864
22864
|
};
|
|
22865
22865
|
};
|
|
@@ -23589,6 +23589,16 @@ interface components {
|
|
|
23589
23589
|
* @description UUID of the location the code was issued in. Required when the check-in is resolved by its code or a customer ref.
|
|
23590
23590
|
*/
|
|
23591
23591
|
locationRef?: string;
|
|
23592
|
+
/**
|
|
23593
|
+
* Format: date-time
|
|
23594
|
+
* @description ISO timestamp of a past arrival to record for the member in customerRef, such as a visit nobody checked them in for. Without checkOutDate the member stays checked in until they check out.
|
|
23595
|
+
*/
|
|
23596
|
+
checkInDate?: string;
|
|
23597
|
+
/**
|
|
23598
|
+
* Format: date-time
|
|
23599
|
+
* @description ISO timestamp of when the member left, which creates the check-in as checked out. Requires checkInDate and must be in the past.
|
|
23600
|
+
*/
|
|
23601
|
+
checkOutDate?: string;
|
|
23592
23602
|
/**
|
|
23593
23603
|
* Format: uuid
|
|
23594
23604
|
* @description ID of a member to check in on their subscription without a code. Only administrators of the location can check a member in this way.
|
|
@@ -25128,7 +25138,7 @@ interface components {
|
|
|
25128
25138
|
tiers: {
|
|
25129
25139
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25130
25140
|
flatAmount: number;
|
|
25131
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25141
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25132
25142
|
from: number;
|
|
25133
25143
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25134
25144
|
unitAmount: number;
|
|
@@ -25192,7 +25202,7 @@ interface components {
|
|
|
25192
25202
|
tiers: {
|
|
25193
25203
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25194
25204
|
flatAmount: number;
|
|
25195
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25205
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25196
25206
|
from: number;
|
|
25197
25207
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25198
25208
|
unitAmount: number;
|
|
@@ -25320,7 +25330,7 @@ interface components {
|
|
|
25320
25330
|
tiers: {
|
|
25321
25331
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25322
25332
|
flatAmount: number;
|
|
25323
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25333
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25324
25334
|
from: number;
|
|
25325
25335
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25326
25336
|
unitAmount: number;
|
|
@@ -25349,7 +25359,7 @@ interface components {
|
|
|
25349
25359
|
tiers: {
|
|
25350
25360
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25351
25361
|
flatAmount: number;
|
|
25352
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25362
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25353
25363
|
from: number;
|
|
25354
25364
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25355
25365
|
unitAmount: number;
|
|
@@ -25635,7 +25645,7 @@ interface components {
|
|
|
25635
25645
|
tiers: {
|
|
25636
25646
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25637
25647
|
flatAmount: number;
|
|
25638
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25648
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25639
25649
|
from: number;
|
|
25640
25650
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25641
25651
|
unitAmount: number;
|
|
@@ -25694,7 +25704,7 @@ interface components {
|
|
|
25694
25704
|
tiers: {
|
|
25695
25705
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25696
25706
|
flatAmount: number;
|
|
25697
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25707
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25698
25708
|
from: number;
|
|
25699
25709
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25700
25710
|
unitAmount: number;
|
|
@@ -25822,7 +25832,7 @@ interface components {
|
|
|
25822
25832
|
tiers: {
|
|
25823
25833
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25824
25834
|
flatAmount: number;
|
|
25825
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25835
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25826
25836
|
from: number;
|
|
25827
25837
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25828
25838
|
unitAmount: number;
|
|
@@ -25851,7 +25861,7 @@ interface components {
|
|
|
25851
25861
|
tiers: {
|
|
25852
25862
|
/** @description Fixed fee added once to bookings in this tier. */
|
|
25853
25863
|
flatAmount: number;
|
|
25854
|
-
/** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
|
|
25864
|
+
/** @description Booking length in minutes at which this tier starts, 0 for the first tier and for example 480 for 8 hours. */
|
|
25855
25865
|
from: number;
|
|
25856
25866
|
/** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
|
|
25857
25867
|
unitAmount: number;
|
|
@@ -28475,7 +28485,7 @@ interface operations {
|
|
|
28475
28485
|
"createDate[gte]"?: string;
|
|
28476
28486
|
/** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
28477
28487
|
"createDate[lte]"?: string;
|
|
28478
|
-
/** @description UUID of the customer whose invoices to list. */
|
|
28488
|
+
/** @description UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
28479
28489
|
customerRef?: string;
|
|
28480
28490
|
/** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
28481
28491
|
"issueDate[gte]"?: string;
|
|
@@ -28489,7 +28499,7 @@ interface operations {
|
|
|
28489
28499
|
membershipRef?: string;
|
|
28490
28500
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28491
28501
|
nextPageToken?: string;
|
|
28492
|
-
/** @description Case-insensitive search by invoice code or number.
|
|
28502
|
+
/** @description Case-insensitive search by invoice code or number. */
|
|
28493
28503
|
q?: string;
|
|
28494
28504
|
/** @description Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
28495
28505
|
status?: string;
|
|
@@ -28885,7 +28895,7 @@ interface operations {
|
|
|
28885
28895
|
"issueDate[lte]"?: string;
|
|
28886
28896
|
/** @description Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28887
28897
|
limit?: number;
|
|
28888
|
-
/** @description UUID of the location whose invoice items to list. */
|
|
28898
|
+
/** @description UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
28889
28899
|
locationRef?: string;
|
|
28890
28900
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28891
28901
|
nextPageToken?: string;
|
|
@@ -29155,7 +29165,7 @@ interface operations {
|
|
|
29155
29165
|
invoiceRef?: string;
|
|
29156
29166
|
/** @description Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29157
29167
|
limit?: number;
|
|
29158
|
-
/** @description UUID of the location whose credit notes to list. */
|
|
29168
|
+
/** @description UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
29159
29169
|
locationRef?: string;
|
|
29160
29170
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
29161
29171
|
nextPageToken?: string;
|
|
@@ -37271,7 +37281,7 @@ interface GetCreditNotesQuery {
|
|
|
37271
37281
|
invoiceRef?: string;
|
|
37272
37282
|
/** Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37273
37283
|
limit?: number;
|
|
37274
|
-
/** UUID of the location whose credit notes to list. */
|
|
37284
|
+
/** UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
37275
37285
|
locationRef?: string;
|
|
37276
37286
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37277
37287
|
nextPageToken?: string;
|
|
@@ -37286,7 +37296,7 @@ interface GetInvoicesQuery {
|
|
|
37286
37296
|
"createDate[gte]"?: string;
|
|
37287
37297
|
/** Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
37288
37298
|
"createDate[lte]"?: string;
|
|
37289
|
-
/** UUID of the customer whose invoices to list. */
|
|
37299
|
+
/** UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
37290
37300
|
customerRef?: string;
|
|
37291
37301
|
/** Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
37292
37302
|
"issueDate[gte]"?: string;
|
|
@@ -37300,7 +37310,7 @@ interface GetInvoicesQuery {
|
|
|
37300
37310
|
membershipRef?: string;
|
|
37301
37311
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37302
37312
|
nextPageToken?: string;
|
|
37303
|
-
/** Case-insensitive search by invoice code or number.
|
|
37313
|
+
/** Case-insensitive search by invoice code or number. */
|
|
37304
37314
|
q?: string;
|
|
37305
37315
|
/** Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
37306
37316
|
status?: string;
|
|
@@ -37333,7 +37343,7 @@ interface ListInvoiceItemsQuery {
|
|
|
37333
37343
|
"issueDate[lte]"?: string;
|
|
37334
37344
|
/** Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37335
37345
|
limit?: number;
|
|
37336
|
-
/** UUID of the location whose invoice items to list. */
|
|
37346
|
+
/** UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
37337
37347
|
locationRef?: string;
|
|
37338
37348
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37339
37349
|
nextPageToken?: string;
|