@izak0s/spacebring-api 11.0.0 → 11.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -688,7 +688,7 @@ interface paths {
688
688
  };
689
689
  /**
690
690
  * List invoice items
691
- * @description List invoice items filtered by customer, location, type, status, pending, or date range. 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>
691
+ * @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>
692
692
  */
693
693
  get: operations["listInvoiceItems"];
694
694
  put?: never;
@@ -11727,6 +11727,11 @@ interface components {
11727
11727
  };
11728
11728
  /** @description ID of the invoice item the booking was billed on. */
11729
11729
  invoiceItemRef?: string;
11730
+ /**
11731
+ * Format: uuid
11732
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
11733
+ */
11734
+ invoiceRef?: string;
11730
11735
  /**
11731
11736
  * Format: uuid
11732
11737
  * @description Subscription the invoice item belongs to.
@@ -12157,6 +12162,11 @@ interface components {
12157
12162
  };
12158
12163
  /** @description ID of the invoice item the booking was billed on. */
12159
12164
  invoiceItemRef?: string;
12165
+ /**
12166
+ * Format: uuid
12167
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
12168
+ */
12169
+ invoiceRef?: string;
12160
12170
  /**
12161
12171
  * Format: uuid
12162
12172
  * @description Subscription the invoice item belongs to.
@@ -12799,6 +12809,11 @@ interface components {
12799
12809
  };
12800
12810
  /** @description ID of the invoice item the booking was billed on. */
12801
12811
  invoiceItemRef?: string;
12812
+ /**
12813
+ * Format: uuid
12814
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
12815
+ */
12816
+ invoiceRef?: string;
12802
12817
  /**
12803
12818
  * Format: uuid
12804
12819
  * @description Subscription the invoice item belongs to.
@@ -13229,6 +13244,11 @@ interface components {
13229
13244
  };
13230
13245
  /** @description ID of the invoice item the booking was billed on. */
13231
13246
  invoiceItemRef?: string;
13247
+ /**
13248
+ * Format: uuid
13249
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
13250
+ */
13251
+ invoiceRef?: string;
13232
13252
  /**
13233
13253
  * Format: uuid
13234
13254
  * @description Subscription the invoice item belongs to.
@@ -27958,6 +27978,8 @@ interface operations {
27958
27978
  * - **voided** — cancelled and no longer valid
27959
27979
  */
27960
27980
  status?: string;
27981
+ /** @description UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
27982
+ invoiceRef?: string;
27961
27983
  /** @description Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
27962
27984
  pending?: "true" | "false";
27963
27985
  /** @description Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
@@ -34810,6 +34832,8 @@ interface operations {
34810
34832
  locationRef: string;
34811
34833
  /** @description The id of the user, host of the visit. */
34812
34834
  userRefHost?: string;
34835
+ /** @description The id of the user, visitor of the visit. */
34836
+ userRefVisitor?: string;
34813
34837
  /** @description The date filter of items. */
34814
34838
  createDate?: {
34815
34839
  /**
@@ -35119,6 +35143,8 @@ interface GetVisitsQuery {
35119
35143
  locationRef: string;
35120
35144
  /** The id of the user, host of the visit. */
35121
35145
  userRefHost?: string;
35146
+ /** The id of the user, visitor of the visit. */
35147
+ userRefVisitor?: string;
35122
35148
  /** The date filter of items. */
35123
35149
  createDate?: {
35124
35150
  lte?: string;
@@ -35951,6 +35977,8 @@ interface ListInvoiceItemsQuery {
35951
35977
  - **paid** — fully paid
35952
35978
  - **voided** — cancelled and no longer valid */
35953
35979
  status?: string;
35980
+ /** UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
35981
+ invoiceRef?: string;
35954
35982
  /** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
35955
35983
  pending?: "true" | "false";
35956
35984
  /** Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
package/dist/index.d.ts CHANGED
@@ -688,7 +688,7 @@ interface paths {
688
688
  };
689
689
  /**
690
690
  * List invoice items
691
- * @description List invoice items filtered by customer, location, type, status, pending, or date range. 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>
691
+ * @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>
692
692
  */
693
693
  get: operations["listInvoiceItems"];
694
694
  put?: never;
@@ -11727,6 +11727,11 @@ interface components {
11727
11727
  };
11728
11728
  /** @description ID of the invoice item the booking was billed on. */
11729
11729
  invoiceItemRef?: string;
11730
+ /**
11731
+ * Format: uuid
11732
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
11733
+ */
11734
+ invoiceRef?: string;
11730
11735
  /**
11731
11736
  * Format: uuid
11732
11737
  * @description Subscription the invoice item belongs to.
@@ -12157,6 +12162,11 @@ interface components {
12157
12162
  };
12158
12163
  /** @description ID of the invoice item the booking was billed on. */
12159
12164
  invoiceItemRef?: string;
12165
+ /**
12166
+ * Format: uuid
12167
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
12168
+ */
12169
+ invoiceRef?: string;
12160
12170
  /**
12161
12171
  * Format: uuid
12162
12172
  * @description Subscription the invoice item belongs to.
@@ -12799,6 +12809,11 @@ interface components {
12799
12809
  };
12800
12810
  /** @description ID of the invoice item the booking was billed on. */
12801
12811
  invoiceItemRef?: string;
12812
+ /**
12813
+ * Format: uuid
12814
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
12815
+ */
12816
+ invoiceRef?: string;
12802
12817
  /**
12803
12818
  * Format: uuid
12804
12819
  * @description Subscription the invoice item belongs to.
@@ -13229,6 +13244,11 @@ interface components {
13229
13244
  };
13230
13245
  /** @description ID of the invoice item the booking was billed on. */
13231
13246
  invoiceItemRef?: string;
13247
+ /**
13248
+ * Format: uuid
13249
+ * @description Invoice the invoice item was added to. Not set while the item is pending.
13250
+ */
13251
+ invoiceRef?: string;
13232
13252
  /**
13233
13253
  * Format: uuid
13234
13254
  * @description Subscription the invoice item belongs to.
@@ -27958,6 +27978,8 @@ interface operations {
27958
27978
  * - **voided** — cancelled and no longer valid
27959
27979
  */
27960
27980
  status?: string;
27981
+ /** @description UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
27982
+ invoiceRef?: string;
27961
27983
  /** @description Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
27962
27984
  pending?: "true" | "false";
27963
27985
  /** @description Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
@@ -34810,6 +34832,8 @@ interface operations {
34810
34832
  locationRef: string;
34811
34833
  /** @description The id of the user, host of the visit. */
34812
34834
  userRefHost?: string;
34835
+ /** @description The id of the user, visitor of the visit. */
34836
+ userRefVisitor?: string;
34813
34837
  /** @description The date filter of items. */
34814
34838
  createDate?: {
34815
34839
  /**
@@ -35119,6 +35143,8 @@ interface GetVisitsQuery {
35119
35143
  locationRef: string;
35120
35144
  /** The id of the user, host of the visit. */
35121
35145
  userRefHost?: string;
35146
+ /** The id of the user, visitor of the visit. */
35147
+ userRefVisitor?: string;
35122
35148
  /** The date filter of items. */
35123
35149
  createDate?: {
35124
35150
  lte?: string;
@@ -35951,6 +35977,8 @@ interface ListInvoiceItemsQuery {
35951
35977
  - **paid** — fully paid
35952
35978
  - **voided** — cancelled and no longer valid */
35953
35979
  status?: string;
35980
+ /** UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
35981
+ invoiceRef?: string;
35954
35982
  /** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
35955
35983
  pending?: "true" | "false";
35956
35984
  /** Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
package/dist/index.js CHANGED
@@ -953,7 +953,7 @@ function createBilling(client, defaults) {
953
953
  /**
954
954
  * List invoice items
955
955
  *
956
- * List invoice items filtered by customer, location, type, status, pending, or date range. 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.
956
+ * 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.
957
957
  */
958
958
  async list(query, options) {
959
959
  return unwrap(await client.GET("/billing/invoices/v1/items", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1/items");
@@ -961,7 +961,7 @@ function createBilling(client, defaults) {
961
961
  /**
962
962
  * List invoice items — iterates every item across all pages.
963
963
  *
964
- * List invoice items filtered by customer, location, type, status, pending, or date range. 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.
964
+ * 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.
965
965
  */
966
966
  iterate(query, options) {
967
967
  return paginate(