conductor-node 14.2.1 → 14.3.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.
@@ -0,0 +1,247 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import { APIPromise } from "../../core/api-promise.mjs";
3
+ import { RequestOptions } from "../../internal/request-options.mjs";
4
+ export declare class ShippingMethods extends APIResource {
5
+ /**
6
+ * Creates a new shipping method.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const shippingMethod =
11
+ * await conductor.qbd.shippingMethods.create({
12
+ * name: 'FedEx Ground',
13
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
14
+ * });
15
+ * ```
16
+ */
17
+ create(params: ShippingMethodCreateParams, options?: RequestOptions): APIPromise<ShippingMethod>;
18
+ /**
19
+ * Retrieves a shipping method by ID.
20
+ *
21
+ * **IMPORTANT:** If you need to fetch multiple specific shipping methods by ID,
22
+ * use the list endpoint instead with the `ids` parameter. It accepts an array of
23
+ * IDs so you can batch the request into a single call, which is significantly
24
+ * faster.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * const shippingMethod =
29
+ * await conductor.qbd.shippingMethods.retrieve(
30
+ * '80000001-1234567890',
31
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
32
+ * );
33
+ * ```
34
+ */
35
+ retrieve(id: string, params: ShippingMethodRetrieveParams, options?: RequestOptions): APIPromise<ShippingMethod>;
36
+ /**
37
+ * Returns a list of shipping methods. NOTE: QuickBooks Desktop does not support
38
+ * pagination for shipping methods; hence, there is no `cursor` parameter. Users
39
+ * typically have few shipping methods.
40
+ *
41
+ * @example
42
+ * ```ts
43
+ * const shippingMethods =
44
+ * await conductor.qbd.shippingMethods.list({
45
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
46
+ * });
47
+ * ```
48
+ */
49
+ list(params: ShippingMethodListParams, options?: RequestOptions): APIPromise<ShippingMethodListResponse>;
50
+ }
51
+ export interface ShippingMethod {
52
+ /**
53
+ * The unique identifier assigned by QuickBooks to this shipping method. This ID is
54
+ * unique across all shipping methods but not across different QuickBooks object
55
+ * types.
56
+ */
57
+ id: string;
58
+ /**
59
+ * The date and time when this shipping method was created, in ISO 8601 format
60
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
61
+ * timezone of the end-user's computer.
62
+ */
63
+ createdAt: string;
64
+ /**
65
+ * Indicates whether this shipping method is active. Inactive objects are typically
66
+ * hidden from views and reports in QuickBooks. Defaults to `true`.
67
+ */
68
+ isActive: boolean;
69
+ /**
70
+ * The case-insensitive unique name of this shipping method, unique across all
71
+ * shipping methods.
72
+ *
73
+ * **NOTE**: Shipping methods do not have a `fullName` field because they are not
74
+ * hierarchical objects, which is why `name` is unique for them but not for objects
75
+ * that have parents.
76
+ */
77
+ name: string;
78
+ /**
79
+ * The type of object. This value is always `"qbd_shipping_method"`.
80
+ */
81
+ objectType: 'qbd_shipping_method';
82
+ /**
83
+ * The current QuickBooks-assigned revision number of this shipping method object,
84
+ * which changes each time the object is modified. When updating this object, you
85
+ * must provide the most recent `revisionNumber` to ensure you're working with the
86
+ * latest data; otherwise, the update will return an error.
87
+ */
88
+ revisionNumber: string;
89
+ /**
90
+ * The date and time when this shipping method was last updated, in ISO 8601 format
91
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
92
+ * timezone of the end-user's computer.
93
+ */
94
+ updatedAt: string;
95
+ }
96
+ export interface ShippingMethodListResponse {
97
+ /**
98
+ * The array of shipping methods.
99
+ */
100
+ data: Array<ShippingMethod>;
101
+ /**
102
+ * The type of object. This value is always `"list"`.
103
+ */
104
+ objectType: 'list';
105
+ /**
106
+ * The endpoint URL where this list can be accessed.
107
+ */
108
+ url: string;
109
+ }
110
+ export interface ShippingMethodCreateParams {
111
+ /**
112
+ * Body param: The case-insensitive unique name of this shipping method, unique
113
+ * across all shipping methods.
114
+ *
115
+ * **NOTE**: Shipping methods do not have a `fullName` field because they are not
116
+ * hierarchical objects, which is why `name` is unique for them but not for objects
117
+ * that have parents.
118
+ *
119
+ * Maximum length: 15 characters.
120
+ */
121
+ name: string;
122
+ /**
123
+ * Header param: The ID of the End-User to receive this request.
124
+ */
125
+ conductorEndUserId: string;
126
+ /**
127
+ * Body param: Indicates whether this shipping method is active. Inactive objects
128
+ * are typically hidden from views and reports in QuickBooks. Defaults to `true`.
129
+ */
130
+ isActive?: boolean;
131
+ }
132
+ export interface ShippingMethodRetrieveParams {
133
+ /**
134
+ * The ID of the End-User to receive this request.
135
+ */
136
+ conductorEndUserId: string;
137
+ }
138
+ export interface ShippingMethodListParams {
139
+ /**
140
+ * Header param: The ID of the End-User to receive this request.
141
+ */
142
+ conductorEndUserId: string;
143
+ /**
144
+ * Query param: Filter for specific shipping methods by their QuickBooks-assigned
145
+ * unique identifier(s).
146
+ *
147
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
148
+ * query parameters for this request.
149
+ *
150
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
151
+ * request will return an error.
152
+ */
153
+ ids?: Array<string>;
154
+ /**
155
+ * Query param: The maximum number of objects to return.
156
+ *
157
+ * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
158
+ * shipping methods. This parameter will limit the response size, but you cannot
159
+ * fetch subsequent results using a cursor. For pagination, use the name-range
160
+ * parameters instead (e.g., `nameFrom=A&nameTo=B`).
161
+ *
162
+ * When this parameter is omitted, the endpoint returns all shipping methods
163
+ * without limit, unlike paginated endpoints which default to 150 records. This is
164
+ * acceptable because shipping methods typically have low record counts.
165
+ */
166
+ limit?: number;
167
+ /**
168
+ * Query param: Filter for shipping methods whose `name` contains this substring,
169
+ * case-insensitive.
170
+ *
171
+ * **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or
172
+ * `nameEndsWith`.
173
+ */
174
+ nameContains?: string;
175
+ /**
176
+ * Query param: Filter for shipping methods whose `name` ends with this substring,
177
+ * case-insensitive.
178
+ *
179
+ * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
180
+ * `nameStartsWith`.
181
+ */
182
+ nameEndsWith?: string;
183
+ /**
184
+ * Query param: Filter for shipping methods whose `name` is alphabetically greater
185
+ * than or equal to this value.
186
+ */
187
+ nameFrom?: string;
188
+ /**
189
+ * Query param: Filter for specific shipping methods by their name(s),
190
+ * case-insensitive. Like `id`, `name` is a unique identifier for a shipping
191
+ * method.
192
+ *
193
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
194
+ * query parameters for this request.
195
+ *
196
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
197
+ * request will return an error.
198
+ */
199
+ names?: Array<string>;
200
+ /**
201
+ * Query param: Filter for shipping methods whose `name` starts with this
202
+ * substring, case-insensitive.
203
+ *
204
+ * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
205
+ * `nameEndsWith`.
206
+ */
207
+ nameStartsWith?: string;
208
+ /**
209
+ * Query param: Filter for shipping methods whose `name` is alphabetically less
210
+ * than or equal to this value.
211
+ */
212
+ nameTo?: string;
213
+ /**
214
+ * Query param: Filter for shipping methods that are active, inactive, or both.
215
+ */
216
+ status?: 'active' | 'all' | 'inactive';
217
+ /**
218
+ * Query param: Filter for shipping methods updated on or after this date/time.
219
+ * Accepts the following ISO 8601 formats:
220
+ *
221
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
222
+ * **start of the specified day** in the local timezone of the end-user's
223
+ * computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
224
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
225
+ * interprets the timestamp in the local timezone of the end-user's computer.
226
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
227
+ * interprets the timestamp using the specified timezone.
228
+ */
229
+ updatedAfter?: string;
230
+ /**
231
+ * Query param: Filter for shipping methods updated on or before this date/time.
232
+ * Accepts the following ISO 8601 formats:
233
+ *
234
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
235
+ * **end of the specified day** in the local timezone of the end-user's computer
236
+ * (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
237
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
238
+ * interprets the timestamp in the local timezone of the end-user's computer.
239
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
240
+ * interprets the timestamp using the specified timezone.
241
+ */
242
+ updatedBefore?: string;
243
+ }
244
+ export declare namespace ShippingMethods {
245
+ export { type ShippingMethod as ShippingMethod, type ShippingMethodListResponse as ShippingMethodListResponse, type ShippingMethodCreateParams as ShippingMethodCreateParams, type ShippingMethodRetrieveParams as ShippingMethodRetrieveParams, type ShippingMethodListParams as ShippingMethodListParams, };
246
+ }
247
+ //# sourceMappingURL=shipping-methods.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shipping-methods.d.mts","sourceRoot":"","sources":["../../src/resources/qbd/shipping-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAShG;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAQ7B;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAQzG;AAED,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAC;IAElC;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,UAAU,CAAC;IAEvC;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -0,0 +1,247 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import { APIPromise } from "../../core/api-promise.js";
3
+ import { RequestOptions } from "../../internal/request-options.js";
4
+ export declare class ShippingMethods extends APIResource {
5
+ /**
6
+ * Creates a new shipping method.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const shippingMethod =
11
+ * await conductor.qbd.shippingMethods.create({
12
+ * name: 'FedEx Ground',
13
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
14
+ * });
15
+ * ```
16
+ */
17
+ create(params: ShippingMethodCreateParams, options?: RequestOptions): APIPromise<ShippingMethod>;
18
+ /**
19
+ * Retrieves a shipping method by ID.
20
+ *
21
+ * **IMPORTANT:** If you need to fetch multiple specific shipping methods by ID,
22
+ * use the list endpoint instead with the `ids` parameter. It accepts an array of
23
+ * IDs so you can batch the request into a single call, which is significantly
24
+ * faster.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * const shippingMethod =
29
+ * await conductor.qbd.shippingMethods.retrieve(
30
+ * '80000001-1234567890',
31
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
32
+ * );
33
+ * ```
34
+ */
35
+ retrieve(id: string, params: ShippingMethodRetrieveParams, options?: RequestOptions): APIPromise<ShippingMethod>;
36
+ /**
37
+ * Returns a list of shipping methods. NOTE: QuickBooks Desktop does not support
38
+ * pagination for shipping methods; hence, there is no `cursor` parameter. Users
39
+ * typically have few shipping methods.
40
+ *
41
+ * @example
42
+ * ```ts
43
+ * const shippingMethods =
44
+ * await conductor.qbd.shippingMethods.list({
45
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
46
+ * });
47
+ * ```
48
+ */
49
+ list(params: ShippingMethodListParams, options?: RequestOptions): APIPromise<ShippingMethodListResponse>;
50
+ }
51
+ export interface ShippingMethod {
52
+ /**
53
+ * The unique identifier assigned by QuickBooks to this shipping method. This ID is
54
+ * unique across all shipping methods but not across different QuickBooks object
55
+ * types.
56
+ */
57
+ id: string;
58
+ /**
59
+ * The date and time when this shipping method was created, in ISO 8601 format
60
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
61
+ * timezone of the end-user's computer.
62
+ */
63
+ createdAt: string;
64
+ /**
65
+ * Indicates whether this shipping method is active. Inactive objects are typically
66
+ * hidden from views and reports in QuickBooks. Defaults to `true`.
67
+ */
68
+ isActive: boolean;
69
+ /**
70
+ * The case-insensitive unique name of this shipping method, unique across all
71
+ * shipping methods.
72
+ *
73
+ * **NOTE**: Shipping methods do not have a `fullName` field because they are not
74
+ * hierarchical objects, which is why `name` is unique for them but not for objects
75
+ * that have parents.
76
+ */
77
+ name: string;
78
+ /**
79
+ * The type of object. This value is always `"qbd_shipping_method"`.
80
+ */
81
+ objectType: 'qbd_shipping_method';
82
+ /**
83
+ * The current QuickBooks-assigned revision number of this shipping method object,
84
+ * which changes each time the object is modified. When updating this object, you
85
+ * must provide the most recent `revisionNumber` to ensure you're working with the
86
+ * latest data; otherwise, the update will return an error.
87
+ */
88
+ revisionNumber: string;
89
+ /**
90
+ * The date and time when this shipping method was last updated, in ISO 8601 format
91
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
92
+ * timezone of the end-user's computer.
93
+ */
94
+ updatedAt: string;
95
+ }
96
+ export interface ShippingMethodListResponse {
97
+ /**
98
+ * The array of shipping methods.
99
+ */
100
+ data: Array<ShippingMethod>;
101
+ /**
102
+ * The type of object. This value is always `"list"`.
103
+ */
104
+ objectType: 'list';
105
+ /**
106
+ * The endpoint URL where this list can be accessed.
107
+ */
108
+ url: string;
109
+ }
110
+ export interface ShippingMethodCreateParams {
111
+ /**
112
+ * Body param: The case-insensitive unique name of this shipping method, unique
113
+ * across all shipping methods.
114
+ *
115
+ * **NOTE**: Shipping methods do not have a `fullName` field because they are not
116
+ * hierarchical objects, which is why `name` is unique for them but not for objects
117
+ * that have parents.
118
+ *
119
+ * Maximum length: 15 characters.
120
+ */
121
+ name: string;
122
+ /**
123
+ * Header param: The ID of the End-User to receive this request.
124
+ */
125
+ conductorEndUserId: string;
126
+ /**
127
+ * Body param: Indicates whether this shipping method is active. Inactive objects
128
+ * are typically hidden from views and reports in QuickBooks. Defaults to `true`.
129
+ */
130
+ isActive?: boolean;
131
+ }
132
+ export interface ShippingMethodRetrieveParams {
133
+ /**
134
+ * The ID of the End-User to receive this request.
135
+ */
136
+ conductorEndUserId: string;
137
+ }
138
+ export interface ShippingMethodListParams {
139
+ /**
140
+ * Header param: The ID of the End-User to receive this request.
141
+ */
142
+ conductorEndUserId: string;
143
+ /**
144
+ * Query param: Filter for specific shipping methods by their QuickBooks-assigned
145
+ * unique identifier(s).
146
+ *
147
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
148
+ * query parameters for this request.
149
+ *
150
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
151
+ * request will return an error.
152
+ */
153
+ ids?: Array<string>;
154
+ /**
155
+ * Query param: The maximum number of objects to return.
156
+ *
157
+ * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
158
+ * shipping methods. This parameter will limit the response size, but you cannot
159
+ * fetch subsequent results using a cursor. For pagination, use the name-range
160
+ * parameters instead (e.g., `nameFrom=A&nameTo=B`).
161
+ *
162
+ * When this parameter is omitted, the endpoint returns all shipping methods
163
+ * without limit, unlike paginated endpoints which default to 150 records. This is
164
+ * acceptable because shipping methods typically have low record counts.
165
+ */
166
+ limit?: number;
167
+ /**
168
+ * Query param: Filter for shipping methods whose `name` contains this substring,
169
+ * case-insensitive.
170
+ *
171
+ * **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or
172
+ * `nameEndsWith`.
173
+ */
174
+ nameContains?: string;
175
+ /**
176
+ * Query param: Filter for shipping methods whose `name` ends with this substring,
177
+ * case-insensitive.
178
+ *
179
+ * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
180
+ * `nameStartsWith`.
181
+ */
182
+ nameEndsWith?: string;
183
+ /**
184
+ * Query param: Filter for shipping methods whose `name` is alphabetically greater
185
+ * than or equal to this value.
186
+ */
187
+ nameFrom?: string;
188
+ /**
189
+ * Query param: Filter for specific shipping methods by their name(s),
190
+ * case-insensitive. Like `id`, `name` is a unique identifier for a shipping
191
+ * method.
192
+ *
193
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
194
+ * query parameters for this request.
195
+ *
196
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
197
+ * request will return an error.
198
+ */
199
+ names?: Array<string>;
200
+ /**
201
+ * Query param: Filter for shipping methods whose `name` starts with this
202
+ * substring, case-insensitive.
203
+ *
204
+ * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
205
+ * `nameEndsWith`.
206
+ */
207
+ nameStartsWith?: string;
208
+ /**
209
+ * Query param: Filter for shipping methods whose `name` is alphabetically less
210
+ * than or equal to this value.
211
+ */
212
+ nameTo?: string;
213
+ /**
214
+ * Query param: Filter for shipping methods that are active, inactive, or both.
215
+ */
216
+ status?: 'active' | 'all' | 'inactive';
217
+ /**
218
+ * Query param: Filter for shipping methods updated on or after this date/time.
219
+ * Accepts the following ISO 8601 formats:
220
+ *
221
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
222
+ * **start of the specified day** in the local timezone of the end-user's
223
+ * computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
224
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
225
+ * interprets the timestamp in the local timezone of the end-user's computer.
226
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
227
+ * interprets the timestamp using the specified timezone.
228
+ */
229
+ updatedAfter?: string;
230
+ /**
231
+ * Query param: Filter for shipping methods updated on or before this date/time.
232
+ * Accepts the following ISO 8601 formats:
233
+ *
234
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
235
+ * **end of the specified day** in the local timezone of the end-user's computer
236
+ * (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
237
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
238
+ * interprets the timestamp in the local timezone of the end-user's computer.
239
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
240
+ * interprets the timestamp using the specified timezone.
241
+ */
242
+ updatedBefore?: string;
243
+ }
244
+ export declare namespace ShippingMethods {
245
+ export { type ShippingMethod as ShippingMethod, type ShippingMethodListResponse as ShippingMethodListResponse, type ShippingMethodCreateParams as ShippingMethodCreateParams, type ShippingMethodRetrieveParams as ShippingMethodRetrieveParams, type ShippingMethodListParams as ShippingMethodListParams, };
246
+ }
247
+ //# sourceMappingURL=shipping-methods.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shipping-methods.d.ts","sourceRoot":"","sources":["../../src/resources/qbd/shipping-methods.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAShG;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAQ7B;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAQzG;AAED,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAC;IAElC;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,UAAU,CAAC;IAEvC;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -0,0 +1,76 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ShippingMethods = void 0;
5
+ const resource_1 = require("../../core/resource.js");
6
+ const headers_1 = require("../../internal/headers.js");
7
+ const path_1 = require("../../internal/utils/path.js");
8
+ class ShippingMethods extends resource_1.APIResource {
9
+ /**
10
+ * Creates a new shipping method.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const shippingMethod =
15
+ * await conductor.qbd.shippingMethods.create({
16
+ * name: 'FedEx Ground',
17
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
18
+ * });
19
+ * ```
20
+ */
21
+ create(params, options) {
22
+ const { conductorEndUserId, ...body } = params;
23
+ return this._client.post('/quickbooks-desktop/shipping-methods', {
24
+ body,
25
+ ...options,
26
+ headers: (0, headers_1.buildHeaders)([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
27
+ });
28
+ }
29
+ /**
30
+ * Retrieves a shipping method by ID.
31
+ *
32
+ * **IMPORTANT:** If you need to fetch multiple specific shipping methods by ID,
33
+ * use the list endpoint instead with the `ids` parameter. It accepts an array of
34
+ * IDs so you can batch the request into a single call, which is significantly
35
+ * faster.
36
+ *
37
+ * @example
38
+ * ```ts
39
+ * const shippingMethod =
40
+ * await conductor.qbd.shippingMethods.retrieve(
41
+ * '80000001-1234567890',
42
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
43
+ * );
44
+ * ```
45
+ */
46
+ retrieve(id, params, options) {
47
+ const { conductorEndUserId } = params;
48
+ return this._client.get((0, path_1.path) `/quickbooks-desktop/shipping-methods/${id}`, {
49
+ ...options,
50
+ headers: (0, headers_1.buildHeaders)([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
51
+ });
52
+ }
53
+ /**
54
+ * Returns a list of shipping methods. NOTE: QuickBooks Desktop does not support
55
+ * pagination for shipping methods; hence, there is no `cursor` parameter. Users
56
+ * typically have few shipping methods.
57
+ *
58
+ * @example
59
+ * ```ts
60
+ * const shippingMethods =
61
+ * await conductor.qbd.shippingMethods.list({
62
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
63
+ * });
64
+ * ```
65
+ */
66
+ list(params, options) {
67
+ const { conductorEndUserId, ...query } = params;
68
+ return this._client.get('/quickbooks-desktop/shipping-methods', {
69
+ query,
70
+ ...options,
71
+ headers: (0, headers_1.buildHeaders)([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
72
+ });
73
+ }
74
+ }
75
+ exports.ShippingMethods = ShippingMethods;
76
+ //# sourceMappingURL=shipping-methods.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shipping-methods.js","sourceRoot":"","sources":["../../src/resources/qbd/shipping-methods.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAkC,EAAE,OAAwB;QACjE,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC/D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wCAAwC,EAAE,EAAE,EAAE;YACxE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAgC,EAAE,OAAwB;QAC7D,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE;YAC9D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;CACF;AAxED,0CAwEC"}
@@ -0,0 +1,72 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../core/resource.mjs";
3
+ import { buildHeaders } from "../../internal/headers.mjs";
4
+ import { path } from "../../internal/utils/path.mjs";
5
+ export class ShippingMethods extends APIResource {
6
+ /**
7
+ * Creates a new shipping method.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const shippingMethod =
12
+ * await conductor.qbd.shippingMethods.create({
13
+ * name: 'FedEx Ground',
14
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
15
+ * });
16
+ * ```
17
+ */
18
+ create(params, options) {
19
+ const { conductorEndUserId, ...body } = params;
20
+ return this._client.post('/quickbooks-desktop/shipping-methods', {
21
+ body,
22
+ ...options,
23
+ headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
24
+ });
25
+ }
26
+ /**
27
+ * Retrieves a shipping method by ID.
28
+ *
29
+ * **IMPORTANT:** If you need to fetch multiple specific shipping methods by ID,
30
+ * use the list endpoint instead with the `ids` parameter. It accepts an array of
31
+ * IDs so you can batch the request into a single call, which is significantly
32
+ * faster.
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * const shippingMethod =
37
+ * await conductor.qbd.shippingMethods.retrieve(
38
+ * '80000001-1234567890',
39
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
40
+ * );
41
+ * ```
42
+ */
43
+ retrieve(id, params, options) {
44
+ const { conductorEndUserId } = params;
45
+ return this._client.get(path `/quickbooks-desktop/shipping-methods/${id}`, {
46
+ ...options,
47
+ headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
48
+ });
49
+ }
50
+ /**
51
+ * Returns a list of shipping methods. NOTE: QuickBooks Desktop does not support
52
+ * pagination for shipping methods; hence, there is no `cursor` parameter. Users
53
+ * typically have few shipping methods.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const shippingMethods =
58
+ * await conductor.qbd.shippingMethods.list({
59
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
60
+ * });
61
+ * ```
62
+ */
63
+ list(params, options) {
64
+ const { conductorEndUserId, ...query } = params;
65
+ return this._client.get('/quickbooks-desktop/shipping-methods', {
66
+ query,
67
+ ...options,
68
+ headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
69
+ });
70
+ }
71
+ }
72
+ //# sourceMappingURL=shipping-methods.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shipping-methods.mjs","sourceRoot":"","sources":["../../src/resources/qbd/shipping-methods.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAkC,EAAE,OAAwB;QACjE,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC/D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wCAAwC,EAAE,EAAE,EAAE;YACxE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAgC,EAAE,OAAwB;QAC7D,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE;YAC9D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -418,6 +418,14 @@ export {
418
418
  type ServiceItemListParams,
419
419
  type ServiceItemsCursorPage,
420
420
  } from './service-items';
421
+ export {
422
+ ShippingMethods,
423
+ type ShippingMethod,
424
+ type ShippingMethodListResponse,
425
+ type ShippingMethodCreateParams,
426
+ type ShippingMethodRetrieveParams,
427
+ type ShippingMethodListParams,
428
+ } from './shipping-methods';
421
429
  export {
422
430
  StandardTerms,
423
431
  type StandardTerm,