orb-billing 1.28.1 → 1.30.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 1.30.0 (2023-11-28)
+
+Full Changelog: [v1.29.0...v1.30.0](https://github.com/orbcorp/orb-node/compare/v1.29.0...v1.30.0)
+
+### Features
+
+* **api:** updates ([#45](https://github.com/orbcorp/orb-node/issues/45)) ([7a04e1a](https://github.com/orbcorp/orb-node/commit/7a04e1aab11063627d2ef73701864d60d0c1cbbe))
+
+
+### Chores
+
+* **internal:** remove file import and conditionally run prepare ([#43](https://github.com/orbcorp/orb-node/issues/43)) ([c65b596](https://github.com/orbcorp/orb-node/commit/c65b5961a26fa2eda9fe806a2214dfe518f6e447))
+
+
+### Documentation
+
+* **api:** update metadata docstrings ([#41](https://github.com/orbcorp/orb-node/issues/41)) ([4334af2](https://github.com/orbcorp/orb-node/commit/4334af25186dae687ad96ab323d5fa53d15b220f))
+
+## 1.29.0 (2023-11-22)
+
+Full Changelog: [v1.28.1...v1.29.0](https://github.com/orbcorp/orb-node/compare/v1.28.1...v1.29.0)
+
+### Features
+
+* allow installing package directly from github ([#37](https://github.com/orbcorp/orb-node/issues/37)) ([8791b26](https://github.com/orbcorp/orb-node/commit/8791b26c93d33807434ad51f40f4e998567216f7))
+* **api:** updates ([#40](https://github.com/orbcorp/orb-node/issues/40)) ([2a17035](https://github.com/orbcorp/orb-node/commit/2a1703539b5c4df7c2b1dc6a5a10b720fa53fa0d))
+
+
+### Chores
+
+* **internal:** don't call prepare in dist ([#39](https://github.com/orbcorp/orb-node/issues/39)) ([986847c](https://github.com/orbcorp/orb-node/commit/986847ce30bdf30bb5e8b8f5e7269b146e726a9c))
+
 ## 1.28.1 (2023-11-20)
 
 Full Changelog: [v1.28.0...v1.28.1](https://github.com/orbcorp/orb-node/compare/v1.28.0...v1.28.1)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "orb-billing",
-  "version": "1.28.1",
-  "description": "Client library for the Orb API",
+  "version": "1.30.0",
+  "description": "The official TypeScript library for the Orb API",
   "author": "Orb <team@withorb.com>",
   "types": "./index.d.ts",
   "main": "./index.js",
@@ -9,6 +9,27 @@
   "repository": "github:orbcorp/orb-node",
   "license": "Apache-2.0",
   "private": false,
+  "scripts": {
+    "test": "bin/check-test-server && yarn jest",
+    "build": "bash ./build",
+    "format": "prettier --write --cache  --cache-strategy metadata . !dist",
+    "tsn": "ts-node -r tsconfig-paths/register",
+    "lint": "eslint --ext ts,js .",
+    "fix": "eslint --fix --ext ts,js ."
+  },
+  "dependencies": {
+    "@types/node": "^18.11.18",
+    "@types/node-fetch": "^2.6.4",
+    "@types/qs": "^6.9.7",
+    "abort-controller": "^3.0.0",
+    "agentkeepalive": "^4.2.1",
+    "digest-fetch": "^1.3.0",
+    "form-data-encoder": "1.7.2",
+    "formdata-node": "^4.3.2",
+    "node-fetch": "^2.6.7",
+    "qs": "^6.10.3",
+    "web-streams-polyfill": "^3.2.1"
+  },
   "sideEffects": [
     "./_shims/index.js",
     "./_shims/index.mjs",
@@ -17,6 +38,10 @@
     "./shims/web.js",
     "./shims/web.mjs"
   ],
+  "imports": {
+    "orb-billing": ".",
+    "orb-billing/*": "./src/*"
+  },
   "exports": {
     "./_shims/auto/*": {
       "deno": {
@@ -74,26 +99,5 @@
       "require": "./*.js",
       "default": "./*.mjs"
     }
-  },
-  "scripts": {
-    "test": "bin/check-test-server && yarn jest",
-    "build": "bash ./build",
-    "format": "prettier --write --cache  --cache-strategy metadata . !dist",
-    "tsn": "ts-node -r tsconfig-paths/register",
-    "lint": "eslint --ext ts,js .",
-    "fix": "eslint --fix --ext ts,js ."
-  },
-  "dependencies": {
-    "@types/node": "^18.11.18",
-    "@types/node-fetch": "^2.6.4",
-    "@types/qs": "^6.9.7",
-    "abort-controller": "^3.0.0",
-    "agentkeepalive": "^4.2.1",
-    "digest-fetch": "^1.3.0",
-    "form-data-encoder": "1.7.2",
-    "formdata-node": "^4.3.2",
-    "node-fetch": "^2.6.7",
-    "qs": "^6.10.3",
-    "web-streams-polyfill": "^3.2.1"
   }
 }

package/resources/customers/credits/ledger.d.ts

@@ -420,8 +420,10 @@ export declare namespace LedgerListResponse {
         entry_type: 'increment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -449,8 +451,10 @@ export declare namespace LedgerListResponse {
         entry_type: 'decrement';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -481,8 +485,10 @@ export declare namespace LedgerListResponse {
         entry_type: 'expiration_change';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -511,8 +517,10 @@ export declare namespace LedgerListResponse {
         entry_type: 'credit_block_expiry';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -540,8 +548,10 @@ export declare namespace LedgerListResponse {
         entry_type: 'void';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -571,8 +581,10 @@ export declare namespace LedgerListResponse {
         entry_type: 'void_initiated';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -603,8 +615,10 @@ export declare namespace LedgerListResponse {
         entry_type: 'amendment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -639,8 +653,10 @@ export declare namespace LedgerCreateEntryResponse {
         entry_type: 'increment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -668,8 +684,10 @@ export declare namespace LedgerCreateEntryResponse {
         entry_type: 'decrement';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -700,8 +718,10 @@ export declare namespace LedgerCreateEntryResponse {
         entry_type: 'expiration_change';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -730,8 +750,10 @@ export declare namespace LedgerCreateEntryResponse {
         entry_type: 'credit_block_expiry';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -759,8 +781,10 @@ export declare namespace LedgerCreateEntryResponse {
         entry_type: 'void';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -790,8 +814,10 @@ export declare namespace LedgerCreateEntryResponse {
         entry_type: 'void_initiated';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -822,8 +848,10 @@ export declare namespace LedgerCreateEntryResponse {
         entry_type: 'amendment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -858,8 +886,10 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
         entry_type: 'increment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -887,8 +917,10 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
         entry_type: 'decrement';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -919,8 +951,10 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
         entry_type: 'expiration_change';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -949,8 +983,10 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
         entry_type: 'credit_block_expiry';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -978,8 +1014,10 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
         entry_type: 'void';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -1009,8 +1047,10 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
         entry_type: 'void_initiated';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -1041,8 +1081,10 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
         entry_type: 'amendment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -1077,8 +1119,10 @@ export declare namespace LedgerListByExternalIDResponse {
         entry_type: 'increment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -1106,8 +1150,10 @@ export declare namespace LedgerListByExternalIDResponse {
         entry_type: 'decrement';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -1138,8 +1184,10 @@ export declare namespace LedgerListByExternalIDResponse {
         entry_type: 'expiration_change';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -1168,8 +1216,10 @@ export declare namespace LedgerListByExternalIDResponse {
         entry_type: 'credit_block_expiry';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -1197,8 +1247,10 @@ export declare namespace LedgerListByExternalIDResponse {
         entry_type: 'void';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -1228,8 +1280,10 @@ export declare namespace LedgerListByExternalIDResponse {
         entry_type: 'void_initiated';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         new_block_expiry_date: string;
@@ -1260,8 +1314,10 @@ export declare namespace LedgerListByExternalIDResponse {
         entry_type: 'amendment';
         ledger_sequence_number: number;
         /**
-         * User specified key-value pairs. If not provided, this defaults to an empty
-         * dictionary.
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
          */
         metadata: Record<string, string>;
         starting_balance: number;
@@ -1321,7 +1377,9 @@ export declare namespace LedgerCreateEntryParams {
          */
         invoice_settings?: LedgerCreateEntryParams.AddIncrementCreditLedgerEntryRequestParams.InvoiceSettings | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
         /**
@@ -1369,7 +1427,9 @@ export declare namespace LedgerCreateEntryParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
     }
@@ -1403,7 +1463,9 @@ export declare namespace LedgerCreateEntryParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
     }
@@ -1425,7 +1487,9 @@ export declare namespace LedgerCreateEntryParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
         /**
@@ -1451,7 +1515,9 @@ export declare namespace LedgerCreateEntryParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
     }
@@ -1489,7 +1555,9 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
          */
         invoice_settings?: LedgerCreateEntryByExternalIDParams.AddIncrementCreditLedgerEntryRequestParams.InvoiceSettings | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
         /**
@@ -1537,7 +1605,9 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
     }
@@ -1571,7 +1641,9 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
     }
@@ -1593,7 +1665,9 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
         /**
@@ -1619,7 +1693,9 @@ export declare namespace LedgerCreateEntryByExternalIDParams {
          */
         description?: string | null;
         /**
-         * User-specified key/value pairs for the resource.
+         * User-specified key/value pairs for the resource. Individual keys can be removed
+         * by setting the value to `null`, and the entire metadata mapping can be cleared
+         * by setting `metadata` to `null`.
          */
         metadata?: Record<string, string | null> | null;
     }