asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-11-17 19:36:58 +02:00
1 parent b3093c3e3d
commit c51dce164d
869 files changed
+15238 -7267
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.adjustInventory.mdx
+2 -2
View File
@@ -126,7 +126,7 @@ async function adjustInventory (
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -171,7 +171,7 @@ async function adjustInventory (
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItem.mdx
+28 -28
View File
@@ -46,7 +46,7 @@ async function createInventoryItem (item: {
"children": [
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -55,7 +55,7 @@ async function createInventoryItem (item: {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -64,7 +64,7 @@ async function createInventoryItem (item: {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The HS code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -73,7 +73,7 @@ async function createInventoryItem (item: {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -82,7 +82,7 @@ async function createInventoryItem (item: {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -91,7 +91,7 @@ async function createInventoryItem (item: {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -100,7 +100,7 @@ async function createInventoryItem (item: {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The MID code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -109,7 +109,7 @@ async function createInventoryItem (item: {
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The origin country of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -119,7 +119,7 @@ async function createInventoryItem (item: {
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "",
"description": "Whether the inventory item requires shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -127,7 +127,7 @@ async function createInventoryItem (item: {
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The SKU of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -136,7 +136,7 @@ async function createInventoryItem (item: {
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The thumbnail of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -145,7 +145,7 @@ async function createInventoryItem (item: {
},
{
"name": "title",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The title of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -154,7 +154,7 @@ async function createInventoryItem (item: {
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -163,7 +163,7 @@ async function createInventoryItem (item: {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -232,7 +232,7 @@ async function createInventoryItem (item: {
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -241,7 +241,7 @@ async function createInventoryItem (item: {
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -250,7 +250,7 @@ async function createInventoryItem (item: {
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -259,7 +259,7 @@ async function createInventoryItem (item: {
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -277,7 +277,7 @@ async function createInventoryItem (item: {
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -286,7 +286,7 @@ async function createInventoryItem (item: {
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -295,7 +295,7 @@ async function createInventoryItem (item: {
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -304,7 +304,7 @@ async function createInventoryItem (item: {
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -313,7 +313,7 @@ async function createInventoryItem (item: {
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -331,7 +331,7 @@ async function createInventoryItem (item: {
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -340,7 +340,7 @@ async function createInventoryItem (item: {
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -349,7 +349,7 @@ async function createInventoryItem (item: {
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -367,7 +367,7 @@ async function createInventoryItem (item: {
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -376,7 +376,7 @@ async function createInventoryItem (item: {
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItems.mdx
+14 -14
View File
@@ -46,7 +46,7 @@ async function createInventoryItems (items: {
"children": [
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -55,7 +55,7 @@ async function createInventoryItems (items: {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -64,7 +64,7 @@ async function createInventoryItems (items: {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The HS code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -73,7 +73,7 @@ async function createInventoryItems (items: {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -82,7 +82,7 @@ async function createInventoryItems (items: {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -91,7 +91,7 @@ async function createInventoryItems (items: {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -100,7 +100,7 @@ async function createInventoryItems (items: {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The MID code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -109,7 +109,7 @@ async function createInventoryItems (items: {
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The origin country of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -119,7 +119,7 @@ async function createInventoryItems (items: {
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "",
"description": "Whether the inventory item requires shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -127,7 +127,7 @@ async function createInventoryItems (items: {
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The SKU of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -136,7 +136,7 @@ async function createInventoryItems (items: {
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The thumbnail of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -145,7 +145,7 @@ async function createInventoryItems (items: {
},
{
"name": "title",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The title of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -154,7 +154,7 @@ async function createInventoryItems (items: {
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -163,7 +163,7 @@ async function createInventoryItems (items: {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the inventory item.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryLevel.mdx
+2 -2
View File
@@ -152,7 +152,7 @@ async function createInventoryLevel (item: {
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -197,7 +197,7 @@ async function createInventoryLevel (item: {
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItem.mdx
+6 -6
View File
@@ -101,7 +101,7 @@ async function createReservationItem (item: {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -179,7 +179,7 @@ async function createReservationItem (item: {
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -188,7 +188,7 @@ async function createReservationItem (item: {
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -197,7 +197,7 @@ async function createReservationItem (item: {
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -224,7 +224,7 @@ async function createReservationItem (item: {
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -242,7 +242,7 @@ async function createReservationItem (item: {
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItems.mdx
+1 -1
View File
@@ -101,7 +101,7 @@ async function createReservationItems (items: {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx
+14 -14
View File
@@ -194,7 +194,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -212,7 +212,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -221,7 +221,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -239,7 +239,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -248,7 +248,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -257,7 +257,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -266,7 +266,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -275,7 +275,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -293,7 +293,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -302,7 +302,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -311,7 +311,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -329,7 +329,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -338,7 +338,7 @@ async function retrieveInventoryItem (id: string) {
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryLevel.mdx
+2 -2
View File
@@ -115,7 +115,7 @@ async function retrieveInventoryLevel (
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -160,7 +160,7 @@ async function retrieveInventoryLevel (
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveReservationItem.mdx
+5 -5
View File
@@ -100,7 +100,7 @@ async function retrieveReservationItem (id: string) {
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -109,7 +109,7 @@ async function retrieveReservationItem (id: string) {
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -118,7 +118,7 @@ async function retrieveReservationItem (id: string) {
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -145,7 +145,7 @@ async function retrieveReservationItem (id: string) {
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -163,7 +163,7 @@ async function retrieveReservationItem (id: string) {
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryItem.mdx
+28 -28
View File
@@ -58,7 +58,7 @@ async function updateInventoryItem (
"children": [
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -67,7 +67,7 @@ async function updateInventoryItem (
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -76,7 +76,7 @@ async function updateInventoryItem (
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The HS code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -85,7 +85,7 @@ async function updateInventoryItem (
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -94,7 +94,7 @@ async function updateInventoryItem (
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ async function updateInventoryItem (
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ async function updateInventoryItem (
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The MID code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ async function updateInventoryItem (
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The origin country of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -131,7 +131,7 @@ async function updateInventoryItem (
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "",
"description": "Whether the inventory item requires shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -139,7 +139,7 @@ async function updateInventoryItem (
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The SKU of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -148,7 +148,7 @@ async function updateInventoryItem (
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The thumbnail of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -157,7 +157,7 @@ async function updateInventoryItem (
},
{
"name": "title",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The title of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -166,7 +166,7 @@ async function updateInventoryItem (
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -175,7 +175,7 @@ async function updateInventoryItem (
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -244,7 +244,7 @@ async function updateInventoryItem (
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -253,7 +253,7 @@ async function updateInventoryItem (
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -262,7 +262,7 @@ async function updateInventoryItem (
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -271,7 +271,7 @@ async function updateInventoryItem (
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -289,7 +289,7 @@ async function updateInventoryItem (
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -298,7 +298,7 @@ async function updateInventoryItem (
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -307,7 +307,7 @@ async function updateInventoryItem (
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -316,7 +316,7 @@ async function updateInventoryItem (
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -325,7 +325,7 @@ async function updateInventoryItem (
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -343,7 +343,7 @@ async function updateInventoryItem (
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -352,7 +352,7 @@ async function updateInventoryItem (
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -361,7 +361,7 @@ async function updateInventoryItem (
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -379,7 +379,7 @@ async function updateInventoryItem (
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -388,7 +388,7 @@ async function updateInventoryItem (
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevel.mdx
+2 -2
View File
@@ -147,7 +147,7 @@ async function updateInventoryLevel (
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ async function updateInventoryLevel (
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevels.mdx
+2 -2
View File
@@ -48,7 +48,7 @@ async function updateInventoryLevels (items: {
{
"name": "incoming_quantity",
"type": "`number`",
"description": "",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -75,7 +75,7 @@ async function updateInventoryLevels (items: {
{
"name": "stocked_quantity",
"type": "`number`",
"description": "",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateReservationItem.mdx
+6 -6
View File
@@ -76,7 +76,7 @@ async function updateReservationItem (
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -154,7 +154,7 @@ async function updateReservationItem (
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -163,7 +163,7 @@ async function updateReservationItem (
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -172,7 +172,7 @@ async function updateReservationItem (
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -199,7 +199,7 @@ async function updateReservationItem (
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -217,7 +217,7 @@ async function updateReservationItem (
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/interfaces/BulkUpdateInventoryLevelInput.mdx
+2 -2
View File
@@ -14,7 +14,7 @@ The attributes to update in an inventory level. The inventory level is identifie
{
"name": "incoming_quantity",
"type": "`number`",
"description": "",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -41,7 +41,7 @@ The attributes to update in an inventory level. The inventory level is identifie
{
"name": "stocked_quantity",
"type": "`number`",
"description": "",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/inventory/interfaces/CreateInventoryItemInput.mdx
+14 -14
View File
@@ -13,7 +13,7 @@ The details of the inventory item to be created.
<ParameterTypes parameters={[
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ The details of the inventory item to be created.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -31,7 +31,7 @@ The details of the inventory item to be created.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The HS code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -40,7 +40,7 @@ The details of the inventory item to be created.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ The details of the inventory item to be created.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ The details of the inventory item to be created.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -67,7 +67,7 @@ The details of the inventory item to be created.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The MID code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -76,7 +76,7 @@ The details of the inventory item to be created.
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The origin country of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -86,7 +86,7 @@ The details of the inventory item to be created.
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "",
"description": "Whether the inventory item requires shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -94,7 +94,7 @@ The details of the inventory item to be created.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The SKU of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ The details of the inventory item to be created.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The thumbnail of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ The details of the inventory item to be created.
},
{
"name": "title",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The title of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ The details of the inventory item to be created.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -130,7 +130,7 @@ The details of the inventory item to be created.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the inventory item.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/interfaces/CreateReservationItemInput.mdx
+1 -1
View File
@@ -67,7 +67,7 @@ The details of the reservation item to be created.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/interfaces/JoinerServiceConfig.mdx
+1 -1
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "`&#123; relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/interfaces/UpdateReservationItemInput.mdx
+1 -1
View File
@@ -31,7 +31,7 @@ The attributes to update in a reservation item.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/types/Exclude.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Exclude
**Exclude**`<TypeParameter T, TypeParameter U>`: T extends U ? never : T
**Exclude**`<TypeParameter T, TypeParameter U>`: `T` extends `U` ? `never` : `T`
Exclude from T those types that are assignable to U
www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx
+14 -14
View File
@@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -130,7 +130,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -139,7 +139,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -157,7 +157,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -166,7 +166,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx
+2 -2
View File
@@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/inventory/types/ModuleJoinerConfig.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleJoinerConfig
**ModuleJoinerConfig**: [Omit](Omit.mdx)&#60;[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), `"serviceName"` \| `"primaryKeys"` \| `"relationships"` \| `"extends"`&#62; & &#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `"date"` \| `"time"` \| `"datetime"` \| `"bigint"` \| `"blob"` \| `"uint8array"` \| `"array"` \| `"enumArray"` \| `"enum"` \| `"json"` \| `"integer"` \| `"smallint"` \| `"tinyint"` \| `"mediumint"` \| `"float"` \| `"double"` \| `"boolean"` \| `"decimal"` \| `"string"` \| `"uuid"` \| `"text"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;
**ModuleJoinerConfig**: [Omit](Omit.mdx)&#60;[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"&#62; & ``{ databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: "date" \| "time" \| "datetime" \| bigint \| "blob" \| "uint8array" \| "array" \| "enumArray" \| "enum" \| "json" \| "integer" \| "smallint" \| "tinyint" \| "mediumint" \| "float" \| "double" \| "boolean" \| "decimal" \| "string" \| "uuid" \| "text" &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }``
www/apps/docs/content/references/inventory/types/ModuleJoinerRelationship.mdx
+1 -1
View File
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ModuleJoinerRelationship
**ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & &#123; deleteCascade?: boolean ; isInternalService?: boolean &#125;
**ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & ``{ deleteCascade?: boolean ; isInternalService?: boolean }``
www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx
+5 -5
View File
@@ -24,7 +24,7 @@ Represents a reservation of an inventory item at a stock location
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -33,7 +33,7 @@ Represents a reservation of an inventory item at a stock location
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -42,7 +42,7 @@ Represents a reservation of an inventory item at a stock location
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -69,7 +69,7 @@ Represents a reservation of an inventory item at a stock location
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -87,7 +87,7 @@ Represents a reservation of an inventory item at a stock location
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",