orb-billing 5.16.0 → 5.17.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/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.17.0 (2025-10-10)
4
+
5
+ Full Changelog: [v5.16.0...v5.17.0](https://github.com/orbcorp/orb-node/compare/v5.16.0...v5.17.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([e8f7516](https://github.com/orbcorp/orb-node/commit/e8f7516e596c23f8d54b36bdc646e25860ce14c2))
10
+
3
11
  ## 5.16.0 (2025-10-07)
4
12
 
5
13
  Full Changelog: [v5.15.0...v5.16.0](https://github.com/orbcorp/orb-node/compare/v5.15.0...v5.16.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "orb-billing",
3
- "version": "5.16.0",
3
+ "version": "5.17.0",
4
4
  "description": "The official TypeScript library for the Orb API",
5
5
  "author": "Orb <team@withorb.com>",
6
6
  "types": "./index.d.ts",
@@ -5,6 +5,17 @@ export declare class InvoiceLineItems extends APIResource {
5
5
  /**
6
6
  * This creates a one-off fixed fee invoice line item on an Invoice. This can only
7
7
  * be done for invoices that are in a `draft` status.
8
+ *
9
+ * The behavior depends on which parameters are provided:
10
+ *
11
+ * - If `item_id` is provided without `name`: The item is looked up by ID, and the
12
+ * item's name is used for the line item.
13
+ * - If `name` is provided without `item_id`: An item with the given name is
14
+ * searched for in the account. If found, that item is used. If not found, a new
15
+ * item is created with that name. The new item's name is used for the line item.
16
+ * - If both `item_id` and `name` are provided: The item is looked up by ID for
17
+ * association, but the provided `name` is used for the line item (not the item's
18
+ * name).
8
19
  */
9
20
  create(body: InvoiceLineItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceLineItemCreateResponse>;
10
21
  }
@@ -128,11 +139,6 @@ export interface InvoiceLineItemCreateParams {
128
139
  * The id of the Invoice to add this line item.
129
140
  */
130
141
  invoice_id: string;
131
- /**
132
- * The item name associated with this line item. If an item with the same name
133
- * exists in Orb, that item will be associated with the line item.
134
- */
135
- name: string;
136
142
  /**
137
143
  * The number of units on the line item
138
144
  */
@@ -141,6 +147,22 @@ export interface InvoiceLineItemCreateParams {
141
147
  * A date string to specify the line item's start date in the customer's timezone.
142
148
  */
143
149
  start_date: string;
150
+ /**
151
+ * The id of the item to associate with this line item. If provided without `name`,
152
+ * the item's name will be used for the price/line item. If provided with `name`,
153
+ * the item will be associated but `name` will be used for the line item. At least
154
+ * one of `name` or `item_id` must be provided.
155
+ */
156
+ item_id?: string | null;
157
+ /**
158
+ * The name to use for the line item. If `item_id` is not provided, Orb will search
159
+ * for an item with this name. If found, that item will be associated with the line
160
+ * item. If not found, a new item will be created with this name. If `item_id` is
161
+ * provided, this name will be used for the line item, but the item association
162
+ * will be based on `item_id`. At least one of `name` or `item_id` must be
163
+ * provided.
164
+ */
165
+ name?: string | null;
144
166
  }
145
167
  export declare namespace InvoiceLineItems {
146
168
  export { type InvoiceLineItemCreateResponse as InvoiceLineItemCreateResponse, type InvoiceLineItemCreateParams as InvoiceLineItemCreateParams, };
@@ -1 +1 @@
1
- {"version":3,"file":"invoice-line-items.d.ts","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,WAAW,EAAE,KAAK,CACd,MAAM,CAAC,+BAA+B,GACtC,MAAM,CAAC,gCAAgC,GACvC,MAAM,CAAC,oCAAoC,GAC3C,MAAM,CAAC,yBAAyB,GAChC,MAAM,CAAC,yBAAyB,CACnC,CAAC;IAEF;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,iBAAiB,GAAG,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAEnG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
1
+ {"version":3,"file":"invoice-line-items.d.ts","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,WAAW,EAAE,KAAK,CACd,MAAM,CAAC,+BAA+B,GACtC,MAAM,CAAC,gCAAgC,GACvC,MAAM,CAAC,oCAAoC,GAC3C,MAAM,CAAC,yBAAyB,GAChC,MAAM,CAAC,yBAAyB,CACnC,CAAC;IAEF;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,iBAAiB,GAAG,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAEnG;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
@@ -7,6 +7,17 @@ class InvoiceLineItems extends resource_1.APIResource {
7
7
  /**
8
8
  * This creates a one-off fixed fee invoice line item on an Invoice. This can only
9
9
  * be done for invoices that are in a `draft` status.
10
+ *
11
+ * The behavior depends on which parameters are provided:
12
+ *
13
+ * - If `item_id` is provided without `name`: The item is looked up by ID, and the
14
+ * item's name is used for the line item.
15
+ * - If `name` is provided without `item_id`: An item with the given name is
16
+ * searched for in the account. If found, that item is used. If not found, a new
17
+ * item is created with that name. The new item's name is used for the line item.
18
+ * - If both `item_id` and `name` are provided: The item is looked up by ID for
19
+ * association, but the provided `name` is used for the line item (not the item's
20
+ * name).
10
21
  */
11
22
  create(body, options) {
12
23
  return this._client.post('/invoice_line_items', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"invoice-line-items.js","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAI1C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;OAGG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAXD,4CAWC"}
1
+ {"version":3,"file":"invoice-line-items.js","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAI1C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAtBD,4CAsBC"}
@@ -4,6 +4,17 @@ export class InvoiceLineItems extends APIResource {
4
4
  /**
5
5
  * This creates a one-off fixed fee invoice line item on an Invoice. This can only
6
6
  * be done for invoices that are in a `draft` status.
7
+ *
8
+ * The behavior depends on which parameters are provided:
9
+ *
10
+ * - If `item_id` is provided without `name`: The item is looked up by ID, and the
11
+ * item's name is used for the line item.
12
+ * - If `name` is provided without `item_id`: An item with the given name is
13
+ * searched for in the account. If found, that item is used. If not found, a new
14
+ * item is created with that name. The new item's name is used for the line item.
15
+ * - If both `item_id` and `name` are provided: The item is looked up by ID for
16
+ * association, but the provided `name` is used for the line item (not the item's
17
+ * name).
7
18
  */
8
19
  create(body, options) {
9
20
  return this._client.post('/invoice_line_items', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"invoice-line-items.mjs","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;OAGG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
1
+ {"version":3,"file":"invoice-line-items.mjs","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
@@ -8,6 +8,17 @@ export class InvoiceLineItems extends APIResource {
8
8
  /**
9
9
  * This creates a one-off fixed fee invoice line item on an Invoice. This can only
10
10
  * be done for invoices that are in a `draft` status.
11
+ *
12
+ * The behavior depends on which parameters are provided:
13
+ *
14
+ * - If `item_id` is provided without `name`: The item is looked up by ID, and the
15
+ * item's name is used for the line item.
16
+ * - If `name` is provided without `item_id`: An item with the given name is
17
+ * searched for in the account. If found, that item is used. If not found, a new
18
+ * item is created with that name. The new item's name is used for the line item.
19
+ * - If both `item_id` and `name` are provided: The item is looked up by ID for
20
+ * association, but the provided `name` is used for the line item (not the item's
21
+ * name).
11
22
  */
12
23
  create(
13
24
  body: InvoiceLineItemCreateParams,
@@ -168,12 +179,6 @@ export interface InvoiceLineItemCreateParams {
168
179
  */
169
180
  invoice_id: string;
170
181
 
171
- /**
172
- * The item name associated with this line item. If an item with the same name
173
- * exists in Orb, that item will be associated with the line item.
174
- */
175
- name: string;
176
-
177
182
  /**
178
183
  * The number of units on the line item
179
184
  */
@@ -183,6 +188,24 @@ export interface InvoiceLineItemCreateParams {
183
188
  * A date string to specify the line item's start date in the customer's timezone.
184
189
  */
185
190
  start_date: string;
191
+
192
+ /**
193
+ * The id of the item to associate with this line item. If provided without `name`,
194
+ * the item's name will be used for the price/line item. If provided with `name`,
195
+ * the item will be associated but `name` will be used for the line item. At least
196
+ * one of `name` or `item_id` must be provided.
197
+ */
198
+ item_id?: string | null;
199
+
200
+ /**
201
+ * The name to use for the line item. If `item_id` is not provided, Orb will search
202
+ * for an item with this name. If found, that item will be associated with the line
203
+ * item. If not found, a new item will be created with this name. If `item_id` is
204
+ * provided, this name will be used for the line item, but the item association
205
+ * will be based on `item_id`. At least one of `name` or `item_id` must be
206
+ * provided.
207
+ */
208
+ name?: string | null;
186
209
  }
187
210
 
188
211
  export declare namespace InvoiceLineItems {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '5.16.0'; // x-release-please-version
1
+ export const VERSION = '5.17.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "5.16.0";
1
+ export declare const VERSION = "5.17.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '5.16.0'; // x-release-please-version
4
+ exports.VERSION = '5.17.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '5.16.0'; // x-release-please-version
1
+ export const VERSION = '5.17.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map