@hardfin/cli 0.0.2-dev.12 → 0.0.2-dev.13

package/README.md

@@ -67,8 +67,19 @@ hardfin asset move execute create \
   --move assetId=ast_b2,locationId=loc_y
 ```
 
-An enum carries its values, so a wrong one fails locally with exit code 2 rather than at the
-API. A required field missing is caught the same way, before any request is made.
+A value is sent as the type the document names. `--useful-life 36` sends the number 36. A
+decimal such as `--salvage-value 1500.00` stays a string, which is how the API takes money
+without losing precision.
+
+Clear a field with `--unset`, naming the flag:
+
+```sh
+hardfin asset accounting update ast_4f9xk2mq7plr8stz --unset useful-life
+```
+
+Three things fail locally with exit code 2, before any request is made: a value outside an
+enum, a required field that is missing, and `--unset` on a field the API will not take null
+for.
 
 ### Overrides
 

package/dist/cli.js

@@ -1632,6 +1632,13 @@ async function runMcp(input) {
 }
 //#endregion
 //#region src/command/operation.ts
+const UNSET_FLAG = {
+	name: "unset",
+	description: "A field to clear, named as its flag is, repeatable",
+	valueName: "field",
+	repeatable: true,
+	schema: z.array(z.string())
+};
 const FILE_FLAG = {
 	name: "file",
 	description: "The file to upload",
@@ -1648,6 +1655,7 @@ function defineOperation(operation) {
 	const flags = [
 		...operation.queryFlags,
 		...operation.bodyFlags,
+		...operation.bodyFlags.some((flag) => flag.nullable) ? [UNSET_FLAG] : [],
 		...operation.upload ? [...operation.upload.fields, FILE_FLAG] : [],
 		JSON_FLAG
 	];
@@ -1661,6 +1669,10 @@ function defineOperation(operation) {
 			description: operation.summary,
 			command: operation.example
 		}] : [],
+		endpoint: {
+			method: operation.method,
+			path: operation.path
+		},
 		run: (input) => runOperation(operation, input)
 	};
 }
@@ -1764,10 +1776,25 @@ function toBody(operation, flags) {
 			hasField = true;
 			continue;
 		}
-		set(body, flag.jsonPath, value);
+		const parsed = flag.schema.safeParse(value);
+		set(body, flag.jsonPath, parsed.success ? parsed.data : value);
 		hasField = true;
 	}
-	return hasField ? body : void 0;
+	const cleared = toCleared(operation, flags, body);
+	if (cleared instanceof Error) return cleared;
+	return hasField || cleared ? body : void 0;
+}
+/** toCleared sends null for each field named by --unset, which is how a field is cleared. */
+function toCleared(operation, flags, body) {
+	const named = flags["unset"];
+	const names = Array.isArray(named) ? named.map(String) : named === void 0 ? [] : [String(named)];
+	for (const name of names) {
+		const flag = operation.bodyFlags.find((entry) => entry.name === name.replace(/^--/, ""));
+		if (!flag) return /* @__PURE__ */ new Error(`--unset names no field called ${name}`);
+		if (!flag.nullable) return /* @__PURE__ */ new Error(`--${flag.name} cannot be cleared, because the API does not accept null for it`);
+		set(body, flag.jsonPath, null);
+	}
+	return names.length > 0;
 }
 /** toElements reads the key=value pairs a repeated flag carries for one array element. */
 function toElements(flag, values) {
@@ -2007,6 +2034,7 @@ const surfaceCommands = [
 						jsonPath: ["allocatedIndirect"],
 						description: "One unit's share of overhead, a cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2014,6 +2042,7 @@ const surfaceCommands = [
 						jsonPath: ["billOfMaterials"],
 						description: "The parts cost of one unit, a cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2033,6 +2062,7 @@ const surfaceCommands = [
 						jsonPath: ["description"],
 						description: "A free-form description of the asset",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2040,6 +2070,7 @@ const surfaceCommands = [
 						jsonPath: ["directLabor"],
 						description: "The labor cost to build one unit, a cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2047,6 +2078,7 @@ const surfaceCommands = [
 						jsonPath: ["freightInbound"],
 						description: "The shipping cost to receive one unit, a cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2054,6 +2086,7 @@ const surfaceCommands = [
 						jsonPath: ["freightOutbound"],
 						description: "The shipping cost to deploy one unit, a deployment cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2061,6 +2094,7 @@ const surfaceCommands = [
 						jsonPath: ["functionalStatus"],
 						description: "The asset's starting functional status, FUNCTIONAL when absent, which cannot be SCRAPPED",
 						valueName: "value",
+						nullable: true,
 						schema: z.enum([
 							"FUNCTIONAL",
 							"NEEDS_REVIEW",
@@ -2080,6 +2114,7 @@ const surfaceCommands = [
 						jsonPath: ["inServiceDate"],
 						description: "The day the asset was put into service, which Hardfin sets itself when absent",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2087,6 +2122,7 @@ const surfaceCommands = [
 						jsonPath: ["installation"],
 						description: "The cost to install one unit, a deployment cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2094,6 +2130,7 @@ const surfaceCommands = [
 						jsonPath: ["interest"],
 						description: "The financing cost of one unit, a cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2116,6 +2153,7 @@ const surfaceCommands = [
 						jsonPath: ["salvageValue"],
 						description: "The value one unit keeps at the end of its useful life, or null to clear it",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2131,6 +2169,7 @@ const surfaceCommands = [
 						jsonPath: ["simpleCostBasis"],
 						description: "A single cost for one unit, which cannot be sent together with the cost components",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2138,6 +2177,7 @@ const surfaceCommands = [
 						jsonPath: ["tariffs"],
 						description: "The import duty paid on one unit, a cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2145,6 +2185,7 @@ const surfaceCommands = [
 						jsonPath: ["tax"],
 						description: "The tax paid on one unit, a cost component",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2152,6 +2193,7 @@ const surfaceCommands = [
 						jsonPath: ["usefulLife"],
 						description: "The number of months one unit is depreciated over, or null to clear it",
 						valueName: "number",
+						nullable: true,
 						schema: z.coerce.number()
 					}
 				]
@@ -2257,6 +2299,7 @@ const surfaceCommands = [
 						jsonPath: ["description"],
 						description: "The asset's new description, or null to clear it",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2264,6 +2307,7 @@ const surfaceCommands = [
 						jsonPath: ["functionalStatus"],
 						description: "The asset's new functional status, which cannot be SCRAPPED because scrapping has its own endpoint",
 						valueName: "value",
+						nullable: true,
 						schema: z.enum([
 							"FUNCTIONAL",
 							"NEEDS_REVIEW",
@@ -2276,6 +2320,7 @@ const surfaceCommands = [
 						jsonPath: ["inInventoryDate"],
 						description: "The day the asset entered inventory, which cannot be in the future",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2283,6 +2328,7 @@ const surfaceCommands = [
 						jsonPath: ["initialLocationId"],
 						description: "The ID of the location the asset entered inventory at",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -2299,6 +2345,7 @@ const surfaceCommands = [
 						jsonPath: ["serial"],
 						description: "The asset's new serial number, which cannot be empty",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					}
 				]
@@ -2327,6 +2374,7 @@ const surfaceCommands = [
 							jsonPath: ["allocatedIndirect"],
 							description: "One unit's share of overhead, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2334,6 +2382,7 @@ const surfaceCommands = [
 							jsonPath: ["billOfMaterials"],
 							description: "The parts cost of one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2353,6 +2402,7 @@ const surfaceCommands = [
 							jsonPath: ["directLabor"],
 							description: "The labor cost to build one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2360,6 +2410,7 @@ const surfaceCommands = [
 							jsonPath: ["freightInbound"],
 							description: "The shipping cost to receive one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2367,6 +2418,7 @@ const surfaceCommands = [
 							jsonPath: ["freightOutbound"],
 							description: "The shipping cost to deploy one unit, a deployment cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2374,6 +2426,7 @@ const surfaceCommands = [
 							jsonPath: ["inServiceDate"],
 							description: "The day the asset was put into service and began depreciating, or null to clear it",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2381,6 +2434,7 @@ const surfaceCommands = [
 							jsonPath: ["installation"],
 							description: "The cost to install one unit, a deployment cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2388,12 +2442,14 @@ const surfaceCommands = [
 							jsonPath: ["interest"],
 							description: "The financing cost of one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
 							name: "is-in-service-date-managed-automatically",
 							jsonPath: ["isInServiceDateManagedAutomatically"],
 							description: "Whether Hardfin sets the in-service date itself, which sending an in-service date turns off",
+							nullable: true,
 							schema: z.boolean()
 						},
 						{
@@ -2401,6 +2457,7 @@ const surfaceCommands = [
 							jsonPath: ["salvageValue"],
 							description: "The value one unit keeps at the end of its useful life, or null to clear it",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2408,6 +2465,7 @@ const surfaceCommands = [
 							jsonPath: ["simpleCostBasis"],
 							description: "A single cost for one unit, which cannot be sent together with the cost components",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2415,6 +2473,7 @@ const surfaceCommands = [
 							jsonPath: ["tariffs"],
 							description: "The import duty paid on one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2422,6 +2481,7 @@ const surfaceCommands = [
 							jsonPath: ["tax"],
 							description: "The tax paid on one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2429,6 +2489,7 @@ const surfaceCommands = [
 							jsonPath: ["usefulLife"],
 							description: "The number of months one unit is depreciated over, or null to clear it",
 							valueName: "number",
+							nullable: true,
 							schema: z.coerce.number()
 						}
 					]
@@ -2508,6 +2569,7 @@ const surfaceCommands = [
 							jsonPath: ["notes"],
 							description: "Free-form detail about the adjustment, which a reason of OTHER requires",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2716,6 +2778,7 @@ const surfaceCommands = [
 								jsonPath: ["salePrice"],
 								description: "What the customer paid for the asset, which cannot be negative",
 								valueName: "value",
+								nullable: true,
 								schema: z.string()
 							}
 						]
@@ -2781,6 +2844,7 @@ const surfaceCommands = [
 								jsonPath: ["customerId"],
 								description: "The ID of the customer that owned the asset during the segment",
 								valueName: "value",
+								nullable: true,
 								schema: z.string()
 							},
 							{
@@ -2788,6 +2852,7 @@ const surfaceCommands = [
 								jsonPath: ["date"],
 								description: "The day the segment's owner took ownership, which cannot be in the future",
 								valueName: "value",
+								nullable: true,
 								schema: z.string()
 							},
 							{
@@ -2795,6 +2860,7 @@ const surfaceCommands = [
 								jsonPath: ["salePrice"],
 								description: "What the owner paid for the asset, which cannot be negative",
 								valueName: "value",
+								nullable: true,
 								schema: z.string()
 							}
 						]
@@ -2851,6 +2917,7 @@ const surfaceCommands = [
 							jsonPath: ["disposalPrice"],
 							description: "What the scrapped asset was sold for, or null when it was not sold",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -2858,6 +2925,7 @@ const surfaceCommands = [
 							jsonPath: ["disposalReason"],
 							description: "Why the asset was scrapped",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						}
 					]
@@ -2920,6 +2988,7 @@ const surfaceCommands = [
 						jsonPath: ["name"],
 						description: "The link's display name, or null to show the address instead",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					}, {
 						name: "url",
@@ -2963,6 +3032,7 @@ const surfaceCommands = [
 							jsonPath: ["notes"],
 							description: "Free-form detail about the revision, which a reason of OTHER requires",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3092,6 +3162,7 @@ const surfaceCommands = [
 						jsonPath: ["billingAddress"],
 						description: "The address invoices are sent to",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3099,6 +3170,7 @@ const surfaceCommands = [
 						jsonPath: ["billingContact", "email"],
 						description: "The billing contact's email address",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3106,6 +3178,7 @@ const surfaceCommands = [
 						jsonPath: ["billingContact", "name"],
 						description: "The billing contact's name",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3113,6 +3186,7 @@ const surfaceCommands = [
 						jsonPath: ["billingContact", "phone"],
 						description: "The billing contact's phone number",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3120,6 +3194,7 @@ const surfaceCommands = [
 						jsonPath: ["comment"],
 						description: "A free-form note about the customer",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3127,6 +3202,7 @@ const surfaceCommands = [
 						jsonPath: ["domain"],
 						description: "The customer's web domain, used to look up its logo",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3134,6 +3210,7 @@ const surfaceCommands = [
 						jsonPath: ["externalId"],
 						description: "The customer's identifier in another system",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3190,6 +3267,7 @@ const surfaceCommands = [
 						jsonPath: ["billingAddress"],
 						description: "The address invoices are sent to",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3197,6 +3275,7 @@ const surfaceCommands = [
 						jsonPath: ["billingContact", "email"],
 						description: "The billing contact's email address",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3204,6 +3283,7 @@ const surfaceCommands = [
 						jsonPath: ["billingContact", "name"],
 						description: "The billing contact's name",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3211,6 +3291,7 @@ const surfaceCommands = [
 						jsonPath: ["billingContact", "phone"],
 						description: "The billing contact's phone number",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3218,6 +3299,7 @@ const surfaceCommands = [
 						jsonPath: ["comment"],
 						description: "A free-form note about the customer",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3225,6 +3307,7 @@ const surfaceCommands = [
 						jsonPath: ["domain"],
 						description: "The customer's web domain, used to look up its logo",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3232,24 +3315,28 @@ const surfaceCommands = [
 						jsonPath: ["externalId"],
 						description: "The customer's identifier in another system",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
 						name: "is-archived",
 						jsonPath: ["isArchived"],
 						description: "Whether the customer is archived",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
 						name: "is-customer",
 						jsonPath: ["isCustomer"],
 						description: "Whether the company is a customer",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
 						name: "is-supplier",
 						jsonPath: ["isSupplier"],
 						description: "Whether the company is a supplier",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
@@ -3257,6 +3344,7 @@ const surfaceCommands = [
 						jsonPath: ["name"],
 						description: "The customer's display name",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					}
 				]
@@ -3433,6 +3521,7 @@ const surfaceCommands = [
 						jsonPath: ["description"],
 						description: "A free-form description of the item",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3561,6 +3650,7 @@ const surfaceCommands = [
 						name: "accepts-bulk-serials",
 						jsonPath: ["acceptsBulkSerials"],
 						description: "Whether a BULK item records serial numbers on its units, read only beside type",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
@@ -3568,6 +3658,7 @@ const surfaceCommands = [
 						jsonPath: ["description"],
 						description: "The item's new description, or null to clear it",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3587,6 +3678,7 @@ const surfaceCommands = [
 						name: "is-archived",
 						jsonPath: ["isArchived"],
 						description: "Whether the item is archived, which cannot be null",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
@@ -3594,6 +3686,7 @@ const surfaceCommands = [
 						jsonPath: ["name"],
 						description: "The item's new display name, which cannot be empty",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3601,6 +3694,7 @@ const surfaceCommands = [
 						jsonPath: ["sku"],
 						description: "The item's new stock keeping unit, which cannot be empty and must be unique within your organization",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3608,6 +3702,7 @@ const surfaceCommands = [
 						jsonPath: ["type"],
 						description: "The type to convert the item to, when the item's assets and inventory history allow the conversion",
 						valueName: "value",
+						nullable: true,
 						schema: z.enum([
 							"BULK",
 							"DEVICE",
@@ -3640,6 +3735,7 @@ const surfaceCommands = [
 							jsonPath: ["allocatedIndirect"],
 							description: "One unit's share of overhead, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3647,6 +3743,7 @@ const surfaceCommands = [
 							jsonPath: ["billOfMaterials"],
 							description: "The parts cost of one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3666,6 +3763,7 @@ const surfaceCommands = [
 							jsonPath: ["directLabor"],
 							description: "The labor cost to build one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3673,6 +3771,7 @@ const surfaceCommands = [
 							jsonPath: ["freightInbound"],
 							description: "The shipping cost to receive one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3680,6 +3779,7 @@ const surfaceCommands = [
 							jsonPath: ["freightOutbound"],
 							description: "The shipping cost to deploy one unit, a deployment cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3687,6 +3787,7 @@ const surfaceCommands = [
 							jsonPath: ["installation"],
 							description: "The cost to install one unit, a deployment cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3694,6 +3795,7 @@ const surfaceCommands = [
 							jsonPath: ["interest"],
 							description: "The financing cost of one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3701,6 +3803,7 @@ const surfaceCommands = [
 							jsonPath: ["salvageValue"],
 							description: "The value one unit keeps at the end of its useful life, or null to clear it",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3708,6 +3811,7 @@ const surfaceCommands = [
 							jsonPath: ["simpleCostBasis"],
 							description: "A single cost for one unit, which cannot be sent together with the cost components",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3715,6 +3819,7 @@ const surfaceCommands = [
 							jsonPath: ["tariffs"],
 							description: "The import duty paid on one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3722,6 +3827,7 @@ const surfaceCommands = [
 							jsonPath: ["tax"],
 							description: "The tax paid on one unit, a cost component",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						},
 						{
@@ -3729,6 +3835,7 @@ const surfaceCommands = [
 							jsonPath: ["usefulLife"],
 							description: "The number of months one unit is depreciated over, or null to clear it",
 							valueName: "number",
+							nullable: true,
 							schema: z.coerce.number()
 						}
 					]
@@ -3785,6 +3892,7 @@ const surfaceCommands = [
 								description: "The field's position within its section, starting at 0",
 								valueName: "number",
 								required: true,
+								nullable: true,
 								schema: z.coerce.number()
 							},
 							{
@@ -3793,6 +3901,7 @@ const surfaceCommands = [
 								description: "The group the field is shown in, starting at 0",
 								valueName: "number",
 								required: true,
+								nullable: true,
 								schema: z.coerce.number()
 							}
 						]
@@ -3818,6 +3927,7 @@ const surfaceCommands = [
 							jsonPath: ["label"],
 							description: "The field's new display name, which cannot be empty",
 							valueName: "value",
+							nullable: true,
 							schema: z.string()
 						}]
 					}),
@@ -3958,6 +4068,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "addressLine1"],
 						description: "The first line of the street address",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3965,6 +4076,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "addressLine2"],
 						description: "The second line of the street address, such as a suite",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3972,6 +4084,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "city"],
 						description: "The city",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3979,6 +4092,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "country"],
 						description: "The country",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3986,6 +4100,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "formattedAddress"],
 						description: "The whole address on one line",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -3993,6 +4108,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "postalCode"],
 						description: "The postal or ZIP code",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4000,6 +4116,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "state"],
 						description: "The state or region",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4007,6 +4124,7 @@ const surfaceCommands = [
 						jsonPath: ["consignee"],
 						description: "The ID of the customer a zone is designated for, such as for reservations, provisioning or a 3PL",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4014,6 +4132,7 @@ const surfaceCommands = [
 						jsonPath: ["customerId"],
 						description: "The ID of the customer to assign a site to, or null for your organization's own site",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4021,6 +4140,7 @@ const surfaceCommands = [
 						jsonPath: ["description"],
 						description: "A free-form description of a zone",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4053,6 +4173,7 @@ const surfaceCommands = [
 						jsonPath: ["parentLocationId"],
 						description: "The ID of the site a zone belongs to, required for a zone and refused for a site",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4100,6 +4221,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "addressLine1"],
 						description: "The first line of the street address",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4107,6 +4229,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "addressLine2"],
 						description: "The second line of the street address, such as a suite",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4114,6 +4237,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "city"],
 						description: "The city",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4121,6 +4245,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "country"],
 						description: "The country",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4128,6 +4253,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "formattedAddress"],
 						description: "The whole address on one line",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4135,6 +4261,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "postalCode"],
 						description: "The postal or ZIP code",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4142,6 +4269,7 @@ const surfaceCommands = [
 						jsonPath: ["address", "state"],
 						description: "The state or region",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4149,6 +4277,7 @@ const surfaceCommands = [
 						jsonPath: ["consignee"],
 						description: "The ID of the customer a zone is designated for, such as for reservations, provisioning or a 3PL",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4156,6 +4285,7 @@ const surfaceCommands = [
 						jsonPath: ["customerId"],
 						description: "The ID of the customer to assign a site to, or null for your organization's own site",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4163,30 +4293,35 @@ const surfaceCommands = [
 						jsonPath: ["description"],
 						description: "A free-form description of a zone",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
 						name: "is-archived",
 						jsonPath: ["isArchived"],
 						description: "Whether the location is archived, and archiving a site archives its zones",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
 						name: "is-inventory",
 						jsonPath: ["isInventory"],
 						description: "Whether assets at the location count as inventory for reporting",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
 						name: "is-inventory-override",
 						jsonPath: ["isInventoryOverride"],
 						description: "Whether a zone sets its own isInventory rather than inheriting its parent site's, which a site refuses",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
 						name: "is-transient",
 						jsonPath: ["isTransient"],
 						description: "Whether assets make only occasional or temporary stops at the location, which hides it from location lists by default",
+						nullable: true,
 						schema: z.boolean()
 					},
 					{
@@ -4194,6 +4329,7 @@ const surfaceCommands = [
 						jsonPath: ["name"],
 						description: "The location's display name",
 						valueName: "value",
+						nullable: true,
 						schema: z.string()
 					},
 					{
@@ -4280,12 +4416,14 @@ const surfaceCommands = [
 					jsonPath: ["name"],
 					description: "The link's display name, or null to show the address instead",
 					valueName: "value",
+					nullable: true,
 					schema: z.string()
 				}, {
 					name: "url",
 					jsonPath: ["url"],
 					description: "The address the link points to, which cannot be empty or null",
 					valueName: "value",
+					nullable: true,
 					schema: z.string()
 				}]
 			}),

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hardfin/cli",
-    "version": "0.0.2-dev.12",
+    "version": "0.0.2-dev.13",
     "description": "Command line interface for the Hardfin API",
     "license": "Apache-2.0",
     "author": "Hardfin, Inc.",