@izak0s/spacebring-api 16.1.0 → 16.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +12 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +167 -9
- package/dist/index.d.ts +167 -9
- package/dist/index.js +12 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -905,7 +905,11 @@ interface paths {
|
|
|
905
905
|
delete?: never;
|
|
906
906
|
options?: never;
|
|
907
907
|
head?: never;
|
|
908
|
-
|
|
908
|
+
/**
|
|
909
|
+
* Update a check-in
|
|
910
|
+
* @description Change when a customer arrived, or when they left on a check-in that is checked out. Fields left out keep their values. The booking, event ticket, or visit behind the check-in gets the new dates too. The customer and administrators are not notified. With bearer token authentication, the user must be an administrator of the check-in's location. <h3>OAuth</h3>Required scopes: <code>checkIns</code>
|
|
911
|
+
*/
|
|
912
|
+
patch: operations["patchCheckIn"];
|
|
909
913
|
trace?: never;
|
|
910
914
|
};
|
|
911
915
|
"/check_ins/v1/checkin": {
|
|
@@ -4216,7 +4220,13 @@ interface components {
|
|
|
4216
4220
|
/** @description Payment method used. */
|
|
4217
4221
|
method: {
|
|
4218
4222
|
/** @description Present when type is external. */
|
|
4219
|
-
external?:
|
|
4223
|
+
external?: {
|
|
4224
|
+
/**
|
|
4225
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
4226
|
+
* @enum {string}
|
|
4227
|
+
*/
|
|
4228
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
4229
|
+
};
|
|
4220
4230
|
/** @description Present when type is paymentGateway. */
|
|
4221
4231
|
paymentGateway?: {
|
|
4222
4232
|
/** @description Payment gateway identifier. */
|
|
@@ -4618,7 +4628,13 @@ interface components {
|
|
|
4618
4628
|
/** @description Payment method used. */
|
|
4619
4629
|
method: {
|
|
4620
4630
|
/** @description Present when type is external. */
|
|
4621
|
-
external?:
|
|
4631
|
+
external?: {
|
|
4632
|
+
/**
|
|
4633
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
4634
|
+
* @enum {string}
|
|
4635
|
+
*/
|
|
4636
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
4637
|
+
};
|
|
4622
4638
|
/** @description Present when type is paymentGateway. */
|
|
4623
4639
|
paymentGateway?: {
|
|
4624
4640
|
/** @description Payment gateway identifier. */
|
|
@@ -5017,7 +5033,13 @@ interface components {
|
|
|
5017
5033
|
/** @description Payment method used. */
|
|
5018
5034
|
method: {
|
|
5019
5035
|
/** @description Present when type is external. */
|
|
5020
|
-
external?:
|
|
5036
|
+
external?: {
|
|
5037
|
+
/**
|
|
5038
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
5039
|
+
* @enum {string}
|
|
5040
|
+
*/
|
|
5041
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
5042
|
+
};
|
|
5021
5043
|
/** @description Present when type is paymentGateway. */
|
|
5022
5044
|
paymentGateway?: {
|
|
5023
5045
|
/** @description Payment gateway identifier. */
|
|
@@ -5528,7 +5550,13 @@ interface components {
|
|
|
5528
5550
|
/** @description Payment method used. */
|
|
5529
5551
|
method: {
|
|
5530
5552
|
/** @description Present when type is external. */
|
|
5531
|
-
external?:
|
|
5553
|
+
external?: {
|
|
5554
|
+
/**
|
|
5555
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
5556
|
+
* @enum {string}
|
|
5557
|
+
*/
|
|
5558
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
5559
|
+
};
|
|
5532
5560
|
/** @description Present when type is paymentGateway. */
|
|
5533
5561
|
paymentGateway?: {
|
|
5534
5562
|
/** @description Payment gateway identifier. */
|
|
@@ -6610,6 +6638,11 @@ interface components {
|
|
|
6610
6638
|
* @description ISO timestamp of when the user checked in.
|
|
6611
6639
|
*/
|
|
6612
6640
|
checkInDate?: string;
|
|
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.
|
|
6643
|
+
* @enum {string}
|
|
6644
|
+
*/
|
|
6645
|
+
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6613
6646
|
/**
|
|
6614
6647
|
* Format: uuid
|
|
6615
6648
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6620,6 +6653,11 @@ interface components {
|
|
|
6620
6653
|
* @description ISO timestamp of when the user checked out.
|
|
6621
6654
|
*/
|
|
6622
6655
|
checkOutDate?: string;
|
|
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.
|
|
6658
|
+
* @enum {string}
|
|
6659
|
+
*/
|
|
6660
|
+
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6623
6661
|
/** @description Confirmation code of the check-in. */
|
|
6624
6662
|
code?: string;
|
|
6625
6663
|
/**
|
|
@@ -6740,6 +6778,11 @@ interface components {
|
|
|
6740
6778
|
* @description ISO timestamp of when the user checked in.
|
|
6741
6779
|
*/
|
|
6742
6780
|
checkInDate?: string;
|
|
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.
|
|
6783
|
+
* @enum {string}
|
|
6784
|
+
*/
|
|
6785
|
+
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6743
6786
|
/**
|
|
6744
6787
|
* Format: uuid
|
|
6745
6788
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6750,6 +6793,11 @@ interface components {
|
|
|
6750
6793
|
* @description ISO timestamp of when the user checked out.
|
|
6751
6794
|
*/
|
|
6752
6795
|
checkOutDate?: string;
|
|
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.
|
|
6798
|
+
* @enum {string}
|
|
6799
|
+
*/
|
|
6800
|
+
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6753
6801
|
/** @description Confirmation code of the check-in. */
|
|
6754
6802
|
code?: string;
|
|
6755
6803
|
/**
|
|
@@ -20713,7 +20761,13 @@ interface components {
|
|
|
20713
20761
|
/** @description Payment method used. */
|
|
20714
20762
|
method: {
|
|
20715
20763
|
/** @description Present when type is external. */
|
|
20716
|
-
external?:
|
|
20764
|
+
external?: {
|
|
20765
|
+
/**
|
|
20766
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
20767
|
+
* @enum {string}
|
|
20768
|
+
*/
|
|
20769
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
20770
|
+
};
|
|
20717
20771
|
/** @description Present when type is paymentGateway. */
|
|
20718
20772
|
paymentGateway?: {
|
|
20719
20773
|
/** @description Payment gateway identifier. */
|
|
@@ -21427,7 +21481,13 @@ interface components {
|
|
|
21427
21481
|
/** @description Payment method used. */
|
|
21428
21482
|
method: {
|
|
21429
21483
|
/** @description Present when type is external. */
|
|
21430
|
-
external?:
|
|
21484
|
+
external?: {
|
|
21485
|
+
/**
|
|
21486
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
21487
|
+
* @enum {string}
|
|
21488
|
+
*/
|
|
21489
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
21490
|
+
};
|
|
21431
21491
|
/** @description Present when type is paymentGateway. */
|
|
21432
21492
|
paymentGateway?: {
|
|
21433
21493
|
/** @description Payment gateway identifier. */
|
|
@@ -22141,7 +22201,13 @@ interface components {
|
|
|
22141
22201
|
/** @description Payment method used. */
|
|
22142
22202
|
method: {
|
|
22143
22203
|
/** @description Present when type is external. */
|
|
22144
|
-
external?:
|
|
22204
|
+
external?: {
|
|
22205
|
+
/**
|
|
22206
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
22207
|
+
* @enum {string}
|
|
22208
|
+
*/
|
|
22209
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
22210
|
+
};
|
|
22145
22211
|
/** @description Present when type is paymentGateway. */
|
|
22146
22212
|
paymentGateway?: {
|
|
22147
22213
|
/** @description Payment gateway identifier. */
|
|
@@ -23237,6 +23303,11 @@ interface components {
|
|
|
23237
23303
|
* @description ISO timestamp of when the money was received. Defaults to now. Must not be in the future.
|
|
23238
23304
|
*/
|
|
23239
23305
|
paymentDate?: string;
|
|
23306
|
+
/**
|
|
23307
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Omit it when unknown.
|
|
23308
|
+
* @enum {string}
|
|
23309
|
+
*/
|
|
23310
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
23240
23311
|
};
|
|
23241
23312
|
/** @description Payment gateway (card) payment method. */
|
|
23242
23313
|
paymentGateway?: {
|
|
@@ -23484,6 +23555,25 @@ interface components {
|
|
|
23484
23555
|
};
|
|
23485
23556
|
};
|
|
23486
23557
|
};
|
|
23558
|
+
patchCheckIn: {
|
|
23559
|
+
content: {
|
|
23560
|
+
"application/json": {
|
|
23561
|
+
/** @description Check-in dates to change. Fields left out keep their values. */
|
|
23562
|
+
checkIn: {
|
|
23563
|
+
/**
|
|
23564
|
+
* Format: date-time
|
|
23565
|
+
* @description ISO timestamp of when the customer arrived. Must be in the past.
|
|
23566
|
+
*/
|
|
23567
|
+
checkInDate?: string;
|
|
23568
|
+
/**
|
|
23569
|
+
* Format: date-time
|
|
23570
|
+
* @description ISO timestamp of when the customer left. Must be in the past and after the check-in date. Accepted only for a check-in that is checked out.
|
|
23571
|
+
*/
|
|
23572
|
+
checkOutDate?: string;
|
|
23573
|
+
};
|
|
23574
|
+
};
|
|
23575
|
+
};
|
|
23576
|
+
};
|
|
23487
23577
|
checkIn: {
|
|
23488
23578
|
content: {
|
|
23489
23579
|
"application/json": {
|
|
@@ -27467,6 +27557,11 @@ interface components {
|
|
|
27467
27557
|
* @description ISO timestamp of when the money was received. Defaults to now. Must not be in the future.
|
|
27468
27558
|
*/
|
|
27469
27559
|
paymentDate?: string;
|
|
27560
|
+
/**
|
|
27561
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Omit it when unknown.
|
|
27562
|
+
* @enum {string}
|
|
27563
|
+
*/
|
|
27564
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
27470
27565
|
};
|
|
27471
27566
|
/** @description Payment gateway (card) payment method. */
|
|
27472
27567
|
paymentGateway?: {
|
|
@@ -29499,6 +29594,66 @@ interface operations {
|
|
|
29499
29594
|
};
|
|
29500
29595
|
};
|
|
29501
29596
|
};
|
|
29597
|
+
patchCheckIn: {
|
|
29598
|
+
parameters: {
|
|
29599
|
+
query?: never;
|
|
29600
|
+
header?: {
|
|
29601
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
29602
|
+
"spacebring-network-id"?: string;
|
|
29603
|
+
};
|
|
29604
|
+
path: {
|
|
29605
|
+
/** @description The ID of the check-in. */
|
|
29606
|
+
checkInId: string;
|
|
29607
|
+
};
|
|
29608
|
+
cookie?: never;
|
|
29609
|
+
};
|
|
29610
|
+
requestBody: components["requestBodies"]["patchCheckIn"];
|
|
29611
|
+
responses: {
|
|
29612
|
+
/** @description No Content */
|
|
29613
|
+
204: {
|
|
29614
|
+
headers: {
|
|
29615
|
+
[name: string]: unknown;
|
|
29616
|
+
};
|
|
29617
|
+
content?: never;
|
|
29618
|
+
};
|
|
29619
|
+
/** @description Bad Request */
|
|
29620
|
+
400: {
|
|
29621
|
+
headers: {
|
|
29622
|
+
[name: string]: unknown;
|
|
29623
|
+
};
|
|
29624
|
+
content: {
|
|
29625
|
+
"application/json": components["schemas"]["responseError"];
|
|
29626
|
+
};
|
|
29627
|
+
};
|
|
29628
|
+
/** @description Forbidden */
|
|
29629
|
+
403: {
|
|
29630
|
+
headers: {
|
|
29631
|
+
[name: string]: unknown;
|
|
29632
|
+
};
|
|
29633
|
+
content: {
|
|
29634
|
+
"application/json": components["schemas"]["responseError"];
|
|
29635
|
+
};
|
|
29636
|
+
};
|
|
29637
|
+
/** @description Not Found */
|
|
29638
|
+
404: {
|
|
29639
|
+
headers: {
|
|
29640
|
+
[name: string]: unknown;
|
|
29641
|
+
};
|
|
29642
|
+
content: {
|
|
29643
|
+
"application/json": components["schemas"]["responseError"];
|
|
29644
|
+
};
|
|
29645
|
+
};
|
|
29646
|
+
/** @description Conflict */
|
|
29647
|
+
409: {
|
|
29648
|
+
headers: {
|
|
29649
|
+
[name: string]: unknown;
|
|
29650
|
+
};
|
|
29651
|
+
content: {
|
|
29652
|
+
"application/json": components["schemas"]["responseError"];
|
|
29653
|
+
};
|
|
29654
|
+
};
|
|
29655
|
+
};
|
|
29656
|
+
};
|
|
29502
29657
|
checkIn: {
|
|
29503
29658
|
parameters: {
|
|
29504
29659
|
query?: never;
|
|
@@ -37093,6 +37248,8 @@ interface GetCheckInsQuery {
|
|
|
37093
37248
|
type CheckInBody = NonNullable<operations["checkIn"]["requestBody"]>["content"]["application/json"];
|
|
37094
37249
|
/** Request body for `sb.checkIns.checkOut()`. */
|
|
37095
37250
|
type CheckOutBody = NonNullable<operations["checkOut"]["requestBody"]>["content"]["application/json"];
|
|
37251
|
+
/** Request body for `sb.checkIns.update()`. */
|
|
37252
|
+
type PatchCheckInBody = NonNullable<NonNullable<operations["patchCheckIn"]["requestBody"]>["content"]["application/json"]["checkIn"]>;
|
|
37096
37253
|
|
|
37097
37254
|
/** A CreditNote entity as returned by the Spacebring API. */
|
|
37098
37255
|
type CreditNote = NonNullable<components["schemas"]["creditNote"]>;
|
|
@@ -37395,6 +37552,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
37395
37552
|
}>;
|
|
37396
37553
|
iterate(query?: Omit<GetCheckInsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CheckIn, void, undefined>;
|
|
37397
37554
|
get(checkInId: string, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
37555
|
+
update(checkInId: string, checkIn: PatchCheckInBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
37398
37556
|
checkIn(body: CheckInBody, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
37399
37557
|
checkOut(body: CheckOutBody, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
37400
37558
|
};
|
|
@@ -37864,4 +38022,4 @@ declare class SpacebringError extends Error {
|
|
|
37864
38022
|
}
|
|
37865
38023
|
|
|
37866
38024
|
export { Spacebring, SpacebringError };
|
|
37867
|
-
export type { Activity, AddEventHostsBody, AltCurrency, Application, ApplyBenefitBody, Assignment, Attachment, Balance, Benefit, BenefitCategory, BenefitMedia, Booking, CheckIn, CheckInBody, CheckInVisitBody, CheckOutBody, CheckOutVisitBody, Comment, Company, CompanyMedia, Contact, Contract, Coupon, CreateAltCurrencyBody, CreateAssignmentBody, CreateBenefitBody, CreateBenefitCategoryBody, CreateBenefitMediaBody, CreateBookingBody, CreateCompanyBody, CreateCompanyMediaBody, CreateContactBody, CreateContractBody, CreateCouponBody, CreateCreditNoteBody, CreateCreditsTransactionBody, CreateDayPassesTransactionBody, CreateEventBody, CreateEventMediaBody, CreateFeedPostBody, CreateFeedPostCommentBody, CreateFeedPostMediaBody, CreateGuideAttachmentBody, CreateGuideBody, CreateGuideMediaBody, CreateInvoiceBody, CreateInvoiceItemBody, CreateMembershipBody, CreateMoneyTransactionBody, CreatePackageBody, CreatePlanBody, CreatePlanMediaBody, CreateProductBody, CreateProductMediaBody, CreatePromocodeBody, CreateRequestBody, CreateResourceBody, CreateResourceMediaBody, CreateShopCategoryBody, CreateSubscriptionBody, CreateSubscriptionItemBody, CreateSupportTicketBody, CreateSupportTicketCommentBody, CreateSupportTicketMediaBody, CreateTemplateBody, CreateTemplateMediaBody, CreateVisitBody, CreditNote, CreditScheduledTransaction, CreditTransaction, DayPassScheduledTransaction, DayPassTransaction, Event, EventMedia, EventTicket, FeedMedia, GetAltCurrenciesQuery, GetAssignmentsQuery, GetBenefitApplicationsQuery, GetBenefitCategoriesQuery, GetBenefitsQuery, GetBookingsQuery, GetCheckInsQuery, GetCompaniesQuery, GetContactsQuery, GetContractsQuery, GetCouponsQuery, GetCreditNotesQuery, GetCreditsTransactionsQuery, GetDayPassesTransactionsQuery, GetDiscountRedemptionsQuery, GetEventTicketsQuery, GetEventsByOrganizationQuery, GetFeedPostsQuery, GetFloorsQuery, GetGuidesQuery, GetInvoicesQuery, GetMembershipsDeletedQuery, GetMembershipsQuery, GetMoneyTransactionsQuery, GetOrdersQuery, GetPackagesQuery, GetPlansQuery, GetProductsQuery, GetPromocodesQuery, GetRegistrationsQuery, GetRequestsQuery, GetResourceAvailability, GetResourceAvailabilityBody, GetResourcesQuery, GetScheduledCreditsTransactionsQuery, GetScheduledDayPassesTransactionsQuery, GetShopCategoriesQuery, GetSubscriptionsQuery, GetSupportTicketsQuery, GetTemplatesQuery, GetUpcomingInvoiceItemsQuery, GetUpcomingInvoiceQuery, GetVisitsQuery, Guide, GuideMedia, Invoice, InvoiceItem, IssueContractBody, IssueInvoiceBody, Like, ListInvoiceItemsQuery, Location, Membership, MoneyTransaction, Network, Order, Package, PatchAssignmentBody, PatchBenefitBody, PatchBookingBody, PatchEventBody, PatchFeedPostBody, PatchGuideBody, PatchMoneyTransactionBody, PatchPackageBody, PatchProductBody, PatchResourceBody, PayInvoiceBody, Payment, Plan, PlanMedia, Post, PreviewCreditNoteBody, Product, ProductMedia, Promocode, Redemption, Refund, RefundMoneyTransactionBody, Registration, Request$1 as Request, Resource, ResourceMedia, ShopCategory, SpacebringConfig, SpacebringErrorBody, SpacebringRequestOptions, SpacebringResources, Subscription, SupportTicket, Template, TemplateMedia, TerminateContractBody, TicketMedia, UpcomingItem, UpdateAltCurrencyBody, UpdateBenefitBody, UpdateBenefitCategoryBody, UpdateCompanyBody, UpdateContractBody, UpdateCouponBody, UpdateCreditNoteBody, UpdateEventBody, UpdateEventTicketBody, UpdateFeedPostBody, UpdateInvoiceBody, UpdateInvoiceItemBody, UpdateMembershipBody, UpdatePlanBody, UpdateProductBody, UpdateShopCategoryBody, UpdateSubscriptionBody, UpdateSubscriptionItemBody, UpdateSupportTicketAssigneeBody, UpdateSupportTicketCommentBody, UpdateSupportTicketStatusBody, UpdateSupportTicketTypeBody, UpdateTemplateBody, UpdateVisitBody, Visit, components, operations, paths };
|
|
38025
|
+
export type { Activity, AddEventHostsBody, AltCurrency, Application, ApplyBenefitBody, Assignment, Attachment, Balance, Benefit, BenefitCategory, BenefitMedia, Booking, CheckIn, CheckInBody, CheckInVisitBody, CheckOutBody, CheckOutVisitBody, Comment, Company, CompanyMedia, Contact, Contract, Coupon, CreateAltCurrencyBody, CreateAssignmentBody, CreateBenefitBody, CreateBenefitCategoryBody, CreateBenefitMediaBody, CreateBookingBody, CreateCompanyBody, CreateCompanyMediaBody, CreateContactBody, CreateContractBody, CreateCouponBody, CreateCreditNoteBody, CreateCreditsTransactionBody, CreateDayPassesTransactionBody, CreateEventBody, CreateEventMediaBody, CreateFeedPostBody, CreateFeedPostCommentBody, CreateFeedPostMediaBody, CreateGuideAttachmentBody, CreateGuideBody, CreateGuideMediaBody, CreateInvoiceBody, CreateInvoiceItemBody, CreateMembershipBody, CreateMoneyTransactionBody, CreatePackageBody, CreatePlanBody, CreatePlanMediaBody, CreateProductBody, CreateProductMediaBody, CreatePromocodeBody, CreateRequestBody, CreateResourceBody, CreateResourceMediaBody, CreateShopCategoryBody, CreateSubscriptionBody, CreateSubscriptionItemBody, CreateSupportTicketBody, CreateSupportTicketCommentBody, CreateSupportTicketMediaBody, CreateTemplateBody, CreateTemplateMediaBody, CreateVisitBody, CreditNote, CreditScheduledTransaction, CreditTransaction, DayPassScheduledTransaction, DayPassTransaction, Event, EventMedia, EventTicket, FeedMedia, GetAltCurrenciesQuery, GetAssignmentsQuery, GetBenefitApplicationsQuery, GetBenefitCategoriesQuery, GetBenefitsQuery, GetBookingsQuery, GetCheckInsQuery, GetCompaniesQuery, GetContactsQuery, GetContractsQuery, GetCouponsQuery, GetCreditNotesQuery, GetCreditsTransactionsQuery, GetDayPassesTransactionsQuery, GetDiscountRedemptionsQuery, GetEventTicketsQuery, GetEventsByOrganizationQuery, GetFeedPostsQuery, GetFloorsQuery, GetGuidesQuery, GetInvoicesQuery, GetMembershipsDeletedQuery, GetMembershipsQuery, GetMoneyTransactionsQuery, GetOrdersQuery, GetPackagesQuery, GetPlansQuery, GetProductsQuery, GetPromocodesQuery, GetRegistrationsQuery, GetRequestsQuery, GetResourceAvailability, GetResourceAvailabilityBody, GetResourcesQuery, GetScheduledCreditsTransactionsQuery, GetScheduledDayPassesTransactionsQuery, GetShopCategoriesQuery, GetSubscriptionsQuery, GetSupportTicketsQuery, GetTemplatesQuery, GetUpcomingInvoiceItemsQuery, GetUpcomingInvoiceQuery, GetVisitsQuery, Guide, GuideMedia, Invoice, InvoiceItem, IssueContractBody, IssueInvoiceBody, Like, ListInvoiceItemsQuery, Location, Membership, MoneyTransaction, Network, Order, Package, PatchAssignmentBody, PatchBenefitBody, PatchBookingBody, PatchCheckInBody, PatchEventBody, PatchFeedPostBody, PatchGuideBody, PatchMoneyTransactionBody, PatchPackageBody, PatchProductBody, PatchResourceBody, PayInvoiceBody, Payment, Plan, PlanMedia, Post, PreviewCreditNoteBody, Product, ProductMedia, Promocode, Redemption, Refund, RefundMoneyTransactionBody, Registration, Request$1 as Request, Resource, ResourceMedia, ShopCategory, SpacebringConfig, SpacebringErrorBody, SpacebringRequestOptions, SpacebringResources, Subscription, SupportTicket, Template, TemplateMedia, TerminateContractBody, TicketMedia, UpcomingItem, UpdateAltCurrencyBody, UpdateBenefitBody, UpdateBenefitCategoryBody, UpdateCompanyBody, UpdateContractBody, UpdateCouponBody, UpdateCreditNoteBody, UpdateEventBody, UpdateEventTicketBody, UpdateFeedPostBody, UpdateInvoiceBody, UpdateInvoiceItemBody, UpdateMembershipBody, UpdatePlanBody, UpdateProductBody, UpdateShopCategoryBody, UpdateSubscriptionBody, UpdateSubscriptionItemBody, UpdateSupportTicketAssigneeBody, UpdateSupportTicketCommentBody, UpdateSupportTicketStatusBody, UpdateSupportTicketTypeBody, UpdateTemplateBody, UpdateVisitBody, Visit, components, operations, paths };
|
package/dist/index.d.ts
CHANGED
|
@@ -905,7 +905,11 @@ interface paths {
|
|
|
905
905
|
delete?: never;
|
|
906
906
|
options?: never;
|
|
907
907
|
head?: never;
|
|
908
|
-
|
|
908
|
+
/**
|
|
909
|
+
* Update a check-in
|
|
910
|
+
* @description Change when a customer arrived, or when they left on a check-in that is checked out. Fields left out keep their values. The booking, event ticket, or visit behind the check-in gets the new dates too. The customer and administrators are not notified. With bearer token authentication, the user must be an administrator of the check-in's location. <h3>OAuth</h3>Required scopes: <code>checkIns</code>
|
|
911
|
+
*/
|
|
912
|
+
patch: operations["patchCheckIn"];
|
|
909
913
|
trace?: never;
|
|
910
914
|
};
|
|
911
915
|
"/check_ins/v1/checkin": {
|
|
@@ -4216,7 +4220,13 @@ interface components {
|
|
|
4216
4220
|
/** @description Payment method used. */
|
|
4217
4221
|
method: {
|
|
4218
4222
|
/** @description Present when type is external. */
|
|
4219
|
-
external?:
|
|
4223
|
+
external?: {
|
|
4224
|
+
/**
|
|
4225
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
4226
|
+
* @enum {string}
|
|
4227
|
+
*/
|
|
4228
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
4229
|
+
};
|
|
4220
4230
|
/** @description Present when type is paymentGateway. */
|
|
4221
4231
|
paymentGateway?: {
|
|
4222
4232
|
/** @description Payment gateway identifier. */
|
|
@@ -4618,7 +4628,13 @@ interface components {
|
|
|
4618
4628
|
/** @description Payment method used. */
|
|
4619
4629
|
method: {
|
|
4620
4630
|
/** @description Present when type is external. */
|
|
4621
|
-
external?:
|
|
4631
|
+
external?: {
|
|
4632
|
+
/**
|
|
4633
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
4634
|
+
* @enum {string}
|
|
4635
|
+
*/
|
|
4636
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
4637
|
+
};
|
|
4622
4638
|
/** @description Present when type is paymentGateway. */
|
|
4623
4639
|
paymentGateway?: {
|
|
4624
4640
|
/** @description Payment gateway identifier. */
|
|
@@ -5017,7 +5033,13 @@ interface components {
|
|
|
5017
5033
|
/** @description Payment method used. */
|
|
5018
5034
|
method: {
|
|
5019
5035
|
/** @description Present when type is external. */
|
|
5020
|
-
external?:
|
|
5036
|
+
external?: {
|
|
5037
|
+
/**
|
|
5038
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
5039
|
+
* @enum {string}
|
|
5040
|
+
*/
|
|
5041
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
5042
|
+
};
|
|
5021
5043
|
/** @description Present when type is paymentGateway. */
|
|
5022
5044
|
paymentGateway?: {
|
|
5023
5045
|
/** @description Payment gateway identifier. */
|
|
@@ -5528,7 +5550,13 @@ interface components {
|
|
|
5528
5550
|
/** @description Payment method used. */
|
|
5529
5551
|
method: {
|
|
5530
5552
|
/** @description Present when type is external. */
|
|
5531
|
-
external?:
|
|
5553
|
+
external?: {
|
|
5554
|
+
/**
|
|
5555
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
5556
|
+
* @enum {string}
|
|
5557
|
+
*/
|
|
5558
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
5559
|
+
};
|
|
5532
5560
|
/** @description Present when type is paymentGateway. */
|
|
5533
5561
|
paymentGateway?: {
|
|
5534
5562
|
/** @description Payment gateway identifier. */
|
|
@@ -6610,6 +6638,11 @@ interface components {
|
|
|
6610
6638
|
* @description ISO timestamp of when the user checked in.
|
|
6611
6639
|
*/
|
|
6612
6640
|
checkInDate?: string;
|
|
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.
|
|
6643
|
+
* @enum {string}
|
|
6644
|
+
*/
|
|
6645
|
+
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6613
6646
|
/**
|
|
6614
6647
|
* Format: uuid
|
|
6615
6648
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6620,6 +6653,11 @@ interface components {
|
|
|
6620
6653
|
* @description ISO timestamp of when the user checked out.
|
|
6621
6654
|
*/
|
|
6622
6655
|
checkOutDate?: string;
|
|
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.
|
|
6658
|
+
* @enum {string}
|
|
6659
|
+
*/
|
|
6660
|
+
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6623
6661
|
/** @description Confirmation code of the check-in. */
|
|
6624
6662
|
code?: string;
|
|
6625
6663
|
/**
|
|
@@ -6740,6 +6778,11 @@ interface components {
|
|
|
6740
6778
|
* @description ISO timestamp of when the user checked in.
|
|
6741
6779
|
*/
|
|
6742
6780
|
checkInDate?: string;
|
|
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.
|
|
6783
|
+
* @enum {string}
|
|
6784
|
+
*/
|
|
6785
|
+
checkInMethod?: "agent" | "api" | "manual" | "reception";
|
|
6743
6786
|
/**
|
|
6744
6787
|
* Format: uuid
|
|
6745
6788
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6750,6 +6793,11 @@ interface components {
|
|
|
6750
6793
|
* @description ISO timestamp of when the user checked out.
|
|
6751
6794
|
*/
|
|
6752
6795
|
checkOutDate?: string;
|
|
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.
|
|
6798
|
+
* @enum {string}
|
|
6799
|
+
*/
|
|
6800
|
+
checkOutMethod?: "agent" | "api" | "manual" | "reception" | "automatic";
|
|
6753
6801
|
/** @description Confirmation code of the check-in. */
|
|
6754
6802
|
code?: string;
|
|
6755
6803
|
/**
|
|
@@ -20713,7 +20761,13 @@ interface components {
|
|
|
20713
20761
|
/** @description Payment method used. */
|
|
20714
20762
|
method: {
|
|
20715
20763
|
/** @description Present when type is external. */
|
|
20716
|
-
external?:
|
|
20764
|
+
external?: {
|
|
20765
|
+
/**
|
|
20766
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
20767
|
+
* @enum {string}
|
|
20768
|
+
*/
|
|
20769
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
20770
|
+
};
|
|
20717
20771
|
/** @description Present when type is paymentGateway. */
|
|
20718
20772
|
paymentGateway?: {
|
|
20719
20773
|
/** @description Payment gateway identifier. */
|
|
@@ -21427,7 +21481,13 @@ interface components {
|
|
|
21427
21481
|
/** @description Payment method used. */
|
|
21428
21482
|
method: {
|
|
21429
21483
|
/** @description Present when type is external. */
|
|
21430
|
-
external?:
|
|
21484
|
+
external?: {
|
|
21485
|
+
/**
|
|
21486
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
21487
|
+
* @enum {string}
|
|
21488
|
+
*/
|
|
21489
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
21490
|
+
};
|
|
21431
21491
|
/** @description Present when type is paymentGateway. */
|
|
21432
21492
|
paymentGateway?: {
|
|
21433
21493
|
/** @description Payment gateway identifier. */
|
|
@@ -22141,7 +22201,13 @@ interface components {
|
|
|
22141
22201
|
/** @description Payment method used. */
|
|
22142
22202
|
method: {
|
|
22143
22203
|
/** @description Present when type is external. */
|
|
22144
|
-
external?:
|
|
22204
|
+
external?: {
|
|
22205
|
+
/**
|
|
22206
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Absent when the administrator did not record it.
|
|
22207
|
+
* @enum {string}
|
|
22208
|
+
*/
|
|
22209
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
22210
|
+
};
|
|
22145
22211
|
/** @description Present when type is paymentGateway. */
|
|
22146
22212
|
paymentGateway?: {
|
|
22147
22213
|
/** @description Payment gateway identifier. */
|
|
@@ -23237,6 +23303,11 @@ interface components {
|
|
|
23237
23303
|
* @description ISO timestamp of when the money was received. Defaults to now. Must not be in the future.
|
|
23238
23304
|
*/
|
|
23239
23305
|
paymentDate?: string;
|
|
23306
|
+
/**
|
|
23307
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Omit it when unknown.
|
|
23308
|
+
* @enum {string}
|
|
23309
|
+
*/
|
|
23310
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
23240
23311
|
};
|
|
23241
23312
|
/** @description Payment gateway (card) payment method. */
|
|
23242
23313
|
paymentGateway?: {
|
|
@@ -23484,6 +23555,25 @@ interface components {
|
|
|
23484
23555
|
};
|
|
23485
23556
|
};
|
|
23486
23557
|
};
|
|
23558
|
+
patchCheckIn: {
|
|
23559
|
+
content: {
|
|
23560
|
+
"application/json": {
|
|
23561
|
+
/** @description Check-in dates to change. Fields left out keep their values. */
|
|
23562
|
+
checkIn: {
|
|
23563
|
+
/**
|
|
23564
|
+
* Format: date-time
|
|
23565
|
+
* @description ISO timestamp of when the customer arrived. Must be in the past.
|
|
23566
|
+
*/
|
|
23567
|
+
checkInDate?: string;
|
|
23568
|
+
/**
|
|
23569
|
+
* Format: date-time
|
|
23570
|
+
* @description ISO timestamp of when the customer left. Must be in the past and after the check-in date. Accepted only for a check-in that is checked out.
|
|
23571
|
+
*/
|
|
23572
|
+
checkOutDate?: string;
|
|
23573
|
+
};
|
|
23574
|
+
};
|
|
23575
|
+
};
|
|
23576
|
+
};
|
|
23487
23577
|
checkIn: {
|
|
23488
23578
|
content: {
|
|
23489
23579
|
"application/json": {
|
|
@@ -27467,6 +27557,11 @@ interface components {
|
|
|
27467
27557
|
* @description ISO timestamp of when the money was received. Defaults to now. Must not be in the future.
|
|
27468
27558
|
*/
|
|
27469
27559
|
paymentDate?: string;
|
|
27560
|
+
/**
|
|
27561
|
+
* @description How the money was collected outside Spacebring: `bankTransfer`, `card` for a card charged on the location's own terminal, `cash`, `check`, or `paymentLink`. Omit it when unknown.
|
|
27562
|
+
* @enum {string}
|
|
27563
|
+
*/
|
|
27564
|
+
paidBy?: "bankTransfer" | "card" | "cash" | "check" | "paymentLink";
|
|
27470
27565
|
};
|
|
27471
27566
|
/** @description Payment gateway (card) payment method. */
|
|
27472
27567
|
paymentGateway?: {
|
|
@@ -29499,6 +29594,66 @@ interface operations {
|
|
|
29499
29594
|
};
|
|
29500
29595
|
};
|
|
29501
29596
|
};
|
|
29597
|
+
patchCheckIn: {
|
|
29598
|
+
parameters: {
|
|
29599
|
+
query?: never;
|
|
29600
|
+
header?: {
|
|
29601
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
29602
|
+
"spacebring-network-id"?: string;
|
|
29603
|
+
};
|
|
29604
|
+
path: {
|
|
29605
|
+
/** @description The ID of the check-in. */
|
|
29606
|
+
checkInId: string;
|
|
29607
|
+
};
|
|
29608
|
+
cookie?: never;
|
|
29609
|
+
};
|
|
29610
|
+
requestBody: components["requestBodies"]["patchCheckIn"];
|
|
29611
|
+
responses: {
|
|
29612
|
+
/** @description No Content */
|
|
29613
|
+
204: {
|
|
29614
|
+
headers: {
|
|
29615
|
+
[name: string]: unknown;
|
|
29616
|
+
};
|
|
29617
|
+
content?: never;
|
|
29618
|
+
};
|
|
29619
|
+
/** @description Bad Request */
|
|
29620
|
+
400: {
|
|
29621
|
+
headers: {
|
|
29622
|
+
[name: string]: unknown;
|
|
29623
|
+
};
|
|
29624
|
+
content: {
|
|
29625
|
+
"application/json": components["schemas"]["responseError"];
|
|
29626
|
+
};
|
|
29627
|
+
};
|
|
29628
|
+
/** @description Forbidden */
|
|
29629
|
+
403: {
|
|
29630
|
+
headers: {
|
|
29631
|
+
[name: string]: unknown;
|
|
29632
|
+
};
|
|
29633
|
+
content: {
|
|
29634
|
+
"application/json": components["schemas"]["responseError"];
|
|
29635
|
+
};
|
|
29636
|
+
};
|
|
29637
|
+
/** @description Not Found */
|
|
29638
|
+
404: {
|
|
29639
|
+
headers: {
|
|
29640
|
+
[name: string]: unknown;
|
|
29641
|
+
};
|
|
29642
|
+
content: {
|
|
29643
|
+
"application/json": components["schemas"]["responseError"];
|
|
29644
|
+
};
|
|
29645
|
+
};
|
|
29646
|
+
/** @description Conflict */
|
|
29647
|
+
409: {
|
|
29648
|
+
headers: {
|
|
29649
|
+
[name: string]: unknown;
|
|
29650
|
+
};
|
|
29651
|
+
content: {
|
|
29652
|
+
"application/json": components["schemas"]["responseError"];
|
|
29653
|
+
};
|
|
29654
|
+
};
|
|
29655
|
+
};
|
|
29656
|
+
};
|
|
29502
29657
|
checkIn: {
|
|
29503
29658
|
parameters: {
|
|
29504
29659
|
query?: never;
|
|
@@ -37093,6 +37248,8 @@ interface GetCheckInsQuery {
|
|
|
37093
37248
|
type CheckInBody = NonNullable<operations["checkIn"]["requestBody"]>["content"]["application/json"];
|
|
37094
37249
|
/** Request body for `sb.checkIns.checkOut()`. */
|
|
37095
37250
|
type CheckOutBody = NonNullable<operations["checkOut"]["requestBody"]>["content"]["application/json"];
|
|
37251
|
+
/** Request body for `sb.checkIns.update()`. */
|
|
37252
|
+
type PatchCheckInBody = NonNullable<NonNullable<operations["patchCheckIn"]["requestBody"]>["content"]["application/json"]["checkIn"]>;
|
|
37096
37253
|
|
|
37097
37254
|
/** A CreditNote entity as returned by the Spacebring API. */
|
|
37098
37255
|
type CreditNote = NonNullable<components["schemas"]["creditNote"]>;
|
|
@@ -37395,6 +37552,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
37395
37552
|
}>;
|
|
37396
37553
|
iterate(query?: Omit<GetCheckInsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CheckIn, void, undefined>;
|
|
37397
37554
|
get(checkInId: string, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
37555
|
+
update(checkInId: string, checkIn: PatchCheckInBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
37398
37556
|
checkIn(body: CheckInBody, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
37399
37557
|
checkOut(body: CheckOutBody, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
37400
37558
|
};
|
|
@@ -37864,4 +38022,4 @@ declare class SpacebringError extends Error {
|
|
|
37864
38022
|
}
|
|
37865
38023
|
|
|
37866
38024
|
export { Spacebring, SpacebringError };
|
|
37867
|
-
export type { Activity, AddEventHostsBody, AltCurrency, Application, ApplyBenefitBody, Assignment, Attachment, Balance, Benefit, BenefitCategory, BenefitMedia, Booking, CheckIn, CheckInBody, CheckInVisitBody, CheckOutBody, CheckOutVisitBody, Comment, Company, CompanyMedia, Contact, Contract, Coupon, CreateAltCurrencyBody, CreateAssignmentBody, CreateBenefitBody, CreateBenefitCategoryBody, CreateBenefitMediaBody, CreateBookingBody, CreateCompanyBody, CreateCompanyMediaBody, CreateContactBody, CreateContractBody, CreateCouponBody, CreateCreditNoteBody, CreateCreditsTransactionBody, CreateDayPassesTransactionBody, CreateEventBody, CreateEventMediaBody, CreateFeedPostBody, CreateFeedPostCommentBody, CreateFeedPostMediaBody, CreateGuideAttachmentBody, CreateGuideBody, CreateGuideMediaBody, CreateInvoiceBody, CreateInvoiceItemBody, CreateMembershipBody, CreateMoneyTransactionBody, CreatePackageBody, CreatePlanBody, CreatePlanMediaBody, CreateProductBody, CreateProductMediaBody, CreatePromocodeBody, CreateRequestBody, CreateResourceBody, CreateResourceMediaBody, CreateShopCategoryBody, CreateSubscriptionBody, CreateSubscriptionItemBody, CreateSupportTicketBody, CreateSupportTicketCommentBody, CreateSupportTicketMediaBody, CreateTemplateBody, CreateTemplateMediaBody, CreateVisitBody, CreditNote, CreditScheduledTransaction, CreditTransaction, DayPassScheduledTransaction, DayPassTransaction, Event, EventMedia, EventTicket, FeedMedia, GetAltCurrenciesQuery, GetAssignmentsQuery, GetBenefitApplicationsQuery, GetBenefitCategoriesQuery, GetBenefitsQuery, GetBookingsQuery, GetCheckInsQuery, GetCompaniesQuery, GetContactsQuery, GetContractsQuery, GetCouponsQuery, GetCreditNotesQuery, GetCreditsTransactionsQuery, GetDayPassesTransactionsQuery, GetDiscountRedemptionsQuery, GetEventTicketsQuery, GetEventsByOrganizationQuery, GetFeedPostsQuery, GetFloorsQuery, GetGuidesQuery, GetInvoicesQuery, GetMembershipsDeletedQuery, GetMembershipsQuery, GetMoneyTransactionsQuery, GetOrdersQuery, GetPackagesQuery, GetPlansQuery, GetProductsQuery, GetPromocodesQuery, GetRegistrationsQuery, GetRequestsQuery, GetResourceAvailability, GetResourceAvailabilityBody, GetResourcesQuery, GetScheduledCreditsTransactionsQuery, GetScheduledDayPassesTransactionsQuery, GetShopCategoriesQuery, GetSubscriptionsQuery, GetSupportTicketsQuery, GetTemplatesQuery, GetUpcomingInvoiceItemsQuery, GetUpcomingInvoiceQuery, GetVisitsQuery, Guide, GuideMedia, Invoice, InvoiceItem, IssueContractBody, IssueInvoiceBody, Like, ListInvoiceItemsQuery, Location, Membership, MoneyTransaction, Network, Order, Package, PatchAssignmentBody, PatchBenefitBody, PatchBookingBody, PatchEventBody, PatchFeedPostBody, PatchGuideBody, PatchMoneyTransactionBody, PatchPackageBody, PatchProductBody, PatchResourceBody, PayInvoiceBody, Payment, Plan, PlanMedia, Post, PreviewCreditNoteBody, Product, ProductMedia, Promocode, Redemption, Refund, RefundMoneyTransactionBody, Registration, Request$1 as Request, Resource, ResourceMedia, ShopCategory, SpacebringConfig, SpacebringErrorBody, SpacebringRequestOptions, SpacebringResources, Subscription, SupportTicket, Template, TemplateMedia, TerminateContractBody, TicketMedia, UpcomingItem, UpdateAltCurrencyBody, UpdateBenefitBody, UpdateBenefitCategoryBody, UpdateCompanyBody, UpdateContractBody, UpdateCouponBody, UpdateCreditNoteBody, UpdateEventBody, UpdateEventTicketBody, UpdateFeedPostBody, UpdateInvoiceBody, UpdateInvoiceItemBody, UpdateMembershipBody, UpdatePlanBody, UpdateProductBody, UpdateShopCategoryBody, UpdateSubscriptionBody, UpdateSubscriptionItemBody, UpdateSupportTicketAssigneeBody, UpdateSupportTicketCommentBody, UpdateSupportTicketStatusBody, UpdateSupportTicketTypeBody, UpdateTemplateBody, UpdateVisitBody, Visit, components, operations, paths };
|
|
38025
|
+
export type { Activity, AddEventHostsBody, AltCurrency, Application, ApplyBenefitBody, Assignment, Attachment, Balance, Benefit, BenefitCategory, BenefitMedia, Booking, CheckIn, CheckInBody, CheckInVisitBody, CheckOutBody, CheckOutVisitBody, Comment, Company, CompanyMedia, Contact, Contract, Coupon, CreateAltCurrencyBody, CreateAssignmentBody, CreateBenefitBody, CreateBenefitCategoryBody, CreateBenefitMediaBody, CreateBookingBody, CreateCompanyBody, CreateCompanyMediaBody, CreateContactBody, CreateContractBody, CreateCouponBody, CreateCreditNoteBody, CreateCreditsTransactionBody, CreateDayPassesTransactionBody, CreateEventBody, CreateEventMediaBody, CreateFeedPostBody, CreateFeedPostCommentBody, CreateFeedPostMediaBody, CreateGuideAttachmentBody, CreateGuideBody, CreateGuideMediaBody, CreateInvoiceBody, CreateInvoiceItemBody, CreateMembershipBody, CreateMoneyTransactionBody, CreatePackageBody, CreatePlanBody, CreatePlanMediaBody, CreateProductBody, CreateProductMediaBody, CreatePromocodeBody, CreateRequestBody, CreateResourceBody, CreateResourceMediaBody, CreateShopCategoryBody, CreateSubscriptionBody, CreateSubscriptionItemBody, CreateSupportTicketBody, CreateSupportTicketCommentBody, CreateSupportTicketMediaBody, CreateTemplateBody, CreateTemplateMediaBody, CreateVisitBody, CreditNote, CreditScheduledTransaction, CreditTransaction, DayPassScheduledTransaction, DayPassTransaction, Event, EventMedia, EventTicket, FeedMedia, GetAltCurrenciesQuery, GetAssignmentsQuery, GetBenefitApplicationsQuery, GetBenefitCategoriesQuery, GetBenefitsQuery, GetBookingsQuery, GetCheckInsQuery, GetCompaniesQuery, GetContactsQuery, GetContractsQuery, GetCouponsQuery, GetCreditNotesQuery, GetCreditsTransactionsQuery, GetDayPassesTransactionsQuery, GetDiscountRedemptionsQuery, GetEventTicketsQuery, GetEventsByOrganizationQuery, GetFeedPostsQuery, GetFloorsQuery, GetGuidesQuery, GetInvoicesQuery, GetMembershipsDeletedQuery, GetMembershipsQuery, GetMoneyTransactionsQuery, GetOrdersQuery, GetPackagesQuery, GetPlansQuery, GetProductsQuery, GetPromocodesQuery, GetRegistrationsQuery, GetRequestsQuery, GetResourceAvailability, GetResourceAvailabilityBody, GetResourcesQuery, GetScheduledCreditsTransactionsQuery, GetScheduledDayPassesTransactionsQuery, GetShopCategoriesQuery, GetSubscriptionsQuery, GetSupportTicketsQuery, GetTemplatesQuery, GetUpcomingInvoiceItemsQuery, GetUpcomingInvoiceQuery, GetVisitsQuery, Guide, GuideMedia, Invoice, InvoiceItem, IssueContractBody, IssueInvoiceBody, Like, ListInvoiceItemsQuery, Location, Membership, MoneyTransaction, Network, Order, Package, PatchAssignmentBody, PatchBenefitBody, PatchBookingBody, PatchCheckInBody, PatchEventBody, PatchFeedPostBody, PatchGuideBody, PatchMoneyTransactionBody, PatchPackageBody, PatchProductBody, PatchResourceBody, PayInvoiceBody, Payment, Plan, PlanMedia, Post, PreviewCreditNoteBody, Product, ProductMedia, Promocode, Redemption, Refund, RefundMoneyTransactionBody, Registration, Request$1 as Request, Resource, ResourceMedia, ShopCategory, SpacebringConfig, SpacebringErrorBody, SpacebringRequestOptions, SpacebringResources, Subscription, SupportTicket, Template, TemplateMedia, TerminateContractBody, TicketMedia, UpcomingItem, UpdateAltCurrencyBody, UpdateBenefitBody, UpdateBenefitCategoryBody, UpdateCompanyBody, UpdateContractBody, UpdateCouponBody, UpdateCreditNoteBody, UpdateEventBody, UpdateEventTicketBody, UpdateFeedPostBody, UpdateInvoiceBody, UpdateInvoiceItemBody, UpdateMembershipBody, UpdatePlanBody, UpdateProductBody, UpdateShopCategoryBody, UpdateSubscriptionBody, UpdateSubscriptionItemBody, UpdateSupportTicketAssigneeBody, UpdateSupportTicketCommentBody, UpdateSupportTicketStatusBody, UpdateSupportTicketTypeBody, UpdateTemplateBody, UpdateVisitBody, Visit, components, operations, paths };
|
package/dist/index.js
CHANGED
|
@@ -1091,6 +1091,18 @@ function createCheckins(client, defaults) {
|
|
|
1091
1091
|
async get(checkInId, options) {
|
|
1092
1092
|
return unwrapProp(await client.GET("/check_ins/v1/{checkInId}", { params: { path: { checkInId } }, signal: options?.signal }), "checkIn", "GET /check_ins/v1/{checkInId}");
|
|
1093
1093
|
},
|
|
1094
|
+
/**
|
|
1095
|
+
* Update a check-in
|
|
1096
|
+
*
|
|
1097
|
+
* Change when a customer arrived, or when they left on a check-in that is checked out. Fields left out keep their values. The booking, event ticket, or visit behind the check-in gets the new dates too. The customer and administrators are not notified. With bearer token authentication, the user must be an administrator of the check-in's location.
|
|
1098
|
+
*
|
|
1099
|
+
* @param checkInId The ID of the check-in.
|
|
1100
|
+
* @param checkIn The `checkIn` payload.
|
|
1101
|
+
* @param options Request options (abort signal).
|
|
1102
|
+
*/
|
|
1103
|
+
async update(checkInId, checkIn, options) {
|
|
1104
|
+
return unwrap(await client.PATCH("/check_ins/v1/{checkInId}", { params: { path: { checkInId } }, body: { checkIn }, signal: options?.signal }), "PATCH /check_ins/v1/{checkInId}");
|
|
1105
|
+
},
|
|
1094
1106
|
/**
|
|
1095
1107
|
* Check in
|
|
1096
1108
|
*
|