@izak0s/spacebring-api 16.3.0 → 16.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +6 -6
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +62 -22
- package/dist/index.d.ts +62 -22
- package/dist/index.js +6 -6
- 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;
|
|
@@ -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, '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.
|
|
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, 'accessControl' by unlocking a door through an access control integration, '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" | "backdated" | "manual" | "reception";
|
|
6645
|
+
checkInMethod?: "accessControl" | "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.
|
|
@@ -6657,7 +6657,7 @@ interface components {
|
|
|
6657
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" | "backdated" | "manual" | "reception" | "automatic";
|
|
6660
|
+
checkOutMethod?: "accessControl" | "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6661
6661
|
/** @description Confirmation code of the check-in. */
|
|
6662
6662
|
code?: string;
|
|
6663
6663
|
/**
|
|
@@ -6667,7 +6667,7 @@ interface components {
|
|
|
6667
6667
|
createDate: string;
|
|
6668
6668
|
/**
|
|
6669
6669
|
* Format: date-time
|
|
6670
|
-
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or
|
|
6670
|
+
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or for a subscription.
|
|
6671
6671
|
*/
|
|
6672
6672
|
endDate?: string;
|
|
6673
6673
|
/** @description Event ticket this check-in was created for, if any. */
|
|
@@ -6738,6 +6738,16 @@ interface components {
|
|
|
6738
6738
|
};
|
|
6739
6739
|
/** @description Visit this check-in was created for, if any. */
|
|
6740
6740
|
visit?: {
|
|
6741
|
+
/** @description The company the host belongs to, read from the customers service so the name is current. */
|
|
6742
|
+
companyHost?: {
|
|
6743
|
+
/**
|
|
6744
|
+
* Format: uuid
|
|
6745
|
+
* @description Unique identifier of the host's company.
|
|
6746
|
+
*/
|
|
6747
|
+
id: string;
|
|
6748
|
+
/** @description Name of the host's company. */
|
|
6749
|
+
title: string;
|
|
6750
|
+
};
|
|
6741
6751
|
/**
|
|
6742
6752
|
* Format: uuid
|
|
6743
6753
|
* @description ID of the visit.
|
|
@@ -6745,6 +6755,8 @@ interface components {
|
|
|
6745
6755
|
id: string;
|
|
6746
6756
|
/** @description The host the visit is with, read from the users service so the details are current. */
|
|
6747
6757
|
userHost?: {
|
|
6758
|
+
/** @description Email address of the host. */
|
|
6759
|
+
email?: string | null;
|
|
6748
6760
|
/**
|
|
6749
6761
|
* Format: uuid
|
|
6750
6762
|
* @description Unique identifier of the host.
|
|
@@ -6779,10 +6791,10 @@ interface components {
|
|
|
6779
6791
|
*/
|
|
6780
6792
|
checkInDate?: string;
|
|
6781
6793
|
/**
|
|
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.
|
|
6794
|
+
* @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, 'accessControl' by unlocking a door through an access control integration, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6783
6795
|
* @enum {string}
|
|
6784
6796
|
*/
|
|
6785
|
-
checkInMethod?: "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6797
|
+
checkInMethod?: "accessControl" | "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6786
6798
|
/**
|
|
6787
6799
|
* Format: uuid
|
|
6788
6800
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6797,7 +6809,7 @@ interface components {
|
|
|
6797
6809
|
* @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
6810
|
* @enum {string}
|
|
6799
6811
|
*/
|
|
6800
|
-
checkOutMethod?: "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6812
|
+
checkOutMethod?: "accessControl" | "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6801
6813
|
/** @description Confirmation code of the check-in. */
|
|
6802
6814
|
code?: string;
|
|
6803
6815
|
/**
|
|
@@ -6807,7 +6819,7 @@ interface components {
|
|
|
6807
6819
|
createDate: string;
|
|
6808
6820
|
/**
|
|
6809
6821
|
* Format: date-time
|
|
6810
|
-
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or
|
|
6822
|
+
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or for a subscription.
|
|
6811
6823
|
*/
|
|
6812
6824
|
endDate?: string;
|
|
6813
6825
|
/** @description Event ticket this check-in was created for, if any. */
|
|
@@ -6878,6 +6890,16 @@ interface components {
|
|
|
6878
6890
|
};
|
|
6879
6891
|
/** @description Visit this check-in was created for, if any. */
|
|
6880
6892
|
visit?: {
|
|
6893
|
+
/** @description The company the host belongs to, read from the customers service so the name is current. */
|
|
6894
|
+
companyHost?: {
|
|
6895
|
+
/**
|
|
6896
|
+
* Format: uuid
|
|
6897
|
+
* @description Unique identifier of the host's company.
|
|
6898
|
+
*/
|
|
6899
|
+
id: string;
|
|
6900
|
+
/** @description Name of the host's company. */
|
|
6901
|
+
title: string;
|
|
6902
|
+
};
|
|
6881
6903
|
/**
|
|
6882
6904
|
* Format: uuid
|
|
6883
6905
|
* @description ID of the visit.
|
|
@@ -6885,6 +6907,8 @@ interface components {
|
|
|
6885
6907
|
id: string;
|
|
6886
6908
|
/** @description The host the visit is with, read from the users service so the details are current. */
|
|
6887
6909
|
userHost?: {
|
|
6910
|
+
/** @description Email address of the host. */
|
|
6911
|
+
email?: string | null;
|
|
6888
6912
|
/**
|
|
6889
6913
|
* Format: uuid
|
|
6890
6914
|
* @description Unique identifier of the host.
|
|
@@ -26017,7 +26041,7 @@ interface components {
|
|
|
26017
26041
|
content: {
|
|
26018
26042
|
"application/json": {
|
|
26019
26043
|
booking: {
|
|
26020
|
-
/** @description Attendees to invite to the booking, each an existing user by id or a person by email. Supported for room resources. A person invited by email joins the network without a membership in the location. The owner is left out, and so are all attendees when the owner is not a member of the location. */
|
|
26044
|
+
/** @description Attendees to invite to the booking, each an existing user by id or a person by email. Supported for room resources. A person invited by email joins the network without a membership in the location. The owner is left out, and so are all attendees when the owner is not a member of the location, unless an API key or an administrator makes the booking. */
|
|
26021
26045
|
attendees?: {
|
|
26022
26046
|
user: {
|
|
26023
26047
|
/**
|
|
@@ -28485,7 +28509,7 @@ interface operations {
|
|
|
28485
28509
|
"createDate[gte]"?: string;
|
|
28486
28510
|
/** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
28487
28511
|
"createDate[lte]"?: string;
|
|
28488
|
-
/** @description UUID of the customer whose invoices to list. */
|
|
28512
|
+
/** @description UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
28489
28513
|
customerRef?: string;
|
|
28490
28514
|
/** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
28491
28515
|
"issueDate[gte]"?: string;
|
|
@@ -28499,7 +28523,7 @@ interface operations {
|
|
|
28499
28523
|
membershipRef?: string;
|
|
28500
28524
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28501
28525
|
nextPageToken?: string;
|
|
28502
|
-
/** @description Case-insensitive search by invoice code or number.
|
|
28526
|
+
/** @description Case-insensitive search by invoice code or number. */
|
|
28503
28527
|
q?: string;
|
|
28504
28528
|
/** @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. */
|
|
28505
28529
|
status?: string;
|
|
@@ -28895,7 +28919,7 @@ interface operations {
|
|
|
28895
28919
|
"issueDate[lte]"?: string;
|
|
28896
28920
|
/** @description Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28897
28921
|
limit?: number;
|
|
28898
|
-
/** @description UUID of the location whose invoice items to list. */
|
|
28922
|
+
/** @description UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
28899
28923
|
locationRef?: string;
|
|
28900
28924
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28901
28925
|
nextPageToken?: string;
|
|
@@ -29165,7 +29189,7 @@ interface operations {
|
|
|
29165
29189
|
invoiceRef?: string;
|
|
29166
29190
|
/** @description Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29167
29191
|
limit?: number;
|
|
29168
|
-
/** @description UUID of the location whose credit notes to list. */
|
|
29192
|
+
/** @description UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
29169
29193
|
locationRef?: string;
|
|
29170
29194
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
29171
29195
|
nextPageToken?: string;
|
|
@@ -29499,7 +29523,7 @@ interface operations {
|
|
|
29499
29523
|
nextPageToken?: string;
|
|
29500
29524
|
/** @description Filter by status: 'scheduled' nobody has arrived yet, 'checkedIn' the person is on site, 'checkedOut' they left, 'expired' the window closed with nobody arriving. Defaults to every status. Comma-separated, one or more of: checkedIn, checkedOut, scheduled, expired. */
|
|
29501
29525
|
status?: string;
|
|
29502
|
-
/** @description Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving with their personal code. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
29526
|
+
/** @description Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving on their subscription, with their personal code or by unlocking a door. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
29503
29527
|
type?: string;
|
|
29504
29528
|
/** @description UUID of the user to filter check-ins by. Defaults to check-ins of every user. */
|
|
29505
29529
|
userRef?: string;
|
|
@@ -33891,6 +33915,14 @@ interface operations {
|
|
|
33891
33915
|
getBookings: {
|
|
33892
33916
|
parameters: {
|
|
33893
33917
|
query?: {
|
|
33918
|
+
/** @description Matches bookings with createDate strictly after this date (ISO 8601). */
|
|
33919
|
+
"createDate[gt]"?: string;
|
|
33920
|
+
/** @description Matches bookings with createDate on or after this date (ISO 8601). */
|
|
33921
|
+
"createDate[gte]"?: string;
|
|
33922
|
+
/** @description Matches bookings with createDate strictly before this date (ISO 8601). */
|
|
33923
|
+
"createDate[lt]"?: string;
|
|
33924
|
+
/** @description Matches bookings with createDate on or before this date (ISO 8601). */
|
|
33925
|
+
"createDate[lte]"?: string;
|
|
33894
33926
|
/** @description Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
33895
33927
|
"endDate[gt]"?: string;
|
|
33896
33928
|
/** @description Matches bookings with endDate on or after this date (ISO 8601). */
|
|
@@ -36814,6 +36846,14 @@ interface GetAssignmentsQuery {
|
|
|
36814
36846
|
}
|
|
36815
36847
|
/** Query parameters for `sb.resources.bookings.list()`. */
|
|
36816
36848
|
interface GetBookingsQuery {
|
|
36849
|
+
/** Matches bookings with createDate strictly after this date (ISO 8601). */
|
|
36850
|
+
"createDate[gt]"?: string;
|
|
36851
|
+
/** Matches bookings with createDate on or after this date (ISO 8601). */
|
|
36852
|
+
"createDate[gte]"?: string;
|
|
36853
|
+
/** Matches bookings with createDate strictly before this date (ISO 8601). */
|
|
36854
|
+
"createDate[lt]"?: string;
|
|
36855
|
+
/** Matches bookings with createDate on or before this date (ISO 8601). */
|
|
36856
|
+
"createDate[lte]"?: string;
|
|
36817
36857
|
/** Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
36818
36858
|
"endDate[gt]"?: string;
|
|
36819
36859
|
/** Matches bookings with endDate on or after this date (ISO 8601). */
|
|
@@ -37249,7 +37289,7 @@ interface GetCheckInsQuery {
|
|
|
37249
37289
|
nextPageToken?: string;
|
|
37250
37290
|
/** Filter by status: 'scheduled' nobody has arrived yet, 'checkedIn' the person is on site, 'checkedOut' they left, 'expired' the window closed with nobody arriving. Defaults to every status. Comma-separated, one or more of: checkedIn, checkedOut, scheduled, expired. */
|
|
37251
37291
|
status?: string;
|
|
37252
|
-
/** Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving with their personal code. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
37292
|
+
/** Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving on their subscription, with their personal code or by unlocking a door. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
37253
37293
|
type?: string;
|
|
37254
37294
|
/** UUID of the user to filter check-ins by. Defaults to check-ins of every user. */
|
|
37255
37295
|
userRef?: string;
|
|
@@ -37281,7 +37321,7 @@ interface GetCreditNotesQuery {
|
|
|
37281
37321
|
invoiceRef?: string;
|
|
37282
37322
|
/** Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37283
37323
|
limit?: number;
|
|
37284
|
-
/** UUID of the location whose credit notes to list. */
|
|
37324
|
+
/** UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
37285
37325
|
locationRef?: string;
|
|
37286
37326
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37287
37327
|
nextPageToken?: string;
|
|
@@ -37296,7 +37336,7 @@ interface GetInvoicesQuery {
|
|
|
37296
37336
|
"createDate[gte]"?: string;
|
|
37297
37337
|
/** Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
37298
37338
|
"createDate[lte]"?: string;
|
|
37299
|
-
/** UUID of the customer whose invoices to list. */
|
|
37339
|
+
/** UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
37300
37340
|
customerRef?: string;
|
|
37301
37341
|
/** Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
37302
37342
|
"issueDate[gte]"?: string;
|
|
@@ -37310,7 +37350,7 @@ interface GetInvoicesQuery {
|
|
|
37310
37350
|
membershipRef?: string;
|
|
37311
37351
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37312
37352
|
nextPageToken?: string;
|
|
37313
|
-
/** Case-insensitive search by invoice code or number.
|
|
37353
|
+
/** Case-insensitive search by invoice code or number. */
|
|
37314
37354
|
q?: string;
|
|
37315
37355
|
/** 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. */
|
|
37316
37356
|
status?: string;
|
|
@@ -37343,7 +37383,7 @@ interface ListInvoiceItemsQuery {
|
|
|
37343
37383
|
"issueDate[lte]"?: string;
|
|
37344
37384
|
/** Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37345
37385
|
limit?: number;
|
|
37346
|
-
/** UUID of the location whose invoice items to list. */
|
|
37386
|
+
/** UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
37347
37387
|
locationRef?: string;
|
|
37348
37388
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37349
37389
|
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;
|
|
@@ -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, '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.
|
|
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, 'accessControl' by unlocking a door through an access control integration, '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" | "backdated" | "manual" | "reception";
|
|
6645
|
+
checkInMethod?: "accessControl" | "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.
|
|
@@ -6657,7 +6657,7 @@ interface components {
|
|
|
6657
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" | "backdated" | "manual" | "reception" | "automatic";
|
|
6660
|
+
checkOutMethod?: "accessControl" | "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6661
6661
|
/** @description Confirmation code of the check-in. */
|
|
6662
6662
|
code?: string;
|
|
6663
6663
|
/**
|
|
@@ -6667,7 +6667,7 @@ interface components {
|
|
|
6667
6667
|
createDate: string;
|
|
6668
6668
|
/**
|
|
6669
6669
|
* Format: date-time
|
|
6670
|
-
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or
|
|
6670
|
+
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or for a subscription.
|
|
6671
6671
|
*/
|
|
6672
6672
|
endDate?: string;
|
|
6673
6673
|
/** @description Event ticket this check-in was created for, if any. */
|
|
@@ -6738,6 +6738,16 @@ interface components {
|
|
|
6738
6738
|
};
|
|
6739
6739
|
/** @description Visit this check-in was created for, if any. */
|
|
6740
6740
|
visit?: {
|
|
6741
|
+
/** @description The company the host belongs to, read from the customers service so the name is current. */
|
|
6742
|
+
companyHost?: {
|
|
6743
|
+
/**
|
|
6744
|
+
* Format: uuid
|
|
6745
|
+
* @description Unique identifier of the host's company.
|
|
6746
|
+
*/
|
|
6747
|
+
id: string;
|
|
6748
|
+
/** @description Name of the host's company. */
|
|
6749
|
+
title: string;
|
|
6750
|
+
};
|
|
6741
6751
|
/**
|
|
6742
6752
|
* Format: uuid
|
|
6743
6753
|
* @description ID of the visit.
|
|
@@ -6745,6 +6755,8 @@ interface components {
|
|
|
6745
6755
|
id: string;
|
|
6746
6756
|
/** @description The host the visit is with, read from the users service so the details are current. */
|
|
6747
6757
|
userHost?: {
|
|
6758
|
+
/** @description Email address of the host. */
|
|
6759
|
+
email?: string | null;
|
|
6748
6760
|
/**
|
|
6749
6761
|
* Format: uuid
|
|
6750
6762
|
* @description Unique identifier of the host.
|
|
@@ -6779,10 +6791,10 @@ interface components {
|
|
|
6779
6791
|
*/
|
|
6780
6792
|
checkInDate?: string;
|
|
6781
6793
|
/**
|
|
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.
|
|
6794
|
+
* @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, 'accessControl' by unlocking a door through an access control integration, 'agent' by the AI agent, and 'api' through the API. Absent on check-ins made before methods were recorded.
|
|
6783
6795
|
* @enum {string}
|
|
6784
6796
|
*/
|
|
6785
|
-
checkInMethod?: "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6797
|
+
checkInMethod?: "accessControl" | "agent" | "api" | "backdated" | "manual" | "reception";
|
|
6786
6798
|
/**
|
|
6787
6799
|
* Format: uuid
|
|
6788
6800
|
* @description ID of the schedule this check-in was opened under. Absent on check-ins created before schedules were introduced.
|
|
@@ -6797,7 +6809,7 @@ interface components {
|
|
|
6797
6809
|
* @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
6810
|
* @enum {string}
|
|
6799
6811
|
*/
|
|
6800
|
-
checkOutMethod?: "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6812
|
+
checkOutMethod?: "accessControl" | "agent" | "api" | "backdated" | "manual" | "reception" | "automatic";
|
|
6801
6813
|
/** @description Confirmation code of the check-in. */
|
|
6802
6814
|
code?: string;
|
|
6803
6815
|
/**
|
|
@@ -6807,7 +6819,7 @@ interface components {
|
|
|
6807
6819
|
createDate: string;
|
|
6808
6820
|
/**
|
|
6809
6821
|
* Format: date-time
|
|
6810
|
-
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or
|
|
6822
|
+
* @description ISO timestamp of when the check-in expires. Absent when it was opened under a schedule without an end date, or for a subscription.
|
|
6811
6823
|
*/
|
|
6812
6824
|
endDate?: string;
|
|
6813
6825
|
/** @description Event ticket this check-in was created for, if any. */
|
|
@@ -6878,6 +6890,16 @@ interface components {
|
|
|
6878
6890
|
};
|
|
6879
6891
|
/** @description Visit this check-in was created for, if any. */
|
|
6880
6892
|
visit?: {
|
|
6893
|
+
/** @description The company the host belongs to, read from the customers service so the name is current. */
|
|
6894
|
+
companyHost?: {
|
|
6895
|
+
/**
|
|
6896
|
+
* Format: uuid
|
|
6897
|
+
* @description Unique identifier of the host's company.
|
|
6898
|
+
*/
|
|
6899
|
+
id: string;
|
|
6900
|
+
/** @description Name of the host's company. */
|
|
6901
|
+
title: string;
|
|
6902
|
+
};
|
|
6881
6903
|
/**
|
|
6882
6904
|
* Format: uuid
|
|
6883
6905
|
* @description ID of the visit.
|
|
@@ -6885,6 +6907,8 @@ interface components {
|
|
|
6885
6907
|
id: string;
|
|
6886
6908
|
/** @description The host the visit is with, read from the users service so the details are current. */
|
|
6887
6909
|
userHost?: {
|
|
6910
|
+
/** @description Email address of the host. */
|
|
6911
|
+
email?: string | null;
|
|
6888
6912
|
/**
|
|
6889
6913
|
* Format: uuid
|
|
6890
6914
|
* @description Unique identifier of the host.
|
|
@@ -26017,7 +26041,7 @@ interface components {
|
|
|
26017
26041
|
content: {
|
|
26018
26042
|
"application/json": {
|
|
26019
26043
|
booking: {
|
|
26020
|
-
/** @description Attendees to invite to the booking, each an existing user by id or a person by email. Supported for room resources. A person invited by email joins the network without a membership in the location. The owner is left out, and so are all attendees when the owner is not a member of the location. */
|
|
26044
|
+
/** @description Attendees to invite to the booking, each an existing user by id or a person by email. Supported for room resources. A person invited by email joins the network without a membership in the location. The owner is left out, and so are all attendees when the owner is not a member of the location, unless an API key or an administrator makes the booking. */
|
|
26021
26045
|
attendees?: {
|
|
26022
26046
|
user: {
|
|
26023
26047
|
/**
|
|
@@ -28485,7 +28509,7 @@ interface operations {
|
|
|
28485
28509
|
"createDate[gte]"?: string;
|
|
28486
28510
|
/** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
28487
28511
|
"createDate[lte]"?: string;
|
|
28488
|
-
/** @description UUID of the customer whose invoices to list. */
|
|
28512
|
+
/** @description UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
28489
28513
|
customerRef?: string;
|
|
28490
28514
|
/** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
28491
28515
|
"issueDate[gte]"?: string;
|
|
@@ -28499,7 +28523,7 @@ interface operations {
|
|
|
28499
28523
|
membershipRef?: string;
|
|
28500
28524
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28501
28525
|
nextPageToken?: string;
|
|
28502
|
-
/** @description Case-insensitive search by invoice code or number.
|
|
28526
|
+
/** @description Case-insensitive search by invoice code or number. */
|
|
28503
28527
|
q?: string;
|
|
28504
28528
|
/** @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. */
|
|
28505
28529
|
status?: string;
|
|
@@ -28895,7 +28919,7 @@ interface operations {
|
|
|
28895
28919
|
"issueDate[lte]"?: string;
|
|
28896
28920
|
/** @description Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28897
28921
|
limit?: number;
|
|
28898
|
-
/** @description UUID of the location whose invoice items to list. */
|
|
28922
|
+
/** @description UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
28899
28923
|
locationRef?: string;
|
|
28900
28924
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28901
28925
|
nextPageToken?: string;
|
|
@@ -29165,7 +29189,7 @@ interface operations {
|
|
|
29165
29189
|
invoiceRef?: string;
|
|
29166
29190
|
/** @description Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29167
29191
|
limit?: number;
|
|
29168
|
-
/** @description UUID of the location whose credit notes to list. */
|
|
29192
|
+
/** @description UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
29169
29193
|
locationRef?: string;
|
|
29170
29194
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
29171
29195
|
nextPageToken?: string;
|
|
@@ -29499,7 +29523,7 @@ interface operations {
|
|
|
29499
29523
|
nextPageToken?: string;
|
|
29500
29524
|
/** @description Filter by status: 'scheduled' nobody has arrived yet, 'checkedIn' the person is on site, 'checkedOut' they left, 'expired' the window closed with nobody arriving. Defaults to every status. Comma-separated, one or more of: checkedIn, checkedOut, scheduled, expired. */
|
|
29501
29525
|
status?: string;
|
|
29502
|
-
/** @description Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving with their personal code. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
29526
|
+
/** @description Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving on their subscription, with their personal code or by unlocking a door. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
29503
29527
|
type?: string;
|
|
29504
29528
|
/** @description UUID of the user to filter check-ins by. Defaults to check-ins of every user. */
|
|
29505
29529
|
userRef?: string;
|
|
@@ -33891,6 +33915,14 @@ interface operations {
|
|
|
33891
33915
|
getBookings: {
|
|
33892
33916
|
parameters: {
|
|
33893
33917
|
query?: {
|
|
33918
|
+
/** @description Matches bookings with createDate strictly after this date (ISO 8601). */
|
|
33919
|
+
"createDate[gt]"?: string;
|
|
33920
|
+
/** @description Matches bookings with createDate on or after this date (ISO 8601). */
|
|
33921
|
+
"createDate[gte]"?: string;
|
|
33922
|
+
/** @description Matches bookings with createDate strictly before this date (ISO 8601). */
|
|
33923
|
+
"createDate[lt]"?: string;
|
|
33924
|
+
/** @description Matches bookings with createDate on or before this date (ISO 8601). */
|
|
33925
|
+
"createDate[lte]"?: string;
|
|
33894
33926
|
/** @description Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
33895
33927
|
"endDate[gt]"?: string;
|
|
33896
33928
|
/** @description Matches bookings with endDate on or after this date (ISO 8601). */
|
|
@@ -36814,6 +36846,14 @@ interface GetAssignmentsQuery {
|
|
|
36814
36846
|
}
|
|
36815
36847
|
/** Query parameters for `sb.resources.bookings.list()`. */
|
|
36816
36848
|
interface GetBookingsQuery {
|
|
36849
|
+
/** Matches bookings with createDate strictly after this date (ISO 8601). */
|
|
36850
|
+
"createDate[gt]"?: string;
|
|
36851
|
+
/** Matches bookings with createDate on or after this date (ISO 8601). */
|
|
36852
|
+
"createDate[gte]"?: string;
|
|
36853
|
+
/** Matches bookings with createDate strictly before this date (ISO 8601). */
|
|
36854
|
+
"createDate[lt]"?: string;
|
|
36855
|
+
/** Matches bookings with createDate on or before this date (ISO 8601). */
|
|
36856
|
+
"createDate[lte]"?: string;
|
|
36817
36857
|
/** Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
36818
36858
|
"endDate[gt]"?: string;
|
|
36819
36859
|
/** Matches bookings with endDate on or after this date (ISO 8601). */
|
|
@@ -37249,7 +37289,7 @@ interface GetCheckInsQuery {
|
|
|
37249
37289
|
nextPageToken?: string;
|
|
37250
37290
|
/** Filter by status: 'scheduled' nobody has arrived yet, 'checkedIn' the person is on site, 'checkedOut' they left, 'expired' the window closed with nobody arriving. Defaults to every status. Comma-separated, one or more of: checkedIn, checkedOut, scheduled, expired. */
|
|
37251
37291
|
status?: string;
|
|
37252
|
-
/** Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving with their personal code. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
37292
|
+
/** Filter by what the check-in is for: 'deskBooking' and 'roomBooking' a booking, 'eventTicket' an event ticket, 'visit' a visit, 'subscription' a member arriving on their subscription, with their personal code or by unlocking a door. Defaults to every type. Comma-separated, one or more of: deskBooking, roomBooking, eventTicket, visit, subscription. */
|
|
37253
37293
|
type?: string;
|
|
37254
37294
|
/** UUID of the user to filter check-ins by. Defaults to check-ins of every user. */
|
|
37255
37295
|
userRef?: string;
|
|
@@ -37281,7 +37321,7 @@ interface GetCreditNotesQuery {
|
|
|
37281
37321
|
invoiceRef?: string;
|
|
37282
37322
|
/** Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37283
37323
|
limit?: number;
|
|
37284
|
-
/** UUID of the location whose credit notes to list. */
|
|
37324
|
+
/** UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
|
|
37285
37325
|
locationRef?: string;
|
|
37286
37326
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37287
37327
|
nextPageToken?: string;
|
|
@@ -37296,7 +37336,7 @@ interface GetInvoicesQuery {
|
|
|
37296
37336
|
"createDate[gte]"?: string;
|
|
37297
37337
|
/** Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
37298
37338
|
"createDate[lte]"?: string;
|
|
37299
|
-
/** UUID of the customer whose invoices to list. */
|
|
37339
|
+
/** UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
|
|
37300
37340
|
customerRef?: string;
|
|
37301
37341
|
/** Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
|
|
37302
37342
|
"issueDate[gte]"?: string;
|
|
@@ -37310,7 +37350,7 @@ interface GetInvoicesQuery {
|
|
|
37310
37350
|
membershipRef?: string;
|
|
37311
37351
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37312
37352
|
nextPageToken?: string;
|
|
37313
|
-
/** Case-insensitive search by invoice code or number.
|
|
37353
|
+
/** Case-insensitive search by invoice code or number. */
|
|
37314
37354
|
q?: string;
|
|
37315
37355
|
/** 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. */
|
|
37316
37356
|
status?: string;
|
|
@@ -37343,7 +37383,7 @@ interface ListInvoiceItemsQuery {
|
|
|
37343
37383
|
"issueDate[lte]"?: string;
|
|
37344
37384
|
/** Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
37345
37385
|
limit?: number;
|
|
37346
|
-
/** UUID of the location whose invoice items to list. */
|
|
37386
|
+
/** UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
|
|
37347
37387
|
locationRef?: string;
|
|
37348
37388
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
37349
37389
|
nextPageToken?: string;
|
package/dist/index.js
CHANGED
|
@@ -778,7 +778,7 @@ function createBilling(client, defaults) {
|
|
|
778
778
|
/**
|
|
779
779
|
* Retrieve credit notes
|
|
780
780
|
*
|
|
781
|
-
* Retrieve
|
|
781
|
+
* 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.
|
|
782
782
|
*/
|
|
783
783
|
async list(query, options) {
|
|
784
784
|
return unwrap(await client.GET("/billing/credit_notes/v1", { params: { query }, signal: options?.signal }), "GET /billing/credit_notes/v1");
|
|
@@ -786,7 +786,7 @@ function createBilling(client, defaults) {
|
|
|
786
786
|
/**
|
|
787
787
|
* Retrieve credit notes — iterates every item across all pages.
|
|
788
788
|
*
|
|
789
|
-
* Retrieve
|
|
789
|
+
* 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.
|
|
790
790
|
*/
|
|
791
791
|
iterate(query, options) {
|
|
792
792
|
return paginate(
|
|
@@ -847,7 +847,7 @@ function createBilling(client, defaults) {
|
|
|
847
847
|
/**
|
|
848
848
|
* Retrieve invoices
|
|
849
849
|
*
|
|
850
|
-
* Retrieve
|
|
850
|
+
* 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.
|
|
851
851
|
*/
|
|
852
852
|
async list(query, options) {
|
|
853
853
|
return unwrap(await client.GET("/billing/invoices/v1", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1");
|
|
@@ -855,7 +855,7 @@ function createBilling(client, defaults) {
|
|
|
855
855
|
/**
|
|
856
856
|
* Retrieve invoices — iterates every item across all pages.
|
|
857
857
|
*
|
|
858
|
-
* Retrieve
|
|
858
|
+
* 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.
|
|
859
859
|
*/
|
|
860
860
|
iterate(query, options) {
|
|
861
861
|
return paginate(
|
|
@@ -985,7 +985,7 @@ function createBilling(client, defaults) {
|
|
|
985
985
|
/**
|
|
986
986
|
* List invoice items
|
|
987
987
|
*
|
|
988
|
-
* 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.
|
|
988
|
+
* 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.
|
|
989
989
|
*/
|
|
990
990
|
async list(query, options) {
|
|
991
991
|
return unwrap(await client.GET("/billing/invoices/v1/items", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1/items");
|
|
@@ -993,7 +993,7 @@ function createBilling(client, defaults) {
|
|
|
993
993
|
/**
|
|
994
994
|
* List invoice items — iterates every item across all pages.
|
|
995
995
|
*
|
|
996
|
-
* 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.
|
|
996
|
+
* 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.
|
|
997
997
|
*/
|
|
998
998
|
iterate(query, options) {
|
|
999
999
|
return paginate(
|