diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts index c3f596e974..cccd6a0fb1 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts @@ -31,8 +31,7 @@ export default function (theme: MarkdownTheme) { (reflection.parent?.kindOf(ReflectionKind.Enum) ? " = " : ": ") + Handlebars.helpers.type.call( reflectionType ? reflectionType : reflection, - "object", - false + "object" ) ) } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/type-utils.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/type-utils.ts index 5816b4859d..2ee2f71df6 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/type-utils.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/type-utils.ts @@ -27,72 +27,73 @@ export type Collapse = "object" | "function" | "all" | "none" export default function getType( reflectionType: SomeType, collapse: Collapse = "none", - emphasis = true, - hideLink = false + wrapBackticks = true, + hideLink = false, + escape?: boolean ): string { if (reflectionType instanceof ReferenceType) { - return getReferenceType(reflectionType, emphasis, hideLink) + return getReferenceType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof ArrayType && reflectionType.elementType) { - return getArrayType(reflectionType, emphasis, hideLink) + return getArrayType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof UnionType && reflectionType.types) { - return getUnionType(reflectionType, emphasis, hideLink) + return getUnionType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof IntersectionType && reflectionType.types) { - return getIntersectionType(reflectionType, emphasis, hideLink) + return getIntersectionType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof TupleType && reflectionType.elements) { - return getTupleType(reflectionType, emphasis, hideLink) + return getTupleType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof IntrinsicType && reflectionType.name) { - return getIntrinsicType(reflectionType, emphasis) + return getIntrinsicType(reflectionType, wrapBackticks, escape) } if (reflectionType instanceof ReflectionType) { return getReflectionType( reflectionType.declaration, collapse, - emphasis, + wrapBackticks, hideLink ) } if (reflectionType instanceof DeclarationReflection) { - return getReflectionType(reflectionType, collapse, emphasis, hideLink) + return getReflectionType(reflectionType, collapse, wrapBackticks, hideLink) } if (reflectionType instanceof TypeOperatorType) { - return getTypeOperatorType(reflectionType, emphasis, hideLink) + return getTypeOperatorType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof QueryType) { - return getQueryType(reflectionType, emphasis, hideLink) + return getQueryType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof ConditionalType) { - return getConditionalType(reflectionType, emphasis, hideLink) + return getConditionalType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof IndexedAccessType) { - return getIndexAccessType(reflectionType, emphasis, hideLink) + return getIndexAccessType(reflectionType, wrapBackticks, hideLink, escape) } if (reflectionType instanceof UnknownType) { - return getUnknownType(reflectionType) + return getUnknownType(reflectionType, escape) } if (reflectionType instanceof InferredType) { - return getInferredType(reflectionType) + return getInferredType(reflectionType, escape) } if (reflectionType instanceof LiteralType) { - return getLiteralType(reflectionType, emphasis) + return getLiteralType(reflectionType, wrapBackticks, escape) } return reflectionType ? escapeChars(reflectionType.toString()) : "" @@ -101,28 +102,37 @@ export default function getType( export function getReflectionType( model: ReflectionParameterType, collapse: Collapse, - emphasis: boolean, + wrapBackticks = true, hideLink = false ): string { if ("signatures" in model && model.signatures) { return collapse === "function" || collapse === "all" - ? `${emphasis ? "`" : ""}fn${emphasis ? "`" : ""}` - : getFunctionType(model.signatures, emphasis, hideLink) + ? `${wrapBackticks ? "`" : ""}fn${wrapBackticks ? "`" : ""}` + : getFunctionType( + model.signatures, + wrapBackticks, + hideLink, + !wrapBackticks + ) } return collapse === "object" || collapse === "all" - ? `${emphasis ? "`" : ""}object${emphasis ? "`" : ""}` - : `${emphasis ? "`" : ""}${getDeclarationType( + ? `${wrapBackticks ? "`" : ""}object${wrapBackticks ? "`" : ""}` + : `${wrapBackticks ? "`" : ""}${getDeclarationType( model as DeclarationReflection, - false, - hideLink - )}${emphasis ? "`" : ""}` + wrapBackticks, + hideLink, + !wrapBackticks + )}${wrapBackticks ? "`" : ""}` } export function getDeclarationType( model: DeclarationReflection, - emphasis: boolean, - hideLink = false + wrapBackticks = true, + hideLink = false, + escape?: boolean ): string { + escape = getShouldEscape(wrapBackticks, escape) + if (model.indexSignature || model.children) { let indexSignature = "" const declarationIndexSignature = model.indexSignature @@ -133,7 +143,13 @@ export function getDeclarationType( ) : "" const obj = declarationIndexSignature.type - ? getType(declarationIndexSignature.type, "none", false, hideLink) + ? getType( + declarationIndexSignature.type, + "none", + false, + hideLink, + escape + ) : "" indexSignature = `${key}: ${obj}; ` } @@ -142,73 +158,88 @@ export function getDeclarationType( model.children.map((obj) => { return `${obj.name}${obj.flags.isOptional ? "?" : ""}: ${ obj.type - ? getType(obj.type, "none", false, hideLink) - : escapeChars(obj.toString()) + ? getType(obj.type, "none", false, hideLink, escape) + : getFormattedStr(obj.toString(), false, escape) } ${ obj.defaultValue && obj.defaultValue !== "..." - ? `= ${escapeChars(`${obj.defaultValue}`)}` + ? `= ${getFormattedStr(`${obj.defaultValue}`, false, escape)}` : "" }` }) - return `${emphasis ? "`{" : getHTMLChar("{")} ${ + return `${wrapBackticks ? "`{" : getHTMLChar("{")} ${ indexSignature ? indexSignature : "" - }${types ? types.join("; ") : ""} ${emphasis ? "}`" : getHTMLChar("}")}${ + }${types ? types.join("; ") : ""} ${ + wrapBackticks ? "}`" : getHTMLChar("}") + }${ model.defaultValue && model.defaultValue !== "..." - ? `= ${escapeChars(`${model.defaultValue}`)}` + ? `= ${getFormattedStr(`${model.defaultValue}`, wrapBackticks, escape)}` : "" }` } - return emphasis ? "`{}`" : escapeChars("{}") + return getFormattedStr("{}", wrapBackticks, escape) } export function getFunctionType( modelSignatures: SignatureReflection[], - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { + escape = getShouldEscape(wrapBackticks, escape) + const functions = modelSignatures.map((fn) => { const typeParams = fn.typeParameters - ? `${emphasis ? "`<" : getHTMLChar("<")}${fn.typeParameters + ? `${wrapBackticks ? "`<" : getHTMLChar("<")}${fn.typeParameters .map((typeParameter) => typeParameter.name) - .join(", ")}${emphasis ? ">`" : getHTMLChar(">")}` + .join(", ")}${wrapBackticks ? ">`" : getHTMLChar(">")}` : [] const params = fn.parameters ? fn.parameters.map((param) => { - return `${param.flags.isRest ? "..." : ""}${emphasis ? "`" : ""}${ - param.name - }${param.flags.isOptional ? "?" : ""}${emphasis ? "`" : ""}: ${ + return `${param.flags.isRest ? "..." : ""}${ + wrapBackticks ? "`" : "" + }${param.name}${param.flags.isOptional ? "?" : ""}${ + wrapBackticks ? "`" : "" + }: ${ param.type - ? getType(param.type, "none", emphasis, hideLink) - : escapeChars(param.toString()) + ? getType(param.type, "none", wrapBackticks, hideLink, escape) + : getFormattedStr(param.toString(), wrapBackticks, escape) }` }) : [] const returns = fn.type - ? getType(fn.type, "none", emphasis, hideLink) - : escapeChars(fn.toString()) + ? getType(fn.type, "none", wrapBackticks, hideLink, escape) + : getFormattedStr(fn.toString(), wrapBackticks, escape) return typeParams + `(${params.join(", ")}) => ${returns}` }) return functions.join("") } -export function getLiteralType(model: LiteralType, emphasis: boolean): string { - if (typeof model.value === "bigint") { - return `${emphasis ? "`" : ""}${model.value}n${emphasis ? "`" : ""}` - } - return `${emphasis ? "`" : ""}\`${JSON.stringify(model.value)}\`${ - emphasis ? "`" : "" - }` +export function getLiteralType( + model: LiteralType, + wrapBackticks: boolean, + escape?: boolean +): string { + escape = getShouldEscape(wrapBackticks, escape) + + return getFormattedStr( + model.value === "bigint" ? model.value : JSON.stringify(model.value), + wrapBackticks, + escape + ) } export function getReferenceType( model: ReferenceType, - emphasis: boolean, - hideLink = false + wrapBackticks = true, + hideLink = false, + escape?: boolean ): string { + escape = getShouldEscape(wrapBackticks, escape) + const shouldShowLink = !hideLink && model.name !== "Record" - const wrappingBackticks = emphasis && !shouldShowLink + const wrappedInBackticks = wrapBackticks && !shouldShowLink if (model.reflection || (model.name && model.typeArguments)) { - const reflection: string[] = [wrappingBackticks ? "`" : ""] + const reflection: string[] = [wrappedInBackticks ? "`" : ""] if (model.reflection?.url) { reflection.push( @@ -216,9 +247,7 @@ export function getReferenceType( ? `[${model.reflection.name}](${Handlebars.helpers.relativeURL( model.reflection.url )})` - : emphasis - ? model.reflection.name - : escapeChars(model.reflection.name) + : getFormattedStr(model.reflection.name, false, escape) ) } else { reflection.push( @@ -226,42 +255,45 @@ export function getReferenceType( ? model.externalUrl ? `[${model.name}]( ${model.externalUrl} )` : model.name - : emphasis - ? model.name - : escapeChars(model.name) + : getFormattedStr(model.name, false, escape) ) } if (model.typeArguments && model.typeArguments.length > 0) { reflection.push( - `${wrappingBackticks ? "<" : getHTMLChar("<")}${model.typeArguments - .map((typeArgument) => getType(typeArgument, "none", false, hideLink)) - .join(", ")}${wrappingBackticks ? ">" : getHTMLChar(">")}` + `${wrappedInBackticks ? "<" : getHTMLChar("<")}${model.typeArguments + .map((typeArgument) => + getType(typeArgument, "none", false, hideLink, false) + ) + .join(", ")}${wrappedInBackticks ? ">" : getHTMLChar(">")}` ) } - if (wrappingBackticks) { + if (wrappedInBackticks) { reflection.push("`") } return reflection.join("") } return shouldShowLink ? model.externalUrl - ? `[${emphasis ? `\`${model.name}\`` : escapeChars(model.name)}]( ${ + ? `[${getFormattedStr(model.name, wrapBackticks, escape)}]( ${ model.externalUrl } )` - : emphasis - ? `\`${model.name}\`` - : escapeChars(model.name) - : emphasis - ? `\`${model.name}\`` - : escapeChars(model.name) + : getFormattedStr(model.name, wrapBackticks, escape) + : getFormattedStr(model.name, wrapBackticks, escape) } export function getArrayType( model: ArrayType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { - const arrayType = getType(model.elementType, "none", emphasis, hideLink) + const arrayType = getType( + model.elementType, + "none", + wrapBackticks, + hideLink, + escape + ) return model.elementType.type === "union" ? `(${arrayType})[]` : `${arrayType}[]` @@ -269,107 +301,132 @@ export function getArrayType( export function getUnionType( model: UnionType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { return model.types - .map((unionType) => getType(unionType, "none", emphasis, hideLink)) + .map((unionType) => + getType(unionType, "none", wrapBackticks, hideLink, escape) + ) .join(` \\| `) } export function getIntersectionType( model: IntersectionType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { return model.types .map((intersectionType) => - getType(intersectionType, "none", emphasis, hideLink) + getType(intersectionType, "none", wrapBackticks, hideLink, escape) ) .join(" & ") } export function getTupleType( model: TupleType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { return `[${model.elements - .map((element) => getType(element, "none", emphasis, hideLink)) + .map((element) => getType(element, "none", wrapBackticks, hideLink, escape)) .join(", ")}]` } export function getIntrinsicType( model: IntrinsicType, - emphasis: boolean + wrapBackticks: boolean, + escape?: boolean ): string { - return emphasis ? `\`${model.name}\`` : escapeChars(model.name) + escape = getShouldEscape(wrapBackticks, escape) + + return getFormattedStr(model.name, wrapBackticks, escape) } export function getTypeOperatorType( model: TypeOperatorType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { return `${model.operator} ${getType( model.target, "none", - emphasis, - hideLink + wrapBackticks, + hideLink, + escape )}` } export function getQueryType( model: QueryType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { - return `typeof ${getType(model.queryType, "none", emphasis, hideLink)}` + return `typeof ${getType( + model.queryType, + "none", + wrapBackticks, + hideLink, + escape + )}` } -export function getInferredType(model: InferredType): string { - return `infer ${escapeChars(model.name)}` +export function getInferredType(model: InferredType, escape?: boolean): string { + escape = getShouldEscape(false, escape) + + return `infer ${getFormattedStr(model.name, false, escape)}` } -export function getUnknownType(model: UnknownType): string { - return escapeChars(model.name) +export function getUnknownType(model: UnknownType, escape?: boolean): string { + escape = getShouldEscape(false, escape) + + return getFormattedStr(model.name, false, escape) } export function getConditionalType( model: ConditionalType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { const md: string[] = [] if (model.checkType) { - md.push(getType(model.checkType, "none", emphasis, hideLink)) + md.push(getType(model.checkType, "none", wrapBackticks, hideLink, escape)) } md.push("extends") if (model.extendsType) { - md.push(getType(model.extendsType, "none", emphasis, hideLink)) + md.push(getType(model.extendsType, "none", wrapBackticks, hideLink, escape)) } md.push("?") if (model.trueType) { - md.push(getType(model.trueType, "none", emphasis, hideLink)) + md.push(getType(model.trueType, "none", wrapBackticks, hideLink, escape)) } md.push(":") if (model.falseType) { - md.push(getType(model.falseType, "none", emphasis, hideLink)) + md.push(getType(model.falseType, "none", wrapBackticks, hideLink, escape)) } return md.join(" ") } export function getIndexAccessType( model: IndexedAccessType, - emphasis: boolean, - hideLink = false + wrapBackticks: boolean, + hideLink = false, + escape?: boolean ): string { const md: string[] = [] if (model.objectType) { - md.push(getType(model.objectType, "none", emphasis, hideLink)) + md.push(getType(model.objectType, "none", wrapBackticks, hideLink, escape)) } if (model.indexType) { - md.push(`[${getType(model.indexType, "none", false, hideLink)}]`) + md.push( + `[${getType(model.indexType, "none", wrapBackticks, hideLink, escape)}]` + ) } return md.join("") } @@ -380,3 +437,15 @@ export function hasTypes(parameters: TypeParameterReflection[]) { ) return !types.every((value) => !value) } + +function getShouldEscape(wrapBackticks: boolean, escape?: boolean) { + return escape === undefined ? !wrapBackticks : escape +} + +function getFormattedStr( + str: string, + wrapBackticks: boolean, + escape?: boolean +) { + return wrapBackticks ? `\`${str}\`` : escape ? escapeChars(str) : str +} diff --git a/packages/medusa-js/src/request.ts b/packages/medusa-js/src/request.ts index 525e682374..2f98064308 100644 --- a/packages/medusa-js/src/request.ts +++ b/packages/medusa-js/src/request.ts @@ -24,12 +24,15 @@ export interface Config { * @interface * * Options to pass to requests sent to custom API Routes - * - * @prop timeout - The number of milliseconds before the request times out. - * @prop numberOfRetries - The number of times to retry a request before failing. */ export interface RequestOptions { + /** + * The number of milliseconds before the request times out. + */ timeout?: number + /** + * The number of times to retry a request before failing. + */ numberOfRetries?: number } diff --git a/packages/medusa/src/types/common.ts b/packages/medusa/src/types/common.ts index ba002da6a0..a8aaecdf41 100644 --- a/packages/medusa/src/types/common.ts +++ b/packages/medusa/src/types/common.ts @@ -142,12 +142,21 @@ export type RequestQueryFields = { * @interface * * Pagination fields returned in the response of an API route. - * - * @prop limit - The maximum number of items that can be returned in the list. - * @prop offset - The number of items skipped before the returned items in the list. - * @prop count - The total number of items available. */ -export type PaginatedResponse = { limit: number; offset: number; count: number } +export type PaginatedResponse = { + /** + * The maximum number of items that can be returned in the list. + */ + limit: number + /** + * The number of items skipped before the returned items in the list. + */ + offset: number + /** + * The total number of items available. + */ + count: number +} /** * @interface diff --git a/packages/types/src/common/common.ts b/packages/types/src/common/common.ts index b7f11f375a..a4bea500d3 100644 --- a/packages/types/src/common/common.ts +++ b/packages/types/src/common/common.ts @@ -45,23 +45,33 @@ export type Writable = { * * An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class, * which provides correct typing of field names in its properties. - * - * @prop select - An array of strings, each being attribute names of the entity to retrieve in the result. - * @prop skip - A number indicating the number of records to skip before retrieving the results. - * @prop take - A number indicating the number of records to return in the result. - * @prop relations - An array of strings, each being relation names of the entity to retrieve in the result. - * @prop order - - * An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` - * to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order. - * @prop withDeleted - A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the - * `SoftDeletableEntity` class. */ export interface FindConfig { + /** + * An array of strings, each being attribute names of the entity to retrieve in the result. + */ select?: (keyof Entity | string)[] + /** + * A number indicating the number of records to skip before retrieving the results. + */ skip?: number + /** + * A number indicating the number of records to return in the result. + */ take?: number + /** + * An array of strings, each being relation names of the entity to retrieve in the result. + */ relations?: string[] + /** + * An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` + * to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order. + */ order?: { [K: string]: "ASC" | "DESC" } + /** + * A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the + * `SoftDeletableEntity` class. + */ withDeleted?: boolean } diff --git a/packages/types/src/dal/index.ts b/packages/types/src/dal/index.ts index 92f8da2702..32531476c6 100644 --- a/packages/types/src/dal/index.ts +++ b/packages/types/src/dal/index.ts @@ -6,12 +6,15 @@ export { FilterQuery } from "./utils" * @interface * * An object used to allow specifying flexible queries with and/or conditions. - * - * @prop $and - An array of filters to apply on the entity, where each item in the array is joined with an "and" condition. - * @prop $or - An array of filters to apply on the entity, where each item in the array is joined with an "or" condition. */ export interface BaseFilterable { + /** + * An array of filters to apply on the entity, where each item in the array is joined with an "and" condition. + */ $and?: (T | BaseFilterable)[] + /** + * An array of filters to apply on the entity, where each item in the array is joined with an "or" condition. + */ $or?: (T | BaseFilterable)[] } diff --git a/packages/types/src/dal/repository-service.ts b/packages/types/src/dal/repository-service.ts index 52f1dbe09d..483b8d50ff 100644 --- a/packages/types/src/dal/repository-service.ts +++ b/packages/types/src/dal/repository-service.ts @@ -83,10 +83,11 @@ export interface TreeRepositoryService * @interface * * An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted. - * - * @prop returnLinkableKeys - An array of strings, each being the ID attribute names of the entity's relations. */ export type SoftDeleteReturn = { + /** + * An array of strings, each being the ID attribute names of the entity's relations. + */ returnLinkableKeys?: TReturnableLinkableKeys[] } @@ -94,9 +95,10 @@ export type SoftDeleteReturn = { * @interface * * An object that is used to specify an entity's related entities that should be restored when the main entity is restored. - * - * @prop returnLinkableKeys - An array of strings, each being the ID attribute names of the entity's relations. */ export type RestoreReturn = { + /** + * An array of strings, each being the ID attribute names of the entity's relations. + */ returnLinkableKeys?: TReturnableLinkableKeys[] } diff --git a/packages/types/src/inventory/common.ts b/packages/types/src/inventory/common.ts index a53689d314..1e23557240 100644 --- a/packages/types/src/inventory/common.ts +++ b/packages/types/src/inventory/common.ts @@ -206,16 +206,11 @@ export type InventoryLevelDTO = { * @interface * * The filters to apply on retrieved reservation items. - * - * @prop id - The IDs to filter reservation items by. - * @prop line_item_id - Filter reservation items by the ID of their associated line item. - * @prop inventory_item_id - Filter reservation items by the ID of their associated inventory item. - * @prop location_id - Filter reservation items by the ID of their associated location. - * @prop description - Description filters to apply on the reservation items' `description` attribute. - * @prop created_by - The "created by" values to filter reservation items by. - * @prop quantity - Filters to apply on the reservation items' `quantity` attribute. */ export type FilterableReservationItemProps = { + /** + * The IDs to filter reservation items by. + */ id?: string | string[] /** * @ignore @@ -224,11 +219,29 @@ export type FilterableReservationItemProps = { * This property is not used. */ type?: string | string[] + /** + * Filter reservation items by the ID of their associated line item. + */ line_item_id?: string | string[] + /** + * Filter reservation items by the ID of their associated inventory item. + */ inventory_item_id?: string | string[] + /** + * Filter reservation items by the ID of their associated location. + */ location_id?: string | string[] + /** + * Description filters to apply on the reservation items' `description` attribute. + */ description?: string | StringComparisonOperator + /** + * The "created by" values to filter reservation items by. + */ created_by?: string | string[] + /** + * Filters to apply on the reservation items' `quantity` attribute. + */ quantity?: number | NumericalComparisonOperator } @@ -236,22 +249,35 @@ export type FilterableReservationItemProps = { * @interface * * The filters to apply on retrieved inventory items. - * - * @prop id - The IDs to filter inventory items by. - * @prop location_id - Filter inventory items by the ID of their associated location. - * @prop q - Search term to search inventory items' attributes. - * @prop sku - The SKUs to filter inventory items by. - * @prop origin_country - The origin country to filter inventory items by. - * @prop hs_code - The HS Codes to filter inventory items by. - * @prop requires_shipping - Filter inventory items by whether they require shipping. */ export type FilterableInventoryItemProps = { + /** + * The IDs to filter inventory items by. + */ id?: string | string[] + /** + * Filter inventory items by the ID of their associated location. + */ location_id?: string | string[] + /** + * Search term to search inventory items' attributes. + */ q?: string + /** + * The SKUs to filter inventory items by. + */ sku?: string | string[] | StringComparisonOperator + /** + * The origin country to filter inventory items by. + */ origin_country?: string | string[] + /** + * The HS Codes to filter inventory items by. + */ hs_code?: string | string[] | StringComparisonOperator + /** + * Filter inventory items by whether they require shipping. + */ requires_shipping?: boolean } @@ -259,36 +285,63 @@ export type FilterableInventoryItemProps = { * @interface * * The details of the inventory item to be created. - * - * @prop sku - The SKU of the inventory item. - * @prop origin_country - The origin country of the inventory item. - * @prop mid_code - The MID code of the inventory item. - * @prop material - The material of the inventory item. - * @prop weight - The weight of the inventory item. - * @prop length - The length of the inventory item. - * @prop height - The height of the inventory item. - * @prop width - The width of the inventory item. - * @prop title - The title of the inventory item. - * @prop description - The description of the inventory item. - * @prop thumbnail - The thumbnail of the inventory item. - * @prop metadata - Holds custom data in key-value pairs. - * @prop hs_code - The HS code of the inventory item. - * @prop requries_shipping - Whether the inventory item requires shipping. */ export type CreateInventoryItemInput = { + /** + * The SKU of the inventory item. + */ sku?: string | null + /** + * The origin country of the inventory item. + */ origin_country?: string | null + /** + * The MID code of the inventory item. + */ mid_code?: string | null + /** + * The material of the inventory item. + */ material?: string | null + /** + * The weight of the inventory item. + */ weight?: number | null + /** + * The length of the inventory item. + */ length?: number | null + /** + * The height of the inventory item. + */ height?: number | null + /** + * The width of the inventory item. + */ width?: number | null + /** + * The title of the inventory item. + */ title?: string | null + /** + * The description of the inventory item. + */ description?: string | null + /** + * The thumbnail of the inventory item. + */ thumbnail?: string | null + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * The HS code of the inventory item. + */ hs_code?: string | null + /** + * Whether the inventory item requires shipping. + */ requires_shipping?: boolean } @@ -296,24 +349,39 @@ export type CreateInventoryItemInput = { * @interface * * The details of the reservation item to be created. - * - * @prop line_item_id - The ID of the associated line item. - * @prop inventory_item_id - The ID of the associated inventory item. - * @prop location_id - The ID of the associated location. - * @prop quantity - The reserved quantity. - * @prop description - The description of the reservation. - * @prop created_by - The user or system that created the reservation. Can be any form of identification string. - * @prop external_id - An ID associated with an external third-party system that the reservation item is connected to. - * @prop metadata - Holds custom data in key-value pairs. */ export type CreateReservationItemInput = { + /** + * The ID of the associated line item. + */ line_item_id?: string + /** + * The ID of the associated inventory item. + */ inventory_item_id: string + /** + * The ID of the associated location. + */ location_id: string + /** + * The reserved quantity. + */ quantity: number + /** + * The description of the reservation. + */ description?: string + /** + * The user or system that created the reservation. Can be any form of identification string. + */ created_by?: string + /** + * An ID associated with an external third-party system that the reservation item is connected to. + */ external_id?: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null } @@ -321,18 +389,27 @@ export type CreateReservationItemInput = { * @interface * * The filters to apply on retrieved inventory levels. - * - * @prop inventory_item_id - Filter inventory levels by the ID of their associated inventory item. - * @prop location_id - Filter inventory levels by the ID of their associated inventory location. - * @prop stocked_quantity - Filters to apply on inventory levels' `stocked_quantity` attribute. - * @prop reserved_quantity - Filters to apply on inventory levels' `reserved_quantity` attribute. - * @prop incoming_quantity - Filters to apply on inventory levels' `incoming_quantity` attribute. */ export type FilterableInventoryLevelProps = { + /** + * Filter inventory levels by the ID of their associated inventory item. + */ inventory_item_id?: string | string[] + /** + * Filter inventory levels by the ID of their associated inventory location. + */ location_id?: string | string[] + /** + * Filters to apply on inventory levels' `stocked_quantity` attribute. + */ stocked_quantity?: number | NumericalComparisonOperator + /** + * Filters to apply on inventory levels' `reserved_quantity` attribute. + */ reserved_quantity?: number | NumericalComparisonOperator + /** + * Filters to apply on inventory levels' `incoming_quantity` attribute. + */ incoming_quantity?: number | NumericalComparisonOperator } @@ -340,18 +417,27 @@ export type FilterableInventoryLevelProps = { * @interface * * The details of the inventory level to be created. - * - * @prop inventory_item_id - The ID of the associated inventory item. - * @prop location_id - The ID of the associated location. - * @prop stocked_quantity - The stocked quantity of the associated inventory item in the associated location. - * @prop reserved_quantity - The reserved quantity of the associated inventory item in the associated location. - * @prop incoming_quantity - The incoming quantity of the associated inventory item in the associated location. */ export type CreateInventoryLevelInput = { + /** + * The ID of the associated inventory item. + */ inventory_item_id: string + /** + * The ID of the associated location. + */ location_id: string + /** + * The stocked quantity of the associated inventory item in the associated location. + */ stocked_quantity: number + /** + * The reserved quantity of the associated inventory item in the associated location. + */ reserved_quantity?: number + /** + * The incoming quantity of the associated inventory item in the associated location. + */ incoming_quantity?: number } @@ -359,12 +445,15 @@ export type CreateInventoryLevelInput = { * @interface * * The attributes to update in an inventory level. - * - * @prop stocked_quantity - The stocked quantity of the associated inventory item in the associated location. - * @prop incoming_quantity - The incoming quantity of the associated inventory item in the associated location. */ export type UpdateInventoryLevelInput = { + /** + * The stocked quantity of the associated inventory item in the associated location. + */ stocked_quantity?: number + /** + * The incoming quantity of the associated inventory item in the associated location. + */ incoming_quantity?: number } @@ -372,12 +461,15 @@ export type UpdateInventoryLevelInput = { * @interface * * The attributes to update in an inventory level. The inventory level is identified by the IDs of its associated inventory item and location. - * - * @prop inventory_item_id - The ID of the associated inventory level. - * @prop location_id - The ID of the associated location. */ export type BulkUpdateInventoryLevelInput = { + /** + * The ID of the associated inventory level. + */ inventory_item_id: string + /** + * The ID of the associated location. + */ location_id: string } & UpdateInventoryLevelInput @@ -385,16 +477,23 @@ export type BulkUpdateInventoryLevelInput = { * @interface * * The attributes to update in a reservation item. - * - * @prop quantity - The reserved quantity. - * @prop location_id - The ID of the associated location. - * @prop description - The description of the reservation item. - * @prop metadata - Holds custom data in key-value pairs. */ export type UpdateReservationItemInput = { + /** + * The reserved quantity. + */ quantity?: number + /** + * The ID of the associated location. + */ location_id?: string + /** + * The description of the reservation item. + */ description?: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null } diff --git a/packages/types/src/product/common.ts b/packages/types/src/product/common.ts index 279cecfb9d..27184f1d79 100644 --- a/packages/types/src/product/common.ts +++ b/packages/types/src/product/common.ts @@ -15,65 +15,138 @@ export enum ProductStatus { * @interface * * A product's data. - * @prop id - The ID of the product. - * @prop title - The title of the product. - * @prop handle - The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`. - * @prop subtitle - The subttle of the product. It can possibly be `null`. - * @prop description - The description of the product. It can possibly be `null`. - * @prop is_giftcard - Whether the product is a gift card. - * @prop status - The status of the product. Its value can be one of the values of the enum {@link ProductStatus}. - * @prop thumbnail - The URL of the product's thumbnail. It can possibly be `null`. - * @prop weight - The weight of the product. It can possibly be `null`. - * @prop length - The length of the product. It can possibly be `null`. - * @prop height - The height of the product. It can possibly be `null`. - * @prop origin_country - The origin country of the product. It can possibly be `null`. - * @prop hs_code - The HS Code of the product. It can possibly be `null`. - * @prop mid_code - The MID Code of the product. It can possibly be `null`. - * @prop material - The material of the product. It can possibly be `null`. - * @prop collection - The associated product collection. It may only be available if the `collection` relation is expanded. - * @prop categories -The associated product categories. It may only be available if the `categories` relation is expanded. - * @prop type - The associated product type. It may only be available if the `type` relation is expanded. - * @prop tags - The associated product tags. It may only be available if the `tags` relation is expanded. - * @prop variants - The associated product variants. It may only be available if the `variants` relation is expanded. - * @prop options - The associated product options. It may only be available if the `options` relation is expanded. - * @prop images - The associated product images. It may only be available if the `images` relation is expanded. - * @prop discountable - Whether the product can be discounted. - * @prop external_id - - * The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain - * a reference to the ID in the integrated service. - * @prop created_at - When the product was created. - * @prop updated_at - When the product was updated. - * @prop deleted_at - When the product was deleted. */ export interface ProductDTO { + /** + * The ID of the product. + */ id: string + /** + * The title of the product. + */ title: string + /** + * The handle of the product. The handle can be used to create slug URL paths. + */ handle?: string | null + /** + * The subttle of the product. + */ subtitle?: string | null + /** + * The description of the product. + */ description?: string | null + /** + * Whether the product is a gift card. + */ is_giftcard: boolean + /** + * The status of the product. + */ status: ProductStatus + /** + * The URL of the product's thumbnail. + */ thumbnail?: string | null + /** + * The width of the product. + */ width?: number | null + /** + * The weight of the product. + */ weight?: number | null + /** + * The length of the product. + */ length?: number | null + /** + * The height of the product. + */ height?: number | null + /** + * The origin country of the product. + */ origin_country?: string | null + /** + * The HS Code of the product. + */ hs_code?: string | null + /** + * The MID Code of the product. + */ mid_code?: string | null + /** + * The material of the product. + */ material?: string | null + /** + * The associated product collection. + * + * @expandable + */ collection: ProductCollectionDTO + /** + * The associated product categories. + * + * @expandable + */ categories?: ProductCategoryDTO[] | null + /** + * The associated product type. + * + * @expandable + */ type: ProductTypeDTO[] + /** + * The associated product tags. + * + * @expandable + */ tags: ProductTagDTO[] + /** + * The associated product variants. + * + * @expandable + */ variants: ProductVariantDTO[] + /** + * The associated product options. + * + * @expandable + */ options: ProductOptionDTO[] + /** + * The associated product images. + * + * @expandable + */ images: ProductImageDTO[] + /** + * Whether the product can be discounted. + */ discountable?: boolean + /** + * The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain + * a reference to the ID in the integrated service. + */ external_id?: string | null + /** + * When the product was created. + */ created_at?: string | Date + /** + * When the product was updated. + */ updated_at?: string | Date + /** + * When the product was deleted. + */ deleted_at?: string | Date + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -81,58 +154,111 @@ export interface ProductDTO { * @interface * * A product variant's data. - * - * @prop id - The ID of the product variant. - * @prop title - The tile of the product variant. - * @prop sku - The SKU of the product variant. It can possibly be `null`. - * @prop barcode - The barcode of the product variant. It can possibly be `null`. - * @prop ean - The EAN of the product variant. It can possibly be `null`. - * @prop upc - The UPC of the product variant. It can possibly be `null`. - * @prop inventory_quantity - The inventory quantiy of the product variant. - * @prop allow_backorder - Whether the product variant can be ordered when it's out of stock. - * @prop manage_inventory - Whether the product variant's inventory should be managed by the core system. - * @prop hs_code - The HS Code of the product variant. It can possibly be `null`. - * @prop origin_country - The origin country of the product variant. It can possibly be `null`. - * @prop mid_code - The MID Code of the product variant. It can possibly be `null`. - * @prop material - The material of the product variant. It can possibly be `null`. - * @prop weight - The weight of the product variant. It can possibly be `null`. - * @prop length - The length of the product variant. It can possibly be `null`. - * @prop height - The height of the product variant. It can possibly be `null`. - * @prop width - The width of the product variant. It can possibly be `null`. - * @prop options - The associated product options. It may only be available if the `options` relation is expanded. - * @prop metadata - Holds custom data in key-value pairs. - * @prop product - The associated product. It may only be available if the `product` relation is expanded. - * @prop product_id - The ID of the associated product. - * @prop variant_rank - The ranking of the variant among other variants associated with the product. It can possibly be `null`. - * @prop created_at - When the product variant was created. - * @prop updated_at - When the product variant was updated. - * @prop deleted_at - When the product variant was deleted. */ export interface ProductVariantDTO { + /** + * The ID of the product variant. + */ id: string + /** + * The tile of the product variant. + */ title: string + /** + * The SKU of the product variant. + */ sku?: string | null + /** + * The barcode of the product variant. + */ barcode?: string | null + /** + * The EAN of the product variant. + */ ean?: string | null + /** + * The UPC of the product variant. + */ upc?: string | null + /** + * The inventory quantiy of the product variant. + */ inventory_quantity: number + /** + * Whether the product variant can be ordered when it's out of stock. + */ allow_backorder?: boolean + /** + * Whether the product variant's inventory should be managed by the core system. + */ manage_inventory?: boolean + /** + * The HS Code of the product variant. + */ hs_code?: string | null + /** + * The origin country of the product variant. + */ origin_country?: string | null + /** + * The MID Code of the product variant. + */ mid_code?: string | null + /** + * The material of the product variant. + */ material?: string | null + /** + * The weight of the product variant. + */ weight?: number | null + /** + * The length of the product variant. + */ length?: number | null + /** + * The height of the product variant. + */ height?: number | null + /** + * The width of the product variant. + */ width?: number | null + /** + * The associated product options. + * + * @expandable + */ options: ProductOptionValueDTO + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * The associated product. + * + * @expandable + */ product: ProductDTO + /** + * The ID of the associated product. + */ product_id: string + /** + * he ranking of the variant among other variants associated with the product. + */ variant_rank?: number | null + /** + * When the product variant was created. + */ created_at: string | Date + /** + * When the product variant was updated. + */ updated_at: string | Date + /** + * When the product variant was deleted. + */ deleted_at: string | Date } @@ -140,30 +266,55 @@ export interface ProductVariantDTO { * @interface * * A product category's data. - * - * @prop id - The ID of the product category. - * @prop name - The name of the product category. - * @prop description - The description of the product category. - * @prop handle - The handle of the product category. The handle can be used to create slug URL paths. - * @prop is_active - Whether the product category is active. - * @prop is_internal - Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers. - * @prop rank - The ranking of the product category among sibling categories. - * @prop parent_category - The associated parent category. It may only be available if the `parent_category` relation is expanded. - * @prop category_children - The associated child categories. It may only be available if the `category_children` relation is expanded. - * @prop created_at - When the product category was created. - * @prop updated_at - When the product category was updated. */ export interface ProductCategoryDTO { + /** + * The ID of the product category. + */ id: string + /** + * The name of the product category. + */ name: string + /** + * The description of the product category. + */ description?: string + /** + * The handle of the product category. The handle can be used to create slug URL paths. + */ handle?: string + /** + * Whether the product category is active. + */ is_active?: boolean + /** + * Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers. + */ is_internal?: boolean + /** + * The ranking of the product category among sibling categories. + */ rank?: number + /** + * The associated parent category. + * + * @expandable + */ parent_category?: ProductCategoryDTO + /** + * The associated child categories. + * + * @expandable + */ category_children: ProductCategoryDTO[] + /** + * When the product category was created. + */ created_at: string | Date + /** + * When the product category was updated. + */ updated_at: string | Date } @@ -171,22 +322,35 @@ export interface ProductCategoryDTO { * @interface * * A product category to create. - * - * @prop name - The product category's name. - * @prop handle - The product category's handle. - * @prop is_active - Whether the product category is active. - * @prop is_internal - Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers. - * @prop rank - The ranking of the category among sibling categories. - * @prop parent_category_id - The ID of the parent product category, if it has any. It may also be `null`. - * @prop metadata - Holds custom data in key-value pairs. */ export interface CreateProductCategoryDTO { + /** + * The product category's name. + */ name: string + /** + * The product category's handle. + */ handle?: string + /** + * Whether the product category is active. + */ is_active?: boolean + /** + * Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers. + */ is_internal?: boolean + /** + * The ranking of the category among sibling categories. + */ rank?: number + /** + * The ID of the parent product category, if it has any. + */ parent_category_id: string | null + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -194,22 +358,35 @@ export interface CreateProductCategoryDTO { * @interface * * The data to update in a product category. - * - * @prop name - The name of the product category. - * @prop handle - The handle of the product category. - * @prop is_active - Whether the product category is active. - * @prop is_internal - Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers. - * @prop rank - The ranking of the category among sibling categories. - * @prop parent_category_id - The ID of the parent product category, if it has any. It may also be `null`. - * @prop metadata - Holds custom data in key-value pairs. */ export interface UpdateProductCategoryDTO { + /** + * The name of the product category. + */ name?: string + /** + * The handle of the product category. + */ handle?: string + /** + * Whether the product category is active. + */ is_active?: boolean + /** + * Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers. + */ is_internal?: boolean + /** + * The ranking of the category among sibling categories. + */ rank?: number + /** + * The ID of the parent product category, if it has any. + */ parent_category_id?: string | null + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -217,16 +394,25 @@ export interface UpdateProductCategoryDTO { * @interface * * A product tag's data. - * - * @prop id - The ID of the product tag. - * @prop value - The value of the product tag. - * @prop metadata - Holds custom data in key-value pairs. - * @prop products - The associated products. It may only be available if the `products` relation is expanded. */ export interface ProductTagDTO { + /** + * The ID of the product tag. + */ id: string + /** + * The value of the product tag. + */ value: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * The associated products. + * + * @expandable + */ products?: ProductDTO[] } @@ -234,20 +420,33 @@ export interface ProductTagDTO { * @interface * * A product collection's data. - * - * @prop id - The ID of the product collection. - * @prop title - The title of the product collection. - * @prop handle - The handle of the product collection. The handle can be used to create slug URL paths. - * @prop metadata - Holds custom data in key-value pairs. - * @prop deleted_at - When the product collection was deleted. - * @prop products - The associated products. It may only be available if the `products` relation is expanded. */ export interface ProductCollectionDTO { + /** + * The ID of the product collection. + */ id: string + /** + * The title of the product collection. + */ title: string + /** + * The handle of the product collection. The handle can be used to create slug URL paths. + */ handle: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * When the product collection was deleted. + */ deleted_at?: string | Date + /** + * The associated products. + * + * @expandable + */ products?: ProductDTO[] } @@ -255,16 +454,23 @@ export interface ProductCollectionDTO { * @interface * * A product type's data. - * - * @prop id - The ID of the product type. - * @prop value - The value of the product type. - * @prop metadata - Holds custom data in key-value pairs. - * @prop deleted_at - When the product type was deleted. */ export interface ProductTypeDTO { + /** + * The ID of the product type. + */ id: string + /** + * The value of the product type. + */ value: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * When the product type was deleted. + */ deleted_at?: string | Date } @@ -273,20 +479,35 @@ export interface ProductTypeDTO { * * A product option's data. * - * @prop id - The ID of the product option. - * @prop title - The title of the product option. - * @prop product - The associated product. It may only be available if the `product` relation is expanded. - * @prop values - The associated product option values. It may only be available if the `values` relation is expanded. - * @prop metadata - Holds custom data in key-value pairs. - * @prop deleted_at - When the product option was deleted. - * */ export interface ProductOptionDTO { + /** + * The ID of the product option. + */ id: string + /** + * The title of the product option. + */ title: string + /** + * The associated product. + * + * @expandable + */ product: ProductDTO + /** + * The associated product option values. + * + * @expandable + */ values: ProductOptionValueDTO[] + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * When the product option was deleted. + */ deleted_at?: string | Date } @@ -294,16 +515,23 @@ export interface ProductOptionDTO { * @interface * * The product image's data. - * - * @prop id - The ID of the product image. - * @prop url - The URL of the product image. - * @prop metadata - Holds custom data in key-value pairs. - * @prop deleted_at - When the product image was deleted. */ export interface ProductImageDTO { + /** + * The ID of the product image. + */ id: string + /** + * The URL of the product image. + */ url: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * When the product image was deleted. + */ deleted_at?: string | Date } @@ -311,20 +539,35 @@ export interface ProductImageDTO { * @interface * * The product option value's data. - * - * @prop id - The ID of the product option value. - * @prop value - The value of the product option value. - * @prop option - The associated product option. It may only be available if the `option` relation is expanded. - * @prop variant - The associated product variant. It may only be available if the `variant` relation is expanded. - * @prop metadata - Holds custom data in key-value pairs. - * @prop deleted_at - When the product option value was deleted. */ export interface ProductOptionValueDTO { + /** + * The ID of the product option value. + */ id: string + /** + * The value of the product option value. + */ value: string + /** + * The associated product option. + * + * @expandable + */ option: ProductOptionDTO + /** + * The associated product variant. + * + * @expandable + */ variant: ProductVariantDTO + /** + * Holds custom data in key-value pairs. + */ metadata?: Record | null + /** + * When the product option value was deleted. + */ deleted_at?: string | Date } @@ -332,26 +575,54 @@ export interface ProductOptionValueDTO { * @interface * * The filters to apply on retrieved products. - * - * @prop q - Search through the products' attributes, such as titles and descriptions, using this search term. - * @prop handle - The handles to filter products by. - * @prop id - The IDs to filter products by. - * @prop tags - Filters on a product's tags. - * @prop categories - Filters on a product's categories. - * @prop collection_id - Filters a product by its associated collections. */ export interface FilterableProductProps extends BaseFilterable { + /** + * Search through the products' attributes, such as titles and descriptions, using this search term. + */ q?: string + /** + * The handles to filter products by. + */ handle?: string | string[] + /** + * The IDs to filter products by. + */ id?: string | string[] - tags?: { value?: string[] } + /** + * Filters on a product's tags. + */ + tags?: { + /** + * Values to filter product tags by. + */ + value?: string[] + } + /** + * Filters on a product's categories. + */ categories?: { + /** + * IDs to filter categories by. + */ id?: string | string[] | OperatorMap + /** + * Filter categories by whether they're internal + */ is_internal?: boolean + /** + * Filter categories by whether they're active. + */ is_active?: boolean } + /** + * Filter a product by the IDs of their associated categories. + */ category_id?: string | string[] | OperatorMap + /** + * Filters a product by the IDs of their associated collections. + */ collection_id?: string | string[] | OperatorMap } @@ -359,13 +630,16 @@ export interface FilterableProductProps * @interface * * The filters to apply on retrieved product tags. - * - * @prop id - The IDs to filter product tags by. - * @prop value - The value to filter product tags by. */ export interface FilterableProductTagProps extends BaseFilterable { + /** + * The IDs to filter product tags by. + */ id?: string | string[] + /** + * The value to filter product tags by. + */ value?: string } @@ -373,13 +647,16 @@ export interface FilterableProductTagProps * @interface * * The filters to apply on retrieved product types. - * - * @prop id - The IDs to filter product types by. - * @prop value - The value to filter product types by. */ export interface FilterableProductTypeProps extends BaseFilterable { + /** + * The IDs to filter product types by. + */ id?: string | string[] + /** + * The value to filter product types by. + */ value?: string } @@ -387,15 +664,20 @@ export interface FilterableProductTypeProps * @interface * * The filters to apply on retrieved product options. - * - * @prop id - The IDs to filter product options by. - * @prop title - The titles to filter product options by. - * @prop product_id - Filter the product options by their associated products' IDs. */ export interface FilterableProductOptionProps extends BaseFilterable { + /** + * The IDs to filter product options by. + */ id?: string | string[] + /** + * The titles to filter product options by. + */ title?: string + /** + * Filter the product options by their associated products' IDs. + */ product_id?: string | string[] } @@ -403,14 +685,20 @@ export interface FilterableProductOptionProps * @interface * * The filters to apply on retrieved product collections. - * - * @prop id - The IDs to filter product collections by. - * @prop title - The title to filter product collections by. */ export interface FilterableProductCollectionProps extends BaseFilterable { + /** + * The IDs to filter product collections by. + */ id?: string | string[] + /** + * The handles to filter product collections by. + */ handle?: string | string[] + /** + * The title to filter product collections by. + */ title?: string } @@ -418,41 +706,66 @@ export interface FilterableProductCollectionProps * @interface * * The filters to apply on retrieved product variants. - * - * @prop id - The IDs to filter product variants by. - * @prop sku - The SKUs to filter product variants by. - * @prop product_id - Filter the product variants by their associated products' IDs. - * @prop options - Filter product variants by their associated options. */ export interface FilterableProductVariantProps extends BaseFilterable { + /** + * The IDs to filter product variants by. + */ id?: string | string[] + /** + * The SKUs to filter product variants by. + */ sku?: string | string[] + /** + * Filter the product variants by their associated products' IDs. + */ product_id?: string | string[] - options?: { id?: string[] } + /** + * Filter product variants by their associated options. + */ + options?: { + /** + * IDs to filter options by. + */ + id?: string[] + } } /** * @interface * * The filters to apply on retrieved product categories. - * - * @prop id - The IDs to filter product categories by. - * @prop name - The names to filter product categories by. - * @prop parent_category_id - Filter product categories by their parent category's ID. - * @prop handle - The handles to filter product categories by. - * @prop is_active - Filter product categories by whether they're active. - * @prop is_internal - Filter product categories by whether they're internal. - * @prop include_descendants_tree - Whether to include children of retrieved product categories. */ export interface FilterableProductCategoryProps extends BaseFilterable { + /** + * The IDs to filter product categories by. + */ id?: string | string[] + /** + * The names to filter product categories by. + */ name?: string | string[] + /** + * Filter product categories by their parent category's ID. + */ parent_category_id?: string | string[] | null + /** + * The handles to filter product categories by. + */ handle?: string | string[] + /** + * Filter product categories by whether they're active. + */ is_active?: boolean + /** + * Filter product categories by whether they're internal. + */ is_internal?: boolean + /** + * Whether to include children of retrieved product categories. + */ include_descendants_tree?: boolean } @@ -460,16 +773,23 @@ export interface FilterableProductCategoryProps * @interface * * A product collection to create. - * - * @prop title - The product collection's title. - * @prop handle - The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title. - * @prop products - The products to associate with the collection. - * @prop metadata - Holds custom data in key-value pairs. */ export interface CreateProductCollectionDTO { + /** + * The product collection's title. + */ title: string + /** + * The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title. + */ handle?: string + /** + * The products to associate with the collection. + */ product_ids?: string[] + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -477,20 +797,31 @@ export interface CreateProductCollectionDTO { * @interface * * The data to update in a product collection. The `id` is used to identify which product collection to update. - * - * @prop id - The ID of the product collection to update. - * @prop value - The value of the product collection. - * @prop title - The title of the product collection. - * @prop handle - The handle of the product collection. - * @prop product_ids - The IDs of the products to associate with the product collection. - * @prop metadata - Holds custom data in key-value pairs. */ export interface UpdateProductCollectionDTO { + /** + * The ID of the product collection to update. + */ id: string + /** + * The value of the product collection. + */ value?: string + /** + * The title of the product collection. + */ title?: string + /** + * The handle of the product collection. + */ handle?: string + /** + * The IDs of the products to associate with the product collection. + */ product_ids?: string[] + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -498,14 +829,19 @@ export interface UpdateProductCollectionDTO { * @interface * * A product type to create. - * - * @prop id - The product type's ID. - * @prop value - The product type's value. - * @prop metadata - Holds custom data in key-value pairs. */ export interface CreateProductTypeDTO { + /** + * The product type's ID. + */ id?: string + /** + * The product type's value. + */ value: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -518,14 +854,19 @@ export interface UpsertProductTypeDTO { * @interface * * The data to update in a product type. The `id` is used to identify which product type to update. - * - * @prop id - The ID of the product type to update. - * @prop value - The new value of the product type. - * @prop metadata - Holds custom data in key-value pairs. */ export interface UpdateProductTypeDTO { + /** + * The ID of the product type to update. + */ id: string + /** + * The new value of the product type. + */ value?: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -533,10 +874,11 @@ export interface UpdateProductTypeDTO { * @interface * * A product tag to create. - * - * @prop value - The value of the product tag. */ export interface CreateProductTagDTO { + /** + * The value of the product tag. + */ value: string } @@ -550,12 +892,15 @@ export interface UpsertProductTagDTO { * @interface * * The data to update in a product tag. The `id` is used to identify which product tag to update. - * - * @prop id - The ID of the product tag to update. - * @prop value - The value of the product tag. */ export interface UpdateProductTagDTO { + /** + * The ID of the product tag to update. + */ id: string + /** + * The value of the product tag. + */ value?: string } @@ -563,12 +908,15 @@ export interface UpdateProductTagDTO { * @interface * * A product option to create. - * - * @prop title - The product option's title. - * @prop product_id - The ID of the associated product. */ export interface CreateProductOptionDTO { + /** + * The product option's title. + */ title: string + /** + * The ID of the associated product. + */ product_id?: string } @@ -582,10 +930,11 @@ export interface UpdateProductOptionDTO { * @interface * * A product variant option to create. - * - * @prop value - The value of a product variant option. */ export interface CreateProductVariantOptionDTO { + /** + * The value of a product variant option. + */ value: string } @@ -593,44 +942,79 @@ export interface CreateProductVariantOptionDTO { * @interface * * A product variant to create. - * - * @prop title - The tile of the product variant. - * @prop sku - The SKU of the product variant. - * @prop barcode - The barcode of the product variant. - * @prop ean - The EAN of the product variant. - * @prop upc - The UPC of the product variant. - * @prop allow_backorder - Whether the product variant can be ordered when it's out of stock. - * @prop inventory_quantity - The inventory quantiy of the product variant. - * @prop manage_inventory - Whether the product variant's inventory should be managed by the core system. - * @prop hs_code - The HS Code of the product variant. - * @prop origin_country - The origin country of the product variant. - * @prop mid_code - The MID Code of the product variant. - * @prop material - The material of the product variant. - * @prop weight - The weight of the product variant. - * @prop length - The length of the product variant. - * @prop height - The height of the product variant. - * @prop width - The width of the product variant. - * @prop options - The product variant options to create and associate with the product variant. - * @prop metadata - Holds custom data in key-value pairs. */ export interface CreateProductVariantDTO { + /** + * The tile of the product variant. + */ title: string + /** + * The SKU of the product variant. + */ sku?: string + /** + * The barcode of the product variant. + */ barcode?: string + /** + * The EAN of the product variant. + */ ean?: string + /** + * The UPC of the product variant. + */ upc?: string + /** + * Whether the product variant can be ordered when it's out of stock. + */ allow_backorder?: boolean + /** + * The inventory quantiy of the product variant. + */ inventory_quantity?: number + /** + * Whether the product variant's inventory should be managed by the core system. + */ manage_inventory?: boolean + /** + * The HS Code of the product variant. + */ hs_code?: string + /** + * The origin country of the product variant. + */ origin_country?: string + /** + * The MID Code of the product variant. + */ mid_code?: string + /** + * The material of the product variant. + */ material?: string + /** + * The weight of the product variant. + */ weight?: number + /** + * The length of the product variant. + */ length?: number + /** + * The height of the product variant. + */ height?: number + /** + * The width of the product variant. + */ width?: number + /** + * The product variant options to create and associate with the product variant. + */ options?: CreateProductVariantOptionDTO[] + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -638,46 +1022,83 @@ export interface CreateProductVariantDTO { * @interface * * The data to update in a product variant. The `id` is used to identify which product variant to update. - * - * @prop id - The ID of the product variant to update. - * @prop title - The tile of the product variant. - * @prop sku - The SKU of the product variant. - * @prop barcode - The barcode of the product variant. - * @prop ean - The EAN of the product variant. - * @prop upc - The UPC of the product variant. - * @prop allow_backorder - Whether the product variant can be ordered when it's out of stock. - * @prop inventory_quantity - The inventory quantiy of the product variant. - * @prop manage_inventory - Whether the product variant's inventory should be managed by the core system. - * @prop hs_code - The HS Code of the product variant. - * @prop origin_country - The origin country of the product variant. - * @prop mid_code - The MID Code of the product variant. - * @prop material - The material of the product variant. - * @prop weight - The weight of the product variant. - * @prop length - The length of the product variant. - * @prop height - The height of the product variant. - * @prop width - The width of the product variant. - * @prop options - The product variant options to create and associate with the product variant. - * @prop metadata - Holds custom data in key-value pairs. */ export interface UpdateProductVariantDTO { + /** + * The ID of the product variant to update. + */ id: string + /** + * The tile of the product variant. + */ title?: string + /** + * The SKU of the product variant. + */ sku?: string + /** + * The barcode of the product variant. + */ barcode?: string + /** + * The EAN of the product variant. + */ ean?: string + /** + * The UPC of the product variant. + */ upc?: string + /** + * Whether the product variant can be ordered when it's out of stock. + */ allow_backorder?: boolean + /** + * The inventory quantiy of the product variant. + */ inventory_quantity?: number + /** + * Whether the product variant's inventory should be managed by the core system. + */ manage_inventory?: boolean + /** + * The HS Code of the product variant. + */ hs_code?: string + /** + * The origin country of the product variant. + */ origin_country?: string + /** + * The MID Code of the product variant. + */ mid_code?: string + /** + * The material of the product variant. + */ material?: string + /** + * The weight of the product variant. + */ weight?: number + /** + * The length of the product variant. + */ length?: number + /** + * The height of the product variant. + */ height?: number + /** + * The width of the product variant. + */ width?: number + /** + * The product variant options to create and associate with the product variant. + */ options?: CreateProductVariantOptionDTO[] + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -685,62 +1106,109 @@ export interface UpdateProductVariantDTO { * @interface * * A product to create. - * - * @prop title - The title of the product. - * @prop subtitle - The subttle of the product. - * @prop description - The description of the product. - * @prop is_giftcard - Whether the product is a gift card. - * @prop discountable - Whether the product can be discounted. - * @prop images - - * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created - * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`. - * @prop thumbnail - The URL of the product's thumbnail. - * @prop handle - - * The handle of the product. The handle can be used to create slug URL paths. - * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute. - * @prop status - The status of the product. Its value can be one of the values of the enum {@link ProductStatus}. - * @prop type - The product type to create and associate with the product. - * @prop type_id - The product type to be associated with the product. - * @prop collection_id - The product collection to be associated with the product. - * @prop tags - The product tags to be created and associated with the product. - * @prop categories - The product categories to associate with the product. - * @prop options - The product options to be created and associated with the product. - * @prop variants - The product variants to be created and associated with the product. - * @prop width - The width of the product. - * @prop height - The height of the product. - * @prop length - The length of the product. - * @prop weight - The weight of the product. - * @prop origin_country - The origin country of the product. - * @prop hs_code - The HS Code of the product. - * @prop material - The material of the product. - * @prop mid_code - The MID Code of the product. - * @prop metadata - Holds custom data in key-value pairs. */ export interface CreateProductDTO { + /** + * The title of the product. + */ title: string + /** + * The subttle of the product. + */ subtitle?: string + /** + * The description of the product. + */ description?: string + /** + * Whether the product is a gift card. + */ is_giftcard?: boolean + /** + * Whether the product can be discounted. + */ discountable?: boolean + /** + * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created + * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`. + */ images?: string[] | { id?: string; url: string }[] + /** + * The URL of the product's thumbnail. + */ thumbnail?: string + /** + * The handle of the product. The handle can be used to create slug URL paths. + * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute. + */ handle?: string + /** + * The status of the product. + */ status?: ProductStatus + /** + * The product type to create and associate with the product. + */ type?: CreateProductTypeDTO + /** + * The product type to be associated with the product. + */ type_id?: string + /** + * The product collection to be associated with the product. + */ collection_id?: string + /** + * The product tags to be created and associated with the product. + */ tags?: CreateProductTagDTO[] + /** + * The product categories to associate with the product. + */ categories?: { id: string }[] + /** + * The product options to be created and associated with the product. + */ options?: CreateProductOptionDTO[] + /** + * The product variants to be created and associated with the product. + */ variants?: CreateProductVariantDTO[] + /** + * The width of the product. + */ width?: number + /** + * The height of the product. + */ height?: number + /** + * The length of the product. + */ length?: number + /** + * The weight of the product. + */ weight?: number + /** + * The origin country of the product. + */ origin_country?: string + /** + * The HS Code of the product. + */ hs_code?: string + /** + * The material of the product. + */ material?: string + /** + * The MID Code of the product. + */ mid_code?: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } @@ -748,65 +1216,113 @@ export interface CreateProductDTO { * @interface * * The data to update in a product. The `id` is used to identify which product to update. - * - * @prop id - The ID of the product to update. - * @prop title - The title of the product. - * @prop subtitle - The subttle of the product. - * @prop description - The description of the product. - * @prop is_giftcard - Whether the product is a gift card. - * @prop discountable - Whether the product can be discounted. - * @prop images - - * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created - * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`. - * @prop thumbnail - The URL of the product's thumbnail. - * @prop handle - - * The handle of the product. The handle can be used to create slug URL paths. - * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute. - * @prop status - The status of the product. Its value can be one of the values of the enum {@link ProductStatus}. - * @prop type - The product type to create and associate with the product. - * @prop type_id - The product type to be associated with the product. - * @prop collection_id - The product collection to be associated with the product. - * @prop tags - The product tags to be created and associated with the product. - * @prop categories - The product categories to associate with the product. - * @prop options - The product options to be created and associated with the product. - * @prop variants - - * The product variants to be created and associated with the product. You can also update existing product variants associated with the product. - * @prop width - The width of the product. - * @prop height - The height of the product. - * @prop length - The length of the product. - * @prop weight - The weight of the product. - * @prop origin_country - The origin country of the product. - * @prop hs_code - The HS Code of the product. - * @prop material - The material of the product. - * @prop mid_code - The MID Code of the product. - * @prop metadata - Holds custom data in key-value pairs. */ export interface UpdateProductDTO { + /** + * The ID of the product to update. + */ id: string + /** + * The title of the product. + */ title?: string + /** + * The subttle of the product. + */ subtitle?: string + /** + * The description of the product. + */ description?: string + /** + * Whether the product is a gift card. + */ is_giftcard?: boolean + /** + * Whether the product can be discounted. + */ discountable?: boolean + /** + * The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created + * and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`. + */ images?: string[] | { id?: string; url: string }[] + /** + * The URL of the product's thumbnail. + */ thumbnail?: string + /** + * The handle of the product. The handle can be used to create slug URL paths. + * If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute. + */ handle?: string + /** + * The status of the product. + */ status?: ProductStatus + /** + * The product type to create and associate with the product. + */ type?: CreateProductTypeDTO + /** + * The product type to be associated with the product. + */ type_id?: string | null + /** + * The product collection to be associated with the product. + */ collection_id?: string | null + /** + * The product tags to be created and associated with the product. + */ tags?: CreateProductTagDTO[] + /** + * The product categories to associate with the product. + */ categories?: { id: string }[] + /** + * The product options to be created and associated with the product. + */ options?: CreateProductOptionDTO[] + /** + * The product variants to be created and associated with the product. You can also update existing product variants associated with the product. + */ variants?: (CreateProductVariantDTO | UpdateProductVariantDTO)[] + /** + * The width of the product. + */ width?: number + /** + * The height of the product. + */ height?: number + /** + * The length of the product. + */ length?: number + /** + * The weight of the product. + */ weight?: number + /** + * The origin country of the product. + */ origin_country?: string + /** + * The HS Code of the product. + */ hs_code?: string + /** + * The material of the product. + */ material?: string + /** + * The MID Code of the product. + */ mid_code?: string + /** + * Holds custom data in key-value pairs. + */ metadata?: Record } diff --git a/packages/types/src/shared-context.ts b/packages/types/src/shared-context.ts index 949a1c37a8..0e414ec420 100644 --- a/packages/types/src/shared-context.ts +++ b/packages/types/src/shared-context.ts @@ -4,12 +4,15 @@ import { EntityManager } from "typeorm" * @interface * * A shared context object that is used to share resources between the application and the module. - * - * @prop transactionManager - An instance of a transaction manager. - * @prop manager - An instance of an entity manager. */ export type SharedContext = { + /** + * An instance of a transaction manager. + */ transactionManager?: EntityManager + /** + * An instance of an entity manager. + */ manager?: EntityManager } @@ -17,17 +20,26 @@ export type SharedContext = { * @interface * * A shared context object that is used to share resources between the application and the module. - * - * @prop transactionManager - An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`. - * @prop manager - An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`. - * @prop isolationLevel - A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`. - * @prop enableNestedTransactions - a boolean value indicating whether nested transactions are enabled. - * @prop transactionId - a string indicating the ID of the current transaction. */ export type Context = { + /** + * An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`. + */ transactionManager?: TManager + /** + * An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`. + */ manager?: TManager + /** + * A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`. + */ isolationLevel?: string + /** + * A boolean value indicating whether nested transactions are enabled. + */ enableNestedTransactions?: boolean + /** + * A string indicating the ID of the current transaction. + */ transactionId?: string } diff --git a/packages/types/src/stock-location/common.ts b/packages/types/src/stock-location/common.ts index 219477755c..9bbfe5df48 100644 --- a/packages/types/src/stock-location/common.ts +++ b/packages/types/src/stock-location/common.ts @@ -155,12 +155,15 @@ export type StockLocationExpandedDTO = StockLocationDTO & { * @interface * * The filters to apply on the retrieved stock locations. - * - * @prop id - The IDs to filter stock locations by. - * @prop name - The names to filter stock locations by. */ export type FilterableStockLocationProps = { + /** + * The IDs to filter stock locations by. + */ id?: string | string[] + /** + * The names to filter stock locations by. + */ name?: string | string[] | StringComparisonOperator } diff --git a/www/apps/docs/content/references/entities/classes/Address.mdx b/www/apps/docs/content/references/entities/classes/Address.mdx index e1ac01d7da..8d72a0a7dd 100644 --- a/www/apps/docs/content/references/entities/classes/Address.mdx +++ b/www/apps/docs/content/references/entities/classes/Address.mdx @@ -13,7 +13,7 @@ An address is used across the Medusa backend within other schemas and object typ `", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", @@ -311,7 +311,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat "children": [ { "name": "CANCELED", - "type": "``\"canceled\"``", + "type": "`\"canceled\"`", "description": "", "optional": true, "defaultValue": "", @@ -320,7 +320,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "COMPLETED", - "type": "``\"completed\"``", + "type": "`\"completed\"`", "description": "", "optional": true, "defaultValue": "", @@ -329,7 +329,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "CONFIRMED", - "type": "``\"confirmed\"``", + "type": "`\"confirmed\"`", "description": "", "optional": true, "defaultValue": "", @@ -338,7 +338,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "CREATED", - "type": "``\"created\"``", + "type": "`\"created\"`", "description": "", "optional": true, "defaultValue": "", @@ -347,7 +347,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "FAILED", - "type": "``\"failed\"``", + "type": "`\"failed\"`", "description": "", "optional": true, "defaultValue": "", @@ -356,7 +356,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "PRE_PROCESSED", - "type": "``\"pre_processed\"``", + "type": "`\"pre_processed\"`", "description": "", "optional": true, "defaultValue": "", @@ -365,7 +365,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "PROCESSING", - "type": "``\"processing\"``", + "type": "`\"processing\"`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Cart.mdx b/www/apps/docs/content/references/entities/classes/Cart.mdx index 6bce374839..9d2546c0e6 100644 --- a/www/apps/docs/content/references/entities/classes/Cart.mdx +++ b/www/apps/docs/content/references/entities/classes/Cart.mdx @@ -76,7 +76,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -157,7 +157,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -184,7 +184,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "object", - "type": "``\"cart\"``", + "type": "`\"cart\"`", "description": "", "optional": false, "defaultValue": "\"cart\"", @@ -220,7 +220,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -301,7 +301,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "shipping_address", - "type": "``null`` \\| [Address](Address.mdx)", + "type": "`null` \\| [Address](Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -328,7 +328,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -355,7 +355,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ClaimImage.mdx b/www/apps/docs/content/references/entities/classes/ClaimImage.mdx index b6a646983e..080a942e66 100644 --- a/www/apps/docs/content/references/entities/classes/ClaimImage.mdx +++ b/www/apps/docs/content/references/entities/classes/ClaimImage.mdx @@ -48,7 +48,7 @@ The details of an image attached to a claim. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -185,7 +185,7 @@ The details of an image attached to a claim. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ClaimItem.mdx b/www/apps/docs/content/references/entities/classes/ClaimItem.mdx index 2f08d87f94..7bb8f9fc64 100644 --- a/www/apps/docs/content/references/entities/classes/ClaimItem.mdx +++ b/www/apps/docs/content/references/entities/classes/ClaimItem.mdx @@ -230,7 +230,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -283,7 +283,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -401,7 +401,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -410,7 +410,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", @@ -419,7 +419,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "fulfilled_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", @@ -428,7 +428,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "gift_card_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", @@ -437,7 +437,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "has_shipping", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", @@ -501,7 +501,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "order_edit", - "type": "``null`` \\| [OrderEdit](OrderEdit.mdx)", + "type": "`null` \\| [OrderEdit](OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", @@ -510,7 +510,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "order_edit_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", @@ -519,7 +519,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", @@ -528,7 +528,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "original_item_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", @@ -537,7 +537,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "original_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", @@ -546,7 +546,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "original_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", @@ -555,7 +555,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "product_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "", "optional": false, "defaultValue": "", @@ -573,7 +573,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "raw_discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", @@ -582,7 +582,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "refundable", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", @@ -591,7 +591,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "returned_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", @@ -600,7 +600,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "shipped_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", @@ -618,7 +618,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "subtotal", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", @@ -654,7 +654,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", @@ -663,7 +663,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -681,7 +681,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", @@ -717,7 +717,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "variant_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", @@ -772,7 +772,7 @@ A claim item is an item created as part of a claim. It references an item in the "children": [ { "name": "MISSING_ITEM", - "type": "``\"missing_item\"``", + "type": "`\"missing_item\"`", "description": "", "optional": true, "defaultValue": "", @@ -781,7 +781,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "OTHER", - "type": "``\"other\"``", + "type": "`\"other\"`", "description": "", "optional": true, "defaultValue": "", @@ -790,7 +790,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "PRODUCTION_FAILURE", - "type": "``\"production_failure\"``", + "type": "`\"production_failure\"`", "description": "", "optional": true, "defaultValue": "", @@ -799,7 +799,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "WRONG_ITEM", - "type": "``\"wrong_item\"``", + "type": "`\"wrong_item\"`", "description": "", "optional": true, "defaultValue": "", @@ -827,7 +827,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -900,7 +900,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -918,7 +918,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -927,7 +927,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -936,7 +936,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -945,7 +945,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -981,7 +981,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -999,7 +999,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1008,7 +1008,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1017,7 +1017,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1035,7 +1035,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1080,7 +1080,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -1098,7 +1098,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -1116,7 +1116,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -1125,7 +1125,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1134,7 +1134,7 @@ A claim item is an item created as part of a claim. It references an item in the }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ClaimTag.mdx b/www/apps/docs/content/references/entities/classes/ClaimTag.mdx index c0cf8bb31d..46b668e4c9 100644 --- a/www/apps/docs/content/references/entities/classes/ClaimTag.mdx +++ b/www/apps/docs/content/references/entities/classes/ClaimTag.mdx @@ -22,7 +22,7 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Country.mdx b/www/apps/docs/content/references/entities/classes/Country.mdx index 6f4555ba0a..863f57889c 100644 --- a/www/apps/docs/content/references/entities/classes/Country.mdx +++ b/www/apps/docs/content/references/entities/classes/Country.mdx @@ -120,7 +120,7 @@ Country details }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -211,7 +211,7 @@ Country details }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -229,7 +229,7 @@ Country details }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -249,7 +249,7 @@ Country details }, { "name": "region_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx b/www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx index 007cb729d0..f0c0e5f0d1 100644 --- a/www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx +++ b/www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx @@ -84,7 +84,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -165,7 +165,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -192,7 +192,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "object", - "type": "``\"cart\"``", + "type": "`\"cart\"`", "description": "", "optional": false, "defaultValue": "\"cart\"", @@ -228,7 +228,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -300,7 +300,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -309,7 +309,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "shipping_address", - "type": "``null`` \\| [Address](Address.mdx)", + "type": "`null` \\| [Address](Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -336,7 +336,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -363,7 +363,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -419,7 +419,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -472,7 +472,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -499,7 +499,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Customer.mdx b/www/apps/docs/content/references/entities/classes/Customer.mdx index 5a81426421..b1b447213c 100644 --- a/www/apps/docs/content/references/entities/classes/Customer.mdx +++ b/www/apps/docs/content/references/entities/classes/Customer.mdx @@ -21,7 +21,7 @@ A customer can make purchases in your store and manage their profile. "children": [ { "name": "address_1", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", @@ -30,7 +30,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "address_2", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", @@ -39,7 +39,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "city", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "City", "optional": false, "defaultValue": "", @@ -48,7 +48,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "company", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", @@ -57,7 +57,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "country", - "type": "``null`` \\| [Country](Country.mdx)", + "type": "`null` \\| [Country](Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", @@ -66,7 +66,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "country_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", @@ -84,7 +84,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "customer", - "type": "``null`` \\| [Customer](Customer.mdx)", + "type": "`null` \\| [Customer](Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", @@ -93,7 +93,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "first_name", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", @@ -129,7 +129,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "last_name", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", @@ -147,7 +147,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "phone", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", @@ -156,7 +156,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "postal_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", @@ -165,7 +165,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "province", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", @@ -185,7 +185,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -203,7 +203,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -256,7 +256,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -518,7 +518,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -599,7 +599,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -635,7 +635,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -752,7 +752,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -788,7 +788,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -833,7 +833,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -842,7 +842,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -897,7 +897,7 @@ A customer can make purchases in your store and manage their profile. "children": [ { "name": "address_1", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", @@ -906,7 +906,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "address_2", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", @@ -915,7 +915,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "city", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "City", "optional": false, "defaultValue": "", @@ -924,7 +924,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "company", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", @@ -933,7 +933,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "country", - "type": "``null`` \\| [Country](Country.mdx)", + "type": "`null` \\| [Country](Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", @@ -942,7 +942,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "country_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", @@ -960,7 +960,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "customer", - "type": "``null`` \\| [Customer](Customer.mdx)", + "type": "`null` \\| [Customer](Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", @@ -969,7 +969,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", @@ -978,7 +978,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -987,7 +987,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "first_name", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", @@ -1005,7 +1005,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "last_name", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", @@ -1023,7 +1023,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "phone", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", @@ -1032,7 +1032,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "postal_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", @@ -1041,7 +1041,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "province", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/CustomerGroup.mdx b/www/apps/docs/content/references/entities/classes/CustomerGroup.mdx index b2aaee5a67..baad3e3bf9 100644 --- a/www/apps/docs/content/references/entities/classes/CustomerGroup.mdx +++ b/www/apps/docs/content/references/entities/classes/CustomerGroup.mdx @@ -39,7 +39,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -57,7 +57,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -176,7 +176,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -238,7 +238,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -256,7 +256,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -302,7 +302,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Discount.mdx b/www/apps/docs/content/references/entities/classes/Discount.mdx index 5d390d5bc2..96b945bf3a 100644 --- a/www/apps/docs/content/references/entities/classes/Discount.mdx +++ b/www/apps/docs/content/references/entities/classes/Discount.mdx @@ -31,7 +31,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -40,7 +40,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -120,7 +120,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -237,7 +237,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -246,7 +246,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -319,7 +319,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -410,7 +410,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -428,7 +428,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -483,7 +483,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -584,7 +584,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -593,7 +593,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/DiscountCondition.mdx b/www/apps/docs/content/references/entities/classes/DiscountCondition.mdx index d82528883d..4ae9cfb844 100644 --- a/www/apps/docs/content/references/entities/classes/DiscountCondition.mdx +++ b/www/apps/docs/content/references/entities/classes/DiscountCondition.mdx @@ -48,7 +48,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -104,7 +104,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -148,7 +148,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -248,7 +248,7 @@ Holds rule conditions for when a discount is applicable "children": [ { "name": "IN", - "type": "``\"in\"``", + "type": "`\"in\"`", "description": "The discountable resources are within the specified resources.", "optional": true, "defaultValue": "", @@ -257,7 +257,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "NOT_IN", - "type": "``\"not_in\"``", + "type": "`\"not_in\"`", "description": "The discountable resources are everything but the specified resources.", "optional": true, "defaultValue": "", @@ -285,7 +285,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -367,7 +367,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -431,7 +431,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -505,7 +505,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -523,7 +523,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -532,7 +532,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -550,7 +550,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -559,7 +559,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -568,7 +568,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -577,7 +577,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -613,7 +613,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -622,7 +622,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -631,7 +631,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -640,7 +640,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -658,7 +658,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -712,7 +712,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -730,7 +730,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -757,7 +757,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -784,7 +784,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -793,7 +793,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -812,7 +812,7 @@ Holds rule conditions for when a discount is applicable "children": [ { "name": "CUSTOMER_GROUPS", - "type": "``\"customer_groups\"``", + "type": "`\"customer_groups\"`", "description": "The discount condition is used for customer groups.", "optional": true, "defaultValue": "", @@ -821,7 +821,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "PRODUCTS", - "type": "``\"products\"``", + "type": "`\"products\"`", "description": "The discount condition is used for products.", "optional": true, "defaultValue": "", @@ -830,7 +830,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "PRODUCT_COLLECTIONS", - "type": "``\"product_collections\"``", + "type": "`\"product_collections\"`", "description": "The discount condition is used for product collections.", "optional": true, "defaultValue": "", @@ -839,7 +839,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "PRODUCT_TAGS", - "type": "``\"product_tags\"``", + "type": "`\"product_tags\"`", "description": "The discount condition is used for product tags.", "optional": true, "defaultValue": "", @@ -848,7 +848,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "PRODUCT_TYPES", - "type": "``\"product_types\"``", + "type": "`\"product_types\"`", "description": "The discount condition is used for product types.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx index 17e763a2ba..cd2c858b1e 100644 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx @@ -57,7 +57,7 @@ Associates a discount condition with a customer group }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -148,7 +148,7 @@ Associates a discount condition with a customer group }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx index b6107f921e..633c9d6bfd 100644 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx @@ -57,7 +57,7 @@ This represents the association between a discount condition and a product }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -203,7 +203,7 @@ This represents the association between a discount condition and a product }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -221,7 +221,7 @@ This represents the association between a discount condition and a product }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -230,7 +230,7 @@ This represents the association between a discount condition and a product }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -248,7 +248,7 @@ This represents the association between a discount condition and a product }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -257,7 +257,7 @@ This represents the association between a discount condition and a product }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -266,7 +266,7 @@ This represents the association between a discount condition and a product }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -275,7 +275,7 @@ This represents the association between a discount condition and a product }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -311,7 +311,7 @@ This represents the association between a discount condition and a product }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ This represents the association between a discount condition and a product }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -329,7 +329,7 @@ This represents the association between a discount condition and a product }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -338,7 +338,7 @@ This represents the association between a discount condition and a product }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -356,7 +356,7 @@ This represents the association between a discount condition and a product }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -410,7 +410,7 @@ This represents the association between a discount condition and a product }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -428,7 +428,7 @@ This represents the association between a discount condition and a product }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -455,7 +455,7 @@ This represents the association between a discount condition and a product }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -482,7 +482,7 @@ This represents the association between a discount condition and a product }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -491,7 +491,7 @@ This represents the association between a discount condition and a product }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx index ed6ac0f3f5..6e74dc5277 100644 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx @@ -57,7 +57,7 @@ This represents the association between a discount condition and a product colle }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ This represents the association between a discount condition and a product colle }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx index 6534b84057..6d518847a0 100644 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx @@ -57,7 +57,7 @@ This represents the association between a discount condition and a product tag }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ This represents the association between a discount condition and a product tag }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx index e6309294a9..644acb1462 100644 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx @@ -57,7 +57,7 @@ This represents the association between a discount condition and a product type }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ This represents the association between a discount condition and a product type }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/DiscountRule.mdx b/www/apps/docs/content/references/entities/classes/DiscountRule.mdx index c179fcba7b..ec01475bed 100644 --- a/www/apps/docs/content/references/entities/classes/DiscountRule.mdx +++ b/www/apps/docs/content/references/entities/classes/DiscountRule.mdx @@ -21,7 +21,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. "children": [ { "name": "ITEM", - "type": "``\"item\"``", + "type": "`\"item\"`", "description": "The discount should be applied to applicable items in the cart.", "optional": true, "defaultValue": "", @@ -30,7 +30,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. }, { "name": "TOTAL", - "type": "``\"total\"``", + "type": "`\"total\"`", "description": "The discount should be applied to the checkout total.", "optional": true, "defaultValue": "", @@ -67,7 +67,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -186,7 +186,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -230,7 +230,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. "children": [ { "name": "FIXED", - "type": "``\"fixed\"``", + "type": "`\"fixed\"`", "description": "Discounts that reduce the price by a fixed amount.", "optional": true, "defaultValue": "", @@ -239,7 +239,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. }, { "name": "FREE_SHIPPING", - "type": "``\"free_shipping\"``", + "type": "`\"free_shipping\"`", "description": "Discounts that sets the shipping price to `0`.", "optional": true, "defaultValue": "", @@ -248,7 +248,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart. }, { "name": "PERCENTAGE", - "type": "``\"percentage\"``", + "type": "`\"percentage\"`", "description": "Discounts that reduce the price by a percentage reduction.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Fulfillment.mdx b/www/apps/docs/content/references/entities/classes/Fulfillment.mdx index 18ebba490b..a3f2f451e7 100644 --- a/www/apps/docs/content/references/entities/classes/Fulfillment.mdx +++ b/www/apps/docs/content/references/entities/classes/Fulfillment.mdx @@ -321,7 +321,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", @@ -518,7 +518,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -599,7 +599,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -635,7 +635,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -752,7 +752,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -788,7 +788,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -833,7 +833,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -842,7 +842,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -997,7 +997,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1178,7 +1178,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx b/www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx index 0a06777c66..86239d574c 100644 --- a/www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx +++ b/www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx @@ -93,7 +93,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -301,7 +301,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", @@ -310,7 +310,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "fulfilled_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", @@ -319,7 +319,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "gift_card_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", @@ -328,7 +328,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "has_shipping", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", @@ -392,7 +392,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "order_edit", - "type": "``null`` \\| [OrderEdit](OrderEdit.mdx)", + "type": "`null` \\| [OrderEdit](OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", @@ -401,7 +401,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "order_edit_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", @@ -410,7 +410,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", @@ -419,7 +419,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "original_item_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", @@ -428,7 +428,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "original_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", @@ -437,7 +437,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "original_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", @@ -446,7 +446,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "product_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "", "optional": false, "defaultValue": "", @@ -464,7 +464,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "raw_discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", @@ -473,7 +473,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "refundable", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", @@ -482,7 +482,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "returned_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", @@ -491,7 +491,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "shipped_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", @@ -509,7 +509,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "subtotal", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", @@ -545,7 +545,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", @@ -554,7 +554,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -572,7 +572,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", @@ -608,7 +608,7 @@ This represents the association between a Line Item and a Fulfillment. }, { "name": "variant_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/GiftCard.mdx b/www/apps/docs/content/references/entities/classes/GiftCard.mdx index 110f58f62c..9413c6cc0a 100644 --- a/www/apps/docs/content/references/entities/classes/GiftCard.mdx +++ b/www/apps/docs/content/references/entities/classes/GiftCard.mdx @@ -40,7 +40,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -255,7 +255,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -336,7 +336,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -372,7 +372,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -489,7 +489,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -525,7 +525,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -570,7 +570,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -579,7 +579,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -670,7 +670,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -761,7 +761,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -779,7 +779,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -808,7 +808,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx b/www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx index 1736183ede..1c9fc03fc3 100644 --- a/www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx +++ b/www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx @@ -66,7 +66,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -147,7 +147,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", @@ -373,7 +373,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -454,7 +454,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -490,7 +490,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -607,7 +607,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -643,7 +643,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -688,7 +688,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -697,7 +697,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -735,7 +735,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Image.mdx b/www/apps/docs/content/references/entities/classes/Image.mdx index b4b27fd280..80dd5d6660 100644 --- a/www/apps/docs/content/references/entities/classes/Image.mdx +++ b/www/apps/docs/content/references/entities/classes/Image.mdx @@ -22,7 +22,7 @@ An Image is used to store details about uploaded images. Images are uploaded by }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Invite.mdx b/www/apps/docs/content/references/entities/classes/Invite.mdx index d92dc49a9e..8bede060bd 100644 --- a/www/apps/docs/content/references/entities/classes/Invite.mdx +++ b/www/apps/docs/content/references/entities/classes/Invite.mdx @@ -31,7 +31,7 @@ An invite is created when an admin user invites a new user to join the store's t }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -75,7 +75,7 @@ An invite is created when an admin user invites a new user to join the store's t "children": [ { "name": "ADMIN", - "type": "``\"admin\"``", + "type": "`\"admin\"`", "description": "The user is an admin.", "optional": true, "defaultValue": "", @@ -84,7 +84,7 @@ An invite is created when an admin user invites a new user to join the store's t }, { "name": "DEVELOPER", - "type": "``\"developer\"``", + "type": "`\"developer\"`", "description": "The user is a developer.", "optional": true, "defaultValue": "", @@ -93,7 +93,7 @@ An invite is created when an admin user invites a new user to join the store's t }, { "name": "MEMBER", - "type": "``\"member\"``", + "type": "`\"member\"`", "description": "The user is a team member.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/LineItem.mdx b/www/apps/docs/content/references/entities/classes/LineItem.mdx index dfad6369f2..671d382fa9 100644 --- a/www/apps/docs/content/references/entities/classes/LineItem.mdx +++ b/www/apps/docs/content/references/entities/classes/LineItem.mdx @@ -76,7 +76,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -85,7 +85,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", @@ -94,7 +94,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "fulfilled_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "gift_card_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", @@ -112,7 +112,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "has_shipping", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", @@ -176,7 +176,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "order_edit", - "type": "``null`` \\| [OrderEdit](OrderEdit.mdx)", + "type": "`null` \\| [OrderEdit](OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", @@ -185,7 +185,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "order_edit_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", @@ -194,7 +194,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", @@ -203,7 +203,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "original_item_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", @@ -212,7 +212,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "original_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", @@ -221,7 +221,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "original_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", @@ -230,7 +230,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "product_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "", "optional": false, "defaultValue": "", @@ -248,7 +248,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "raw_discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", @@ -257,7 +257,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "refundable", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", @@ -266,7 +266,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "returned_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", @@ -275,7 +275,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "shipped_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", @@ -293,7 +293,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "subtotal", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", @@ -329,7 +329,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", @@ -338,7 +338,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -356,7 +356,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", @@ -392,7 +392,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "variant_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx b/www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx index f055d4c171..2ede42cbd4 100644 --- a/www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx +++ b/www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx @@ -13,7 +13,7 @@ A Line Item Tax Line represents the taxes applied on a line item. `", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -484,7 +484,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -502,7 +502,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -547,7 +547,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -565,7 +565,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -583,7 +583,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -592,7 +592,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -601,7 +601,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -638,7 +638,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -656,7 +656,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -665,7 +665,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -674,7 +674,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -683,7 +683,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -719,7 +719,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -737,7 +737,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -746,7 +746,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -755,7 +755,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -773,7 +773,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -818,7 +818,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -836,7 +836,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -854,7 +854,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -863,7 +863,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -872,7 +872,7 @@ A Money Amount represent a price amount, for example, a product variant's price }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Note.mdx b/www/apps/docs/content/references/entities/classes/Note.mdx index edd7640be6..e518562708 100644 --- a/www/apps/docs/content/references/entities/classes/Note.mdx +++ b/www/apps/docs/content/references/entities/classes/Note.mdx @@ -39,7 +39,7 @@ A Note is an element that can be used in association with different resources to }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -140,7 +140,7 @@ A Note is an element that can be used in association with different resources to }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Notification.mdx b/www/apps/docs/content/references/entities/classes/Notification.mdx index be59026cea..3767f79880 100644 --- a/www/apps/docs/content/references/entities/classes/Notification.mdx +++ b/www/apps/docs/content/references/entities/classes/Notification.mdx @@ -39,7 +39,7 @@ A notification is an alert sent, typically to customers, using the installed Not }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -57,7 +57,7 @@ A notification is an alert sent, typically to customers, using the installed Not }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -176,7 +176,7 @@ A notification is an alert sent, typically to customers, using the installed Not }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", @@ -247,7 +247,7 @@ A notification is an alert sent, typically to customers, using the installed Not }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", @@ -429,7 +429,7 @@ A notification is an alert sent, typically to customers, using the installed Not }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Order.mdx b/www/apps/docs/content/references/entities/classes/Order.mdx index 8bc66a31bb..4dea76bf2b 100644 --- a/www/apps/docs/content/references/entities/classes/Order.mdx +++ b/www/apps/docs/content/references/entities/classes/Order.mdx @@ -175,7 +175,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -256,7 +256,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -409,7 +409,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -445,7 +445,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -490,7 +490,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -499,7 +499,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/OrderEdit.mdx b/www/apps/docs/content/references/entities/classes/OrderEdit.mdx index 4d7d416ca2..3ff36755fe 100644 --- a/www/apps/docs/content/references/entities/classes/OrderEdit.mdx +++ b/www/apps/docs/content/references/entities/classes/OrderEdit.mdx @@ -247,7 +247,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/OrderItemChange.mdx b/www/apps/docs/content/references/entities/classes/OrderItemChange.mdx index a103f2fdb2..7782360f1f 100644 --- a/www/apps/docs/content/references/entities/classes/OrderItemChange.mdx +++ b/www/apps/docs/content/references/entities/classes/OrderItemChange.mdx @@ -22,7 +22,7 @@ An order item change is a change made within an order edit to an order's items. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Payment.mdx b/www/apps/docs/content/references/entities/classes/Payment.mdx index cffa4d2988..4fbd8a12db 100644 --- a/www/apps/docs/content/references/entities/classes/Payment.mdx +++ b/www/apps/docs/content/references/entities/classes/Payment.mdx @@ -120,7 +120,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -201,7 +201,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -228,7 +228,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "object", - "type": "``\"cart\"``", + "type": "`\"cart\"`", "description": "", "optional": false, "defaultValue": "\"cart\"", @@ -264,7 +264,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -336,7 +336,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -345,7 +345,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "shipping_address", - "type": "``null`` \\| [Address](Address.mdx)", + "type": "`null` \\| [Address](Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -372,7 +372,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -399,7 +399,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -726,7 +726,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -807,7 +807,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -843,7 +843,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -960,7 +960,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -996,7 +996,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -1041,7 +1041,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -1050,7 +1050,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1168,7 +1168,7 @@ A payment is originally created from a payment session. Once a payment session i }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/PaymentCollection.mdx b/www/apps/docs/content/references/entities/classes/PaymentCollection.mdx index 47b13fa15b..ffa8098494 100644 --- a/www/apps/docs/content/references/entities/classes/PaymentCollection.mdx +++ b/www/apps/docs/content/references/entities/classes/PaymentCollection.mdx @@ -22,7 +22,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -114,7 +114,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -123,7 +123,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", @@ -176,7 +176,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "cart_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", @@ -230,7 +230,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "is_selected", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", @@ -511,7 +511,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -602,7 +602,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -620,7 +620,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -657,7 +657,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi "children": [ { "name": "AUTHORIZED", - "type": "``\"authorized\"``", + "type": "`\"authorized\"`", "description": "The payment colleciton is authorized.", "optional": true, "defaultValue": "", @@ -666,7 +666,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "AWAITING", - "type": "``\"awaiting\"``", + "type": "`\"awaiting\"`", "description": "The payment collection is awaiting payment.", "optional": true, "defaultValue": "", @@ -675,7 +675,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "CANCELED", - "type": "``\"canceled\"``", + "type": "`\"canceled\"`", "description": "The payment collection is canceled.", "optional": true, "defaultValue": "", @@ -684,7 +684,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "NOT_PAID", - "type": "``\"not_paid\"``", + "type": "`\"not_paid\"`", "description": "The payment collection isn't paid.", "optional": true, "defaultValue": "", @@ -693,7 +693,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "PARTIALLY_AUTHORIZED", - "type": "``\"partially_authorized\"``", + "type": "`\"partially_authorized\"`", "description": "Some of the payments in the payment collection are authorized.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/PaymentSession.mdx b/www/apps/docs/content/references/entities/classes/PaymentSession.mdx index a84827834b..406e0dbe0b 100644 --- a/www/apps/docs/content/references/entities/classes/PaymentSession.mdx +++ b/www/apps/docs/content/references/entities/classes/PaymentSession.mdx @@ -93,7 +93,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -174,7 +174,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -201,7 +201,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "object", - "type": "``\"cart\"``", + "type": "`\"cart\"`", "description": "", "optional": false, "defaultValue": "\"cart\"", @@ -237,7 +237,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -309,7 +309,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -318,7 +318,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "shipping_address", - "type": "``null`` \\| [Address](Address.mdx)", + "type": "`null` \\| [Address](Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -345,7 +345,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -372,7 +372,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -410,7 +410,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "cart_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", @@ -464,7 +464,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "is_selected", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/PriceList.mdx b/www/apps/docs/content/references/entities/classes/PriceList.mdx index b17803c0b0..940cd39cbc 100644 --- a/www/apps/docs/content/references/entities/classes/PriceList.mdx +++ b/www/apps/docs/content/references/entities/classes/PriceList.mdx @@ -48,7 +48,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -104,7 +104,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -122,7 +122,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -203,7 +203,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -221,7 +221,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", @@ -230,7 +230,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", @@ -239,7 +239,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "price_list", - "type": "``null`` \\| [PriceList](PriceList.mdx)", + "type": "`null` \\| [PriceList](PriceList.mdx)", "description": "The details of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", @@ -248,7 +248,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "price_list_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", @@ -313,7 +313,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", @@ -330,8 +330,8 @@ A Price List represents a set of prices that override the default price for one "children": [ { "name": "ACTIVE", - "type": "``\"active\"``", - "description": "The price list is active, meaning its prices are applied to customers.", + "type": "`\"active\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -339,8 +339,8 @@ A Price List represents a set of prices that override the default price for one }, { "name": "DRAFT", - "type": "``\"draft\"``", - "description": "The price list is a draft, meaning its not yet applied to customers.", + "type": "`\"draft\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -358,8 +358,8 @@ A Price List represents a set of prices that override the default price for one "children": [ { "name": "OVERRIDE", - "type": "``\"override\"``", - "description": "The price list is used to override original prices for specific conditions.", + "type": "`\"override\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -367,8 +367,8 @@ A Price List represents a set of prices that override the default price for one }, { "name": "SALE", - "type": "``\"sale\"``", - "description": "The price list is used for a sale.", + "type": "`\"sale\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/entities/classes/Product.mdx b/www/apps/docs/content/references/entities/classes/Product.mdx index 241a804d48..f34e1f91d3 100644 --- a/www/apps/docs/content/references/entities/classes/Product.mdx +++ b/www/apps/docs/content/references/entities/classes/Product.mdx @@ -94,7 +94,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -176,7 +176,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -241,7 +241,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -259,7 +259,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -268,7 +268,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -286,7 +286,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -295,7 +295,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -304,7 +304,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -313,7 +313,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -348,7 +348,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -404,7 +404,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -413,7 +413,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -422,7 +422,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -431,7 +431,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -457,7 +457,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -531,7 +531,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -557,7 +557,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -657,7 +657,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -748,7 +748,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -757,7 +757,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -793,7 +793,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -830,7 +830,7 @@ A product is a saleable item that holds general information such as name or desc "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "The product is a draft. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -839,7 +839,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "The product is proposed, but not yet published.", "optional": true, "defaultValue": "", @@ -848,7 +848,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "The product is published.", "optional": true, "defaultValue": "", @@ -857,7 +857,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "The product is rejected. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -868,7 +868,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -894,7 +894,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -941,7 +941,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -976,7 +976,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1023,7 +1023,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -1058,7 +1058,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -1076,7 +1076,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1085,7 +1085,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -1094,7 +1094,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1103,7 +1103,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1139,7 +1139,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1157,7 +1157,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1166,7 +1166,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1175,7 +1175,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1193,7 +1193,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1238,7 +1238,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -1256,7 +1256,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -1274,7 +1274,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -1283,7 +1283,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1292,7 +1292,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1303,7 +1303,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1312,7 +1312,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductCategory.mdx b/www/apps/docs/content/references/entities/classes/ProductCategory.mdx index 50cc1f40a7..e885832432 100644 --- a/www/apps/docs/content/references/entities/classes/ProductCategory.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductCategory.mdx @@ -93,7 +93,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -221,7 +221,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -230,7 +230,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -266,7 +266,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -284,7 +284,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -293,7 +293,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -311,7 +311,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -329,7 +329,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -338,7 +338,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -374,7 +374,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -383,7 +383,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -392,7 +392,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -401,7 +401,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -419,7 +419,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -473,7 +473,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -491,7 +491,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -518,7 +518,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -545,7 +545,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -554,7 +554,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductCollection.mdx b/www/apps/docs/content/references/entities/classes/ProductCollection.mdx index c6cace393d..733bfec465 100644 --- a/www/apps/docs/content/references/entities/classes/ProductCollection.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductCollection.mdx @@ -22,7 +22,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -85,7 +85,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -112,7 +112,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -130,7 +130,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -139,7 +139,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -148,7 +148,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -157,7 +157,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -202,7 +202,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -211,7 +211,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -220,7 +220,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -238,7 +238,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -310,7 +310,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -337,7 +337,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -364,7 +364,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -373,7 +373,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductOption.mdx b/www/apps/docs/content/references/entities/classes/ProductOption.mdx index 85d2766c92..1503c63114 100644 --- a/www/apps/docs/content/references/entities/classes/ProductOption.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductOption.mdx @@ -22,7 +22,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -94,7 +94,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -121,7 +121,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -130,7 +130,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -139,7 +139,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -148,7 +148,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -184,7 +184,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -202,7 +202,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -211,7 +211,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -229,7 +229,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -283,7 +283,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -301,7 +301,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -328,7 +328,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -355,7 +355,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -364,7 +364,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -419,7 +419,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx b/www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx index 530b8797ae..10ffa6a537 100644 --- a/www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx @@ -22,7 +22,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -66,7 +66,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -184,7 +184,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -202,7 +202,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -211,7 +211,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -220,7 +220,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -229,7 +229,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -265,7 +265,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -283,7 +283,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -301,7 +301,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -319,7 +319,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -364,7 +364,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -382,7 +382,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -400,7 +400,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -409,7 +409,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -418,7 +418,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductTag.mdx b/www/apps/docs/content/references/entities/classes/ProductTag.mdx index 12336654b5..473ead8e27 100644 --- a/www/apps/docs/content/references/entities/classes/ProductTag.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductTag.mdx @@ -22,7 +22,7 @@ A Product Tag can be added to Products for easy filtering and grouping. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx b/www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx index 7be5ba1bec..44109909ab 100644 --- a/www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx @@ -58,7 +58,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -85,7 +85,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -112,7 +112,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -121,7 +121,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -130,7 +130,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -166,7 +166,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -175,7 +175,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -184,7 +184,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -211,7 +211,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -265,7 +265,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -283,7 +283,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -310,7 +310,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -337,7 +337,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -346,7 +346,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -383,7 +383,7 @@ This represents the association between a tax rate and a product to indicate tha "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -464,7 +464,7 @@ This represents the association between a tax rate and a product to indicate tha }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductType.mdx b/www/apps/docs/content/references/entities/classes/ProductType.mdx index 67d5b340bf..67aa4a325f 100644 --- a/www/apps/docs/content/references/entities/classes/ProductType.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductType.mdx @@ -22,7 +22,7 @@ A Product Type can be added to Products for filtering and reporting purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx b/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx index 2a184d5514..812a693945 100644 --- a/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx @@ -48,7 +48,7 @@ This represents the association between a tax rate and a product type to indicat }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -121,7 +121,7 @@ This represents the association between a tax rate and a product type to indicat "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -202,7 +202,7 @@ This represents the association between a tax rate and a product type to indicat }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductVariant.mdx b/www/apps/docs/content/references/entities/classes/ProductVariant.mdx index e763960845..35dd602b78 100644 --- a/www/apps/docs/content/references/entities/classes/ProductVariant.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductVariant.mdx @@ -22,7 +22,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -40,7 +40,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -49,7 +49,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -58,7 +58,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -176,7 +176,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -194,7 +194,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -203,7 +203,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -212,7 +212,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -238,7 +238,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -321,7 +321,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -374,7 +374,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -392,7 +392,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", @@ -401,7 +401,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", @@ -410,7 +410,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "price_list", - "type": "``null`` \\| [PriceList](PriceList.mdx)", + "type": "`null` \\| [PriceList](PriceList.mdx)", "description": "The details of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", @@ -419,7 +419,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "price_list_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", @@ -511,7 +511,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -529,7 +529,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -538,7 +538,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -556,7 +556,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -565,7 +565,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -574,7 +574,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -583,7 +583,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -619,7 +619,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -628,7 +628,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -637,7 +637,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -646,7 +646,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -664,7 +664,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -718,7 +718,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -736,7 +736,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -763,7 +763,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -790,7 +790,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -799,7 +799,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -828,7 +828,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -846,7 +846,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -864,7 +864,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -873,7 +873,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -882,7 +882,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx b/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx index 498749ed2e..d4be9fcf50 100644 --- a/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx @@ -22,7 +22,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -84,7 +84,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -120,7 +120,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -129,7 +129,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -165,7 +165,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -183,7 +183,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -192,7 +192,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -201,7 +201,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -219,7 +219,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -264,7 +264,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -282,7 +282,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -300,7 +300,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -309,7 +309,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -318,7 +318,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx b/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx index cfaf37aee9..ea3632f7ba 100644 --- a/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx @@ -22,7 +22,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx b/www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx index 41756747ad..836b729550 100644 --- a/www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx +++ b/www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx @@ -22,7 +22,7 @@ A Publishable API key defines scopes that resources are available in. Then, it c }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -49,7 +49,7 @@ A Publishable API key defines scopes that resources are available in. Then, it c }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Refund.mdx b/www/apps/docs/content/references/entities/classes/Refund.mdx index a79a3549a4..5a8934782e 100644 --- a/www/apps/docs/content/references/entities/classes/Refund.mdx +++ b/www/apps/docs/content/references/entities/classes/Refund.mdx @@ -237,7 +237,7 @@ A refund represents an amount of money transfered back to the customer for a giv }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -318,7 +318,7 @@ A refund represents an amount of money transfered back to the customer for a giv }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -354,7 +354,7 @@ A refund represents an amount of money transfered back to the customer for a giv }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -471,7 +471,7 @@ A refund represents an amount of money transfered back to the customer for a giv }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -507,7 +507,7 @@ A refund represents an amount of money transfered back to the customer for a giv }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -552,7 +552,7 @@ A refund represents an amount of money transfered back to the customer for a giv }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -561,7 +561,7 @@ A refund represents an amount of money transfered back to the customer for a giv }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Region.mdx b/www/apps/docs/content/references/entities/classes/Region.mdx index 3ea4f4dd23..af168b29cb 100644 --- a/www/apps/docs/content/references/entities/classes/Region.mdx +++ b/www/apps/docs/content/references/entities/classes/Region.mdx @@ -93,7 +93,7 @@ A region holds settings specific to a geographical location, including the curre }, { "name": "region_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", @@ -178,7 +178,7 @@ A region holds settings specific to a geographical location, including the curre }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -326,7 +326,7 @@ A region holds settings specific to a geographical location, including the curre }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -344,7 +344,7 @@ A region holds settings specific to a geographical location, including the curre }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Return.mdx b/www/apps/docs/content/references/entities/classes/Return.mdx index b688709bfe..188595b07f 100644 --- a/www/apps/docs/content/references/entities/classes/Return.mdx +++ b/www/apps/docs/content/references/entities/classes/Return.mdx @@ -212,7 +212,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", @@ -239,7 +239,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "idempotency_key", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", @@ -366,7 +366,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", @@ -375,7 +375,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -384,7 +384,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -563,7 +563,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -644,7 +644,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -680,7 +680,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -797,7 +797,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -833,7 +833,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -878,7 +878,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -887,7 +887,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -916,7 +916,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -987,7 +987,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", @@ -1151,7 +1151,7 @@ A Return holds information about Line Items that a Customer wishes to send back, "children": [ { "name": "CANCELED", - "type": "``\"canceled\"``", + "type": "`\"canceled\"`", "description": "The return is canceled.", "optional": true, "defaultValue": "", @@ -1160,7 +1160,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "RECEIVED", - "type": "``\"received\"``", + "type": "`\"received\"`", "description": "The return is received.", "optional": true, "defaultValue": "", @@ -1169,7 +1169,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "REQUESTED", - "type": "``\"requested\"``", + "type": "`\"requested\"`", "description": "The return is requested.", "optional": true, "defaultValue": "", @@ -1178,7 +1178,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "REQUIRES_ACTION", - "type": "``\"requires_action\"``", + "type": "`\"requires_action\"`", "description": "The return is awaiting action.", "optional": true, "defaultValue": "", @@ -1260,7 +1260,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1415,7 +1415,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ReturnItem.mdx b/www/apps/docs/content/references/entities/classes/ReturnItem.mdx index 015a655ff0..8a2448c531 100644 --- a/www/apps/docs/content/references/entities/classes/ReturnItem.mdx +++ b/www/apps/docs/content/references/entities/classes/ReturnItem.mdx @@ -93,7 +93,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", @@ -111,7 +111,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "fulfilled_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", @@ -120,7 +120,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "gift_card_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", @@ -129,7 +129,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "has_shipping", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "order_edit", - "type": "``null`` \\| [OrderEdit](OrderEdit.mdx)", + "type": "`null` \\| [OrderEdit](OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", @@ -202,7 +202,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "order_edit_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", @@ -211,7 +211,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", @@ -220,7 +220,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "original_item_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", @@ -229,7 +229,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "original_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", @@ -238,7 +238,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "original_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", @@ -247,7 +247,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "product_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "", "optional": false, "defaultValue": "", @@ -265,7 +265,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "raw_discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", @@ -274,7 +274,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "refundable", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", @@ -283,7 +283,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "returned_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "shipped_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", @@ -310,7 +310,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "subtotal", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", @@ -346,7 +346,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", @@ -355,7 +355,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -373,7 +373,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", @@ -409,7 +409,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "variant_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", @@ -473,7 +473,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -518,7 +518,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -527,7 +527,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", @@ -618,7 +618,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", @@ -645,7 +645,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "idempotency_key", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", @@ -663,7 +663,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", @@ -672,7 +672,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -681,7 +681,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -699,7 +699,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -762,7 +762,7 @@ A return item represents a line item in an order that is to be returned. It incl }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ReturnReason.mdx b/www/apps/docs/content/references/entities/classes/ReturnReason.mdx index 4d8226ba74..8e64f52867 100644 --- a/www/apps/docs/content/references/entities/classes/ReturnReason.mdx +++ b/www/apps/docs/content/references/entities/classes/ReturnReason.mdx @@ -22,7 +22,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -147,7 +147,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -156,7 +156,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/SalesChannel.mdx b/www/apps/docs/content/references/entities/classes/SalesChannel.mdx index 80439f78a3..cd139c8893 100644 --- a/www/apps/docs/content/references/entities/classes/SalesChannel.mdx +++ b/www/apps/docs/content/references/entities/classes/SalesChannel.mdx @@ -22,7 +22,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -31,7 +31,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -75,7 +75,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -131,7 +131,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx b/www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx index 7d4d54b25a..96c8369b31 100644 --- a/www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx +++ b/www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx @@ -22,7 +22,7 @@ This represents the association between a sales channel and a stock locations. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -66,7 +66,7 @@ This represents the association between a sales channel and a stock locations. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -75,7 +75,7 @@ This represents the association between a sales channel and a stock locations. }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ This represents the association between a sales channel and a stock locations. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ShippingMethod.mdx b/www/apps/docs/content/references/entities/classes/ShippingMethod.mdx index 85dc79dc3c..7ea95c2542 100644 --- a/www/apps/docs/content/references/entities/classes/ShippingMethod.mdx +++ b/www/apps/docs/content/references/entities/classes/ShippingMethod.mdx @@ -84,7 +84,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -165,7 +165,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -192,7 +192,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "object", - "type": "``\"cart\"``", + "type": "`\"cart\"`", "description": "", "optional": false, "defaultValue": "\"cart\"", @@ -228,7 +228,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -300,7 +300,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -309,7 +309,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "shipping_address", - "type": "``null`` \\| [Address](Address.mdx)", + "type": "`null` \\| [Address](Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -336,7 +336,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -363,7 +363,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -609,7 +609,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", @@ -816,7 +816,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -897,7 +897,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -933,7 +933,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -1050,7 +1050,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -1086,7 +1086,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -1131,7 +1131,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -1140,7 +1140,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1213,7 +1213,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", @@ -1240,7 +1240,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "idempotency_key", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", @@ -1258,7 +1258,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", @@ -1267,7 +1267,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1276,7 +1276,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -1294,7 +1294,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -1357,7 +1357,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", @@ -1394,7 +1394,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -1421,7 +1421,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1648,7 +1648,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1820,7 +1820,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx b/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx index 0dc57f910b..17be92cdec 100644 --- a/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx +++ b/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx @@ -13,7 +13,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in `", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -220,7 +220,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -238,7 +238,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -310,7 +310,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -337,7 +337,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -364,7 +364,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -373,7 +373,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -401,7 +401,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -428,7 +428,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -574,7 +574,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful "children": [ { "name": "CUSTOM", - "type": "``\"custom\"``", + "type": "`\"custom\"`", "description": "The profile used to ship custom items.", "optional": true, "defaultValue": "", @@ -583,7 +583,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "DEFAULT", - "type": "``\"default\"``", + "type": "`\"default\"`", "description": "The default profile used to ship item.", "optional": true, "defaultValue": "", @@ -592,7 +592,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "GIFT_CARD", - "type": "``\"gift_card\"``", + "type": "`\"gift_card\"`", "description": "The profile used to ship gift cards.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx b/www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx index 98eb4d6cd2..ce233e5bd6 100644 --- a/www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx +++ b/www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx @@ -57,7 +57,7 @@ This represents the tax rates applied on a shipping option. }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -84,7 +84,7 @@ This represents the tax rates applied on a shipping option. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -239,7 +239,7 @@ This represents the tax rates applied on a shipping option. "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ This represents the tax rates applied on a shipping option. }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/SoftDeletableEntity.mdx b/www/apps/docs/content/references/entities/classes/SoftDeletableEntity.mdx index 6cbc8b4d14..2768a19720 100644 --- a/www/apps/docs/content/references/entities/classes/SoftDeletableEntity.mdx +++ b/www/apps/docs/content/references/entities/classes/SoftDeletableEntity.mdx @@ -22,7 +22,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Store.mdx b/www/apps/docs/content/references/entities/classes/Store.mdx index fcc6bc51a7..87d1d36cf1 100644 --- a/www/apps/docs/content/references/entities/classes/Store.mdx +++ b/www/apps/docs/content/references/entities/classes/Store.mdx @@ -169,7 +169,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -178,7 +178,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -214,7 +214,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -243,7 +243,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "default_sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the store's default sales channel.", "optional": false, "defaultValue": "", @@ -261,7 +261,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "invite_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Invite links from", "optional": false, "defaultValue": "", @@ -270,7 +270,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -288,7 +288,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "payment_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Payment links from. Use {{cart\\_id}} to include the payment's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -297,7 +297,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "swap_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Swap links from. Use {{cart\\_id}} to include the Swap's `cart\\_id` in the link.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/Swap.mdx b/www/apps/docs/content/references/entities/classes/Swap.mdx index 52e1d029d7..6178bcc2d8 100644 --- a/www/apps/docs/content/references/entities/classes/Swap.mdx +++ b/www/apps/docs/content/references/entities/classes/Swap.mdx @@ -76,7 +76,7 @@ A swap can be created when a Customer wishes to exchange Products that they have }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/TaxLine.mdx b/www/apps/docs/content/references/entities/classes/TaxLine.mdx index c51327727d..58b945bc03 100644 --- a/www/apps/docs/content/references/entities/classes/TaxLine.mdx +++ b/www/apps/docs/content/references/entities/classes/TaxLine.mdx @@ -13,7 +13,7 @@ A tax line represents the taxes amount applied to a line item. `", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -302,7 +302,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -374,7 +374,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -392,7 +392,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -419,7 +419,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -446,7 +446,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -455,7 +455,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -466,7 +466,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -528,7 +528,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -619,7 +619,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -637,7 +637,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -692,7 +692,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -719,7 +719,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/TrackingLink.mdx b/www/apps/docs/content/references/entities/classes/TrackingLink.mdx index 85bf03d703..a2b536ad5b 100644 --- a/www/apps/docs/content/references/entities/classes/TrackingLink.mdx +++ b/www/apps/docs/content/references/entities/classes/TrackingLink.mdx @@ -22,7 +22,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/classes/User.mdx b/www/apps/docs/content/references/entities/classes/User.mdx index 21f66c99f4..61e3f8502e 100644 --- a/www/apps/docs/content/references/entities/classes/User.mdx +++ b/www/apps/docs/content/references/entities/classes/User.mdx @@ -31,7 +31,7 @@ A User is an administrator who can manage store settings and data. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A User is an administrator who can manage store settings and data. "children": [ { "name": "ADMIN", - "type": "``\"admin\"``", + "type": "`\"admin\"`", "description": "The user is an admin.", "optional": true, "defaultValue": "", @@ -111,7 +111,7 @@ A User is an administrator who can manage store settings and data. }, { "name": "DEVELOPER", - "type": "``\"developer\"``", + "type": "`\"developer\"`", "description": "The user is a developer.", "optional": true, "defaultValue": "", @@ -120,7 +120,7 @@ A User is an administrator who can manage store settings and data. }, { "name": "MEMBER", - "type": "``\"member\"``", + "type": "`\"member\"`", "description": "The user is a team member.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx b/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx index 716795ec1c..458f0df10c 100644 --- a/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/PriceListStatus.mdx @@ -6,20 +6,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PriceListStatus -The status of a price list. - ## Enumeration Members ### ACTIVE **ACTIVE** = `"active"` -The price list is active, meaning its prices are applied to customers. - ___ ### DRAFT **DRAFT** = `"draft"` - -The price list is a draft, meaning its not yet applied to customers. diff --git a/www/apps/docs/content/references/entities/enums/PriceListType.mdx b/www/apps/docs/content/references/entities/enums/PriceListType.mdx index 904c7bd3be..f079104657 100644 --- a/www/apps/docs/content/references/entities/enums/PriceListType.mdx +++ b/www/apps/docs/content/references/entities/enums/PriceListType.mdx @@ -6,20 +6,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PriceListType -The type of price list. - ## Enumeration Members ### OVERRIDE **OVERRIDE** = `"override"` -The price list is used to override original prices for specific conditions. - ___ ### SALE **SALE** = `"sale"` - -The price list is used for a sale. diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.adjustInventory.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.adjustInventory.mdx index 3e9921db47..3566f3ad19 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.adjustInventory.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.adjustInventory.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItem.mdx index e5014f9455..4877752116 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItem.mdx @@ -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`", + "type": "`null` \\| `Record`", "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` \\| ``null``", + "type": "`Record` \\| `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": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItems.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItems.mdx index 5f21a0ce91..6ff01f88b8 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItems.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryItems.mdx @@ -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`", + "type": "`null` \\| `Record`", "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": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryLevel.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryLevel.mdx index 27588c1259..e1f5a358e5 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryLevel.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createInventoryLevel.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItem.mdx index 63f5c745cd..1680bd24c4 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItem.mdx @@ -101,7 +101,7 @@ async function createReservationItem (item: { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItems.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItems.mdx index e76d4bc342..294f7003cb 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItems.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.createReservationItems.mdx @@ -101,7 +101,7 @@ async function createReservationItems (items: { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx index 0bb21c6f49..b4bc6183a1 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryItem.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `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": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryLevel.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryLevel.mdx index 78edf645ec..1fbe83f9a5 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryLevel.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveInventoryLevel.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveReservationItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveReservationItem.mdx index 64f4bc8960..9275006552 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveReservationItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.retrieveReservationItem.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryItem.mdx index 8408f1924e..d7a0922ff1 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryItem.mdx @@ -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`", + "type": "`null` \\| `Record`", "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` \\| ``null``", + "type": "`Record` \\| `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": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevel.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevel.mdx index b638e5782c..f37a715ea5 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevel.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevel.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevels.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevels.mdx index 83b15a0a15..180c995833 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevels.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateInventoryLevels.mdx @@ -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, diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateReservationItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateReservationItem.mdx index 5667f822d8..0d41f98c2a 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateReservationItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/IInventoryService.updateReservationItem.mdx @@ -76,7 +76,7 @@ async function updateReservationItem ( }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/interfaces/BulkUpdateInventoryLevelInput.mdx b/www/apps/docs/content/references/inventory/interfaces/BulkUpdateInventoryLevelInput.mdx index 14ad253a09..e7850511c2 100644 --- a/www/apps/docs/content/references/inventory/interfaces/BulkUpdateInventoryLevelInput.mdx +++ b/www/apps/docs/content/references/inventory/interfaces/BulkUpdateInventoryLevelInput.mdx @@ -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, diff --git a/www/apps/docs/content/references/inventory/interfaces/CreateInventoryItemInput.mdx b/www/apps/docs/content/references/inventory/interfaces/CreateInventoryItemInput.mdx index 07a381d601..83643efb51 100644 --- a/www/apps/docs/content/references/inventory/interfaces/CreateInventoryItemInput.mdx +++ b/www/apps/docs/content/references/inventory/interfaces/CreateInventoryItemInput.mdx @@ -13,7 +13,7 @@ The details of the inventory item to be created. `", + "type": "`null` \\| `Record`", "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": "", diff --git a/www/apps/docs/content/references/inventory/interfaces/CreateReservationItemInput.mdx b/www/apps/docs/content/references/inventory/interfaces/CreateReservationItemInput.mdx index 4de0ee761f..5acd73a685 100644 --- a/www/apps/docs/content/references/inventory/interfaces/CreateReservationItemInput.mdx +++ b/www/apps/docs/content/references/inventory/interfaces/CreateReservationItemInput.mdx @@ -67,7 +67,7 @@ The details of the reservation item to be created. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/interfaces/JoinerServiceConfig.mdx b/www/apps/docs/content/references/inventory/interfaces/JoinerServiceConfig.mdx index 6591a4773f..d0af4456f0 100644 --- a/www/apps/docs/content/references/inventory/interfaces/JoinerServiceConfig.mdx +++ b/www/apps/docs/content/references/inventory/interfaces/JoinerServiceConfig.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "extends", - "type": "`{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }`[]", + "type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/interfaces/UpdateReservationItemInput.mdx b/www/apps/docs/content/references/inventory/interfaces/UpdateReservationItemInput.mdx index 192be1cd39..815fcf1b9d 100644 --- a/www/apps/docs/content/references/inventory/interfaces/UpdateReservationItemInput.mdx +++ b/www/apps/docs/content/references/inventory/interfaces/UpdateReservationItemInput.mdx @@ -31,7 +31,7 @@ The attributes to update in a reservation item. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/types/Exclude.mdx b/www/apps/docs/content/references/inventory/types/Exclude.mdx index ad34e309ff..d0c2e50b0c 100644 --- a/www/apps/docs/content/references/inventory/types/Exclude.mdx +++ b/www/apps/docs/content/references/inventory/types/Exclude.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Exclude - **Exclude**``: T extends U ? never : T + **Exclude**``: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U diff --git a/www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx b/www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx index 2e50d2b7c7..e5aa11dfa7 100644 --- a/www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx +++ b/www/apps/docs/content/references/inventory/types/InventoryItemDTO.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `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": "", diff --git a/www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx b/www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx index d4dc0847d1..150fae7a35 100644 --- a/www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx +++ b/www/apps/docs/content/references/inventory/types/InventoryLevelDTO.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/inventory/types/ModuleJoinerConfig.mdx b/www/apps/docs/content/references/inventory/types/ModuleJoinerConfig.mdx index de4da66a88..0c35f803a4 100644 --- a/www/apps/docs/content/references/inventory/types/ModuleJoinerConfig.mdx +++ b/www/apps/docs/content/references/inventory/types/ModuleJoinerConfig.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerConfig - **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), `"serviceName"` \| `"primaryKeys"` \| `"relationships"` \| `"extends"`> & { databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: `"date"` \| `"time"` \| `"datetime"` \| `"bigint"` \| `"blob"` \| `"uint8array"` \| `"array"` \| `"enumArray"` \| `"enum"` \| `"json"` \| `"integer"` \| `"smallint"` \| `"tinyint"` \| `"mediumint"` \| `"float"` \| `"double"` \| `"boolean"` \| `"decimal"` \| `"string"` \| `"uuid"` \| `"text"` }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string } + **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & ``{ databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: "date" \| "time" \| "datetime" \| bigint \| "blob" \| "uint8array" \| "array" \| "enumArray" \| "enum" \| "json" \| "integer" \| "smallint" \| "tinyint" \| "mediumint" \| "float" \| "double" \| "boolean" \| "decimal" \| "string" \| "uuid" \| "text" }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }`` diff --git a/www/apps/docs/content/references/inventory/types/ModuleJoinerRelationship.mdx b/www/apps/docs/content/references/inventory/types/ModuleJoinerRelationship.mdx index e85f23d080..f41f742feb 100644 --- a/www/apps/docs/content/references/inventory/types/ModuleJoinerRelationship.mdx +++ b/www/apps/docs/content/references/inventory/types/ModuleJoinerRelationship.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerRelationship - **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & { deleteCascade?: boolean ; isInternalService?: boolean } + **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & ``{ deleteCascade?: boolean ; isInternalService?: boolean }`` diff --git a/www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx b/www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx index 1b039b69cc..f7a961d860 100644 --- a/www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx +++ b/www/apps/docs/content/references/inventory/types/ReservationItemDTO.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/CommonTypes/interfaces/internal.internal-1.CommonTypes.SoftDeletableEntity.mdx b/www/apps/docs/content/references/js-client/CommonTypes/interfaces/internal.internal-1.CommonTypes.SoftDeletableEntity.mdx index 3712fb59ac..0f45f106fc 100644 --- a/www/apps/docs/content/references/js-client/CommonTypes/interfaces/internal.internal-1.CommonTypes.SoftDeletableEntity.mdx +++ b/www/apps/docs/content/references/js-client/CommonTypes/interfaces/internal.internal-1.CommonTypes.SoftDeletableEntity.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx b/www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx index a956f1a52d..038f3c51ee 100644 --- a/www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx +++ b/www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx @@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "database_extra", - "type": "`Record` & `{ ssl: { rejectUnauthorized: `false` } }`", + "type": "`Record` & ``{ ssl: { rejectUnauthorized: false } }``", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx similarity index 72% rename from www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx rename to www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx index eb3880ae8f..bb2ec34727 100644 --- a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx +++ b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx @@ -4,9 +4,11 @@ displayed_sidebar: jsClientSidebar import ParameterTypes from "@site/src/components/ParameterTypes" -# CreateInventoryLevelInput +# BulkUpdateInventoryLevelInput -### Type declaration +The attributes to update in an inventory level. The inventory level is identified by the IDs of its associated inventory item and location. + +## Properties ` \\| ``null``", - "description": "", + "type": "`null` \\| `Record`", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -65,8 +67,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "mid_code", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The MID code of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -74,8 +76,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "origin_country", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The origin country of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -92,8 +94,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "sku", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The SKU of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -101,8 +103,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "thumbnail", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The thumbnail of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -110,8 +112,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "title", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The title of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -119,8 +121,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "weight", - "type": "`number` \\| ``null``", - "description": "", + "type": "`null` \\| `number`", + "description": "The weight of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -128,8 +130,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "width", - "type": "`number` \\| ``null``", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx new file mode 100644 index 0000000000..d7fe7bd4f5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreateInventoryLevelInput + +The details of the inventory level to be created. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx similarity index 66% rename from www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx rename to www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx index f837c5cb8d..66109b79f6 100644 --- a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx +++ b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx @@ -6,13 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreateReservationItemInput -### Type declaration +The details of the reservation item to be created. + +## Properties ` \\| ``null``", - "description": "", + "type": "`null` \\| `Record`", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -75,7 +77,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" { "name": "quantity", "type": "`number`", - "description": "", + "description": "The reserved quantity.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx similarity index 73% rename from www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx rename to www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx index b2f63912f9..c833793610 100644 --- a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx +++ b/www/apps/docs/content/references/js-client/InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx @@ -6,13 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterableInventoryItemProps -### Type declaration +The filters to apply on retrieved inventory items. + +## Properties ` \\| ``null``", - "description": "", + "type": "`null` \\| `Record`", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -39,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" { "name": "quantity", "type": "`number`", - "description": "", + "description": "The reserved quantity.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx b/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx deleted file mode 100644 index f5756d3035..0000000000 --- a/www/apps/docs/content/references/js-client/InventoryTypes/types/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# BulkUpdateInventoryLevelInput diff --git a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx index fd2bdc8bc4..80744bf80d 100644 --- a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx +++ b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx @@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "server.type", - "type": "``\"http\"``", + "type": "`\"http\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleDefinition.mdx b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleDefinition.mdx index 15e415295d..652cbaf3df 100644 --- a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleDefinition.mdx +++ b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleDefinition.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "defaultPackage", - "type": "`string` \\| ``false``", + "type": "`string` \\| `false`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx index b164efd07f..d93586f37b 100644 --- a/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx +++ b/www/apps/docs/content/references/js-client/ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx @@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "resolutionPath", - "type": "`string` \\| ``false``", + "type": "`string` \\| `false`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx new file mode 100644 index 0000000000..7117ba17dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListStatus.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListStatus + +The price list's status. + +## Enumeration Members + +### ACTIVE + +The price list is enabled and its prices can be used. + +___ + +### DRAFT + +The price list is disabled, meaning its prices can't be used yet. diff --git a/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx new file mode 100644 index 0000000000..8612f7faa1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/enums/internal.internal-1.PricingTypes.PriceListType.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListType + +The price list's type. + +## Enumeration Members + +### OVERRIDE + +The price list's prices override original prices. This affects the calculated price of associated price sets. + +___ + +### SALE + +The price list's prices are used for a sale. diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPriceListPricesDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPriceListPricesDTO.mdx new file mode 100644 index 0000000000..946065e562 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPriceListPricesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AddPriceListPricesDTO + +The prices to be added to a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.AddRulesDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.AddRulesDTO.mdx index fb97259755..87bbbea4a8 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.AddRulesDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.AddRulesDTO.mdx @@ -22,8 +22,8 @@ The rules to add to a price set. }, { "name": "rules", - "type": "`{ attribute: string }`[]", - "description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ attribute: string }``[]", + "description": "The rules to add to a price set.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSet.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSet.mdx new file mode 100644 index 0000000000..2deece1f06 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSet.mdx @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CalculatedPriceSet + +The calculated price for a specific price set and context. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSetDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSetDTO.mdx index b0e28d7c3d..f30d522557 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSetDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CalculatedPriceSetDTO.mdx @@ -13,7 +13,7 @@ A calculated price set's data. diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateMoneyAmountDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateMoneyAmountDTO.mdx index 5dd3ce1535..9373437054 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreateMoneyAmountDTO.mdx @@ -15,7 +15,7 @@ The money amount to create. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -49,7 +49,7 @@ The money amount to create. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -58,7 +58,7 @@ The money amount to create. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListDTO.mdx new file mode 100644 index 0000000000..2a1c92a82e --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListDTO.mdx @@ -0,0 +1,95 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListDTO + +The price list to create. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleDTO.mdx new file mode 100644 index 0000000000..8854880987 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleDTO.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRuleDTO + +The price list rule to create. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleValueDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleValueDTO.mdx new file mode 100644 index 0000000000..7d163c1f02 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleValueDTO.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRuleValueDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx new file mode 100644 index 0000000000..61f3a554a2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRules.mdx @@ -0,0 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRules + +The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value + * is the values of the rule. diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx index d14bd1cfc3..01a0e79b7d 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx @@ -20,15 +20,6 @@ A price rule to create. "expandable": false, "children": [] }, - { - "name": "price_list_id", - "type": "`string`", - "description": "The ID of the associated price list.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "price_set_id", "type": "`string`", @@ -41,7 +32,7 @@ A price rule to create. { "name": "price_set_money_amount_id", "type": "`string`", - "description": "The ID of the associated price set money amount.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -50,7 +41,7 @@ A price rule to create. { "name": "priority", "type": "`number`", - "description": "The priority of the price rule in comparison to other applicable price rules.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx index 4332bcd83e..4efedbdc35 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetDTO.mdx @@ -22,8 +22,8 @@ A price set to create. }, { "name": "rules", - "type": "`{ rule_attribute: string }`[]", - "description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ rule_attribute: string }``[]", + "description": "The rules to associate with the price set.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountDTO.mdx index 3657c87d3a..daecf12792 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceSetMoneyAmountDTO.mdx @@ -18,6 +18,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "expandable": false, "children": [] }, + { + "name": "price_list", + "type": "`string` \\| [PriceListDTO](internal.internal-1.PricingTypes.PriceListDTO.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "price_set", "type": "`string` \\| [PriceSetDTO](internal.internal-1.PricingTypes.PriceSetDTO.mdx)", diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePricesDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePricesDTO.mdx index d1b5acb6de..f9b0a8e8b8 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePricesDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePricesDTO.mdx @@ -15,7 +15,7 @@ The prices to create part of a price set. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -49,7 +49,7 @@ The prices to create part of a price set. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -58,7 +58,7 @@ The prices to create part of a price set. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx new file mode 100644 index 0000000000..49f6b033df --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx @@ -0,0 +1,79 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterablePriceListProps + +#### Inteface + +Filters to apply on price lists. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx new file mode 100644 index 0000000000..a39bc8a3ca --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx @@ -0,0 +1,68 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterablePriceListRuleProps + +Filters to apply on price list rules. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleValueProps.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleValueProps.mdx new file mode 100644 index 0000000000..b719be5093 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleValueProps.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterablePriceListRuleValueProps + +An object used to allow specifying flexible queries with and/or conditions. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx index 93b7a110c2..3cd1e34a0c 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterablePriceRuleProps -Filters to apply to price rules. +Filters to apply on price rules. ## Properties diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx index 991b13f1fc..16af403b10 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx @@ -38,6 +38,15 @@ Filters to apply on price set money amounts. "expandable": false, "children": [] }, + { + "name": "price_list_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount's associated price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "price_set_id", "type": "`string`[]", diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx index 02838866f7..caa236ec37 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx @@ -23,10 +23,10 @@ A money amount's data. A money amount represents a price. { "name": "currency", "type": "[CurrencyDTO](internal.internal-1.PricingTypes.CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -64,5 +64,14 @@ A money amount's data. A money amount represents a price. "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] } ]} /> diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx new file mode 100644 index 0000000000..0e34b3dc4a --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx @@ -0,0 +1,113 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListDTO + +A price list's details. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListPriceDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListPriceDTO.mdx new file mode 100644 index 0000000000..4db783f7f3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListPriceDTO.mdx @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListPriceDTO + +The prices associated with a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx new file mode 100644 index 0000000000..a05d064d1b --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListRuleDTO + +The price list rule's details. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleValueDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleValueDTO.mdx new file mode 100644 index 0000000000..578c952b1e --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleValueDTO.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListRuleValueDTO + +The price list rule value's details. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx index a9945b4f28..5d05d258e2 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx @@ -32,10 +32,10 @@ A price rule's data. { "name": "price_set", "type": "[PriceSetDTO](internal.internal-1.PricingTypes.PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -68,10 +68,10 @@ A price rule's data. { "name": "rule_type", "type": "[RuleTypeDTO](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx index 3de898ac8d..49691b7e53 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx @@ -23,34 +23,43 @@ A price set money amount's data. { "name": "money_amount", "type": "[MoneyAmountDTO](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)", - "description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.", + "description": "The money amount associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](internal.internal-1.PricingTypes.PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, "children": [] }, { "name": "price_rules", "type": "[PriceRuleDTO](internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]", - "description": "", + "description": "The price rules associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set", "type": "[PriceSetDTO](internal.internal-1.PricingTypes.PriceSetDTO.mdx)", - "description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.", + "description": "The price set associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set_id", "type": "`string`", - "description": "", + "description": "The ID of the associated price set.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx index abd365bc74..caea7eebb9 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetMoneyAmountRulesDTO.mdx @@ -23,19 +23,19 @@ A price set money amount rule's data. { "name": "price_set_money_amount", "type": "[PriceSetMoneyAmountDTO](internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)", - "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "description": "The associated price set money amount.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "rule_type", "type": "[RuleTypeDTO](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceListRulesDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceListRulesDTO.mdx new file mode 100644 index 0000000000..235b5e0a78 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceListRulesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RemovePriceListRulesDTO + +The rules to remove from a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.SetPriceListRulesDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.SetPriceListRulesDTO.mdx new file mode 100644 index 0000000000..cec4b99247 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.SetPriceListRulesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SetPriceListRulesDTO + +The rules to add to a price list. + +## Properties + +`", + "description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value is the value(s) of the rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateMoneyAmountDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateMoneyAmountDTO.mdx index 21aee954c3..1eaf85e1bd 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateMoneyAmountDTO.mdx @@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpdateMoneyAmountDTO -* - The data to update in a money amount. The `id` is used to identify which money amount to update. ## Properties diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx new file mode 100644 index 0000000000..f01b7f2dd1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListDTO + +The attributes to update in a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleDTO.mdx new file mode 100644 index 0000000000..aed3f6a43d --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleDTO.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListRuleDTO + +The attributes to update in a price list rule. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleValueDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleValueDTO.mdx new file mode 100644 index 0000000000..f98cadebee --- /dev/null +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleValueDTO.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListRuleValueDTO + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx index c86019b818..3cab234805 100644 --- a/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/js-client/PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx @@ -14,7 +14,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "id", "type": "`string`", - "description": "The ID of the price rule to update.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -32,7 +32,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "price_set_id", "type": "`string`", - "description": "The ID of the associated price set.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -59,7 +59,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "rule_type_id", "type": "`string`", - "description": "The ID of the associated rule type.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx index 34cda8cb76..32a56069f2 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx @@ -58,7 +58,7 @@ A product category to create. }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent product category, if it has any. It may also be `null`.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx index 638d87e89c..de1f1f97c0 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx @@ -13,7 +13,7 @@ A product to create. `", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx index 87333c1f8e..06ae6e14de 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx @@ -13,7 +13,7 @@ A product's data. `", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx index 0b2925851d..513f89b0df 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx @@ -31,7 +31,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx index 6cdc7547bc..88daf74255 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx @@ -31,7 +31,7 @@ The product option value's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx index 1c5f9ef067..68b3356106 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx @@ -22,7 +22,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTypeDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTypeDTO.mdx index 523a783b7d..06e19a0f46 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTypeDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTypeDTO.mdx @@ -31,7 +31,7 @@ A product type's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx index c0d3d0f550..a786cc3085 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx @@ -22,7 +22,7 @@ A product variant's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The barcode of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -49,7 +49,7 @@ A product variant's data. }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The EAN of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -58,7 +58,7 @@ A product variant's data. }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -67,7 +67,7 @@ A product variant's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The HS Code of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -94,7 +94,7 @@ A product variant's data. }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -112,7 +112,7 @@ A product variant's data. }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -121,7 +121,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -130,7 +130,7 @@ A product variant's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The MID Code of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -148,7 +148,7 @@ A product variant's data. }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The origin country of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -175,7 +175,7 @@ A product variant's data. }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The SKU of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -193,7 +193,7 @@ A product variant's data. }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The UPC of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -211,7 +211,7 @@ A product variant's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -220,7 +220,7 @@ A product variant's data. }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", @@ -229,7 +229,7 @@ A product variant's data. }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the product variant. It can possibly be `null`.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx index 9fd389f187..3bef7a65d0 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx @@ -58,7 +58,7 @@ The data to update in a product category. }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent product category, if it has any. It may also be `null`.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx index 253ae23585..0481fb92c1 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx @@ -13,7 +13,7 @@ The data to update in a product. The `id` is used to identify which product to u `", + "type": "`null` \\| `Record`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx b/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx index b7a2ca26f3..23601c7a3d 100644 --- a/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx +++ b/www/apps/docs/content/references/js-client/SearchTypes/interfaces/internal.internal-1.SearchTypes.ISearchService.mdx @@ -298,7 +298,7 @@ Used to search for a document in an index }, { "name": "query", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "the search query", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx b/www/apps/docs/content/references/js-client/StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx similarity index 76% rename from www/apps/docs/content/references/js-client/StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx rename to www/apps/docs/content/references/js-client/StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx index bd69b89014..c8dfbbe964 100644 --- a/www/apps/docs/content/references/js-client/StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx +++ b/www/apps/docs/content/references/js-client/StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx @@ -6,13 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterableStockLocationProps -### Type declaration +The filters to apply on the retrieved stock locations. + +## Properties ` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -94,7 +94,7 @@ Represents a Stock Location Address }, { "name": "phone", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' phone number", "optional": true, "defaultValue": "", @@ -103,7 +103,7 @@ Represents a Stock Location Address }, { "name": "postal_code", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' postal code", "optional": true, "defaultValue": "", @@ -112,7 +112,7 @@ Represents a Stock Location Address }, { "name": "province", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' province", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AddressesResource.mdx b/www/apps/docs/content/references/js-client/classes/AddressesResource.mdx index 659d259a12..bfd450d13b 100644 --- a/www/apps/docs/content/references/js-client/classes/AddressesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AddressesResource.mdx @@ -197,7 +197,7 @@ medusa.customers.addresses "children": [ { "name": "customer", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">", "description": "Customer details.", "optional": false, "defaultValue": "", @@ -214,7 +214,7 @@ medusa.customers.addresses }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -232,7 +232,7 @@ medusa.customers.addresses }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -407,7 +407,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => { "children": [ { "name": "customer", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">", "description": "Customer details.", "optional": false, "defaultValue": "", @@ -424,7 +424,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => { }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -442,7 +442,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -730,7 +730,7 @@ medusa.customers.addresses "children": [ { "name": "customer", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">", "description": "Customer details.", "optional": false, "defaultValue": "", @@ -747,7 +747,7 @@ medusa.customers.addresses }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -765,7 +765,7 @@ medusa.customers.addresses }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminAuthResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminAuthResource.mdx index 1f53e21d72..e74695be9b 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminAuthResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminAuthResource.mdx @@ -99,7 +99,7 @@ medusa.admin.AdminAuthResource.createSession({ "children": [ { "name": "user", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">", "description": "User details.", "optional": false, "defaultValue": "", @@ -125,7 +125,7 @@ medusa.admin.AdminAuthResource.createSession({ }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -299,7 +299,7 @@ medusa.admin.auth.getSession().then(({ user }) => { "children": [ { "name": "user", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">", "description": "User details.", "optional": false, "defaultValue": "", @@ -325,7 +325,7 @@ medusa.admin.auth.getSession().then(({ user }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.mdx index 36f733a417..276a86876c 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.mdx @@ -131,7 +131,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => { }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the batch job.", "optional": false, "defaultValue": "", @@ -149,7 +149,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -203,7 +203,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => { }, { "name": "result", - "type": "`{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }` & `Record`", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", @@ -359,7 +359,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => { }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the batch job.", "optional": false, "defaultValue": "", @@ -377,7 +377,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -431,7 +431,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => { }, { "name": "result", - "type": "`{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }` & `Record`", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", @@ -620,7 +620,7 @@ medusa.admin.batchJobs.create({ }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the batch job.", "optional": false, "defaultValue": "", @@ -638,7 +638,7 @@ medusa.admin.batchJobs.create({ }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -692,7 +692,7 @@ medusa.admin.batchJobs.create({ }, { "name": "result", - "type": "`{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }` & `Record`", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", @@ -798,7 +798,7 @@ medusa.admin.batchJobs "children": [ { "name": "canceled_at", - "type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", + "type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", "description": "Date filters to apply on the batch jobs' `canceled_at` date.", "optional": true, "defaultValue": "", @@ -807,7 +807,7 @@ medusa.admin.batchJobs }, { "name": "completed_at", - "type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", + "type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", "description": "Date filters to apply on the batch jobs' `completed_at` date.", "optional": true, "defaultValue": "", @@ -816,7 +816,7 @@ medusa.admin.batchJobs }, { "name": "confirmed_at", - "type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", + "type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", "description": "Date filters to apply on the batch jobs' `confirmed_at` date.", "optional": true, "defaultValue": "", @@ -880,7 +880,7 @@ medusa.admin.batchJobs }, { "name": "failed_at", - "type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", + "type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", "description": "Date filters to apply on the batch jobs' `failed_at` date.", "optional": true, "defaultValue": "", @@ -934,7 +934,7 @@ medusa.admin.batchJobs }, { "name": "pre_processed_at", - "type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", + "type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)", "description": "Date filters to apply on the batch jobs' `pre_processed_at` date.", "optional": true, "defaultValue": "", @@ -1022,7 +1022,7 @@ medusa.admin.batchJobs "children": [ { "name": "AdminBatchJobListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ batch_jobs: [BatchJob](../internal/classes/internal.BatchJob.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ batch_jobs: [BatchJob](../internal/classes/internal.BatchJob.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -1110,7 +1110,7 @@ medusa.admin.batchJobs }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the batch job.", "optional": false, "defaultValue": "", @@ -1128,7 +1128,7 @@ medusa.admin.batchJobs }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1182,7 +1182,7 @@ medusa.admin.batchJobs }, { "name": "result", - "type": "`{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }` & `Record`", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", @@ -1338,7 +1338,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => { }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the batch job.", "optional": false, "defaultValue": "", @@ -1356,7 +1356,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1410,7 +1410,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => { }, { "name": "result", - "type": "`{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }` & `Record`", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.mdx index 9e42222d25..5955cc7d4c 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.mdx @@ -115,7 +115,7 @@ medusa.admin.collections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -294,7 +294,7 @@ medusa.admin.collections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -713,7 +713,7 @@ medusa.admin.collections "children": [ { "name": "AdminCollectionsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -765,7 +765,7 @@ medusa.admin.collections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1027,7 +1027,7 @@ medusa.admin.collections.retrieve(collectionId).then(({ collection }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1215,7 +1215,7 @@ medusa.admin.collections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.mdx index db9c8f2df3..a509bc4069 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.mdx @@ -135,7 +135,7 @@ medusa.admin.currencies "children": [ { "name": "AdminCurrenciesListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ currencies: [Currency](../internal/classes/internal.Currency.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ currencies: [Currency](../internal/classes/internal.Currency.mdx)[] }``", "description": "List of currencies with pagination fields.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx index 1c7d924a8b..c427d81ae1 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx @@ -122,7 +122,7 @@ Add a list of customers to a customer group. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ medusa.admin.customerGroups }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -690,7 +690,7 @@ medusa.admin.customerGroups "children": [ { "name": "AdminCustomerGroupsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ customer_groups: [CustomerGroup](../internal/classes/internal.CustomerGroup.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ customer_groups: [CustomerGroup](../internal/classes/internal.CustomerGroup.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -751,7 +751,7 @@ medusa.admin.customerGroups }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -930,7 +930,7 @@ medusa.admin.customerGroups "children": [ { "name": "AdminCustomersListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ customers: [Customer](../internal/classes/internal.Customer.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ customers: [Customer](../internal/classes/internal.Customer.mdx)[] }``", "description": "The list of customers with pagination fields.", "optional": false, "defaultValue": "", @@ -982,7 +982,7 @@ medusa.admin.customerGroups }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -1000,7 +1000,7 @@ medusa.admin.customerGroups }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1238,7 +1238,7 @@ medusa.admin.customerGroups }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1415,7 +1415,7 @@ medusa.admin.customerGroups }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1579,7 +1579,7 @@ Update a customer group's details. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.mdx index 2231cb795f..96951f38e7 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.mdx @@ -156,7 +156,7 @@ medusa.admin.customers }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -174,7 +174,7 @@ medusa.admin.customers }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -430,7 +430,7 @@ medusa.admin.customers "children": [ { "name": "AdminCustomersListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ customers: [Customer](../internal/classes/internal.Customer.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ customers: [Customer](../internal/classes/internal.Customer.mdx)[] }``", "description": "The list of customers with pagination fields.", "optional": false, "defaultValue": "", @@ -482,7 +482,7 @@ medusa.admin.customers }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -500,7 +500,7 @@ medusa.admin.customers }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -692,7 +692,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => { }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -710,7 +710,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -989,7 +989,7 @@ medusa.admin.customers }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -1007,7 +1007,7 @@ medusa.admin.customers }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.mdx index 822c989d81..f87d7de53c 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.mdx @@ -94,7 +94,7 @@ medusa.admin.discounts "children": [ { "name": "resources", - "type": "`{ id: string }`[]", + "type": "``{ id: string }``[]", "description": "The resources to be added to the discount condition", "optional": false, "defaultValue": "", @@ -199,7 +199,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -208,7 +208,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -325,7 +325,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -334,7 +334,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -445,7 +445,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -454,7 +454,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => { }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -571,7 +571,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => { }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -580,7 +580,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => { }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -708,7 +708,7 @@ medusa.admin.discounts "children": [ { "name": "ITEM", - "type": "``\"item\"``", + "type": "`\"item\"`", "description": "The discount should be applied to applicable items in the cart.", "optional": true, "defaultValue": "", @@ -717,7 +717,7 @@ medusa.admin.discounts }, { "name": "TOTAL", - "type": "``\"total\"``", + "type": "`\"total\"`", "description": "The discount should be applied to the checkout total.", "optional": true, "defaultValue": "", @@ -809,7 +809,7 @@ medusa.admin.discounts "children": [ { "name": "FIXED", - "type": "``\"fixed\"``", + "type": "`\"fixed\"`", "description": "Discounts that reduce the price by a fixed amount.", "optional": true, "defaultValue": "", @@ -818,7 +818,7 @@ medusa.admin.discounts }, { "name": "FREE_SHIPPING", - "type": "``\"free_shipping\"``", + "type": "`\"free_shipping\"`", "description": "Discounts that sets the shipping price to `0`.", "optional": true, "defaultValue": "", @@ -827,7 +827,7 @@ medusa.admin.discounts }, { "name": "PERCENTAGE", - "type": "``\"percentage\"``", + "type": "`\"percentage\"`", "description": "Discounts that reduce the price by a percentage reduction.", "optional": true, "defaultValue": "", @@ -934,7 +934,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -943,7 +943,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -1060,7 +1060,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -1069,7 +1069,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -1172,7 +1172,7 @@ medusa.admin.discounts "children": [ { "name": "IN", - "type": "``\"in\"``", + "type": "`\"in\"`", "description": "The discountable resources are within the specified resources.", "optional": true, "defaultValue": "", @@ -1181,7 +1181,7 @@ medusa.admin.discounts }, { "name": "NOT_IN", - "type": "``\"not_in\"``", + "type": "`\"not_in\"`", "description": "The discountable resources are everything but the specified resources.", "optional": true, "defaultValue": "", @@ -1314,7 +1314,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1323,7 +1323,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -1440,7 +1440,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -1449,7 +1449,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -1593,7 +1593,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1602,7 +1602,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -1719,7 +1719,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -1728,7 +1728,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -1970,7 +1970,7 @@ medusa.admin.discounts "children": [ { "name": "resources", - "type": "`{ id: string }`[]", + "type": "``{ id: string }``[]", "description": "The resources to be removed from the discount condition", "optional": false, "defaultValue": "", @@ -2047,7 +2047,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2056,7 +2056,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -2173,7 +2173,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -2182,7 +2182,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -2295,7 +2295,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2304,7 +2304,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -2421,7 +2421,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -2430,7 +2430,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -2588,7 +2588,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2845,7 +2845,7 @@ medusa.admin.discounts "children": [ { "name": "ITEM", - "type": "``\"item\"``", + "type": "`\"item\"`", "description": "The discount should be applied to applicable items in the cart.", "optional": true, "defaultValue": "", @@ -2854,7 +2854,7 @@ medusa.admin.discounts }, { "name": "TOTAL", - "type": "``\"total\"``", + "type": "`\"total\"`", "description": "The discount should be applied to the checkout total.", "optional": true, "defaultValue": "", @@ -2873,7 +2873,7 @@ medusa.admin.discounts "children": [ { "name": "FIXED", - "type": "``\"fixed\"``", + "type": "`\"fixed\"`", "description": "Discounts that reduce the price by a fixed amount.", "optional": true, "defaultValue": "", @@ -2882,7 +2882,7 @@ medusa.admin.discounts }, { "name": "FREE_SHIPPING", - "type": "``\"free_shipping\"``", + "type": "`\"free_shipping\"`", "description": "Discounts that sets the shipping price to `0`.", "optional": true, "defaultValue": "", @@ -2891,7 +2891,7 @@ medusa.admin.discounts }, { "name": "PERCENTAGE", - "type": "``\"percentage\"``", + "type": "`\"percentage\"`", "description": "Discounts that reduce the price by a percentage reduction.", "optional": true, "defaultValue": "", @@ -2928,7 +2928,7 @@ medusa.admin.discounts "children": [ { "name": "AdminDiscountsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ discounts: [Discount](../internal/classes/internal.Discount-1.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ discounts: [Discount](../internal/classes/internal.Discount-1.mdx)[] }``", "description": "The list of discounts with pagination fields.", "optional": false, "defaultValue": "", @@ -2989,7 +2989,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2998,7 +2998,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -3115,7 +3115,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -3124,7 +3124,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -3237,7 +3237,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3246,7 +3246,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -3363,7 +3363,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -3372,7 +3372,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -3474,7 +3474,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3483,7 +3483,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => { }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -3600,7 +3600,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => { }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -3609,7 +3609,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => { }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -3711,7 +3711,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3720,7 +3720,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => { }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -3837,7 +3837,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => { }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -3846,7 +3846,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => { }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -3913,7 +3913,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date and time at which the discount should no longer be available.", "optional": true, "defaultValue": "", @@ -3965,7 +3965,7 @@ medusa.admin.discounts "children": [ { "name": "ITEM", - "type": "``\"item\"``", + "type": "`\"item\"`", "description": "The discount should be applied to applicable items in the cart.", "optional": true, "defaultValue": "", @@ -3974,7 +3974,7 @@ medusa.admin.discounts }, { "name": "TOTAL", - "type": "``\"total\"``", + "type": "`\"total\"`", "description": "The discount should be applied to the checkout total.", "optional": true, "defaultValue": "", @@ -4096,7 +4096,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Maximum number of times the discount can be used", "optional": true, "defaultValue": "", @@ -4105,7 +4105,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The duration the discount runs between", "optional": true, "defaultValue": "", @@ -4172,7 +4172,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -4181,7 +4181,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -4298,7 +4298,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -4307,7 +4307,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", @@ -4530,7 +4530,7 @@ medusa.admin.discounts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -4539,7 +4539,7 @@ medusa.admin.discounts }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -4656,7 +4656,7 @@ medusa.admin.discounts }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -4665,7 +4665,7 @@ medusa.admin.discounts }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.mdx index a06d4cae43..a6ec0cd6cf 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.mdx @@ -861,7 +861,7 @@ medusa.admin.draftOrders "children": [ { "name": "AdminDraftOrdersListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ draft_orders: [DraftOrder](../internal/classes/internal.DraftOrder.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ draft_orders: [DraftOrder](../internal/classes/internal.DraftOrder.mdx)[] }``", "description": "The list of draft orders with pagination fields.", "optional": false, "defaultValue": "", @@ -1268,7 +1268,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -1349,7 +1349,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -1493,7 +1493,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -1529,7 +1529,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -1574,7 +1574,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => { }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -1583,7 +1583,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.mdx index 896d8fea70..2a0381507e 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.mdx @@ -163,7 +163,7 @@ medusa.admin.giftCards }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -244,7 +244,7 @@ medusa.admin.giftCards }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", @@ -458,7 +458,7 @@ medusa.admin.giftCards "children": [ { "name": "AdminGiftCardsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ gift_cards: [GiftCard](../internal/classes/internal.GiftCard-1.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ gift_cards: [GiftCard](../internal/classes/internal.GiftCard-1.mdx)[] }``", "description": "The list of gift cards with pagination fields.", "optional": false, "defaultValue": "", @@ -528,7 +528,7 @@ medusa.admin.giftCards }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -609,7 +609,7 @@ medusa.admin.giftCards }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", @@ -738,7 +738,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -819,7 +819,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => { }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", @@ -904,7 +904,7 @@ medusa.admin.giftCards }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date and time at which the Gift Card should no longer be available.", "optional": true, "defaultValue": "", @@ -1007,7 +1007,7 @@ medusa.admin.giftCards }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1088,7 +1088,7 @@ medusa.admin.giftCards }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.mdx index 60281ebd8e..bdebe7c5bf 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.mdx @@ -254,7 +254,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -263,7 +263,7 @@ medusa.admin.inventoryItems }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the inventory item", "optional": true, "defaultValue": "", @@ -272,7 +272,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -281,7 +281,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -299,7 +299,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -308,7 +308,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -317,7 +317,7 @@ medusa.admin.inventoryItems }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -326,7 +326,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -335,7 +335,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -353,7 +353,7 @@ medusa.admin.inventoryItems }, { "name": "sku", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", @@ -362,7 +362,7 @@ medusa.admin.inventoryItems }, { "name": "thumbnail", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", @@ -371,7 +371,7 @@ medusa.admin.inventoryItems }, { "name": "title", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Title of the inventory item", "optional": true, "defaultValue": "", @@ -389,7 +389,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -398,7 +398,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -561,7 +561,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -570,7 +570,7 @@ medusa.admin.inventoryItems }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the inventory item", "optional": true, "defaultValue": "", @@ -579,7 +579,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -588,7 +588,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -606,7 +606,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -615,7 +615,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -624,7 +624,7 @@ medusa.admin.inventoryItems }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -633,7 +633,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -642,7 +642,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -660,7 +660,7 @@ medusa.admin.inventoryItems }, { "name": "sku", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", @@ -669,7 +669,7 @@ medusa.admin.inventoryItems }, { "name": "thumbnail", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", @@ -678,7 +678,7 @@ medusa.admin.inventoryItems }, { "name": "title", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Title of the inventory item", "optional": true, "defaultValue": "", @@ -696,7 +696,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -705,7 +705,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1056,7 +1056,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1065,7 +1065,7 @@ medusa.admin.inventoryItems }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the inventory item", "optional": true, "defaultValue": "", @@ -1074,7 +1074,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1083,7 +1083,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1101,7 +1101,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1110,7 +1110,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1119,7 +1119,7 @@ medusa.admin.inventoryItems }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -1128,7 +1128,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1137,7 +1137,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1155,7 +1155,7 @@ medusa.admin.inventoryItems }, { "name": "sku", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", @@ -1164,7 +1164,7 @@ medusa.admin.inventoryItems }, { "name": "thumbnail", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", @@ -1173,7 +1173,7 @@ medusa.admin.inventoryItems }, { "name": "title", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Title of the inventory item", "optional": true, "defaultValue": "", @@ -1191,7 +1191,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1200,7 +1200,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1425,7 +1425,7 @@ medusa.admin.inventoryItems "children": [ { "name": "AdminInventoryItemsListWithVariantsAndLocationLevelsRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ inventory_items: [DecoratedInventoryItemDTO](../internal/types/internal.DecoratedInventoryItemDTO.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ inventory_items: [DecoratedInventoryItemDTO](../internal/types/internal.DecoratedInventoryItemDTO.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -1477,7 +1477,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1486,7 +1486,7 @@ medusa.admin.inventoryItems }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the inventory item", "optional": true, "defaultValue": "", @@ -1495,7 +1495,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1504,7 +1504,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1522,7 +1522,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1531,7 +1531,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1540,7 +1540,7 @@ medusa.admin.inventoryItems }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -1549,7 +1549,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1558,7 +1558,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1576,7 +1576,7 @@ medusa.admin.inventoryItems }, { "name": "sku", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", @@ -1585,7 +1585,7 @@ medusa.admin.inventoryItems }, { "name": "thumbnail", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", @@ -1594,7 +1594,7 @@ medusa.admin.inventoryItems }, { "name": "title", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Title of the inventory item", "optional": true, "defaultValue": "", @@ -1612,7 +1612,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1621,7 +1621,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1912,7 +1912,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1921,7 +1921,7 @@ medusa.admin.inventoryItems }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the inventory item", "optional": true, "defaultValue": "", @@ -1930,7 +1930,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1939,7 +1939,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1957,7 +1957,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1966,7 +1966,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1975,7 +1975,7 @@ medusa.admin.inventoryItems }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -1984,7 +1984,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -1993,7 +1993,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2011,7 +2011,7 @@ medusa.admin.inventoryItems }, { "name": "sku", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", @@ -2020,7 +2020,7 @@ medusa.admin.inventoryItems }, { "name": "thumbnail", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", @@ -2029,7 +2029,7 @@ medusa.admin.inventoryItems }, { "name": "title", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Title of the inventory item", "optional": true, "defaultValue": "", @@ -2047,7 +2047,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2056,7 +2056,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2308,7 +2308,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2317,7 +2317,7 @@ medusa.admin.inventoryItems }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the inventory item", "optional": true, "defaultValue": "", @@ -2326,7 +2326,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2335,7 +2335,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2353,7 +2353,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2362,7 +2362,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2371,7 +2371,7 @@ medusa.admin.inventoryItems }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -2380,7 +2380,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2389,7 +2389,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2407,7 +2407,7 @@ medusa.admin.inventoryItems }, { "name": "sku", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", @@ -2416,7 +2416,7 @@ medusa.admin.inventoryItems }, { "name": "thumbnail", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", @@ -2425,7 +2425,7 @@ medusa.admin.inventoryItems }, { "name": "title", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Title of the inventory item", "optional": true, "defaultValue": "", @@ -2443,7 +2443,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2452,7 +2452,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2614,7 +2614,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2623,7 +2623,7 @@ medusa.admin.inventoryItems }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the inventory item", "optional": true, "defaultValue": "", @@ -2632,7 +2632,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2641,7 +2641,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2659,7 +2659,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2668,7 +2668,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2677,7 +2677,7 @@ medusa.admin.inventoryItems }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -2686,7 +2686,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2695,7 +2695,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2713,7 +2713,7 @@ medusa.admin.inventoryItems }, { "name": "sku", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", @@ -2722,7 +2722,7 @@ medusa.admin.inventoryItems }, { "name": "thumbnail", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", @@ -2731,7 +2731,7 @@ medusa.admin.inventoryItems }, { "name": "title", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Title of the inventory item", "optional": true, "defaultValue": "", @@ -2749,7 +2749,7 @@ medusa.admin.inventoryItems }, { "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": "", @@ -2758,7 +2758,7 @@ medusa.admin.inventoryItems }, { "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": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.mdx index cd8a7b1b77..261253e8b8 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.mdx @@ -372,7 +372,7 @@ medusa.admin.invites.list().then(({ invites }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx index 7705360f81..cb594373f1 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx @@ -144,7 +144,7 @@ medusa.admin.notes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -394,7 +394,7 @@ medusa.admin.notes "children": [ { "name": "AdminNotesListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ notes: [Note](../internal/classes/internal.Note.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ notes: [Note](../internal/classes/internal.Note.mdx)[] }``", "description": "The list of notes with pagination fields.", "optional": false, "defaultValue": "", @@ -464,7 +464,7 @@ medusa.admin.notes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -629,7 +629,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -817,7 +817,7 @@ medusa.admin.notes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.mdx index 5a5e1d89c0..5ea81c5e0f 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.mdx @@ -185,7 +185,7 @@ medusa.admin.notifications "children": [ { "name": "AdminNotificationsListRes", - "type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `{ notifications: [Notification](../internal/classes/internal.Notification.mdx)[] }`", + "type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & ``{ notifications: [Notification](../internal/classes/internal.Notification.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -246,7 +246,7 @@ medusa.admin.notifications }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", @@ -475,7 +475,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => { }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.mdx index 6a95a763ec..581188cbcf 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.mdx @@ -362,7 +362,7 @@ medusa.admin.orderEdits }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -698,7 +698,7 @@ medusa.admin.orderEdits.cancel(orderEditId).then(({ order_edit }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1034,7 +1034,7 @@ medusa.admin.orderEdits.confirm(orderEditId).then(({ order_edit }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1398,7 +1398,7 @@ medusa.admin.orderEdits.create({ orderId }).then(({ order_edit }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1603,7 +1603,7 @@ medusa.admin.orderEdits }, { "name": "object", - "type": "``\"item_change\"``", + "type": "`\"item_change\"`", "description": "The type of the object that was deleted.", "optional": false, "defaultValue": "item_change", @@ -1758,7 +1758,7 @@ medusa.admin.orderEdits "children": [ { "name": "AdminOrderEditsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ order_edits: [OrderEdit](../internal/classes/internal.OrderEdit.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ order_edits: [OrderEdit](../internal/classes/internal.OrderEdit.mdx)[] }``", "description": "The list of order edits with pagination fields.", "optional": false, "defaultValue": "", @@ -2035,7 +2035,7 @@ medusa.admin.orderEdits }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -2383,7 +2383,7 @@ medusa.admin.orderEdits }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -2721,7 +2721,7 @@ medusa.admin.orderEdits.requestConfirmation(orderEditId) }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -3102,7 +3102,7 @@ medusa.admin.orderEdits }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -3461,7 +3461,7 @@ medusa.admin.orderEdits }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -3830,7 +3830,7 @@ medusa.admin.orderEdits }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.mdx index 3aaf07c38a..34eabb7b69 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.mdx @@ -900,7 +900,7 @@ medusa.admin.orders }, { "name": "type", - "type": "``\"refund\"`` \\| ``\"replace\"``", + "type": "`\"refund\"` \\| `\"replace\"`", "description": "The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items.", "optional": false, "defaultValue": "", @@ -2040,7 +2040,7 @@ medusa.admin.orders "children": [ { "name": "AdminOrdersListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ orders: [Order](../internal/classes/internal.Order.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ orders: [Order](../internal/classes/internal.Order.mdx)[] }``", "description": "The list of orders with pagination fields.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.mdx index 9429241d61..a2ff6185df 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.mdx @@ -95,7 +95,7 @@ medusa.admin.paymentCollections }, { "name": "object", - "type": "``\"payment_collection\"``", + "type": "`\"payment_collection\"`", "description": "The type of the object that was deleted.", "optional": false, "defaultValue": "payment_collection", @@ -188,7 +188,7 @@ medusa.admin.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -233,7 +233,7 @@ medusa.admin.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -242,7 +242,7 @@ medusa.admin.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", @@ -463,7 +463,7 @@ medusa.admin.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -508,7 +508,7 @@ medusa.admin.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -517,7 +517,7 @@ medusa.admin.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", @@ -723,7 +723,7 @@ medusa.admin.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -768,7 +768,7 @@ medusa.admin.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -777,7 +777,7 @@ medusa.admin.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.mdx index e4d8702893..13ca66c61f 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.mdx @@ -331,7 +331,7 @@ medusa.admin.payments "children": [ { "name": "CLAIM", - "type": "``\"claim\"``", + "type": "`\"claim\"`", "description": "The refund is applied because of a created claim.", "optional": true, "defaultValue": "", @@ -340,7 +340,7 @@ medusa.admin.payments }, { "name": "DISCOUNT", - "type": "``\"discount\"``", + "type": "`\"discount\"`", "description": "The refund is applied as a discount.", "optional": true, "defaultValue": "", @@ -349,7 +349,7 @@ medusa.admin.payments }, { "name": "OTHER", - "type": "``\"other\"``", + "type": "`\"other\"`", "description": "The refund is created for a custom reason.", "optional": true, "defaultValue": "", @@ -358,7 +358,7 @@ medusa.admin.payments }, { "name": "RETURN", - "type": "``\"return\"``", + "type": "`\"return\"`", "description": "The refund is applied because of a created return.", "optional": true, "defaultValue": "", @@ -367,7 +367,7 @@ medusa.admin.payments }, { "name": "SWAP", - "type": "``\"swap\"``", + "type": "`\"swap\"`", "description": "The refund is applied because of a created swap.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.mdx index 5141cb84e3..b09d4d031f 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.mdx @@ -205,7 +205,7 @@ medusa.admin.priceLists }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -223,7 +223,7 @@ medusa.admin.priceLists }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -269,7 +269,7 @@ medusa.admin.priceLists }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", @@ -488,8 +488,8 @@ medusa.admin.priceLists "children": [ { "name": "ACTIVE", - "type": "``\"active\"``", - "description": "The price list is active, meaning its prices are applied to customers.", + "type": "`\"active\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -497,8 +497,8 @@ medusa.admin.priceLists }, { "name": "DRAFT", - "type": "``\"draft\"``", - "description": "The price list is a draft, meaning its not yet applied to customers.", + "type": "`\"draft\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -516,8 +516,8 @@ medusa.admin.priceLists "children": [ { "name": "OVERRIDE", - "type": "``\"override\"``", - "description": "The price list is used to override original prices for specific conditions.", + "type": "`\"override\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -525,8 +525,8 @@ medusa.admin.priceLists }, { "name": "SALE", - "type": "``\"sale\"``", - "description": "The price list is used for a sale.", + "type": "`\"sale\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -594,7 +594,7 @@ medusa.admin.priceLists }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -612,7 +612,7 @@ medusa.admin.priceLists }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -658,7 +658,7 @@ medusa.admin.priceLists }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", @@ -1455,7 +1455,7 @@ medusa.admin.priceLists }, { "name": "status", - "type": "[PriceListStatus](../internal/enums/internal.PriceListStatus.mdx)[]", + "type": "[PriceListStatus](../internal/enums/internal.PriceListStatus-1.mdx)[]", "description": "Statuses to filter price lists by.", "optional": true, "defaultValue": "", @@ -1463,7 +1463,7 @@ medusa.admin.priceLists "children": [ { "name": "ACTIVE", - "type": "``\"active\"``", + "type": "`\"active\"`", "description": "The price list is active, meaning its prices are applied to customers.", "optional": true, "defaultValue": "", @@ -1472,7 +1472,7 @@ medusa.admin.priceLists }, { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "The price list is a draft, meaning its not yet applied to customers.", "optional": true, "defaultValue": "", @@ -1483,7 +1483,7 @@ medusa.admin.priceLists }, { "name": "type", - "type": "[PriceListType](../internal/enums/internal.PriceListType.mdx)[]", + "type": "[PriceListType](../internal/enums/internal.PriceListType-1.mdx)[]", "description": "Types to filter price lists by.", "optional": true, "defaultValue": "", @@ -1491,7 +1491,7 @@ medusa.admin.priceLists "children": [ { "name": "OVERRIDE", - "type": "``\"override\"``", + "type": "`\"override\"`", "description": "The price list is used to override original prices for specific conditions.", "optional": true, "defaultValue": "", @@ -1500,7 +1500,7 @@ medusa.admin.priceLists }, { "name": "SALE", - "type": "``\"sale\"``", + "type": "`\"sale\"`", "description": "The price list is used for a sale.", "optional": true, "defaultValue": "", @@ -1581,7 +1581,7 @@ medusa.admin.priceLists "children": [ { "name": "AdminPriceListsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ price_lists: [PriceList](../internal/classes/internal.PriceList.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ price_lists: [PriceList](../internal/classes/internal.PriceList.mdx)[] }``", "description": "The list of price lists with pagination fields.", "optional": false, "defaultValue": "", @@ -1642,7 +1642,7 @@ medusa.admin.priceLists }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1660,7 +1660,7 @@ medusa.admin.priceLists }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -1706,7 +1706,7 @@ medusa.admin.priceLists }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", @@ -2022,7 +2022,7 @@ medusa.admin.priceLists "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "The product is a draft. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -2031,7 +2031,7 @@ medusa.admin.priceLists }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "The product is proposed, but not yet published.", "optional": true, "defaultValue": "", @@ -2040,7 +2040,7 @@ medusa.admin.priceLists }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "The product is published.", "optional": true, "defaultValue": "", @@ -2049,7 +2049,7 @@ medusa.admin.priceLists }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "The product is rejected. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -2157,7 +2157,7 @@ medusa.admin.priceLists "children": [ { "name": "AdminPriceListsProductsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ products: [Product](../internal/classes/internal.Product.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ products: [Product](../internal/classes/internal.Product.mdx)[] }``", "description": "The list of products with pagination fields.", "optional": false, "defaultValue": "", @@ -2219,7 +2219,7 @@ medusa.admin.priceLists }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -2237,7 +2237,7 @@ medusa.admin.priceLists }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2246,7 +2246,7 @@ medusa.admin.priceLists }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -2264,7 +2264,7 @@ medusa.admin.priceLists }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -2273,7 +2273,7 @@ medusa.admin.priceLists }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -2282,7 +2282,7 @@ medusa.admin.priceLists }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2291,7 +2291,7 @@ medusa.admin.priceLists }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2327,7 +2327,7 @@ medusa.admin.priceLists }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2336,7 +2336,7 @@ medusa.admin.priceLists }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2345,7 +2345,7 @@ medusa.admin.priceLists }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -2354,7 +2354,7 @@ medusa.admin.priceLists }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2372,7 +2372,7 @@ medusa.admin.priceLists }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2426,7 +2426,7 @@ medusa.admin.priceLists }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -2444,7 +2444,7 @@ medusa.admin.priceLists }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -2471,7 +2471,7 @@ medusa.admin.priceLists }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -2498,7 +2498,7 @@ medusa.admin.priceLists }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2507,7 +2507,7 @@ medusa.admin.priceLists }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2609,7 +2609,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2627,7 +2627,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => { }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -2673,7 +2673,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => { }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", @@ -2786,7 +2786,7 @@ medusa.admin.priceLists }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List ends being valid.", "optional": true, "defaultValue": "", @@ -2887,7 +2887,7 @@ medusa.admin.priceLists }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": true, "defaultValue": "", @@ -2904,8 +2904,8 @@ medusa.admin.priceLists "children": [ { "name": "ACTIVE", - "type": "``\"active\"``", - "description": "The price list is active, meaning its prices are applied to customers.", + "type": "`\"active\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -2913,8 +2913,8 @@ medusa.admin.priceLists }, { "name": "DRAFT", - "type": "``\"draft\"``", - "description": "The price list is a draft, meaning its not yet applied to customers.", + "type": "`\"draft\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -2932,8 +2932,8 @@ medusa.admin.priceLists "children": [ { "name": "OVERRIDE", - "type": "``\"override\"``", - "description": "The price list is used to override original prices for specific conditions.", + "type": "`\"override\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -2941,8 +2941,8 @@ medusa.admin.priceLists }, { "name": "SALE", - "type": "``\"sale\"``", - "description": "The price list is used for a sale.", + "type": "`\"sale\"`", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -3010,7 +3010,7 @@ medusa.admin.priceLists }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3028,7 +3028,7 @@ medusa.admin.priceLists }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -3074,7 +3074,7 @@ medusa.admin.priceLists }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.mdx index 9794a7a7ee..26fdc9e5b5 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.mdx @@ -200,7 +200,7 @@ medusa.admin.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -209,7 +209,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -330,7 +330,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent product category", "optional": true, "defaultValue": "", @@ -451,7 +451,7 @@ medusa.admin.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -460,7 +460,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -725,7 +725,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Filter product categories by their associated parent ID.", "optional": true, "defaultValue": "", @@ -767,7 +767,7 @@ medusa.admin.productCategories "children": [ { "name": "AdminProductCategoriesListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] }``", "description": "The list of product categories with pagination fields.", "optional": false, "defaultValue": "", @@ -882,7 +882,7 @@ medusa.admin.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -891,7 +891,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -1111,7 +1111,7 @@ medusa.admin.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -1120,7 +1120,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -1350,7 +1350,7 @@ medusa.admin.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -1359,7 +1359,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -1489,7 +1489,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent product category", "optional": true, "defaultValue": "", @@ -1619,7 +1619,7 @@ medusa.admin.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -1628,7 +1628,7 @@ medusa.admin.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.mdx index ffac6a6034..cec802643e 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.mdx @@ -233,7 +233,7 @@ medusa.admin.productTags "children": [ { "name": "AdminProductTagsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] }``", "description": "The list of product tags with pagination fields.", "optional": false, "defaultValue": "", @@ -285,7 +285,7 @@ medusa.admin.productTags }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.mdx index 527d7b41e7..a4e62b620e 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.mdx @@ -243,7 +243,7 @@ medusa.admin.productTypes "children": [ { "name": "AdminProductTypesListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] }``", "description": "The list of product types with pagination fields.", "optional": false, "defaultValue": "", @@ -295,7 +295,7 @@ medusa.admin.productTypes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminProductsResource.mdx index 079529e508..46408a12b0 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminProductsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminProductsResource.mdx @@ -127,7 +127,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -145,7 +145,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -154,7 +154,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -172,7 +172,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -181,7 +181,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -190,7 +190,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -199,7 +199,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -235,7 +235,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -244,7 +244,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -253,7 +253,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -262,7 +262,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -280,7 +280,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -334,7 +334,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -352,7 +352,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -379,7 +379,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -406,7 +406,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -415,7 +415,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -649,7 +649,7 @@ medusa.admin.products "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "The product is a draft. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -658,7 +658,7 @@ medusa.admin.products }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "The product is proposed, but not yet published.", "optional": true, "defaultValue": "", @@ -667,7 +667,7 @@ medusa.admin.products }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "The product is published.", "optional": true, "defaultValue": "", @@ -676,7 +676,7 @@ medusa.admin.products }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "The product is rejected. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -1084,7 +1084,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -1102,7 +1102,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1111,7 +1111,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -1129,7 +1129,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -1138,7 +1138,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -1147,7 +1147,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1156,7 +1156,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1192,7 +1192,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1201,7 +1201,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1210,7 +1210,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1219,7 +1219,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1237,7 +1237,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1291,7 +1291,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -1309,7 +1309,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -1336,7 +1336,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -1363,7 +1363,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1372,7 +1372,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1738,7 +1738,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -1756,7 +1756,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1765,7 +1765,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -1783,7 +1783,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -1792,7 +1792,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -1801,7 +1801,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1810,7 +1810,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1846,7 +1846,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1855,7 +1855,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1864,7 +1864,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1873,7 +1873,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1891,7 +1891,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1945,7 +1945,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -1963,7 +1963,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -1990,7 +1990,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -2017,7 +2017,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2026,7 +2026,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2120,7 +2120,7 @@ medusa.admin.products.delete(productId).then(({ id, object, deleted }) => { }, { "name": "object", - "type": "``\"product\"``", + "type": "`\"product\"`", "description": "The type of the object that was deleted.", "optional": false, "defaultValue": "product", @@ -2201,7 +2201,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "object", - "type": "``\"option\"``", + "type": "`\"option\"`", "description": "The type of the object that was deleted.", "optional": false, "defaultValue": "option", @@ -2246,7 +2246,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -2264,7 +2264,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2273,7 +2273,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -2291,7 +2291,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -2300,7 +2300,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -2309,7 +2309,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2318,7 +2318,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2354,7 +2354,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2363,7 +2363,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2372,7 +2372,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -2381,7 +2381,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2399,7 +2399,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2453,7 +2453,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -2471,7 +2471,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -2498,7 +2498,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -2525,7 +2525,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2534,7 +2534,7 @@ Delete a product option. If there are product variants that use this product opt }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2630,7 +2630,7 @@ medusa.admin.products }, { "name": "object", - "type": "``\"product-variant\"``", + "type": "`\"product-variant\"`", "description": "The type of the object that was deleted.", "optional": false, "defaultValue": "product-variant", @@ -2666,7 +2666,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -2684,7 +2684,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2693,7 +2693,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -2711,7 +2711,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -2720,7 +2720,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -2729,7 +2729,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2738,7 +2738,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2774,7 +2774,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2783,7 +2783,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2792,7 +2792,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -2801,7 +2801,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2819,7 +2819,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -2873,7 +2873,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -2891,7 +2891,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -2918,7 +2918,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -2945,7 +2945,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -2954,7 +2954,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -3287,7 +3287,7 @@ medusa.admin.products "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "The product is a draft. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -3296,7 +3296,7 @@ medusa.admin.products }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "The product is proposed, but not yet published.", "optional": true, "defaultValue": "", @@ -3305,7 +3305,7 @@ medusa.admin.products }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "The product is published.", "optional": true, "defaultValue": "", @@ -3314,7 +3314,7 @@ medusa.admin.products }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "The product is rejected. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -3422,7 +3422,7 @@ medusa.admin.products "children": [ { "name": "AdminProductsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ products: ([PricedProduct](../internal/types/internal.PricedProduct.mdx) \\| [Product](../internal/classes/internal.Product.mdx))[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ products: ([PricedProduct](../internal/types/internal.PricedProduct.mdx) \\| [Product](../internal/classes/internal.Product.mdx))[] }``", "description": "The list of products with pagination fields.", "optional": false, "defaultValue": "", @@ -3522,7 +3522,7 @@ medusa.admin.products.listTags().then(({ tags }) => { "children": [ { "name": "tags", - "type": "[Pick](../internal/types/internal.Pick.mdx)<[ProductTag](../internal/classes/internal.ProductTag.mdx), `\"id\"` \\| `\"value\"`> & `{ usage_count: number }`[]", + "type": "[Pick](../internal/types/internal.Pick.mdx)<[ProductTag](../internal/classes/internal.ProductTag.mdx), \"id\" \\| \"value\"> & ``{ usage_count: number }``[]", "description": "An array of product tags details.", "optional": false, "defaultValue": "", @@ -3539,7 +3539,7 @@ medusa.admin.products.listTags().then(({ tags }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3687,7 +3687,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -3705,7 +3705,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3714,7 +3714,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -3732,7 +3732,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -3741,7 +3741,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -3750,7 +3750,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -3759,7 +3759,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -3795,7 +3795,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -3804,7 +3804,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -3813,7 +3813,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -3822,7 +3822,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -3840,7 +3840,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -3894,7 +3894,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -3912,7 +3912,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -3939,7 +3939,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -3966,7 +3966,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -3975,7 +3975,7 @@ medusa.admin.products.retrieve(productId).then(({ product }) => { }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -4112,7 +4112,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -4130,7 +4130,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -4139,7 +4139,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -4157,7 +4157,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -4166,7 +4166,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -4175,7 +4175,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -4184,7 +4184,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -4220,7 +4220,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -4229,7 +4229,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -4238,7 +4238,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -4247,7 +4247,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -4265,7 +4265,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -4319,7 +4319,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -4337,7 +4337,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -4364,7 +4364,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -4391,7 +4391,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -4400,7 +4400,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -4586,7 +4586,7 @@ medusa.admin.products }, { "name": "sales_channels", - "type": "``null`` \\| [ProductSalesChannelReq](../internal/classes/internal.ProductSalesChannelReq.mdx)[]", + "type": "`null` \\| [ProductSalesChannelReq](../internal/classes/internal.ProductSalesChannelReq.mdx)[]", "description": "Sales channels to associate the Product with.", "optional": true, "defaultValue": "", @@ -4603,7 +4603,7 @@ medusa.admin.products "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "The product is a draft. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -4612,7 +4612,7 @@ medusa.admin.products }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "The product is proposed, but not yet published.", "optional": true, "defaultValue": "", @@ -4621,7 +4621,7 @@ medusa.admin.products }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "The product is published.", "optional": true, "defaultValue": "", @@ -4630,7 +4630,7 @@ medusa.admin.products }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "The product is rejected. It's not viewable by customers.", "optional": true, "defaultValue": "", @@ -5065,7 +5065,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -5083,7 +5083,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -5092,7 +5092,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -5110,7 +5110,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -5119,7 +5119,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -5128,7 +5128,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -5137,7 +5137,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5173,7 +5173,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -5182,7 +5182,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5191,7 +5191,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -5200,7 +5200,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5218,7 +5218,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5272,7 +5272,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -5290,7 +5290,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -5317,7 +5317,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -5344,7 +5344,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -5353,7 +5353,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -5488,7 +5488,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -5506,7 +5506,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -5515,7 +5515,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -5533,7 +5533,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -5542,7 +5542,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -5551,7 +5551,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -5560,7 +5560,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5596,7 +5596,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -5605,7 +5605,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5614,7 +5614,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -5623,7 +5623,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5641,7 +5641,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -5695,7 +5695,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -5713,7 +5713,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -5740,7 +5740,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -5767,7 +5767,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -5776,7 +5776,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -6160,7 +6160,7 @@ medusa.admin.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -6178,7 +6178,7 @@ medusa.admin.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -6187,7 +6187,7 @@ medusa.admin.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -6205,7 +6205,7 @@ medusa.admin.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -6214,7 +6214,7 @@ medusa.admin.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -6223,7 +6223,7 @@ medusa.admin.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -6232,7 +6232,7 @@ medusa.admin.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -6268,7 +6268,7 @@ medusa.admin.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -6277,7 +6277,7 @@ medusa.admin.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -6286,7 +6286,7 @@ medusa.admin.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -6295,7 +6295,7 @@ medusa.admin.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -6313,7 +6313,7 @@ medusa.admin.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -6367,7 +6367,7 @@ medusa.admin.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -6385,7 +6385,7 @@ medusa.admin.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -6412,7 +6412,7 @@ medusa.admin.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -6439,7 +6439,7 @@ medusa.admin.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -6448,7 +6448,7 @@ medusa.admin.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.mdx index c6e14a4cb1..7a54276ca1 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.mdx @@ -134,7 +134,7 @@ medusa.admin.publishableApiKeys }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -161,7 +161,7 @@ medusa.admin.publishableApiKeys }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", @@ -286,7 +286,7 @@ medusa.admin.publishableApiKeys }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -313,7 +313,7 @@ medusa.admin.publishableApiKeys }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", @@ -545,7 +545,7 @@ medusa.admin.publishableApiKeys }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -572,7 +572,7 @@ medusa.admin.publishableApiKeys }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", @@ -724,7 +724,7 @@ medusa.admin.publishableApiKeys "children": [ { "name": "AdminPublishableApiKeysListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ publishable_api_keys: [PublishableApiKey](../internal/classes/internal.PublishableApiKey.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ publishable_api_keys: [PublishableApiKey](../internal/classes/internal.PublishableApiKey.mdx)[] }``", "description": "The list of publishable API keys with pagination fields.", "optional": false, "defaultValue": "", @@ -776,7 +776,7 @@ medusa.admin.publishableApiKeys }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -803,7 +803,7 @@ medusa.admin.publishableApiKeys }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", @@ -971,7 +971,7 @@ medusa.admin.publishableApiKeys }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -980,7 +980,7 @@ medusa.admin.publishableApiKeys }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -1016,7 +1016,7 @@ medusa.admin.publishableApiKeys }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1138,7 +1138,7 @@ medusa.admin.publishableApiKeys }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -1165,7 +1165,7 @@ medusa.admin.publishableApiKeys }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", @@ -1278,7 +1278,7 @@ medusa.admin.publishableApiKeys }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -1305,7 +1305,7 @@ medusa.admin.publishableApiKeys }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", @@ -1439,7 +1439,7 @@ medusa.admin.publishableApiKeys }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -1466,7 +1466,7 @@ medusa.admin.publishableApiKeys }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.mdx index 1763745f94..15a0395eb8 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.mdx @@ -154,7 +154,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -245,7 +245,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -263,7 +263,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -424,7 +424,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -515,7 +515,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -533,7 +533,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -694,7 +694,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -785,7 +785,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -803,7 +803,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -1033,7 +1033,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1124,7 +1124,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -1142,7 +1142,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -1371,7 +1371,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1462,7 +1462,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => { }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -1480,7 +1480,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => { }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -1629,7 +1629,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1720,7 +1720,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -1738,7 +1738,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -1887,7 +1887,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1978,7 +1978,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -1996,7 +1996,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -2248,7 +2248,7 @@ medusa.admin.regions "children": [ { "name": "AdminRegionsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ regions: [Region](../internal/classes/internal.Region.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ regions: [Region](../internal/classes/internal.Region.mdx)[] }``", "description": "The list of regions with pagination fields.", "optional": false, "defaultValue": "", @@ -2336,7 +2336,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2427,7 +2427,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -2445,7 +2445,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -2583,7 +2583,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2674,7 +2674,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => { }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -2692,7 +2692,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => { }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -2916,7 +2916,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider to use. If none provided, the system tax provider is used.", "optional": true, "defaultValue": "", @@ -3019,7 +3019,7 @@ medusa.admin.regions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3110,7 +3110,7 @@ medusa.admin.regions }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -3128,7 +3128,7 @@ medusa.admin.regions }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.mdx index 983fdc4c1a..ad5ae99dac 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.mdx @@ -158,7 +158,7 @@ medusa.admin.reservations }, { "name": "created_by", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "UserId of user who created the reservation item", "optional": true, "defaultValue": "", @@ -167,7 +167,7 @@ medusa.admin.reservations }, { "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": "", @@ -176,7 +176,7 @@ medusa.admin.reservations }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the reservation item", "optional": true, "defaultValue": "", @@ -203,7 +203,7 @@ medusa.admin.reservations }, { "name": "line_item_id", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -221,7 +221,7 @@ medusa.admin.reservations }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -601,7 +601,7 @@ medusa.admin.reservations "children": [ { "name": "AdminReservationsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ reservations: [ReservationItemDTO](../internal/types/internal.ReservationItemDTO.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ reservations: [ReservationItemDTO](../internal/types/internal.ReservationItemDTO.mdx)[] }``", "description": "The list of reservations with pagination fields.", "optional": false, "defaultValue": "", @@ -653,7 +653,7 @@ medusa.admin.reservations }, { "name": "created_by", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "UserId of user who created the reservation item", "optional": true, "defaultValue": "", @@ -662,7 +662,7 @@ medusa.admin.reservations }, { "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": "", @@ -671,7 +671,7 @@ medusa.admin.reservations }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the reservation item", "optional": true, "defaultValue": "", @@ -698,7 +698,7 @@ medusa.admin.reservations }, { "name": "line_item_id", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -716,7 +716,7 @@ medusa.admin.reservations }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -827,7 +827,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => { }, { "name": "created_by", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "UserId of user who created the reservation item", "optional": true, "defaultValue": "", @@ -836,7 +836,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => { }, { "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": "", @@ -845,7 +845,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => { }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the reservation item", "optional": true, "defaultValue": "", @@ -872,7 +872,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => { }, { "name": "line_item_id", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -890,7 +890,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => { }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1051,7 +1051,7 @@ medusa.admin.reservations }, { "name": "created_by", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "UserId of user who created the reservation item", "optional": true, "defaultValue": "", @@ -1060,7 +1060,7 @@ medusa.admin.reservations }, { "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": "", @@ -1069,7 +1069,7 @@ medusa.admin.reservations }, { "name": "description", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Description of the reservation item", "optional": true, "defaultValue": "", @@ -1096,7 +1096,7 @@ medusa.admin.reservations }, { "name": "line_item_id", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -1114,7 +1114,7 @@ medusa.admin.reservations }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.mdx index 8f5b20c7d6..99d621c156 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.mdx @@ -146,7 +146,7 @@ medusa.admin.returnReasons }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -191,7 +191,7 @@ medusa.admin.returnReasons }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -200,7 +200,7 @@ medusa.admin.returnReasons }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", @@ -395,7 +395,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -440,7 +440,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => { }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -449,7 +449,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => { }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", @@ -571,7 +571,7 @@ medusa.admin.returnReasons }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -616,7 +616,7 @@ medusa.admin.returnReasons }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -625,7 +625,7 @@ medusa.admin.returnReasons }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", @@ -795,7 +795,7 @@ medusa.admin.returnReasons }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -840,7 +840,7 @@ medusa.admin.returnReasons }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -849,7 +849,7 @@ medusa.admin.returnReasons }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.mdx index 8021150293..1fea3504d3 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.mdx @@ -248,7 +248,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -329,7 +329,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -473,7 +473,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -509,7 +509,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -554,7 +554,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => { }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -563,7 +563,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -686,7 +686,7 @@ medusa.admin.returns "children": [ { "name": "AdminReturnsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ returns: [Return](../internal/classes/internal.Return.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ returns: [Return](../internal/classes/internal.Return.mdx)[] }``", "description": "The list of returns with pagination fields.", "optional": false, "defaultValue": "", @@ -738,7 +738,7 @@ medusa.admin.returns }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", @@ -765,7 +765,7 @@ medusa.admin.returns }, { "name": "idempotency_key", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", @@ -783,7 +783,7 @@ medusa.admin.returns }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", @@ -792,7 +792,7 @@ medusa.admin.returns }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -801,7 +801,7 @@ medusa.admin.returns }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -819,7 +819,7 @@ medusa.admin.returns }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -882,7 +882,7 @@ medusa.admin.returns }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", @@ -1049,7 +1049,7 @@ medusa.admin.returns }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", @@ -1076,7 +1076,7 @@ medusa.admin.returns }, { "name": "idempotency_key", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", @@ -1094,7 +1094,7 @@ medusa.admin.returns }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", @@ -1103,7 +1103,7 @@ medusa.admin.returns }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1112,7 +1112,7 @@ medusa.admin.returns }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -1130,7 +1130,7 @@ medusa.admin.returns }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -1193,7 +1193,7 @@ medusa.admin.returns }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.mdx index 5e451ce91e..173ba01a65 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.mdx @@ -118,7 +118,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -127,7 +127,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -163,7 +163,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -311,7 +311,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -356,7 +356,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -500,7 +500,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -509,7 +509,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -545,7 +545,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -971,7 +971,7 @@ medusa.admin.salesChannels "children": [ { "name": "AdminSalesChannelsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ sales_channels: [SalesChannel](../internal/classes/internal.SalesChannel.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ sales_channels: [SalesChannel](../internal/classes/internal.SalesChannel.mdx)[] }``", "description": "The list of sales channels with pagination fields.", "optional": false, "defaultValue": "", @@ -1023,7 +1023,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1032,7 +1032,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -1068,7 +1068,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1202,7 +1202,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1211,7 +1211,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -1247,7 +1247,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1395,7 +1395,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1404,7 +1404,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -1440,7 +1440,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1553,7 +1553,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1562,7 +1562,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -1598,7 +1598,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1750,7 +1750,7 @@ medusa.admin.salesChannels }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1759,7 +1759,7 @@ medusa.admin.salesChannels }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -1795,7 +1795,7 @@ medusa.admin.salesChannels }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.mdx index b8e74a71d0..7db9cc2f62 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.mdx @@ -232,7 +232,7 @@ medusa.admin.shippingOptions }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -259,7 +259,7 @@ medusa.admin.shippingOptions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -566,7 +566,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => { "children": [ { "name": "AdminShippingOptionsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ shipping_options: [ShippingOption](../internal/classes/internal.ShippingOption.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ shipping_options: [ShippingOption](../internal/classes/internal.ShippingOption.mdx)[] }``", "description": "The list of shipping options with pagination fields.", "optional": false, "defaultValue": "", @@ -618,7 +618,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => { }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -645,7 +645,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -865,7 +865,7 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => { }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -892,7 +892,7 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1216,7 +1216,7 @@ medusa.admin.shippingOptions }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -1243,7 +1243,7 @@ medusa.admin.shippingOptions }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.mdx index 3a9ebb8ff1..564860806c 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.mdx @@ -77,7 +77,7 @@ medusa.admin.shippingProfiles "children": [ { "name": "CUSTOM", - "type": "``\"custom\"``", + "type": "`\"custom\"`", "description": "The profile used to ship custom items.", "optional": true, "defaultValue": "", @@ -86,7 +86,7 @@ medusa.admin.shippingProfiles }, { "name": "DEFAULT", - "type": "``\"default\"``", + "type": "`\"default\"`", "description": "The default profile used to ship item.", "optional": true, "defaultValue": "", @@ -95,7 +95,7 @@ medusa.admin.shippingProfiles }, { "name": "GIFT_CARD", - "type": "``\"gift_card\"``", + "type": "`\"gift_card\"`", "description": "The profile used to ship gift cards.", "optional": true, "defaultValue": "", @@ -155,7 +155,7 @@ medusa.admin.shippingProfiles }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -386,7 +386,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -544,7 +544,7 @@ medusa.admin.shippingProfiles }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -709,7 +709,7 @@ medusa.admin.shippingProfiles "children": [ { "name": "CUSTOM", - "type": "``\"custom\"``", + "type": "`\"custom\"`", "description": "The profile used to ship custom items.", "optional": true, "defaultValue": "", @@ -718,7 +718,7 @@ medusa.admin.shippingProfiles }, { "name": "DEFAULT", - "type": "``\"default\"``", + "type": "`\"default\"`", "description": "The default profile used to ship item.", "optional": true, "defaultValue": "", @@ -727,7 +727,7 @@ medusa.admin.shippingProfiles }, { "name": "GIFT_CARD", - "type": "``\"gift_card\"``", + "type": "`\"gift_card\"`", "description": "The profile used to ship gift cards.", "optional": true, "defaultValue": "", @@ -787,7 +787,7 @@ medusa.admin.shippingProfiles }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.mdx index 93d9261516..ebc743ef76 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.mdx @@ -228,7 +228,7 @@ medusa.admin.stockLocations }, { "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": "", @@ -246,7 +246,7 @@ medusa.admin.stockLocations }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -545,7 +545,7 @@ medusa.admin.stockLocations "children": [ { "name": "AdminStockLocationsListRes", - "type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `{ stock_locations: [StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)[] }`", + "type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & ``{ stock_locations: [StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)[] }``", "description": "The list of stock locations with pagination fields.", "optional": false, "defaultValue": "", @@ -615,7 +615,7 @@ medusa.admin.stockLocations }, { "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": "", @@ -633,7 +633,7 @@ medusa.admin.stockLocations }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -773,7 +773,7 @@ medusa.admin.stockLocations }, { "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": "", @@ -791,7 +791,7 @@ medusa.admin.stockLocations }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1052,7 +1052,7 @@ medusa.admin.stockLocations }, { "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": "", @@ -1070,7 +1070,7 @@ medusa.admin.stockLocations }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminStoresResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminStoresResource.mdx index 00832652ac..c2e89235b6 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminStoresResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminStoresResource.mdx @@ -139,7 +139,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => { }, { "name": "default_sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the store's default sales channel.", "optional": false, "defaultValue": "", @@ -157,7 +157,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => { }, { "name": "invite_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Invite links from", "optional": false, "defaultValue": "", @@ -166,7 +166,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -184,7 +184,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => { }, { "name": "payment_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Payment links from. Use {{cart\\_id}} to include the payment's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => { }, { "name": "swap_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Swap links from. Use {{cart\\_id}} to include the Swap's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -340,7 +340,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => { }, { "name": "default_sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the store's default sales channel.", "optional": false, "defaultValue": "", @@ -358,7 +358,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => { }, { "name": "invite_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Invite links from", "optional": false, "defaultValue": "", @@ -367,7 +367,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -385,7 +385,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => { }, { "name": "payment_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Payment links from. Use {{cart\\_id}} to include the payment's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -394,7 +394,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => { }, { "name": "swap_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Swap links from. Use {{cart\\_id}} to include the Swap's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -700,7 +700,7 @@ medusa.admin.store.retrieve().then(({ store }) => { }, { "name": "default_sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the store's default sales channel.", "optional": false, "defaultValue": "", @@ -718,7 +718,7 @@ medusa.admin.store.retrieve().then(({ store }) => { }, { "name": "invite_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Invite links from", "optional": false, "defaultValue": "", @@ -727,7 +727,7 @@ medusa.admin.store.retrieve().then(({ store }) => { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -745,7 +745,7 @@ medusa.admin.store.retrieve().then(({ store }) => { }, { "name": "payment_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Payment links from. Use {{cart\\_id}} to include the payment's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -754,7 +754,7 @@ medusa.admin.store.retrieve().then(({ store }) => { }, { "name": "swap_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Swap links from. Use {{cart\\_id}} to include the Swap's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -1005,7 +1005,7 @@ medusa.admin.store }, { "name": "default_sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the store's default sales channel.", "optional": false, "defaultValue": "", @@ -1023,7 +1023,7 @@ medusa.admin.store }, { "name": "invite_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Invite links from", "optional": false, "defaultValue": "", @@ -1032,7 +1032,7 @@ medusa.admin.store }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -1050,7 +1050,7 @@ medusa.admin.store }, { "name": "payment_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Payment links from. Use {{cart\\_id}} to include the payment's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -1059,7 +1059,7 @@ medusa.admin.store }, { "name": "swap_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Swap links from. Use {{cart\\_id}} to include the Swap's `cart\\_id` in the link.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.mdx index 94e6da13e6..43def44533 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.mdx @@ -107,7 +107,7 @@ medusa.admin.swaps "children": [ { "name": "AdminSwapsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ swaps: [Swap](../internal/classes/internal.Swap.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ swaps: [Swap](../internal/classes/internal.Swap.mdx)[] }``", "description": "The list of swaps with pagination fields.", "optional": false, "defaultValue": "", @@ -213,7 +213,7 @@ medusa.admin.swaps }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -504,7 +504,7 @@ medusa.admin.swaps.retrieve(swapId).then(({ swap }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.mdx index 71e5a68d8d..793e33fbfa 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.mdx @@ -136,7 +136,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -217,7 +217,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -397,7 +397,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -478,7 +478,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -658,7 +658,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -739,7 +739,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -871,7 +871,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge.", "optional": true, "defaultValue": "", @@ -966,7 +966,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -1047,7 +1047,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -1349,7 +1349,7 @@ medusa.admin.taxRates "children": [ { "name": "AdminTaxRatesListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ tax_rates: [TaxRate](../internal/classes/internal.TaxRate.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ tax_rates: [TaxRate](../internal/classes/internal.TaxRate.mdx)[] }``", "description": "The list of tax rates with pagination fields.", "optional": false, "defaultValue": "", @@ -1392,7 +1392,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -1473,7 +1473,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -1653,7 +1653,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -1734,7 +1734,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -1914,7 +1914,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -1995,7 +1995,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -2175,7 +2175,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -2256,7 +2256,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -2430,7 +2430,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -2511,7 +2511,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", @@ -2650,7 +2650,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge.", "optional": true, "defaultValue": "", @@ -2745,7 +2745,7 @@ medusa.admin.taxRates "children": [ { "name": "code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", @@ -2826,7 +2826,7 @@ medusa.admin.taxRates }, { "name": "rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The numeric rate to charge", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminUsersResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminUsersResource.mdx index 9edd04cacc..bec6303eeb 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminUsersResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminUsersResource.mdx @@ -82,7 +82,7 @@ medusa.admin.users "children": [ { "name": "user", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">", "description": "User details.", "optional": false, "defaultValue": "", @@ -108,7 +108,7 @@ medusa.admin.users }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ medusa.admin.users.list().then(({ users }) => { "children": [ { "name": "users", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>[]", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">[]", "description": "An array of users details.", "optional": false, "defaultValue": "", @@ -346,7 +346,7 @@ medusa.admin.users.list().then(({ users }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -519,7 +519,7 @@ medusa.admin.users "children": [ { "name": "user", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">", "description": "User details.", "optional": false, "defaultValue": "", @@ -545,7 +545,7 @@ medusa.admin.users }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -684,7 +684,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => { "children": [ { "name": "user", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">", "description": "User details.", "optional": false, "defaultValue": "", @@ -710,7 +710,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -981,7 +981,7 @@ medusa.admin.users "children": [ { "name": "user", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">", "description": "User details.", "optional": false, "defaultValue": "", @@ -1007,7 +1007,7 @@ medusa.admin.users }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx b/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx index 710a5cedac..e7327bc163 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx @@ -104,7 +104,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => { }, { "name": "sales_channel_availability", - "type": "`{ available_quantity: number ; channel_id: string ; channel_name: string }`[]", + "type": "``{ available_quantity: number ; channel_id: string ; channel_name: string }``[]", "description": "Details about the variant's inventory availability in sales channels.", "optional": false, "defaultValue": "", @@ -315,7 +315,7 @@ medusa.admin.variants "children": [ { "name": "AdminVariantsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ variants: [PricedVariant](../internal/types/internal.PricedVariant.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ variants: [PricedVariant](../internal/types/internal.PricedVariant.mdx)[] }``", "description": "The list of variants with pagination fields.", "optional": false, "defaultValue": "", @@ -367,7 +367,7 @@ medusa.admin.variants }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -385,7 +385,7 @@ medusa.admin.variants }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -394,7 +394,7 @@ medusa.admin.variants }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -403,7 +403,7 @@ medusa.admin.variants }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -412,7 +412,7 @@ medusa.admin.variants }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -448,7 +448,7 @@ medusa.admin.variants }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -466,7 +466,7 @@ medusa.admin.variants }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -475,7 +475,7 @@ medusa.admin.variants }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -484,7 +484,7 @@ medusa.admin.variants }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -502,7 +502,7 @@ medusa.admin.variants }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -547,7 +547,7 @@ medusa.admin.variants }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -565,7 +565,7 @@ medusa.admin.variants }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -583,7 +583,7 @@ medusa.admin.variants }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -592,7 +592,7 @@ medusa.admin.variants }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -601,7 +601,7 @@ medusa.admin.variants }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -610,7 +610,7 @@ medusa.admin.variants }, { "name": "calculated_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The lowest price among the retrieved prices.", "optional": false, "defaultValue": "", @@ -619,7 +619,7 @@ medusa.admin.variants }, { "name": "calculated_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `calculated_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -629,7 +629,7 @@ medusa.admin.variants }, { "name": "calculated_price_type", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.", "optional": true, "defaultValue": "", @@ -638,7 +638,7 @@ medusa.admin.variants }, { "name": "original_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The original price of the variant.", "optional": false, "defaultValue": "", @@ -647,7 +647,7 @@ medusa.admin.variants }, { "name": "original_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `original_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -666,7 +666,7 @@ medusa.admin.variants }, { "name": "calculated_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the calculated price.", "optional": false, "defaultValue": "", @@ -675,7 +675,7 @@ medusa.admin.variants }, { "name": "calculated_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the calculated price.", "optional": false, "defaultValue": "", @@ -684,7 +684,7 @@ medusa.admin.variants }, { "name": "original_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the original price.", "optional": false, "defaultValue": "", @@ -693,7 +693,7 @@ medusa.admin.variants }, { "name": "original_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the original price.", "optional": false, "defaultValue": "", @@ -702,7 +702,7 @@ medusa.admin.variants }, { "name": "tax_rates", - "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``", + "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`", "description": "The list of tax rates.", "optional": false, "defaultValue": "", @@ -840,7 +840,7 @@ medusa.admin.variants }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -858,7 +858,7 @@ medusa.admin.variants }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -867,7 +867,7 @@ medusa.admin.variants }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -876,7 +876,7 @@ medusa.admin.variants }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -885,7 +885,7 @@ medusa.admin.variants }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -921,7 +921,7 @@ medusa.admin.variants }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -939,7 +939,7 @@ medusa.admin.variants }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -948,7 +948,7 @@ medusa.admin.variants }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -957,7 +957,7 @@ medusa.admin.variants }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -975,7 +975,7 @@ medusa.admin.variants }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1020,7 +1020,7 @@ medusa.admin.variants }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -1038,7 +1038,7 @@ medusa.admin.variants }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -1056,7 +1056,7 @@ medusa.admin.variants }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -1065,7 +1065,7 @@ medusa.admin.variants }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1074,7 +1074,7 @@ medusa.admin.variants }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1083,7 +1083,7 @@ medusa.admin.variants }, { "name": "calculated_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The lowest price among the retrieved prices.", "optional": false, "defaultValue": "", @@ -1092,7 +1092,7 @@ medusa.admin.variants }, { "name": "calculated_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `calculated_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -1102,7 +1102,7 @@ medusa.admin.variants }, { "name": "calculated_price_type", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.", "optional": true, "defaultValue": "", @@ -1111,7 +1111,7 @@ medusa.admin.variants }, { "name": "original_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The original price of the variant.", "optional": false, "defaultValue": "", @@ -1120,7 +1120,7 @@ medusa.admin.variants }, { "name": "original_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `original_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -1139,7 +1139,7 @@ medusa.admin.variants }, { "name": "calculated_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the calculated price.", "optional": false, "defaultValue": "", @@ -1148,7 +1148,7 @@ medusa.admin.variants }, { "name": "calculated_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the calculated price.", "optional": false, "defaultValue": "", @@ -1157,7 +1157,7 @@ medusa.admin.variants }, { "name": "original_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the original price.", "optional": false, "defaultValue": "", @@ -1166,7 +1166,7 @@ medusa.admin.variants }, { "name": "original_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the original price.", "optional": false, "defaultValue": "", @@ -1175,7 +1175,7 @@ medusa.admin.variants }, { "name": "tax_rates", - "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``", + "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`", "description": "The list of tax rates.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/AuthResource.mdx b/www/apps/docs/content/references/js-client/classes/AuthResource.mdx index 66d1d37ce4..f974fd37b0 100644 --- a/www/apps/docs/content/references/js-client/classes/AuthResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/AuthResource.mdx @@ -118,7 +118,7 @@ medusa.auth }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -136,7 +136,7 @@ medusa.auth }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -435,7 +435,7 @@ medusa.auth.getSession().then(({ customer }) => { }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -453,7 +453,7 @@ medusa.auth.getSession().then(({ customer }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/CartsResource.mdx b/www/apps/docs/content/references/js-client/classes/CartsResource.mdx index e47fe4eedc..564aa23335 100644 --- a/www/apps/docs/content/references/js-client/classes/CartsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/CartsResource.mdx @@ -121,7 +121,7 @@ medusa.carts "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -192,7 +192,7 @@ medusa.carts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -273,7 +273,7 @@ medusa.carts }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -327,7 +327,7 @@ medusa.carts }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -381,7 +381,7 @@ medusa.carts }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -390,7 +390,7 @@ medusa.carts }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -417,7 +417,7 @@ medusa.carts }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -444,7 +444,7 @@ medusa.carts }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -542,7 +542,7 @@ medusa.carts.complete(cartId).then(({ cart }) => { "children": [ { "name": "StoreCompleteCartRes", - "type": "`{ data: [Cart](../internal/classes/internal.Cart.mdx) ; type: `\"cart\"` }` \\| `{ data: [Order](../internal/classes/internal.Order.mdx) ; type: `\"order\"` }` \\| `{ data: [Swap](../internal/classes/internal.Swap.mdx) ; type: `\"swap\"` }`", + "type": "``{ data: [Cart](../internal/classes/internal.Cart.mdx) ; type: \"cart\" }`` \\| ``{ data: [Order](../internal/classes/internal.Order.mdx) ; type: \"order\" }`` \\| ``{ data: [Swap](../internal/classes/internal.Swap.mdx) ; type: \"swap\" }``", "description": "If the cart is completed successfully, this will have the created order or the swap's details, based on the cart's type. Otherwise, it'll be the cart's details.", "optional": false, "defaultValue": "", @@ -680,7 +680,7 @@ medusa.carts.create().then(({ cart }) => { "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -751,7 +751,7 @@ medusa.carts.create().then(({ cart }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -832,7 +832,7 @@ medusa.carts.create().then(({ cart }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -886,7 +886,7 @@ medusa.carts.create().then(({ cart }) => { }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -940,7 +940,7 @@ medusa.carts.create().then(({ cart }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -949,7 +949,7 @@ medusa.carts.create().then(({ cart }) => { }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -976,7 +976,7 @@ medusa.carts.create().then(({ cart }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -1003,7 +1003,7 @@ medusa.carts.create().then(({ cart }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -1106,7 +1106,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -1177,7 +1177,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1258,7 +1258,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -1312,7 +1312,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -1366,7 +1366,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -1375,7 +1375,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -1402,7 +1402,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -1429,7 +1429,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -1541,7 +1541,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -1612,7 +1612,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1693,7 +1693,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -1747,7 +1747,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -1801,7 +1801,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -1810,7 +1810,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -1837,7 +1837,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -1864,7 +1864,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -1975,7 +1975,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -2046,7 +2046,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2127,7 +2127,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -2181,7 +2181,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -2235,7 +2235,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -2244,7 +2244,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -2271,7 +2271,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -2298,7 +2298,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -2409,7 +2409,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -2480,7 +2480,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2561,7 +2561,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -2615,7 +2615,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -2669,7 +2669,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -2678,7 +2678,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -2705,7 +2705,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -2732,7 +2732,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -2834,7 +2834,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -2905,7 +2905,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2986,7 +2986,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -3040,7 +3040,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -3094,7 +3094,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -3103,7 +3103,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -3130,7 +3130,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -3157,7 +3157,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -3283,7 +3283,7 @@ medusa.carts "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -3354,7 +3354,7 @@ medusa.carts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3435,7 +3435,7 @@ medusa.carts }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -3489,7 +3489,7 @@ medusa.carts }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -3543,7 +3543,7 @@ medusa.carts }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -3552,7 +3552,7 @@ medusa.carts }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -3579,7 +3579,7 @@ medusa.carts }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -3606,7 +3606,7 @@ medusa.carts }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -3832,7 +3832,7 @@ medusa.carts "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -3903,7 +3903,7 @@ medusa.carts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -3984,7 +3984,7 @@ medusa.carts }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -4038,7 +4038,7 @@ medusa.carts }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -4092,7 +4092,7 @@ medusa.carts }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -4101,7 +4101,7 @@ medusa.carts }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -4128,7 +4128,7 @@ medusa.carts }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -4155,7 +4155,7 @@ medusa.carts }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -4291,7 +4291,7 @@ medusa.carts "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -4362,7 +4362,7 @@ medusa.carts }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -4443,7 +4443,7 @@ medusa.carts }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -4497,7 +4497,7 @@ medusa.carts }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -4551,7 +4551,7 @@ medusa.carts }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -4560,7 +4560,7 @@ medusa.carts }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -4587,7 +4587,7 @@ medusa.carts }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -4614,7 +4614,7 @@ medusa.carts }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/CollectionsResource.mdx b/www/apps/docs/content/references/js-client/classes/CollectionsResource.mdx index bd899d9ef1..e67e60fb18 100644 --- a/www/apps/docs/content/references/js-client/classes/CollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/CollectionsResource.mdx @@ -203,7 +203,7 @@ medusa.collections "children": [ { "name": "StoreCollectionsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] }``", "description": "The list of product collections with pagination fields.", "optional": false, "defaultValue": "", @@ -255,7 +255,7 @@ medusa.collections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -401,7 +401,7 @@ medusa.collections.retrieve(collectionId).then(({ collection }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/CustomersResource.mdx b/www/apps/docs/content/references/js-client/classes/CustomersResource.mdx index 6e672a8e3e..8c71df9b13 100644 --- a/www/apps/docs/content/references/js-client/classes/CustomersResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/CustomersResource.mdx @@ -151,7 +151,7 @@ medusa.customers "children": [ { "name": "customer", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">", "description": "Customer details.", "optional": false, "defaultValue": "", @@ -168,7 +168,7 @@ medusa.customers }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -186,7 +186,7 @@ medusa.customers }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -556,7 +556,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { "children": [ { "name": "CANCELED", - "type": "``\"canceled\"``", + "type": "`\"canceled\"`", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", @@ -565,7 +565,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "FULFILLED", - "type": "``\"fulfilled\"``", + "type": "`\"fulfilled\"`", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", @@ -574,7 +574,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "NOT_FULFILLED", - "type": "``\"not_fulfilled\"``", + "type": "`\"not_fulfilled\"`", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", @@ -583,7 +583,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "PARTIALLY_FULFILLED", - "type": "``\"partially_fulfilled\"``", + "type": "`\"partially_fulfilled\"`", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", @@ -592,7 +592,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "PARTIALLY_RETURNED", - "type": "``\"partially_returned\"``", + "type": "`\"partially_returned\"`", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", @@ -601,7 +601,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "PARTIALLY_SHIPPED", - "type": "``\"partially_shipped\"``", + "type": "`\"partially_shipped\"`", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", @@ -610,7 +610,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "REQUIRES_ACTION", - "type": "``\"requires_action\"``", + "type": "`\"requires_action\"`", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", @@ -619,7 +619,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "RETURNED", - "type": "``\"returned\"``", + "type": "`\"returned\"`", "description": "The order's items are returned.", "optional": true, "defaultValue": "", @@ -628,7 +628,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "SHIPPED", - "type": "``\"shipped\"``", + "type": "`\"shipped\"`", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", @@ -674,7 +674,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { "children": [ { "name": "AWAITING", - "type": "``\"awaiting\"``", + "type": "`\"awaiting\"`", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", @@ -683,7 +683,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "CANCELED", - "type": "``\"canceled\"``", + "type": "`\"canceled\"`", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", @@ -692,7 +692,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "CAPTURED", - "type": "``\"captured\"``", + "type": "`\"captured\"`", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", @@ -701,7 +701,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "NOT_PAID", - "type": "``\"not_paid\"``", + "type": "`\"not_paid\"`", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", @@ -710,7 +710,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "PARTIALLY_REFUNDED", - "type": "``\"partially_refunded\"``", + "type": "`\"partially_refunded\"`", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", @@ -719,7 +719,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "REFUNDED", - "type": "``\"refunded\"``", + "type": "`\"refunded\"`", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", @@ -728,7 +728,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "REQUIRES_ACTION", - "type": "``\"requires_action\"``", + "type": "`\"requires_action\"`", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", @@ -765,7 +765,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { "children": [ { "name": "ARCHIVED", - "type": "``\"archived\"``", + "type": "`\"archived\"`", "description": "The order is archived.", "optional": true, "defaultValue": "", @@ -774,7 +774,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "CANCELED", - "type": "``\"canceled\"``", + "type": "`\"canceled\"`", "description": "The order is canceled.", "optional": true, "defaultValue": "", @@ -783,7 +783,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "COMPLETED", - "type": "``\"completed\"``", + "type": "`\"completed\"`", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", @@ -792,7 +792,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "PENDING", - "type": "``\"pending\"``", + "type": "`\"pending\"`", "description": "The order is pending.", "optional": true, "defaultValue": "", @@ -801,7 +801,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "REQUIRES_ACTION", - "type": "``\"requires_action\"``", + "type": "`\"requires_action\"`", "description": "The order requires action.", "optional": true, "defaultValue": "", @@ -891,7 +891,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { "children": [ { "name": "StoreCustomersListOrdersRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ orders: [Order](../internal/classes/internal.Order.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ orders: [Order](../internal/classes/internal.Order.mdx)[] }``", "description": "The list of the customer's orders with pagination fields.", "optional": false, "defaultValue": "", @@ -1096,7 +1096,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -1177,7 +1177,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -1321,7 +1321,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -1357,7 +1357,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -1402,7 +1402,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -1411,7 +1411,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1539,7 +1539,7 @@ medusa.customers "children": [ { "name": "customer", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">", "description": "Customer details.", "optional": false, "defaultValue": "", @@ -1556,7 +1556,7 @@ medusa.customers }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -1574,7 +1574,7 @@ medusa.customers }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1740,7 +1740,7 @@ medusa.customers.retrieve().then(({ customer }) => { "children": [ { "name": "customer", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">", "description": "Customer details.", "optional": false, "defaultValue": "", @@ -1757,7 +1757,7 @@ medusa.customers.retrieve().then(({ customer }) => { }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -1775,7 +1775,7 @@ medusa.customers.retrieve().then(({ customer }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -2018,7 +2018,7 @@ medusa.customers "children": [ { "name": "customer", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">", "description": "Customer details.", "optional": false, "defaultValue": "", @@ -2035,7 +2035,7 @@ medusa.customers }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -2053,7 +2053,7 @@ medusa.customers }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/GiftCardsResource.mdx b/www/apps/docs/content/references/js-client/classes/GiftCardsResource.mdx index 4f4ba9488a..8bf67bc4fb 100644 --- a/www/apps/docs/content/references/js-client/classes/GiftCardsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/GiftCardsResource.mdx @@ -110,7 +110,7 @@ medusa.giftCards.retrieve(code).then(({ gift_card }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -191,7 +191,7 @@ medusa.giftCards.retrieve(code).then(({ gift_card }) => { }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/LineItemsResource.mdx b/www/apps/docs/content/references/js-client/classes/LineItemsResource.mdx index 23f542c87b..f843e0f2c8 100644 --- a/www/apps/docs/content/references/js-client/classes/LineItemsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/LineItemsResource.mdx @@ -112,7 +112,7 @@ medusa.carts.lineItems "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -183,7 +183,7 @@ medusa.carts.lineItems }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -264,7 +264,7 @@ medusa.carts.lineItems }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -318,7 +318,7 @@ medusa.carts.lineItems }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -372,7 +372,7 @@ medusa.carts.lineItems }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -381,7 +381,7 @@ medusa.carts.lineItems }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -408,7 +408,7 @@ medusa.carts.lineItems }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -435,7 +435,7 @@ medusa.carts.lineItems }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -546,7 +546,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -617,7 +617,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -698,7 +698,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -752,7 +752,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -806,7 +806,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -815,7 +815,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -842,7 +842,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -869,7 +869,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", @@ -1012,7 +1012,7 @@ medusa.carts.lineItems "children": [ { "name": "cart", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\">", "description": "Cart details.", "optional": false, "defaultValue": "", @@ -1083,7 +1083,7 @@ medusa.carts.lineItems }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1164,7 +1164,7 @@ medusa.carts.lineItems }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -1218,7 +1218,7 @@ medusa.carts.lineItems }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -1272,7 +1272,7 @@ medusa.carts.lineItems }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -1281,7 +1281,7 @@ medusa.carts.lineItems }, { "name": "shipping_address", - "type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)", + "type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -1308,7 +1308,7 @@ medusa.carts.lineItems }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -1335,7 +1335,7 @@ medusa.carts.lineItems }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/OrderEditsResource.mdx b/www/apps/docs/content/references/js-client/classes/OrderEditsResource.mdx index a89a38389f..a9601f6f87 100644 --- a/www/apps/docs/content/references/js-client/classes/OrderEditsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/OrderEditsResource.mdx @@ -75,7 +75,7 @@ medusa.orderEdits.complete(orderEditId).then(({ order_edit }) => { "children": [ { "name": "order_edit", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[OrderEdit](../internal/classes/internal.OrderEdit.mdx), `\"internal_note\"` \\| `\"created_by\"` \\| `\"confirmed_by\"` \\| `\"canceled_by\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[OrderEdit](../internal/classes/internal.OrderEdit.mdx), \"internal_note\" \\| \"created_by\" \\| \"confirmed_by\" \\| \"canceled_by\">", "description": "Order edit details.", "optional": false, "defaultValue": "", @@ -281,7 +281,7 @@ medusa.orderEdits.complete(orderEditId).then(({ order_edit }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -393,7 +393,7 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => { "children": [ { "name": "order_edit", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[OrderEdit](../internal/classes/internal.OrderEdit.mdx), `\"internal_note\"` \\| `\"created_by\"` \\| `\"confirmed_by\"` \\| `\"canceled_by\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[OrderEdit](../internal/classes/internal.OrderEdit.mdx), \"internal_note\" \\| \"created_by\" \\| \"confirmed_by\" \\| \"canceled_by\">", "description": "Order edit details.", "optional": false, "defaultValue": "", @@ -599,7 +599,7 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -692,7 +692,7 @@ medusa.orderEdits.retrieve(orderEditId).then(({ order_edit }) => { "children": [ { "name": "order_edit", - "type": "[Omit](../internal/types/internal.Omit.mdx)<[OrderEdit](../internal/classes/internal.OrderEdit.mdx), `\"internal_note\"` \\| `\"created_by\"` \\| `\"confirmed_by\"` \\| `\"canceled_by\"`>", + "type": "[Omit](../internal/types/internal.Omit.mdx)<[OrderEdit](../internal/classes/internal.OrderEdit.mdx), \"internal_note\" \\| \"created_by\" \\| \"confirmed_by\" \\| \"canceled_by\">", "description": "Order edit details.", "optional": false, "defaultValue": "", @@ -898,7 +898,7 @@ medusa.orderEdits.retrieve(orderEditId).then(({ order_edit }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/OrdersResource.mdx b/www/apps/docs/content/references/js-client/classes/OrdersResource.mdx index 49cc595059..ca49be416e 100644 --- a/www/apps/docs/content/references/js-client/classes/OrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/OrdersResource.mdx @@ -375,7 +375,7 @@ medusa.orders }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -456,7 +456,7 @@ medusa.orders }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -600,7 +600,7 @@ medusa.orders }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -636,7 +636,7 @@ medusa.orders }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -681,7 +681,7 @@ medusa.orders }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -690,7 +690,7 @@ medusa.orders }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1026,7 +1026,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -1107,7 +1107,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -1251,7 +1251,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -1287,7 +1287,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -1332,7 +1332,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => { }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -1341,7 +1341,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", @@ -1604,7 +1604,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -1685,7 +1685,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => { }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -1829,7 +1829,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => { }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -1865,7 +1865,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => { }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -1910,7 +1910,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => { }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -1919,7 +1919,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => { }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.mdx index 7eb086908f..8393ec42fe 100644 --- a/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.mdx @@ -101,7 +101,7 @@ medusa.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -146,7 +146,7 @@ medusa.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -155,7 +155,7 @@ medusa.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", @@ -350,7 +350,7 @@ medusa.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -395,7 +395,7 @@ medusa.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -404,7 +404,7 @@ medusa.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", @@ -599,7 +599,7 @@ medusa.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -644,7 +644,7 @@ medusa.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -653,7 +653,7 @@ medusa.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", @@ -909,7 +909,7 @@ medusa.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -954,7 +954,7 @@ medusa.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -963,7 +963,7 @@ medusa.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", @@ -1156,7 +1156,7 @@ medusa.paymentCollections }, { "name": "cart_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", @@ -1210,7 +1210,7 @@ medusa.paymentCollections }, { "name": "is_selected", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", @@ -1386,7 +1386,7 @@ medusa.paymentCollections }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -1431,7 +1431,7 @@ medusa.paymentCollections }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -1440,7 +1440,7 @@ medusa.paymentCollections }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.mdx b/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.mdx index bb5b9f7208..7e8c593116 100644 --- a/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.mdx @@ -65,7 +65,7 @@ medusa.customers.paymentMethods.list().then(({ payment_methods }) => { "children": [ { "name": "payment_methods", - "type": "`{ data: object ; provider_id: string }`[]", + "type": "``{ data: object ; provider_id: string }``[]", "description": "The details of the saved payment methods.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx index 4b0398da1d..fbbd57184d 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx @@ -156,7 +156,7 @@ medusa.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Filter product categories by the ID of their associated parent category.", "optional": true, "defaultValue": "", @@ -198,7 +198,7 @@ medusa.productCategories "children": [ { "name": "StoreGetProductCategoriesRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] }``", "description": "The list of product categories with pagination fields.", "optional": false, "defaultValue": "", @@ -313,7 +313,7 @@ medusa.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -322,7 +322,7 @@ medusa.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", @@ -552,7 +552,7 @@ medusa.productCategories }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -561,7 +561,7 @@ medusa.productCategories }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", diff --git a/www/apps/docs/content/references/js-client/classes/ProductTagsResource.mdx b/www/apps/docs/content/references/js-client/classes/ProductTagsResource.mdx index 62608c528f..9a46ef042e 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductTagsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ProductTagsResource.mdx @@ -238,7 +238,7 @@ medusa.productTags "children": [ { "name": "StoreProductTagsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] }``", "description": "The list of product tags with pagination fields.", "optional": false, "defaultValue": "", @@ -290,7 +290,7 @@ medusa.productTags }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/ProductTypesResource.mdx b/www/apps/docs/content/references/js-client/classes/ProductTypesResource.mdx index ca2073efd3..07ae22af9b 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductTypesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ProductTypesResource.mdx @@ -240,7 +240,7 @@ medusa.productTypes "children": [ { "name": "StoreProductTypesListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ medusa.productTypes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.mdx b/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.mdx index 411d343c02..5f7164b322 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.mdx @@ -239,7 +239,7 @@ medusa.product.variants }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -257,7 +257,7 @@ medusa.product.variants }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -266,7 +266,7 @@ medusa.product.variants }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -275,7 +275,7 @@ medusa.product.variants }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -284,7 +284,7 @@ medusa.product.variants }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ medusa.product.variants }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -338,7 +338,7 @@ medusa.product.variants }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -347,7 +347,7 @@ medusa.product.variants }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -356,7 +356,7 @@ medusa.product.variants }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -374,7 +374,7 @@ medusa.product.variants }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -419,7 +419,7 @@ medusa.product.variants }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -437,7 +437,7 @@ medusa.product.variants }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -455,7 +455,7 @@ medusa.product.variants }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -464,7 +464,7 @@ medusa.product.variants }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -473,7 +473,7 @@ medusa.product.variants }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -482,7 +482,7 @@ medusa.product.variants }, { "name": "calculated_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The lowest price among the retrieved prices.", "optional": false, "defaultValue": "", @@ -491,7 +491,7 @@ medusa.product.variants }, { "name": "calculated_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `calculated_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -501,7 +501,7 @@ medusa.product.variants }, { "name": "calculated_price_type", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.", "optional": true, "defaultValue": "", @@ -510,7 +510,7 @@ medusa.product.variants }, { "name": "original_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The original price of the variant.", "optional": false, "defaultValue": "", @@ -519,7 +519,7 @@ medusa.product.variants }, { "name": "original_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `original_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -538,7 +538,7 @@ medusa.product.variants }, { "name": "calculated_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the calculated price.", "optional": false, "defaultValue": "", @@ -547,7 +547,7 @@ medusa.product.variants }, { "name": "calculated_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the calculated price.", "optional": false, "defaultValue": "", @@ -556,7 +556,7 @@ medusa.product.variants }, { "name": "original_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the original price.", "optional": false, "defaultValue": "", @@ -565,7 +565,7 @@ medusa.product.variants }, { "name": "original_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the original price.", "optional": false, "defaultValue": "", @@ -574,7 +574,7 @@ medusa.product.variants }, { "name": "tax_rates", - "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``", + "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`", "description": "The list of tax rates.", "optional": false, "defaultValue": "", @@ -671,7 +671,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -689,7 +689,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -698,7 +698,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -707,7 +707,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -716,7 +716,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -752,7 +752,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -770,7 +770,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -779,7 +779,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -788,7 +788,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -806,7 +806,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -851,7 +851,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -869,7 +869,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -887,7 +887,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -896,7 +896,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -905,7 +905,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -914,7 +914,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "calculated_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The lowest price among the retrieved prices.", "optional": false, "defaultValue": "", @@ -923,7 +923,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "calculated_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `calculated_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -933,7 +933,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "calculated_price_type", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.", "optional": true, "defaultValue": "", @@ -942,7 +942,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "original_price", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The original price of the variant.", "optional": false, "defaultValue": "", @@ -951,7 +951,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "original_price_includes_tax", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the `original_price` field includes taxes.", "optional": true, "defaultValue": "", @@ -970,7 +970,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "calculated_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the calculated price.", "optional": false, "defaultValue": "", @@ -979,7 +979,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "calculated_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the calculated price.", "optional": false, "defaultValue": "", @@ -988,7 +988,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "original_price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The price after applying the tax amount on the original price.", "optional": false, "defaultValue": "", @@ -997,7 +997,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "original_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax amount applied to the original price.", "optional": false, "defaultValue": "", @@ -1006,7 +1006,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => { }, { "name": "tax_rates", - "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``", + "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`", "description": "The list of tax rates.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/ProductsResource.mdx b/www/apps/docs/content/references/js-client/classes/ProductsResource.mdx index 91761eca23..53f673546a 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ProductsResource.mdx @@ -394,7 +394,7 @@ medusa.products "children": [ { "name": "StoreProductsListRes", - "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `{ products: [PricedProduct](../internal/types/internal.PricedProduct.mdx)[] }`", + "type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ products: [PricedProduct](../internal/types/internal.PricedProduct.mdx)[] }``", "description": "The list of products with pagination fields.", "optional": false, "defaultValue": "", @@ -456,7 +456,7 @@ medusa.products }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -474,7 +474,7 @@ medusa.products }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -483,7 +483,7 @@ medusa.products }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -501,7 +501,7 @@ medusa.products }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -510,7 +510,7 @@ medusa.products }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -519,7 +519,7 @@ medusa.products }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -528,7 +528,7 @@ medusa.products }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -564,7 +564,7 @@ medusa.products }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -573,7 +573,7 @@ medusa.products }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -582,7 +582,7 @@ medusa.products }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -591,7 +591,7 @@ medusa.products }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -609,7 +609,7 @@ medusa.products }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -663,7 +663,7 @@ medusa.products }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -681,7 +681,7 @@ medusa.products }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -708,7 +708,7 @@ medusa.products }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -726,7 +726,7 @@ medusa.products }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -735,7 +735,7 @@ medusa.products }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -850,7 +850,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -868,7 +868,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -877,7 +877,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -895,7 +895,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -904,7 +904,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -913,7 +913,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -922,7 +922,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -958,7 +958,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -967,7 +967,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -976,7 +976,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -985,7 +985,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1003,7 +1003,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -1057,7 +1057,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -1075,7 +1075,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -1102,7 +1102,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -1120,7 +1120,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1129,7 +1129,7 @@ medusa.products.retrieve(productId).then(({ product }) => { }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -1247,7 +1247,7 @@ medusa.products "children": [ { "name": "StorePostSearchRes", - "type": "`{ hits: unknown[] }` & `Record`", + "type": "``{ hits: unknown[] }`` & `Record`", "description": "The list of search results.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/RegionsResource.mdx b/www/apps/docs/content/references/js-client/classes/RegionsResource.mdx index b09c47def3..194d4c3868 100644 --- a/www/apps/docs/content/references/js-client/classes/RegionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/RegionsResource.mdx @@ -58,7 +58,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => { "children": [ { "name": "StoreRegionsListRes", - "type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `{ regions: [Region](../internal/classes/internal.Region.mdx)[] }`", + "type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & ``{ regions: [Region](../internal/classes/internal.Region.mdx)[] }``", "description": "The list of regions with pagination fields.", "optional": false, "defaultValue": "", @@ -146,7 +146,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -237,7 +237,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => { }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -255,7 +255,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => { }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", @@ -392,7 +392,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -483,7 +483,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => { }, { "name": "tax_provider_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", @@ -501,7 +501,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => { }, { "name": "tax_rates", - "type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", + "type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.mdx index b0066935e7..ac713062e7 100644 --- a/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.mdx @@ -80,7 +80,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -125,7 +125,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => { }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -134,7 +134,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => { }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", @@ -253,7 +253,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -298,7 +298,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => { }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -307,7 +307,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => { }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/ReturnsResource.mdx b/www/apps/docs/content/references/js-client/classes/ReturnsResource.mdx index 6caeb08b80..e0d6d48b5d 100644 --- a/www/apps/docs/content/references/js-client/classes/ReturnsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ReturnsResource.mdx @@ -176,7 +176,7 @@ medusa.returns }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", @@ -203,7 +203,7 @@ medusa.returns }, { "name": "idempotency_key", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", @@ -221,7 +221,7 @@ medusa.returns }, { "name": "location_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", @@ -230,7 +230,7 @@ medusa.returns }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -239,7 +239,7 @@ medusa.returns }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -257,7 +257,7 @@ medusa.returns }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ medusa.returns }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.mdx index 357dbc4d52..6414085276 100644 --- a/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.mdx @@ -119,7 +119,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => { }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -146,7 +146,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -282,7 +282,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => { }, { "name": "price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "Price including taxes", "optional": false, "defaultValue": "", @@ -300,7 +300,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => { }, { "name": "tax_rates", - "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``", + "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`", "description": "An array of applied tax rates", "optional": false, "defaultValue": "", @@ -392,7 +392,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => { }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -419,7 +419,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -555,7 +555,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => { }, { "name": "price_incl_tax", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "Price including taxes", "optional": false, "defaultValue": "", @@ -573,7 +573,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => { }, { "name": "tax_rates", - "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``", + "type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`", "description": "An array of applied tax rates", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/classes/SwapsResource.mdx b/www/apps/docs/content/references/js-client/classes/SwapsResource.mdx index b5029a0e5a..d0b5b738b6 100644 --- a/www/apps/docs/content/references/js-client/classes/SwapsResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/SwapsResource.mdx @@ -260,7 +260,7 @@ medusa.swaps }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -550,7 +550,7 @@ medusa.swaps.retrieveByCartId(cartId).then(({ swap }) => { }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx b/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx index 385c7a01c9..32d62446ef 100644 --- a/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx @@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Context -The interface tag is used to ensure that the type is documented similar to interfaces. - A shared context object that is used to share resources between the application and the module. ## Type parameters diff --git a/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.ILinkModule.mdx b/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.ILinkModule.mdx index 21f35955a8..4a2c8c2604 100644 --- a/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.ILinkModule.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.ILinkModule.mdx @@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ` \\| ``null``", + "type": "`Record` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "phone", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "postal_code", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -110,7 +110,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "province", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal-1/types/internal.internal-1.CartDTO.mdx b/www/apps/docs/content/references/js-client/internal-1/types/internal.internal-1.CartDTO.mdx index 1035e53cbd..9ea7658ce0 100644 --- a/www/apps/docs/content/references/js-client/internal-1/types/internal.internal-1.CartDTO.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/types/internal.internal-1.CartDTO.mdx @@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "item_tax_total", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -173,7 +173,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "sales_channel_id", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -191,7 +191,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "shipping_tax_total", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -218,7 +218,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "tax_total", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal-3/classes/internal.internal-3.Writable.mdx b/www/apps/docs/content/references/js-client/internal-3/classes/internal.internal-3.Writable.mdx index 757119b03e..668a0b00b9 100644 --- a/www/apps/docs/content/references/js-client/internal-3/classes/internal.internal-3.Writable.mdx +++ b/www/apps/docs/content/references/js-client/internal-3/classes/internal.internal-3.Writable.mdx @@ -33,7 +33,7 @@ v0.9.4 }, { "name": "errored", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "Returns error if the stream has been destroyed with an error.", "optional": false, "defaultValue": "", @@ -209,7 +209,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -241,7 +241,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -282,7 +282,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -332,7 +332,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -364,7 +364,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -416,7 +416,7 @@ The defined events on documents including: `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "Callback for when this chunk of data is flushed.", "optional": true, "defaultValue": "", @@ -3408,7 +3408,7 @@ v0.9.4 }, { "name": "callback", - "type": "(`error`: `undefined` \\| ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -3526,7 +3526,7 @@ A utility method for creating a `Writable` from a web `WritableStream`. }, { "name": "options", - "type": "[Pick](../../internal/types/internal.Pick.mdx)<[WritableOptions](../interfaces/internal.internal-3.WritableOptions.mdx), `\"signal\"` \\| `\"decodeStrings\"` \\| `\"highWaterMark\"` \\| `\"objectMode\"`>", + "type": "[Pick](../../internal/types/internal.Pick.mdx)<[WritableOptions](../interfaces/internal.internal-3.WritableOptions.mdx), \"signal\" \\| \"decodeStrings\" \\| \"highWaterMark\" \\| \"objectMode\">", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.StreamOptions.mdx b/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.StreamOptions.mdx index 639b6317a9..bb8dc6c73e 100644 --- a/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.StreamOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.StreamOptions.mdx @@ -88,7 +88,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -129,7 +129,7 @@ ___ }, { "name": "error", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "", "optional": false, "defaultValue": "", @@ -138,7 +138,7 @@ ___ }, { "name": "callback", - "type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.WritableOptions.mdx b/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.WritableOptions.mdx index 373d25be7d..62ebce5a62 100644 --- a/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.WritableOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal-3/interfaces/internal.internal-3.WritableOptions.mdx @@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -133,7 +133,7 @@ ___ }, { "name": "error", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "", "optional": false, "defaultValue": "", @@ -142,7 +142,7 @@ ___ }, { "name": "callback", - "type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -183,7 +183,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -242,7 +242,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -283,7 +283,7 @@ ___ }, { "name": "chunks", - "type": "`{ chunk: any ; encoding: [BufferEncoding](../../internal/types/internal.BufferEncoding.mdx) }`[]", + "type": "``{ chunk: any ; encoding: [BufferEncoding](../../internal/types/internal.BufferEncoding.mdx) }``[]", "description": "", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractSearchService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractSearchService.mdx index feaf7ab96e..469b140c26 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractSearchService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractSearchService.mdx @@ -329,7 +329,7 @@ Used to search for a document in an index }, { "name": "query", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "the search query", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Address.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Address.mdx index da8ed36aad..4e1743bd3e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Address.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Address.mdx @@ -13,7 +13,7 @@ An address is used across the Medusa backend within other schemas and object typ `", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Cart.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Cart.mdx index a123443d9e..fd9761f612 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Cart.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Cart.mdx @@ -76,7 +76,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -157,7 +157,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -211,7 +211,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](internal.PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -283,7 +283,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "shipping_address", - "type": "``null`` \\| [Address](internal.Address.mdx)", + "type": "`null` \\| [Address](internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -319,7 +319,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -346,7 +346,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Customer.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Customer.mdx index f323adb723..08cdc9fb8b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Customer.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Customer.mdx @@ -22,7 +22,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -40,7 +40,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.CustomerGroup.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.CustomerGroup.mdx index bbbd2be363..07ab364b76 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.CustomerGroup.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.CustomerGroup.mdx @@ -31,7 +31,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Discount-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Discount-1.mdx index 2dd7c7a0d7..94c1c75815 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Discount-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Discount-1.mdx @@ -31,7 +31,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -40,7 +40,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -157,7 +157,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -166,7 +166,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.DiscountCondition.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.DiscountCondition.mdx index d7429bf609..da7c486b6a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.DiscountCondition.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.DiscountCondition.mdx @@ -31,7 +31,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Duplex.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Duplex.mdx index a1eed77f46..a54a0815c2 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Duplex.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Duplex.mdx @@ -54,7 +54,7 @@ v0.9.4 }, { "name": "errored", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "Returns error if the stream has been destroyed with an error.", "optional": false, "defaultValue": "", @@ -90,7 +90,7 @@ v0.9.4 }, { "name": "readableEncoding", - "type": "``null`` \\| [BufferEncoding](../types/internal.BufferEncoding.mdx)", + "type": "`null` \\| [BufferEncoding](../types/internal.BufferEncoding.mdx)", "description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.", "optional": false, "defaultValue": "", @@ -108,7 +108,7 @@ v0.9.4 }, { "name": "readableFlowing", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.", "optional": false, "defaultValue": "", @@ -353,7 +353,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -385,7 +385,7 @@ ___ `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -426,7 +426,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -508,7 +508,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -540,7 +540,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -597,7 +597,7 @@ The defined events on documents including: `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1956,7 +1956,7 @@ If the *fn* function returns a promise - that promise will be `await`ed. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to filter chunks from the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2008,7 +2008,7 @@ If all of the *fn* calls on the chunks return a falsy value, the promise is fulf data is T", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => data is T", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2051,7 +2051,7 @@ v17.5.0 `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -2098,7 +2098,7 @@ will be merged (flattened) into the returned stream. `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. May be async. May be a stream or generator.", "optional": false, "defaultValue": "", @@ -2154,7 +2154,7 @@ in the underlying machinary and can limit the number of concurrent *fn* calls. `void` \\| Promise<void>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `void` \\| Promise<void>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2407,7 +2407,7 @@ If the *fn* function returns a promise - that promise will be `await`ed before b `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2528,7 +2528,7 @@ myEE.emit('foo'); `T`", + "type": "(`previous`: `any`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "a reducer function to call over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -4803,7 +4803,7 @@ or parallelism. To perform a reduce concurrently, you can extract the async func }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4837,7 +4837,7 @@ v17.5.0 `T`", + "type": "(`previous`: `T`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "", "optional": false, "defaultValue": "", @@ -4855,7 +4855,7 @@ v17.5.0 }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -5013,7 +5013,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -5724,7 +5724,7 @@ This method returns a new stream with the first *limit* chunks. }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -5765,7 +5765,7 @@ for interoperability and convenience, not as the primary way to consume streams. `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -6188,7 +6188,7 @@ v0.9.4 }, { "name": "cb", - "type": "(`error`: `undefined` \\| ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -6378,7 +6378,7 @@ A utility method for creating a `Duplex` from a web `ReadableStream` and `Writab }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[DuplexOptions](../interfaces/internal.DuplexOptions.mdx), `\"signal\"` \\| `\"allowHalfOpen\"` \\| `\"decodeStrings\"` \\| `\"encoding\"` \\| `\"highWaterMark\"` \\| `\"objectMode\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[DuplexOptions](../interfaces/internal.DuplexOptions.mdx), \"signal\" \\| \"allowHalfOpen\" \\| \"decodeStrings\" \\| \"encoding\" \\| \"highWaterMark\" \\| \"objectMode\">", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.FilterablePriceListProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.FilterablePriceListProps.mdx index 5d2e7e5fbf..71f98160d3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.FilterablePriceListProps.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.FilterablePriceListProps.mdx @@ -76,7 +76,7 @@ Filters to apply on the retrieved price lists. }, { "name": "status", - "type": "[PriceListStatus](../enums/internal.PriceListStatus.mdx)[]", + "type": "[PriceListStatus](../enums/internal.PriceListStatus-1.mdx)[]", "description": "Statuses to filter price lists by.", "optional": true, "defaultValue": "", @@ -85,7 +85,7 @@ Filters to apply on the retrieved price lists. }, { "name": "type", - "type": "[PriceListType](../enums/internal.PriceListType.mdx)[]", + "type": "[PriceListType](../enums/internal.PriceListType-1.mdx)[]", "description": "Types to filter price lists by.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.FlagRouter.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.FlagRouter.mdx index e47c8f1617..8e2dc1cc17 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.FlagRouter.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.FlagRouter.mdx @@ -73,7 +73,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -541,8 +541,8 @@ quantity from the quantity that was originally purchased. `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -372,7 +372,7 @@ ___ `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -413,7 +413,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -577,7 +577,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -609,7 +609,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -666,7 +666,7 @@ The defined events on documents including: `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2025,7 +2025,7 @@ If the *fn* function returns a promise - that promise will be `await`ed. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to filter chunks from the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2077,7 +2077,7 @@ If all of the *fn* calls on the chunks return a falsy value, the promise is fulf data is T", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => data is T", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2120,7 +2120,7 @@ v17.5.0 `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -2167,7 +2167,7 @@ will be merged (flattened) into the returned stream. `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. May be async. May be a stream or generator.", "optional": false, "defaultValue": "", @@ -2223,7 +2223,7 @@ in the underlying machinary and can limit the number of concurrent *fn* calls. `void` \\| Promise<void>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `void` \\| Promise<void>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2476,7 +2476,7 @@ If the *fn* function returns a promise - that promise will be `await`ed before b `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2597,7 +2597,7 @@ myEE.emit('foo'); `T`", + "type": "(`previous`: `any`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "a reducer function to call over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -4872,7 +4872,7 @@ or parallelism. To perform a reduce concurrently, you can extract the async func }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4906,7 +4906,7 @@ v17.5.0 `T`", + "type": "(`previous`: `T`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "", "optional": false, "defaultValue": "", @@ -4924,7 +4924,7 @@ v17.5.0 }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -5082,7 +5082,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -5793,7 +5793,7 @@ This method returns a new stream with the first *limit* chunks. }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -5834,7 +5834,7 @@ for interoperability and convenience, not as the primary way to consume streams. `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -6257,7 +6257,7 @@ v0.9.4 }, { "name": "cb", - "type": "(`error`: `undefined` \\| ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -6447,7 +6447,7 @@ A utility method for creating a `Duplex` from a web `ReadableStream` and `Writab }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[DuplexOptions](../interfaces/internal.DuplexOptions.mdx), `\"signal\"` \\| `\"allowHalfOpen\"` \\| `\"decodeStrings\"` \\| `\"encoding\"` \\| `\"highWaterMark\"` \\| `\"objectMode\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[DuplexOptions](../interfaces/internal.DuplexOptions.mdx), \"signal\" \\| \"allowHalfOpen\" \\| \"decodeStrings\" \\| \"encoding\" \\| \"highWaterMark\" \\| \"objectMode\">", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentCollection.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentCollection.mdx index 984ac131ec..0dde0d2fde 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentCollection.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentCollection.mdx @@ -22,7 +22,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "authorized_amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentService.mdx index 323fe512ce..f607fecd0e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentService.mdx @@ -399,7 +399,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentSession.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentSession.mdx index 824497aaeb..c5e3b502f6 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentSession.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.PaymentSession.mdx @@ -31,7 +31,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "cart_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", @@ -85,7 +85,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "is_selected", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.PriceList.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.PriceList.mdx index e3b04b7df1..4a3825b4b4 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.PriceList.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.PriceList.mdx @@ -31,7 +31,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -49,7 +49,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -95,7 +95,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Product.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Product.mdx index 815235e7ef..2c88720144 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Product.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Product.mdx @@ -32,7 +32,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -50,7 +50,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -59,7 +59,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -77,7 +77,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -86,7 +86,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -95,7 +95,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -104,7 +104,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -140,7 +140,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -149,7 +149,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -158,7 +158,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -167,7 +167,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -185,7 +185,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -239,7 +239,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -257,7 +257,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -284,7 +284,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -311,7 +311,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -320,7 +320,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx index 7bf12008c5..ab201ccba8 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx @@ -85,7 +85,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](internal.ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -94,7 +94,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCollection.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCollection.mdx index 9f8b903e92..ef197265bc 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCollection.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCollection.mdx @@ -22,7 +22,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductTag.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductTag.mdx index 09b5a48a3a..b830c79b47 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductTag.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductTag.mdx @@ -22,7 +22,7 @@ A Product Tag can be added to Products for easy filtering and grouping. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductType.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductType.mdx index 47a3ca84e8..9b4b609bd0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductType.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductType.mdx @@ -22,7 +22,7 @@ A Product Type can be added to Products for filtering and reporting purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.PublishableApiKey.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.PublishableApiKey.mdx index 58924ce441..101a07a91f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.PublishableApiKey.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.PublishableApiKey.mdx @@ -22,7 +22,7 @@ A Publishable API key defines scopes that resources are available in. Then, it c }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the key.", "optional": false, "defaultValue": "", @@ -49,7 +49,7 @@ A Publishable API key defines scopes that resources are available in. Then, it c }, { "name": "revoked_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that revoked the key.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Readable.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Readable.mdx index 6fdef952d6..02340a104b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Readable.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Readable.mdx @@ -33,7 +33,7 @@ v0.9.4 }, { "name": "errored", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "Returns error if the stream has been destroyed with an error.", "optional": false, "defaultValue": "", @@ -69,7 +69,7 @@ v0.9.4 }, { "name": "readableEncoding", - "type": "``null`` \\| [BufferEncoding](../types/internal.BufferEncoding.mdx)", + "type": "`null` \\| [BufferEncoding](../types/internal.BufferEncoding.mdx)", "description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.", "optional": false, "defaultValue": "", @@ -87,7 +87,7 @@ v0.9.4 }, { "name": "readableFlowing", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.", "optional": false, "defaultValue": "", @@ -260,7 +260,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -377,7 +377,7 @@ The defined events on documents including: `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1267,7 +1267,7 @@ If the *fn* function returns a promise - that promise will be `await`ed. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to filter chunks from the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1319,7 +1319,7 @@ If all of the *fn* calls on the chunks return a falsy value, the promise is fulf data is T", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => data is T", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1362,7 +1362,7 @@ v17.5.0 `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -1409,7 +1409,7 @@ will be merged (flattened) into the returned stream. `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. May be async. May be a stream or generator.", "optional": false, "defaultValue": "", @@ -1465,7 +1465,7 @@ in the underlying machinary and can limit the number of concurrent *fn* calls. `void` \\| Promise<void>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `void` \\| Promise<void>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1718,7 +1718,7 @@ If the *fn* function returns a promise - that promise will be `await`ed before b `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1839,7 +1839,7 @@ myEE.emit('foo'); `T`", + "type": "(`previous`: `any`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "a reducer function to call over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -3490,7 +3490,7 @@ or parallelism. To perform a reduce concurrently, you can extract the async func }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -3524,7 +3524,7 @@ v17.5.0 `T`", + "type": "(`previous`: `T`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "", "optional": false, "defaultValue": "", @@ -3542,7 +3542,7 @@ v17.5.0 }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -3700,7 +3700,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -4217,7 +4217,7 @@ This method returns a new stream with the first *limit* chunks. }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4258,7 +4258,7 @@ for interoperability and convenience, not as the primary way to consume streams. `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -307,7 +307,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -392,7 +392,7 @@ The defined events on documents including: `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1282,7 +1282,7 @@ If the *fn* function returns a promise - that promise will be `await`ed. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to filter chunks from the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1334,7 +1334,7 @@ If all of the *fn* calls on the chunks return a falsy value, the promise is fulf data is T", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => data is T", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1377,7 +1377,7 @@ v17.5.0 `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -1424,7 +1424,7 @@ will be merged (flattened) into the returned stream. `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. May be async. May be a stream or generator.", "optional": false, "defaultValue": "", @@ -1480,7 +1480,7 @@ in the underlying machinary and can limit the number of concurrent *fn* calls. `void` \\| Promise<void>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `void` \\| Promise<void>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1733,7 +1733,7 @@ If the *fn* function returns a promise - that promise will be `await`ed before b `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1854,7 +1854,7 @@ myEE.emit('foo'); `T`", + "type": "(`previous`: `any`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "a reducer function to call over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -3505,7 +3505,7 @@ or parallelism. To perform a reduce concurrently, you can extract the async func }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -3539,7 +3539,7 @@ v17.5.0 `T`", + "type": "(`previous`: `T`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "", "optional": false, "defaultValue": "", @@ -3557,7 +3557,7 @@ v17.5.0 }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -3715,7 +3715,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -4232,7 +4232,7 @@ This method returns a new stream with the first *limit* chunks. }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4273,7 +4273,7 @@ for interoperability and convenience, not as the primary way to consume streams. `", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -85,7 +85,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -166,7 +166,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ReturnReason.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ReturnReason.mdx index 4603021cf4..fb42a6c381 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ReturnReason.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ReturnReason.mdx @@ -22,7 +22,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](internal.ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](internal.ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.SalesChannel.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.SalesChannel.mdx index 859b2582b0..a771194d91 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.SalesChannel.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.SalesChannel.mdx @@ -22,7 +22,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -31,7 +31,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingMethod-4.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingMethod-4.mdx index 88d5c6f27f..59cf078def 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingMethod-4.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingMethod-4.mdx @@ -40,7 +40,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingOption.mdx index 63a9cc895f..437e3488e4 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingOption.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingOption.mdx @@ -22,7 +22,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S }, { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.", "optional": false, "defaultValue": "", @@ -49,7 +49,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingProfile.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingProfile.mdx index a1c9543aba..74745b3849 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingProfile.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ShippingProfile.mdx @@ -22,7 +22,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Socket.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Socket.mdx index 30bd47d292..d3ec68225a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Socket.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Socket.mdx @@ -99,7 +99,7 @@ v0.3.4 }, { "name": "errored", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "Returns error if the stream has been destroyed with an error.", "optional": false, "defaultValue": "", @@ -171,7 +171,7 @@ v0.3.4 }, { "name": "readableEncoding", - "type": "``null`` \\| [BufferEncoding](../types/internal.BufferEncoding.mdx)", + "type": "`null` \\| [BufferEncoding](../types/internal.BufferEncoding.mdx)", "description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.", "optional": false, "defaultValue": "", @@ -189,7 +189,7 @@ v0.3.4 }, { "name": "readableFlowing", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.", "optional": false, "defaultValue": "", @@ -479,7 +479,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -511,7 +511,7 @@ ___ `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -552,7 +552,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -634,7 +634,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -666,7 +666,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -759,7 +759,7 @@ events.EventEmitter `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2194,7 +2194,7 @@ If the *fn* function returns a promise - that promise will be `await`ed. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to filter chunks from the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2246,7 +2246,7 @@ If all of the *fn* calls on the chunks return a falsy value, the promise is fulf data is T", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => data is T", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2289,7 +2289,7 @@ v17.5.0 `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -2336,7 +2336,7 @@ will be merged (flattened) into the returned stream. `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. May be async. May be a stream or generator.", "optional": false, "defaultValue": "", @@ -2392,7 +2392,7 @@ in the underlying machinary and can limit the number of concurrent *fn* calls. `void` \\| Promise<void>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `void` \\| Promise<void>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2645,7 +2645,7 @@ If the *fn* function returns a promise - that promise will be `await`ed before b `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2809,7 +2809,7 @@ v0.1.101 `T`", + "type": "(`previous`: `any`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "a reducer function to call over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -4709,7 +4709,7 @@ or parallelism. To perform a reduce concurrently, you can extract the async func }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4743,7 +4743,7 @@ v17.5.0 `T`", + "type": "(`previous`: `T`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "", "optional": false, "defaultValue": "", @@ -4761,7 +4761,7 @@ v17.5.0 }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4944,7 +4944,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -5814,7 +5814,7 @@ This method returns a new stream with the first *limit* chunks. }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -5855,7 +5855,7 @@ for interoperability and convenience, not as the primary way to consume streams. `", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -112,7 +112,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "payment_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Payment links from. Use {{cart\\_id}} to include the payment's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -121,7 +121,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "swap_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Swap links from. Use {{cart\\_id}} to include the Swap's `cart\\_id` in the link.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.StoreGetProductCategoriesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.StoreGetProductCategoriesParams.mdx index 3a72bccd43..395adcc65e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.StoreGetProductCategoriesParams.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.StoreGetProductCategoriesParams.mdx @@ -67,7 +67,7 @@ Parameters used to filter and configure the pagination of the retrieved product }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Filter product categories by the ID of their associated parent category.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.Swap.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.Swap.mdx index 35c63cecf6..c94a1f34f6 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.Swap.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.Swap.mdx @@ -76,7 +76,7 @@ A swap can be created when a Customer wishes to exchange Products that they have }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.TaxLine.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.TaxLine.mdx index e0cffd23d2..cfb7308c90 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.TaxLine.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.TaxLine.mdx @@ -13,7 +13,7 @@ A tax line represents the taxes amount applied to a line item. `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -382,7 +382,7 @@ ___ `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -423,7 +423,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -587,7 +587,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -619,7 +619,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -676,7 +676,7 @@ The defined events on documents including: `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2035,7 +2035,7 @@ If the *fn* function returns a promise - that promise will be `await`ed. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to filter chunks from the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2087,7 +2087,7 @@ If all of the *fn* calls on the chunks return a falsy value, the promise is fulf data is T", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => data is T", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2130,7 +2130,7 @@ v17.5.0 `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -2177,7 +2177,7 @@ will be merged (flattened) into the returned stream. `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. May be async. May be a stream or generator.", "optional": false, "defaultValue": "", @@ -2233,7 +2233,7 @@ in the underlying machinary and can limit the number of concurrent *fn* calls. `void` \\| Promise<void>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `void` \\| Promise<void>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2486,7 +2486,7 @@ If the *fn* function returns a promise - that promise will be `await`ed before b `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -2607,7 +2607,7 @@ myEE.emit('foo'); `T`", + "type": "(`previous`: `any`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "a reducer function to call over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -4882,7 +4882,7 @@ or parallelism. To perform a reduce concurrently, you can extract the async func }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4916,7 +4916,7 @@ v17.5.0 `T`", + "type": "(`previous`: `T`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "", "optional": false, "defaultValue": "", @@ -4934,7 +4934,7 @@ v17.5.0 }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -5092,7 +5092,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -5803,7 +5803,7 @@ This method returns a new stream with the first *limit* chunks. }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](../interfaces/internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -5844,7 +5844,7 @@ for interoperability and convenience, not as the primary way to consume streams. `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -6267,7 +6267,7 @@ v0.9.4 }, { "name": "cb", - "type": "(`error`: `undefined` \\| ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -6457,7 +6457,7 @@ A utility method for creating a `Duplex` from a web `ReadableStream` and `Writab }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[DuplexOptions](../interfaces/internal.DuplexOptions.mdx), `\"signal\"` \\| `\"allowHalfOpen\"` \\| `\"decodeStrings\"` \\| `\"encoding\"` \\| `\"highWaterMark\"` \\| `\"objectMode\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[DuplexOptions](../interfaces/internal.DuplexOptions.mdx), \"signal\" \\| \"allowHalfOpen\" \\| \"decodeStrings\" \\| \"encoding\" \\| \"highWaterMark\" \\| \"objectMode\">", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.User.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.User.mdx index e4f377b26b..91992da025 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.User.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.User.mdx @@ -31,7 +31,7 @@ A User is an administrator who can manage store settings and data. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.WritableBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.WritableBase.mdx index 82ce27c320..9458b6b28d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.WritableBase.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.WritableBase.mdx @@ -48,7 +48,7 @@ v0.1.26 }, { "name": "errored", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "Returns error if the stream has been destroyed with an error.", "optional": false, "defaultValue": "", @@ -224,7 +224,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -256,7 +256,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -297,7 +297,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -347,7 +347,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -379,7 +379,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -431,7 +431,7 @@ The defined events on documents including: `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "Callback for when this chunk of data is flushed.", "optional": true, "defaultValue": "", @@ -3423,7 +3423,7 @@ v0.9.4 }, { "name": "callback", - "type": "(`error`: `undefined` \\| ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `undefined` \\| `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractBatchJobStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractBatchJobStrategy.mdx index 876bfca510..ca367bf060 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractBatchJobStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractBatchJobStrategy.mdx @@ -390,7 +390,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractCartCompletionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractCartCompletionStrategy.mdx index e3b1360315..44ada000d5 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractCartCompletionStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractCartCompletionStrategy.mdx @@ -194,7 +194,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFileService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFileService.mdx index 26806f7399..fca0a2f0fd 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFileService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFileService.mdx @@ -277,7 +277,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFulfillmentService.mdx index 905df2a5f7..55af8c50d1 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFulfillmentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractFulfillmentService.mdx @@ -428,7 +428,7 @@ ___ }, { "name": "documentType", - "type": "``\"label\"`` \\| ``\"invoice\"``", + "type": "`\"label\"` \\| `\"invoice\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractNotificationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractNotificationService.mdx index 965c865845..37d12611ae 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractNotificationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractNotificationService.mdx @@ -268,7 +268,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPaymentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPaymentService.mdx index b2c93bb085..ac3df41fc3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPaymentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPaymentService.mdx @@ -592,7 +592,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPriceSelectionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPriceSelectionStrategy.mdx index b7fd160f7d..770fc5a574 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPriceSelectionStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AbstractPriceSelectionStrategy.mdx @@ -144,7 +144,7 @@ circumstances described in the context. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfig.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfig.mdx index 6f315fba47..413d094c55 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfig.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfig.mdx @@ -31,7 +31,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfigService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfigService.mdx index 536ebe4fcc..3f3890e217 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfigService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AnalyticsConfigService.mdx @@ -264,7 +264,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AuthService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AuthService.mdx index be2dc83660..0a074725e3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AuthService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.AuthService.mdx @@ -322,7 +322,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.BatchJobService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.BatchJobService.mdx index 9dc180ce3e..4faf8322c3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.BatchJobService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.BatchJobService.mdx @@ -610,7 +610,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -651,7 +651,7 @@ ___ }, { "name": "data", - "type": "[Partial](../types/internal.Partial.mdx)<[Pick](../types/internal.Pick.mdx)<[BatchJob](internal.BatchJob.mdx), `\"context\"` \\| `\"result\"`>>", + "type": "[Partial](../types/internal.Partial.mdx)<[Pick](../types/internal.Pick.mdx)<[BatchJob](internal.BatchJob.mdx), \"context\" \\| \"result\">>", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CartService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CartService.mdx index e84d95d6ac..0a52afc0f6 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CartService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CartService.mdx @@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cartRepository_", - "type": "Repository<[Cart](internal.Cart.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Cart](internal.Cart.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -128,7 +128,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "lineItemRepository_", - "type": "Repository<[LineItem](internal.LineItem.mdx)> & `{ findByReturn: Method findByReturn }`", + "type": "Repository<[LineItem](internal.LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``", "description": "", "optional": false, "defaultValue": "", @@ -802,7 +802,7 @@ set the payment on the cart. }, { "name": "context", - "type": "`Record` & `{ cart_id: string }`", + "type": "`Record` & ``{ cart_id: string }``", "description": "object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling.", "optional": true, "defaultValue": "", @@ -957,7 +957,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1846,7 +1846,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimService.mdx index 17942e9207..cc92367e2e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimService.mdx @@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "lineItemRepository_", - "type": "Repository<[LineItem](internal.LineItem.mdx)> & `{ findByReturn: Method findByReturn }`", + "type": "Repository<[LineItem](internal.LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``", "description": "", "optional": false, "defaultValue": "", @@ -530,7 +530,7 @@ ___ }, { "name": "trackingLinks", - "type": "`{ tracking_number: string }`[]", + "type": "``{ tracking_number: string }``[]", "description": "", "optional": true, "defaultValue": "", @@ -753,7 +753,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimTag.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimTag.mdx index bd8acc4dca..d7806fc1c5 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimTag.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ClaimTag.mdx @@ -22,7 +22,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Country.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Country.mdx index a99cf7a617..5fc63fd316 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Country.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Country.mdx @@ -76,7 +76,7 @@ Country details }, { "name": "region_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CurrencyService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CurrencyService.mdx index 960e694c9b..79b1a0877e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CurrencyService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CurrencyService.mdx @@ -260,7 +260,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOption.mdx index bd0ad0c73d..0c41e2d2d8 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOption.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOption.mdx @@ -40,7 +40,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOptionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOptionService.mdx index 9f6b2efcbf..a044865aa7 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOptionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomShippingOptionService.mdx @@ -266,7 +266,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerGroupService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerGroupService.mdx index 28d2c05dd5..7ded3f1410 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerGroupService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerGroupService.mdx @@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "customerGroupRepository_", - "type": "Repository<[CustomerGroup](internal.CustomerGroup.mdx)> & `{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }`", + "type": "Repository<[CustomerGroup](internal.CustomerGroup.mdx)> & ``{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }``", "description": "", "optional": false, "defaultValue": "", @@ -277,7 +277,7 @@ List customer groups. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerService.mdx index 48b667f694..1244ce4259 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.CustomerService.mdx @@ -49,7 +49,7 @@ Provides layer to manipulate customers. }, { "name": "customerRepository_", - "type": "Repository<[Customer](internal.Customer.mdx)> & `{ listAndCount: Method listAndCount }`", + "type": "Repository<[Customer](internal.Customer.mdx)> & ``{ listAndCount: Method listAndCount }``", "description": "", "optional": false, "defaultValue": "", @@ -415,7 +415,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DiscountConditionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DiscountConditionService.mdx index 8e0d9b6ffa..5a4a7e48bb 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DiscountConditionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DiscountConditionService.mdx @@ -42,7 +42,7 @@ Provides layer to manipulate discount conditions. }, { "name": "discountConditionRepository_", - "type": "Repository<[DiscountCondition](internal.DiscountCondition.mdx)> & `{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }`", + "type": "Repository<[DiscountCondition](internal.DiscountCondition.mdx)> & ``{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }``", "description": "", "optional": false, "defaultValue": "", @@ -191,7 +191,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -383,7 +383,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DraftOrderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DraftOrderService.mdx index 4510c3cebc..43d9da1659 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DraftOrderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.DraftOrderService.mdx @@ -96,7 +96,7 @@ Handles draft orders }, { "name": "orderRepository_", - "type": "Repository<[Order](internal.Order.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Order](internal.Order.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -532,7 +532,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx index 4d70428e8f..000d6f73dd 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx @@ -343,7 +343,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.FulfillmentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.FulfillmentProviderService.mdx index ee81b16ca8..4abbbbf855 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.FulfillmentProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.FulfillmentProviderService.mdx @@ -298,7 +298,7 @@ ___ }, { "name": "fulfillment", - "type": "[Omit](../types/internal.Omit.mdx)<[Fulfillment](internal.Fulfillment.mdx), `\"beforeInsert\"`>", + "type": "[Omit](../types/internal.Omit.mdx)<[Fulfillment](internal.Fulfillment.mdx), \"beforeInsert\">", "description": "", "optional": false, "defaultValue": "", @@ -464,7 +464,7 @@ Fetches documents from the fulfillment provider }, { "name": "documentType", - "type": "``\"label\"`` \\| ``\"invoice\"``", + "type": "`\"label\"` \\| `\"invoice\"`", "description": "the typ of", "optional": false, "defaultValue": "", @@ -528,7 +528,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.GiftCardService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.GiftCardService.mdx index 3ebf03ffbc..dfb1cacec0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.GiftCardService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.GiftCardService.mdx @@ -49,7 +49,7 @@ Provides layer to manipulate gift cards. }, { "name": "giftCardRepository_", - "type": "Repository<[GiftCard](internal.GiftCard-1.mdx)> & `{ listGiftCardsAndCount: Method listGiftCardsAndCount }`", + "type": "Repository<[GiftCard](internal.GiftCard-1.mdx)> & ``{ listGiftCardsAndCount: Method listGiftCardsAndCount }``", "description": "", "optional": false, "defaultValue": "", @@ -500,7 +500,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -630,7 +630,7 @@ provided by the user or the tax rate. Based on these conditions, tax\_rate chang ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Image.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Image.mdx index cea10e1d5e..c6afe50cf0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Image.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.Image.mdx @@ -22,7 +22,7 @@ An Image is used to store details about uploaded images. Images are uploaded by }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemAdjustmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemAdjustmentService.mdx index c877c8fbbc..1da8f258ca 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemAdjustmentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemAdjustmentService.mdx @@ -279,7 +279,7 @@ Deletes line item adjustments matching a selector ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemService.mdx index 1b5e3ba342..a22427401a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemService.mdx @@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cartRepository_", - "type": "Repository<[Cart](internal.Cart.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Cart](internal.Cart.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "itemTaxLineRepo_", - "type": "Repository<[LineItemTaxLine](internal.internal.LineItemTaxLine.mdx)> & `{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`", + "type": "Repository<[LineItemTaxLine](internal.internal.LineItemTaxLine.mdx)> & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }``", "description": "", "optional": false, "defaultValue": "", @@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "lineItemRepository_", - "type": "Repository<[LineItem](internal.LineItem.mdx)> & `{ findByReturn: Method findByReturn }`", + "type": "Repository<[LineItem](internal.LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``", "description": "", "optional": false, "defaultValue": "", @@ -414,7 +414,7 @@ Deletes a line item. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemTaxLine.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemTaxLine.mdx index 568d5f7334..a8adda2559 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemTaxLine.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.LineItemTaxLine.mdx @@ -13,7 +13,7 @@ A tax line represents the taxes amount applied to a line item. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NoteService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NoteService.mdx index d4d9a0f0a4..253c7e62b3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NoteService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NoteService.mdx @@ -406,7 +406,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NotificationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NotificationService.mdx index 5ea7dc5231..5d05effbf3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NotificationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.NotificationService.mdx @@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "container_", - "type": "[InjectedDependencies](../types/internal.InjectedDependencies-16.mdx) & `{}`", + "type": "[InjectedDependencies](../types/internal.InjectedDependencies-16.mdx) & ``{}``", "description": "", "optional": false, "defaultValue": "", @@ -566,7 +566,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OauthService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OauthService.mdx index e0ceb1cefb..9a7c3255f7 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OauthService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OauthService.mdx @@ -433,7 +433,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditItemChangeService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditItemChangeService.mdx index 5c856992ad..a66160ad02 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditItemChangeService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditItemChangeService.mdx @@ -346,7 +346,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditService.mdx index d35ba81a60..c1eb16778a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderEditService.mdx @@ -736,7 +736,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderService.mdx index 5f7fd60037..faa2eb418c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.OrderService.mdx @@ -173,7 +173,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "orderRepository_", - "type": "Repository<[Order](internal.Order.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Order](internal.Order.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -1620,7 +1620,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1872,8 +1872,8 @@ quantity from the quantity that was originally purchased. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PaymentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PaymentProviderService.mdx index 0f7f444663..b1ff2a2759 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PaymentProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PaymentProviderService.mdx @@ -313,7 +313,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PriceListService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PriceListService.mdx index 1486af2e6d..9b81c880e1 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PriceListService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PriceListService.mdx @@ -67,7 +67,7 @@ Provides layer to manipulate product tags. }, { "name": "moneyAmountRepo_", - "type": "Repository<[MoneyAmount](internal.internal.MoneyAmount.mdx)> & `{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }`", + "type": "Repository<[MoneyAmount](internal.internal.MoneyAmount.mdx)> & ``{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }``", "description": "", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ Provides layer to manipulate product tags. }, { "name": "priceListRepo_", - "type": "Repository<[PriceList](internal.PriceList.mdx)> & `{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }`", + "type": "Repository<[PriceList](internal.PriceList.mdx)> & ``{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }``", "description": "", "optional": false, "defaultValue": "", @@ -804,7 +804,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -888,7 +888,7 @@ ___ }, { "name": "customerGroups", - "type": "`{ id: string }`[]", + "type": "``{ id: string }``[]", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PricingService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PricingService.mdx index 4d38c95c54..02828c57a2 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PricingService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.PricingService.mdx @@ -164,6 +164,15 @@ ___ #### Returns Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "addPrices", "type": "(`data`: [AddPricesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPricesDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>(`data`: [AddPricesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.AddPricesDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>", @@ -218,6 +227,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "createPriceListRules", + "type": "(`data`: [CreatePriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "createPriceLists", + "type": "(`data`: [CreatePriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceListDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "createPriceRules", "type": "(`data`: [CreatePriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CreatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]>", @@ -272,6 +299,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "deletePriceListRules", + "type": "(`priceListRuleIds`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "deletePriceLists", + "type": "(`priceListIds`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "deletePriceRules", "type": "(`priceRuleIds`: `string`[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", @@ -335,6 +380,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "listAndCountPriceListRules", + "type": "(`filters?`: [FilterablePriceListRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[], number]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "listAndCountPriceLists", + "type": "(`filters?`: [FilterablePriceListProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[], number]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "listAndCountPriceRules", "type": "(`filters?`: [FilterablePriceRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[], number]>", @@ -389,6 +452,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "listPriceListRules", + "type": "(`filters?`: [FilterablePriceListRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "listPriceLists", + "type": "(`filters?`: [FilterablePriceListProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceListProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "listPriceRules", "type": "(`filters?`: [FilterablePriceRuleProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]>", @@ -425,6 +506,15 @@ ___ "expandable": false, "children": [] }, + { + "name": "removePriceListRules", + "type": "(`data`: [RemovePriceListRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceListRulesDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "removeRules", "type": "(`data`: [RemovePriceSetRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.RemovePriceSetRulesDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<void>", @@ -461,6 +551,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "retrievePriceList", + "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "retrievePriceListRule", + "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "retrievePriceRule", "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)>", @@ -488,6 +596,15 @@ ___ "expandable": false, "children": [] }, + { + "name": "setPriceListRules", + "type": "(`data`: [SetPriceListRulesDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.SetPriceListRulesDTO.mdx), `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "updateCurrencies", "type": "(`data`: [UpdateCurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdateCurrencyDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[CurrencyDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.CurrencyDTO.mdx)[]>", @@ -506,6 +623,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "updatePriceListRules", + "type": "(`data`: [UpdatePriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListRuleDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "updatePriceLists", + "type": "(`data`: [UpdatePriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceListDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "updatePriceRules", "type": "(`data`: [UpdatePriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.UpdatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)) => Promise<[PriceRuleDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]>", @@ -544,7 +679,7 @@ ___ `) => Promise<any> \\| ``null``", + "type": "(`query`: `string` \\| [RemoteJoinerQuery](../../internal-1/interfaces/internal.internal-1.RemoteJoinerQuery.mdx) \\| `object`, `variables?`: `Record`) => Promise<any> \\| `null`", "description": "", "optional": false, "defaultValue": "", @@ -697,7 +832,7 @@ be fetched. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCategoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCategoryService.mdx index e4d6dbe0f9..7f146d82aa 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCategoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCategoryService.mdx @@ -58,7 +58,7 @@ Provides layer to manipulate product categories. }, { "name": "productCategoryRepo_", - "type": "TreeRepository<[ProductCategory](internal.ProductCategory.mdx)> & `{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }`", + "type": "TreeRepository<[ProductCategory](internal.ProductCategory.mdx)> & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``", "description": "", "optional": false, "defaultValue": "", @@ -407,7 +407,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCollectionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCollectionService.mdx index 32d79720e8..4875ee486c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCollectionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductCollectionService.mdx @@ -58,7 +58,7 @@ Provides layer to manipulate product collections. }, { "name": "productCollectionRepository_", - "type": "Repository<[ProductCollection](internal.ProductCollection.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }`", + "type": "Repository<[ProductCollection](internal.ProductCollection.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }``", "description": "", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ Provides layer to manipulate product collections. }, { "name": "productRepository_", - "type": "Repository<[Product](internal.Product.mdx)> & `{ _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }`", + "type": "Repository<[Product](internal.Product.mdx)> & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``", "description": "", "optional": false, "defaultValue": "", @@ -331,7 +331,7 @@ Lists product collections ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOption.mdx index c5afdfc050..287398f817 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOption.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOption.mdx @@ -22,7 +22,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOptionValue.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOptionValue.mdx index 092ffdba52..5fc24be7f2 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOptionValue.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductOptionValue.mdx @@ -22,7 +22,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductService.mdx index 97ebf8af16..abf3d4eb8b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductService.mdx @@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "imageRepository_", - "type": "Repository<[Image](internal.internal.Image.mdx)> & `{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }`", + "type": "Repository<[Image](internal.internal.Image.mdx)> & ``{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }``", "description": "", "optional": false, "defaultValue": "", @@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productCategoryRepository_", - "type": "TreeRepository<[ProductCategory](internal.ProductCategory.mdx)> & `{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }`", + "type": "TreeRepository<[ProductCategory](internal.ProductCategory.mdx)> & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``", "description": "", "optional": false, "defaultValue": "", @@ -92,7 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productRepository_", - "type": "Repository<[Product](internal.Product.mdx)> & `{ _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }`", + "type": "Repository<[Product](internal.Product.mdx)> & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``", "description": "", "optional": false, "defaultValue": "", @@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productTagRepository_", - "type": "Repository<[ProductTag](internal.ProductTag.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }`", + "type": "Repository<[ProductTag](internal.ProductTag.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }``", "description": "", "optional": false, "defaultValue": "", @@ -110,7 +110,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productTypeRepository_", - "type": "Repository<[ProductType](internal.ProductType.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }`", + "type": "Repository<[ProductType](internal.ProductType.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }``", "description": "", "optional": false, "defaultValue": "", @@ -191,7 +191,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "IndexName", - "type": "``\"products\"``", + "type": "`\"products\"`", "description": "", "optional": false, "defaultValue": "\"products\"", @@ -973,7 +973,7 @@ Retrieve product's option by title. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1219,7 +1219,7 @@ Assign a product to a profile, if a profile id null is provided then detach the }, { "name": "profileId", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Shipping profile ID to update the shipping options with", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductTypeService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductTypeService.mdx index bd658e35c4..6bb9f368f0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductTypeService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductTypeService.mdx @@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "typeRepository_", - "type": "Repository<[ProductType](internal.ProductType.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }`", + "type": "Repository<[ProductType](internal.ProductType.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }``", "description": "", "optional": false, "defaultValue": "", @@ -148,7 +148,7 @@ Lists product types ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariant.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariant.mdx index 482475f544..f540f6df9e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariant.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariant.mdx @@ -22,7 +22,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -40,7 +40,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -49,7 +49,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -58,7 +58,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -121,7 +121,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -130,7 +130,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -139,7 +139,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -157,7 +157,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -202,7 +202,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -220,7 +220,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -238,7 +238,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -247,7 +247,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -256,7 +256,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryItem.mdx index 50937621db..c7d22ada60 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryItem.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryItem.mdx @@ -22,7 +22,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryService.mdx index e5f3840b9d..bacbc38b08 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ProductVariantInventoryService.mdx @@ -126,18 +126,9 @@ ___ #### Returns [ModuleJoinerConfig](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "adjustInventory", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -146,7 +137,7 @@ ___ }, { "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<boolean>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -155,7 +146,7 @@ ___ }, { "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", + "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -164,7 +155,7 @@ ___ }, { "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]>", + "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -173,7 +164,7 @@ ___ }, { "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -182,7 +173,7 @@ ___ }, { "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", + "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -191,7 +182,7 @@ ___ }, { "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", + "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -200,7 +191,7 @@ ___ }, { "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]>", + "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -209,7 +200,7 @@ ___ }, { "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -218,7 +209,7 @@ ___ }, { "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -227,7 +218,7 @@ ___ }, { "name": "deleteInventoryLevel", - "type": "(`inventoryLevelId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -236,7 +227,7 @@ ___ }, { "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -245,7 +236,7 @@ ___ }, { "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -254,7 +245,7 @@ ___ }, { "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -263,7 +254,7 @@ ___ }, { "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -272,7 +263,7 @@ ___ }, { "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -281,7 +272,7 @@ ___ }, { "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -290,7 +281,7 @@ ___ }, { "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -299,7 +290,7 @@ ___ }, { "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -308,7 +299,7 @@ ___ }, { "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -317,7 +308,7 @@ ___ }, { "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -326,7 +317,7 @@ ___ }, { "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", + "type": "(`reservationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -335,7 +326,7 @@ ___ }, { "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -344,7 +335,7 @@ ___ }, { "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -353,7 +344,7 @@ ___ }, { "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/internal.Partial.mdx)<[CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -362,7 +353,7 @@ ___ }, { "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -371,7 +362,7 @@ ___ }, { "name": "updateInventoryLevels", - "type": "(`updates`: `{ inventory_item_id: string ; location_id: string }` & [UpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", + "type": "(`updates`: [BulkUpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -380,7 +371,7 @@ ___ }, { "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", + "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -396,18 +387,9 @@ ___ #### Returns [ModuleJoinerConfig](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "create", - "type": "(`input`: [CreateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", + "type": "(`input`: [CreateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -416,7 +398,7 @@ ___ }, { "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`id`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -425,7 +407,7 @@ ___ }, { "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]>", + "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -434,7 +416,7 @@ ___ }, { "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -443,7 +425,7 @@ ___ }, { "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -452,7 +434,7 @@ ___ }, { "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -641,7 +623,7 @@ Attach a variant to an inventory item ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1279,7 +1261,7 @@ Validate stock at a location for fulfillment items ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -861,7 +861,7 @@ Updates a collection of variant. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -968,7 +968,7 @@ the id can be passed to check that country updates are allowed. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ReturnService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ReturnService.mdx index c1e13852c3..1d0fa3c257 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ReturnService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ReturnService.mdx @@ -641,7 +641,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelInventoryService.mdx index 86174808ab..f72e1bef2d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelInventoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelInventoryService.mdx @@ -99,18 +99,9 @@ ___ #### Returns [ModuleJoinerConfig](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "adjustInventory", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -119,7 +110,7 @@ ___ }, { "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<boolean>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -128,7 +119,7 @@ ___ }, { "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", + "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -137,7 +128,7 @@ ___ }, { "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]>", + "type": "(`input`: [CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -146,7 +137,7 @@ ___ }, { "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -155,7 +146,7 @@ ___ }, { "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", + "type": "(`data`: [CreateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -164,7 +155,7 @@ ___ }, { "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", + "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -173,7 +164,7 @@ ___ }, { "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]>", + "type": "(`input`: [CreateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -182,7 +173,7 @@ ___ }, { "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -191,7 +182,7 @@ ___ }, { "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -200,7 +191,7 @@ ___ }, { "name": "deleteInventoryLevel", - "type": "(`inventoryLevelId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -209,7 +200,7 @@ ___ }, { "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -218,7 +209,7 @@ ___ }, { "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -227,7 +218,7 @@ ___ }, { "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -236,7 +227,7 @@ ___ }, { "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -245,7 +236,7 @@ ___ }, { "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -254,7 +245,7 @@ ___ }, { "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../../InventoryTypes/types/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -263,7 +254,7 @@ ___ }, { "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -272,7 +263,7 @@ ___ }, { "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -281,7 +272,7 @@ ___ }, { "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -290,7 +281,7 @@ ___ }, { "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -299,7 +290,7 @@ ___ }, { "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", + "type": "(`reservationId`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -308,7 +299,7 @@ ___ }, { "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -317,7 +308,7 @@ ___ }, { "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -326,7 +317,7 @@ ___ }, { "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [CreateInventoryItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/internal.Partial.mdx)<[CreateInventoryItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/internal.InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -335,7 +326,7 @@ ___ }, { "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -344,7 +335,7 @@ ___ }, { "name": "updateInventoryLevels", - "type": "(`updates`: `{ inventory_item_id: string ; location_id: string }` & [UpdateInventoryLevelInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", + "type": "(`updates`: [BulkUpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/internal.InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -353,7 +344,7 @@ ___ }, { "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../../InventoryTypes/types/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", + "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/internal.ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -468,7 +459,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocation.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocation.mdx index caa8243ce5..d8db6cb5a0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocation.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocation.mdx @@ -22,7 +22,7 @@ This represents the association between a sales channel and a stock locations. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocationService.mdx index 479cb149f0..a3aba376d4 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelLocationService.mdx @@ -101,18 +101,9 @@ ___ #### Returns [ModuleJoinerConfig](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "create", - "type": "(`input`: [CreateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", + "type": "(`input`: [CreateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.CreateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -121,7 +112,7 @@ ___ }, { "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<void>", + "type": "(`id`: `string`, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -130,7 +121,7 @@ ___ }, { "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]>", + "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -139,7 +130,7 @@ ___ }, { "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx), `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/internal.StockLocationDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -148,7 +139,7 @@ ___ }, { "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `config?`: [FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>, `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -157,7 +148,7 @@ ___ }, { "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/types/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../../StockLocationTypes/types/internal.internal-1.StockLocationTypes.UpdateStockLocationInput.mdx), `context?`: [SharedContext](../../internal-1/interfaces/internal.internal-1.SharedContext.mdx)) => Promise<[StockLocationDTO](../types/internal.StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -383,7 +374,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelService.mdx index e21838d519..91884e0cd6 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SalesChannelService.mdx @@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "salesChannelRepository_", - "type": "Repository<[SalesChannel](internal.SalesChannel.mdx)> & `{ addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }`", + "type": "Repository<[SalesChannel](internal.SalesChannel.mdx)> & ``{ addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }``", "description": "", "optional": false, "defaultValue": "", @@ -606,7 +606,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ShippingMethodTaxLine.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ShippingMethodTaxLine.mdx index 25d1ddc73f..895a01fc69 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ShippingMethodTaxLine.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.ShippingMethodTaxLine.mdx @@ -13,7 +13,7 @@ A tax line represents the taxes amount applied to a line item. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -805,7 +805,7 @@ match, or when the shipping option requirements are not satisfied. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StagedJobService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StagedJobService.mdx index 0195510c07..86d861fdda 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StagedJobService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StagedJobService.mdx @@ -49,7 +49,7 @@ Provides layer to manipulate users. }, { "name": "stagedJobRepository_", - "type": "Repository<[StagedJob](internal.internal.StagedJob.mdx)> & `{ insertBulk: Method insertBulk }`", + "type": "Repository<[StagedJob](internal.internal.StagedJob.mdx)> & ``{ insertBulk: Method insertBulk }``", "description": "", "optional": false, "defaultValue": "", @@ -244,7 +244,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StoreService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StoreService.mdx index 35cea96b86..4d0bd30cf2 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StoreService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StoreService.mdx @@ -320,7 +320,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StrategyResolverService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StrategyResolverService.mdx index a449b7c49d..7d596fc40e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StrategyResolverService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.StrategyResolverService.mdx @@ -178,7 +178,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SwapService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SwapService.mdx index 8836950a9b..0ee95b2c9e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SwapService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.SwapService.mdx @@ -292,7 +292,7 @@ Handles swaps ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1094,7 +1094,7 @@ Transform find config object for retrieval. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxProviderService.mdx index 5bc864f81d..bfdd83551b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxProviderService.mdx @@ -85,7 +85,7 @@ Finds tax providers and assists in tax related operations. }, { "name": "smTaxLineRepo_", - "type": "Repository<[ShippingMethodTaxLine](internal.internal.ShippingMethodTaxLine.mdx)> & `{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`", + "type": "Repository<[ShippingMethodTaxLine](internal.internal.ShippingMethodTaxLine.mdx)> & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }``", "description": "", "optional": false, "defaultValue": "", @@ -94,7 +94,7 @@ Finds tax providers and assists in tax related operations. }, { "name": "taxLineRepo_", - "type": "Repository<[LineItemTaxLine](internal.internal.LineItemTaxLine.mdx)> & `{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`", + "type": "Repository<[LineItemTaxLine](internal.internal.LineItemTaxLine.mdx)> & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }``", "description": "", "optional": false, "defaultValue": "", @@ -669,7 +669,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxRateService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxRateService.mdx index 61a1416b4b..c306365743 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxRateService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TaxRateService.mdx @@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "taxRateRepository_", - "type": "Repository<[TaxRate](internal.TaxRate.mdx)> & `{ addToProduct: Method addToProduct ; addToProductType: Method addToProductType ; addToShippingOption: Method addToShippingOption ; applyResolutionsToQueryBuilder: Method applyResolutionsToQueryBuilder ; findAndCountWithResolution: Method findAndCountWithResolution ; findOneWithResolution: Method findOneWithResolution ; findWithResolution: Method findWithResolution ; getFindQueryBuilder: Method getFindQueryBuilder ; listByProduct: Method listByProduct ; listByShippingOption: Method listByShippingOption ; removeFromProduct: Method removeFromProduct ; removeFromProductType: Method removeFromProductType ; removeFromShippingOption: Method removeFromShippingOption }`", + "type": "Repository<[TaxRate](internal.TaxRate.mdx)> & ``{ addToProduct: Method addToProduct ; addToProductType: Method addToProductType ; addToShippingOption: Method addToShippingOption ; applyResolutionsToQueryBuilder: Method applyResolutionsToQueryBuilder ; findAndCountWithResolution: Method findAndCountWithResolution ; findOneWithResolution: Method findOneWithResolution ; findWithResolution: Method findWithResolution ; getFindQueryBuilder: Method getFindQueryBuilder ; listByProduct: Method listByProduct ; listByShippingOption: Method listByShippingOption ; removeFromProduct: Method removeFromProduct ; removeFromProductType: Method removeFromProductType ; removeFromShippingOption: Method removeFromShippingOption }``", "description": "", "optional": false, "defaultValue": "", @@ -706,7 +706,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TotalsService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TotalsService.mdx index d4aa452450..06f7e51454 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TotalsService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TotalsService.mdx @@ -1141,7 +1141,7 @@ Currently based on the Danish tax system ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TrackingLink.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TrackingLink.mdx index bb7d05edec..d88b9d9988 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TrackingLink.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TrackingLink.mdx @@ -22,7 +22,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TransactionBaseService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TransactionBaseService.mdx index baa1f014b4..3ed063ab6a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TransactionBaseService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.TransactionBaseService.mdx @@ -137,7 +137,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.UserService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.UserService.mdx index f0ca3857a5..05dc4ee4cd 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.UserService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.UserService.mdx @@ -588,7 +588,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListStatus-1.mdx b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListStatus-1.mdx new file mode 100644 index 0000000000..6aa4332b2d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListStatus-1.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListStatus + +The status of a price list. + +## Enumeration Members + +### ACTIVE + +The price list is active, meaning its prices are applied to customers. + +___ + +### DRAFT + +The price list is a draft, meaning its not yet applied to customers. diff --git a/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListStatus.mdx index 6aa4332b2d..3e271cd096 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListStatus.mdx @@ -6,16 +6,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PriceListStatus -The status of a price list. - ## Enumeration Members ### ACTIVE -The price list is active, meaning its prices are applied to customers. - ___ ### DRAFT - -The price list is a draft, meaning its not yet applied to customers. diff --git a/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListType-1.mdx b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListType-1.mdx new file mode 100644 index 0000000000..f21f72a907 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListType-1.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListType + +The type of price list. + +## Enumeration Members + +### OVERRIDE + +The price list is used to override original prices for specific conditions. + +___ + +### SALE + +The price list is used for a sale. diff --git a/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListType.mdx b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListType.mdx index f21f72a907..c8c14af199 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/internal.PriceListType.mdx @@ -6,16 +6,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PriceListType -The type of price list. - ## Enumeration Members ### OVERRIDE -The price list is used to override original prices for specific conditions. - ___ ### SALE - -The price list is used for a sale. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosDefaults.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosDefaults.mdx index ff42ab99e7..8ae879d1ca 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosDefaults.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosDefaults.mdx @@ -189,7 +189,7 @@ Construct a type with the properties of T except for those in type K. }, { "name": "proxy", - "type": "``false`` \\| [AxiosProxyConfig](internal.AxiosProxyConfig.mdx)", + "type": "`false` \\| [AxiosProxyConfig](internal.AxiosProxyConfig.mdx)", "description": "", "optional": true, "defaultValue": "", @@ -225,7 +225,7 @@ Construct a type with the properties of T except for those in type K. }, { "name": "socketPath", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "", "optional": true, "defaultValue": "", @@ -288,7 +288,7 @@ Construct a type with the properties of T except for those in type K. }, { "name": "validateStatus", - "type": "``null`` \\| (`status`: `number`) => `boolean`", + "type": "`null` \\| (`status`: `number`) => `boolean`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosPromise.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosPromise.mdx index c2da809472..a36033a328 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosPromise.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.AxiosPromise.mdx @@ -45,7 +45,7 @@ Attaches a callback for only the rejection of the Promise. `TResult` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult>", + "type": "`null` \\| (`reason`: `any`) => `TResult` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult>", "description": "The callback to execute when the Promise is rejected.", "optional": true, "defaultValue": "", @@ -80,7 +80,7 @@ resolved value cannot be modified from the callback. `void`", + "type": "`null` \\| () => `void`", "description": "The callback to execute when the Promise is settled (fulfilled or rejected).", "optional": true, "defaultValue": "", @@ -114,7 +114,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise. `TResult1` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult1>", + "type": "`null` \\| (`value`: [AxiosResponse](internal.AxiosResponse.mdx)<T, any>) => `TResult1` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult1>", "description": "The callback to execute when the Promise is resolved.", "optional": true, "defaultValue": "", @@ -123,7 +123,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise. }, { "name": "onrejected", - "type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult2>", + "type": "`null` \\| (`reason`: `any`) => `TResult2` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult2>", "description": "The callback to execute when the Promise is rejected.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.Buffer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.Buffer.mdx index bd6b92df06..b068dffaac 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.Buffer.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.Buffer.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"Uint8Array\"``", + "type": "`\"Uint8Array\"`", "description": "", "optional": false, "defaultValue": "", @@ -224,8 +224,8 @@ console.log(buf1.compare(buf2, 5, 6, 5)); `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -196,7 +196,7 @@ ___ }, { "name": "error", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "", "optional": false, "defaultValue": "", @@ -205,7 +205,7 @@ ___ }, { "name": "callback", - "type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -246,7 +246,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -346,7 +346,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -387,7 +387,7 @@ ___ }, { "name": "chunks", - "type": "`{ chunk: any ; encoding: [BufferEncoding](../types/internal.BufferEncoding.mdx) }`[]", + "type": "``{ chunk: any ; encoding: [BufferEncoding](../types/internal.BufferEncoding.mdx) }``[]", "description": "", "optional": false, "defaultValue": "", @@ -396,7 +396,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.HTTPResponse.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.HTTPResponse.mdx index 861364ff31..dd94ae7431 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.HTTPResponse.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.HTTPResponse.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "headers", - "type": "`Record` & `{ set-cookie?: string[] }`", + "type": "`Record` & ``{ set-cookie?: string[] }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ICacheService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ICacheService.mdx index f2b9329e9f..26d4a3caca 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ICacheService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ICacheService.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - -___ - ### adjustInventory +This method is used to adjust the inventory level's stocked quantity. The inventory level is identified by the IDs of its associated inventory item and location. + +#### Example + +```ts +import { + initialize as initializeInventoryModule, +} from "@medusajs/inventory" + +async function adjustInventory ( + inventoryItemId: string, + locationId: string, + adjustment: number +) { + const inventoryModule = await initializeInventoryModule({}) + + const inventoryLevel = await inventoryModule.adjustInventory( + inventoryItemId, + locationId, + adjustment + ) + + // do something with the inventory level or return it. +} +``` + #### Parameters + +#### Returns + + + +___ + ### addPrices `**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)>` @@ -849,6 +915,132 @@ async function retrieveMoneyAmounts() { ___ +### createPriceListRules + +This method is used to create price list rules. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function createPriceListRules (items: { + rule_type_id: string + price_list_id: string +}[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.createPriceListRules(items) + + // do something with the price list rule or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + +### createPriceLists + +This method is used to create price lists. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function createPriceList (items: { + title: string + description: string + starts_at?: string + ends_at?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.createPriceLists(items) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### createPriceRules This method is used to create new price rules based on the provided data. @@ -1223,6 +1415,120 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) { ___ +### deletePriceListRules + +This method is used to delete price list rules. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function deletePriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + await pricingService.deletePriceListRules(priceListRuleIds) +} +``` + +#### Parameters + + + +#### Returns + + + +___ + +### deletePriceLists + +This method is used to delete price lists. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function deletePriceLists (ids: string[]) { + const pricingService = await initializePricingModule() + + await pricingService.deletePriceLists(ids) +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### deletePriceRules This method is used to delete price rules based on the specified IDs. @@ -1984,6 +2290,314 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str ___ +### listAndCountPriceListRules + +This method is used to retrieve a paginated list of price list ruless along with the total count of available price list ruless satisfying the provided filters. + +#### Example + +To retrieve a list of price list vs using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + ) + + // do something with the price list rules or return them +} +``` + +To specify relations that should be retrieved within the price list rules: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"] + } + ) + + // do something with the price list rules or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + $and: [ + { + id: priceListRuleIds + }, + { + rule_types: ruleTypeIDs + } + ] + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + +### listAndCountPriceLists + +This method is used to retrieve a paginated list of price lists along with the total count of available price lists satisfying the provided filters. + +#### Example + +To retrieve a list of price lists using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + ) + + // do something with the price lists or return them +} +``` + +To specify relations that should be retrieved within the price lists: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price lists or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + $and: [ + { + id: priceListIds + }, + { + title: titles + } + ] + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### listAndCountPriceRules This method is used to retrieve a paginated list of price rules along with the total count of available price rules satisfying the provided filters. @@ -2840,6 +3454,314 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str ___ +### listPriceListRules + +This method is used to retrieve a paginated list of price list rules based on optional filters and configuration. + +#### Example + +To retrieve a list of price list vs using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + ) + + // do something with the price list rules or return them +} +``` + +To specify relations that should be retrieved within the price list rules: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"] + } + ) + + // do something with the price list rules or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + $and: [ + { + id: priceListRuleIds + }, + { + rule_types: ruleTypeIDs + } + ] + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + +### listPriceLists + +This method is used to retrieve a paginated list of price lists based on optional filters and configuration. + +#### Example + +To retrieve a list of price lists using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + ) + + // do something with the price lists or return them +} +``` + +To specify relations that should be retrieved within the price lists: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price lists or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + $and: [ + { + id: priceListIds + }, + { + title: titles + } + ] + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### listPriceRules This method is used to retrieve a paginated list of price rules based on optional filters and configuration. @@ -3418,6 +4340,68 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu ___ +### removePriceListRules + +This method is used to remove rules from a price list. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function setPriceListRules (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.removePriceListRules({ + priceListId, + rules: ["region_id"] + }) + + // do something with the price list or return it +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### removeRules This method remove rules from a price set. @@ -3482,7 +4466,7 @@ ___ ### retrieve -This method is used to retrieves a price set by its ID. +This method is used to retrieve a price set by its ID. #### Example @@ -3759,6 +4743,192 @@ async function retrieveMoneyAmount (moneyAmountId: string) { ___ +### retrievePriceList + +This method is used to retrieve a price list by its ID. + +#### Example + +A simple example that retrieves a price list by its ID: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceList (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.retrievePriceList( + priceListId + ) + + // do something with the price list or return it +} +``` + +To specify relations that should be retrieved: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceList (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.retrievePriceList( + priceListId, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price list or return it +} +``` + +#### Parameters + + + +#### Returns + + + +___ + +### retrievePriceListRule + +This method is used to retrieve a price list rule by its ID. + +#### Example + +A simple example that retrieves a price list rule by its ID: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceListRule (priceListRuleId: string) { + const pricingService = await initializePricingModule() + + const priceListRule = await pricingService.retrievePriceListRule( + priceListRuleId + ) + + // do something with the price list rule or return it +} +``` + +To specify relations that should be retrieved: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceListRule (priceListRuleId: string) { + const pricingService = await initializePricingModule() + + const priceListRule = await pricingService.retrievePriceListRule( + priceListRuleId, + { + relations: ["price_list"] + } + ) + + // do something with the price list rule or return it +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### retrievePriceRule This method is used to retrieve a price rule by its ID. @@ -4023,6 +5193,70 @@ async function retrieveRuleType (ruleTypeId: string) { ___ +### setPriceListRules + +This method is used to set the rules of a price list. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function setPriceListRules (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.setPriceListRules({ + priceListId, + rules: { + region_id: "US" + } + }) + + // do something with the price list or return it +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### updateCurrencies This method is used to update existing currencies with the provided data. In each currency object, the currency code must be provided to identify which currency to update. @@ -4149,6 +5383,134 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { ___ +### updatePriceListRules + +This method is used to update price list rules. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function updatePriceListRules (items: { + id: string + rule_type_id?: string + price_list_id?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.updatePriceListRules(items) + + // do something with the price list rule or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + +### updatePriceLists + +This method is used to update price lists. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function updatePriceLists (items: { + id: string + title: string + description: string + starts_at?: string + ends_at?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.updatePriceLists(items) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + + + +___ + ### updatePriceRules This method is used to update price rules, each with their provided data. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx index e4304a6025..7f7e414d20 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx @@ -8,33 +8,35 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### \_\_joinerConfig - -#### Returns - - - -___ - ### create +This method is used to create a stock location. + +#### Example + +```ts +import { + initialize as initializeStockLocationModule, +} from "@medusajs/stock-location" + +async function createStockLocation (name: string) { + const stockLocationModule = await initializeStockLocationModule({}) + + const stockLocation = await stockLocationModule.create({ + name + }) + + // do something with the stock location or return it +} +``` + #### Parameters `TResult1` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult1>", + "type": "`null` \\| (`value`: `T`) => `TResult1` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult1>", "description": "The callback to execute when the Promise is resolved.", "optional": true, "defaultValue": "", @@ -40,7 +40,7 @@ Attaches callbacks for the resolution and/or rejection of the Promise. }, { "name": "onrejected", - "type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult2>", + "type": "`null` \\| (`reason`: `any`) => `TResult2` \\| [PromiseLike](internal.PromiseLike.mdx)<TResult2>", "description": "The callback to execute when the Promise is rejected.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadWriteStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadWriteStream.mdx index 94fa8464de..635847c0e7 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadWriteStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadWriteStream.mdx @@ -1369,7 +1369,7 @@ ___ }, { "name": "cb", - "type": "(`err?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`err?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -1417,7 +1417,7 @@ ___ }, { "name": "cb", - "type": "(`err?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`err?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController-1.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController-1.mdx index 226773e715..6cf35fbff7 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController-1.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "desiredSize", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController.mdx index 36219f4443..201a040b6f 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableByteStreamController.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -124,7 +124,7 @@ ___ }, { "name": "error", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "", "optional": false, "defaultValue": "", @@ -133,7 +133,7 @@ ___ }, { "name": "callback", - "type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-2.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-2.mdx index c401b16257..8adb8f604a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-2.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream-2.mdx @@ -122,7 +122,7 @@ ___ }, { "name": "options.mode", - "type": "``\"byob\"``", + "type": "`\"byob\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream.mdx index b9d4fabc66..d55c936dad 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStream.mdx @@ -94,7 +94,7 @@ ___ }, { "name": "options.mode", - "type": "``\"byob\"``", + "type": "`\"byob\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBRequest.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBRequest.mdx index 2bcd9ad23f..26e4ec5687 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBRequest.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.ReadableStreamBYOBRequest.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -196,7 +196,7 @@ ___ }, { "name": "error", - "type": "``null`` \\| [Error](../../modules/internal.mdx#error)", + "type": "`null` \\| [Error](../../modules/internal.mdx#error)", "description": "", "optional": false, "defaultValue": "", @@ -205,7 +205,7 @@ ___ }, { "name": "callback", - "type": "(`error`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -246,7 +246,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -446,7 +446,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -487,7 +487,7 @@ ___ }, { "name": "chunks", - "type": "`{ chunk: any ; encoding: [BufferEncoding](../types/internal.BufferEncoding.mdx) }`[]", + "type": "``{ chunk: any ; encoding: [BufferEncoding](../types/internal.BufferEncoding.mdx) }``[]", "description": "", "optional": false, "defaultValue": "", @@ -496,7 +496,7 @@ ___ }, { "name": "callback", - "type": "(`error?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource-1.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource-1.mdx index f2341bf7d7..763e8efe24 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource-1.mdx @@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "type", - "type": "``\"bytes\"``", + "type": "`\"bytes\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource.mdx index 9883fa5a62..689c602f49 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingByteSource.mdx @@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "type", - "type": "``\"bytes\"``", + "type": "`\"bytes\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSource.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSource.mdx index ccde439cb4..82a8280604 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSource.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.UnderlyingSource.mdx @@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "type", - "type": "``\"bytes\"``", + "type": "`\"bytes\"`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStream.mdx index 5a4888fc68..1a8f525751 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStream.mdx @@ -1079,7 +1079,7 @@ ___ }, { "name": "cb", - "type": "(`err?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`err?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", @@ -1127,7 +1127,7 @@ ___ }, { "name": "cb", - "type": "(`err?`: ``null`` \\| [Error](../../modules/internal.mdx#error)) => `void`", + "type": "(`err?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter-1.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter-1.mdx index 870313ca00..f99157fc71 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter-1.mdx @@ -39,7 +39,7 @@ sink. }, { "name": "desiredSize", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter.mdx index ff68df1ba0..d07f6fbacc 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.WritableStreamDefaultWriter.mdx @@ -38,7 +38,7 @@ This Streams API interface is the object returned by WritableStream.getWriter() }, { "name": "desiredSize", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize)", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.FulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.FulfillmentService.mdx index e45459148e..f798e6842a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.FulfillmentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.FulfillmentService.mdx @@ -392,7 +392,7 @@ ___ }, { "name": "documentType", - "type": "``\"label\"`` \\| ``\"invoice\"``", + "type": "`\"label\"` \\| `\"invoice\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IBatchJobStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IBatchJobStrategy.mdx index 7e5a5c43a3..234abeeb57 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IBatchJobStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IBatchJobStrategy.mdx @@ -268,7 +268,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IFileService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IFileService.mdx index bb6ae5ab3e..f361ab8700 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IFileService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IFileService.mdx @@ -273,7 +273,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.INotificationService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.INotificationService.mdx index 07a6742a75..16afdf7075 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.INotificationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.INotificationService.mdx @@ -237,7 +237,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IPriceSelectionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IPriceSelectionStrategy.mdx index b1aeb46538..aa4df4c485 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IPriceSelectionStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/internal.internal.IPriceSelectionStrategy.mdx @@ -18,7 +18,7 @@ circumstances described in the context. `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -477,7 +477,7 @@ ___ `void`", + "type": "(`error?`: `null` \\| [Error](../../modules/internal.mdx#error)) => `void`", "description": "", "optional": false, "defaultValue": "", @@ -562,7 +562,7 @@ The defined events on documents including: `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1405,7 +1405,7 @@ If the *fn* function returns a promise - that promise will be `await`ed. `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to filter chunks from the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1457,7 +1457,7 @@ If all of the *fn* calls on the chunks return a falsy value, the promise is fulf data is T", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => data is T", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1500,7 +1500,7 @@ v17.5.0 `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -1547,7 +1547,7 @@ will be merged (flattened) into the returned stream. `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. May be async. May be a stream or generator.", "optional": false, "defaultValue": "", @@ -1603,7 +1603,7 @@ in the underlying machinary and can limit the number of concurrent *fn* calls. `void` \\| Promise<void>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `void` \\| Promise<void>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1856,7 +1856,7 @@ If the *fn* function returns a promise - that promise will be `await`ed before b `any`", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `any`", "description": "a function to map over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -1950,7 +1950,7 @@ ___ `T`", + "type": "(`previous`: `any`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "a reducer function to call over every chunk in the stream. Async or not.", "optional": false, "defaultValue": "", @@ -3536,7 +3536,7 @@ or parallelism. To perform a reduce concurrently, you can extract the async func }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -3570,7 +3570,7 @@ v17.5.0 `T`", + "type": "(`previous`: `T`, `data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `T`", "description": "", "optional": false, "defaultValue": "", @@ -3588,7 +3588,7 @@ v17.5.0 }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -3666,7 +3666,7 @@ ___ `boolean` \\| Promise<boolean>", + "type": "(`data`: `any`, `options?`: [Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">) => `boolean` \\| Promise<boolean>", "description": "a function to call on each chunk of the stream. Async or not.", "optional": false, "defaultValue": "", @@ -4226,7 +4226,7 @@ This method returns a new stream with the first *limit* chunks. }, { "name": "options", - "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), `\"signal\"`>", + "type": "[Pick](../types/internal.Pick.mdx)<[ArrayOptions](internal.ArrayOptions.mdx), \"signal\">", "description": "", "optional": true, "defaultValue": "", @@ -4267,7 +4267,7 @@ for interoperability and convenience, not as the primary way to consume streams. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/modules/internal.internal.mdx b/www/apps/docs/content/references/js-client/internal/modules/internal.internal.mdx index 90d0992084..c1f95e1a35 100644 --- a/www/apps/docs/content/references/js-client/internal/modules/internal.internal.mdx +++ b/www/apps/docs/content/references/js-client/internal/modules/internal.internal.mdx @@ -42,7 +42,7 @@ ___ }, { "name": "OVERRIDE", - "type": "[OVERRIDE](../enums/internal.PriceListType.mdx#override)", + "type": "[OVERRIDE](../enums/internal.PriceListType-1.mdx#override)", "description": "", "optional": false, "defaultValue": "", @@ -51,7 +51,7 @@ ___ }, { "name": "SALE", - "type": "[SALE](../enums/internal.PriceListType.mdx#sale)", + "type": "[SALE](../enums/internal.PriceListType-1.mdx#sale)", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.AdminAuthRes.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.AdminAuthRes.mdx index 50e2bfe568..53b9b9b5a8 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.AdminAuthRes.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.AdminAuthRes.mdx @@ -13,7 +13,7 @@ The user's details. ` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -92,7 +92,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": "", @@ -101,7 +101,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": "", @@ -119,7 +119,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": "", @@ -128,7 +128,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": "", @@ -137,7 +137,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": "", @@ -155,7 +155,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": "", @@ -164,7 +164,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": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.InventoryLevelDTO.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.InventoryLevelDTO.mdx index f6f39fc011..8527e6d9c4 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.InventoryLevelDTO.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.InventoryLevelDTO.mdx @@ -20,7 +20,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": "", @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.LineAllocationsMap.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.LineAllocationsMap.mdx index 426639fb9a..0b2dd3e9fb 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.LineAllocationsMap.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.LineAllocationsMap.mdx @@ -11,4 +11,4 @@ allocations ### Index signature -▪ [K: `string`]: `{ discount?: [DiscountAllocation](internal.DiscountAllocation.mdx) ; gift_card?: [GiftCardAllocation](internal.GiftCardAllocation.mdx) }` +▪ [K: `string`]: ``{ discount?: [DiscountAllocation](internal.DiscountAllocation.mdx) ; gift_card?: [GiftCardAllocation](internal.GiftCardAllocation.mdx) }`` diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.LookupFunction.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.LookupFunction.mdx index 3f51be97f3..7d6f2556a0 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.LookupFunction.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.LookupFunction.mdx @@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "callback", - "type": "(`err`: [ErrnoException](../interfaces/internal.ErrnoException.mdx) \\| ``null``, `addresses`: [LookupAddress](../interfaces/internal.LookupAddress.mdx)[]) => `void`", + "type": "(`err`: [ErrnoException](../interfaces/internal.ErrnoException.mdx) \\| `null`, `addresses`: [LookupAddress](../interfaces/internal.LookupAddress.mdx)[]) => `void`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.PaymentSessionInput.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.PaymentSessionInput.mdx index 43a66681a5..64695f2bb3 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.PaymentSessionInput.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.PaymentSessionInput.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cart", - "type": "[Cart](../classes/internal.Cart.mdx) \\| `{ billing_address?: [Address](../classes/internal.Address.mdx) \\| `null` ; context: Record<string, unknown> ; email: string ; id: string ; shipping_address: [Address](../classes/internal.Address.mdx) \\| `null` ; shipping_methods: [ShippingMethod](../classes/internal.ShippingMethod-4.mdx)[] }`", + "type": "[Cart](../classes/internal.Cart.mdx) \\| ``{ billing_address?: [Address](../classes/internal.Address.mdx) \\| null ; context: Record<string, unknown> ; email: string ; id: string ; shipping_address: [Address](../classes/internal.Address.mdx) \\| null ; shipping_methods: [ShippingMethod](../classes/internal.ShippingMethod-4.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "customer", - "type": "[Customer](../classes/internal.Customer.mdx) \\| ``null``", + "type": "[Customer](../classes/internal.Customer.mdx) \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.PricingContext.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.PricingContext.mdx index cc6099c562..936501dd1e 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.PricingContext.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.PricingContext.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "tax_rate", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.ProductCategoryInput.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.ProductCategoryInput.mdx index 3420c30653..04d2730bc0 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.ProductCategoryInput.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.ProductCategoryInput.mdx @@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "parent_category", - "type": "[ProductCategory](../classes/internal.ProductCategory.mdx) \\| ``null``", + "type": "[ProductCategory](../classes/internal.ProductCategory.mdx) \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "parent_category_id", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.ProviderLineItemTaxLine.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.ProviderLineItemTaxLine.mdx index e6aeaa41fc..8ef27426f9 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.ProviderLineItemTaxLine.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.ProviderLineItemTaxLine.mdx @@ -13,7 +13,7 @@ The tax line properties for a given line item. ` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.ReserveQuantityContext.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.ReserveQuantityContext.mdx index f53e10bc6b..9894ae9d99 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.ReserveQuantityContext.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.ReserveQuantityContext.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "salesChannelId", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.ShippingMethodUpdate.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.ShippingMethodUpdate.mdx index 60abf2de17..abfd8a41b0 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.ShippingMethodUpdate.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.ShippingMethodUpdate.mdx @@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.StoreCartsRes.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.StoreCartsRes.mdx index fe614b543d..b00ebc73f5 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.StoreCartsRes.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.StoreCartsRes.mdx @@ -13,7 +13,7 @@ The cart's details. `", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -762,8 +762,8 @@ async function createProduct (title: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -772,16 +772,16 @@ async function createProduct (title: string) { { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -790,7 +790,7 @@ async function createProduct (title: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -798,8 +798,8 @@ async function createProduct (title: string) { }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -808,16 +808,16 @@ async function createProduct (title: string) { { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -835,10 +835,10 @@ async function createProduct (title: string) { { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -853,16 +853,16 @@ async function createProduct (title: string) { { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -870,8 +870,8 @@ async function createProduct (title: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx index 8ab47b7615..58a42e7dfc 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCategory.mdx @@ -92,8 +92,8 @@ async function createCategory (name: string, parent_category_id: string | null) }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", - "description": "The ID of the parent product category, if it has any. It may also be `null`.", + "type": "`null` \\| `string`", + "description": "The ID of the parent product category, if it has any.", "optional": false, "defaultValue": "", "expandable": false, @@ -121,7 +121,7 @@ async function createCategory (name: string, parent_category_id: string | null) { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -148,7 +148,7 @@ async function createCategory (name: string, parent_category_id: string | null) { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -181,18 +181,18 @@ async function createCategory (name: string, parent_category_id: string | null) { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -261,10 +261,10 @@ async function createCategory (name: string, parent_category_id: string | null) { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -353,18 +353,18 @@ async function createCategory (name: string, parent_category_id: string | null) { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -433,10 +433,10 @@ async function createCategory (name: string, parent_category_id: string | null) { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx index e24f2de7c5..20557f71f0 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createCollections.mdx @@ -67,7 +67,7 @@ async function createCollection (title: string) { { "name": "product_ids", "type": "`string`[]", - "description": "", + "description": "The products to associate with the collection.", "optional": true, "defaultValue": "", "expandable": false, @@ -95,7 +95,7 @@ async function createCollection (title: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -122,7 +122,7 @@ async function createCollection (title: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -189,7 +189,7 @@ async function createCollection (title: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -199,10 +199,10 @@ async function createCollection (title: string) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx index aa06bd124b..0e8aa07ec9 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createOptions.mdx @@ -78,7 +78,7 @@ async function createProductOption (title: string, productId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -105,7 +105,7 @@ async function createProductOption (title: string, productId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -163,7 +163,7 @@ async function createProductOption (title: string, productId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -173,10 +173,10 @@ async function createProductOption (title: string, productId: string) { { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -191,10 +191,10 @@ async function createProductOption (title: string, productId: string) { { "name": "values", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx index 5f4ac49c9b..557f980b4e 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTags.mdx @@ -68,7 +68,7 @@ async function createProductTags (values: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -95,7 +95,7 @@ async function createProductTags (values: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -144,7 +144,7 @@ async function createProductTags (values: string[]) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -154,10 +154,10 @@ async function createProductTags (values: string[]) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx index 0b4de088ee..66c1ff8a2b 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.createTypes.mdx @@ -86,7 +86,7 @@ async function createProductType (value: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -113,7 +113,7 @@ async function createProductType (value: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -171,7 +171,7 @@ async function createProductType (value: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx index 670207f7ca..38e85c00e2 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.delete.mdx @@ -52,7 +52,7 @@ async function deleteProducts (ids: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function deleteProducts (ids: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx index bbd88028d3..1194c7fe14 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCategory.mdx @@ -52,7 +52,7 @@ async function deleteCategory (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function deleteCategory (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx index 7f995c74e4..bfc59e1a55 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteCollections.mdx @@ -52,7 +52,7 @@ async function deleteCollection (ids: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function deleteCollection (ids: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx index 238492d2a6..6845cb008b 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteOptions.mdx @@ -52,7 +52,7 @@ async function deleteProductOptions (ids: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function deleteProductOptions (ids: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx index 3de22c5ea6..7131d42038 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTags.mdx @@ -53,7 +53,7 @@ async function deleteProductTags (ids: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -80,7 +80,7 @@ async function deleteProductTags (ids: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx index 959ce0c8ad..9a3289718f 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.deleteTypes.mdx @@ -52,7 +52,7 @@ async function deleteProductTypes (ids: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function deleteProductTypes (ids: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx index 2e805f447b..cd4618b2c6 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.list.mdx @@ -146,7 +146,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "", + "description": "IDs to filter categories by.", "optional": true, "defaultValue": "", "expandable": false, @@ -155,7 +155,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "is_active", "type": "`boolean`", - "description": "", + "description": "Filter categories by whether they're active.", "optional": true, "defaultValue": "", "expandable": false, @@ -164,7 +164,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "is_internal", "type": "`boolean`", - "description": "", + "description": "Filter categories by whether they're internal", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "category_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "", + "description": "Filter a product by the IDs of their associated categories.", "optional": true, "defaultValue": "", "expandable": false, @@ -184,7 +184,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "collection_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "Filters a product by its associated collections.", + "description": "Filters a product by the IDs of their associated collections.", "optional": true, "defaultValue": "", "expandable": false, @@ -228,7 +228,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "value", "type": "`string`[]", - "description": "", + "description": "Values to filter product tags by.", "optional": true, "defaultValue": "", "expandable": false, @@ -323,7 +323,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -350,7 +350,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -390,20 +390,20 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -426,8 +426,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -444,7 +444,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -453,8 +453,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -462,8 +462,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -471,8 +471,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -490,10 +490,10 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "images", "type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -507,8 +507,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -516,8 +516,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -526,7 +526,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -534,8 +534,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -544,16 +544,16 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -562,7 +562,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -570,8 +570,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -580,16 +580,16 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -607,10 +607,10 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -625,16 +625,16 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -642,8 +642,8 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx index e3e90edad4..0987a7ba2f 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCount.mdx @@ -146,7 +146,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "", + "description": "IDs to filter categories by.", "optional": true, "defaultValue": "", "expandable": false, @@ -155,7 +155,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "is_active", "type": "`boolean`", - "description": "", + "description": "Filter categories by whether they're active.", "optional": true, "defaultValue": "", "expandable": false, @@ -164,7 +164,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "is_internal", "type": "`boolean`", - "description": "", + "description": "Filter categories by whether they're internal", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "category_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "", + "description": "Filter a product by the IDs of their associated categories.", "optional": true, "defaultValue": "", "expandable": false, @@ -184,7 +184,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "collection_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../types/OperatorMap.mdx)<string>", - "description": "Filters a product by its associated collections.", + "description": "Filters a product by the IDs of their associated collections.", "optional": true, "defaultValue": "", "expandable": false, @@ -228,7 +228,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "value", "type": "`string`[]", - "description": "", + "description": "Values to filter product tags by.", "optional": true, "defaultValue": "", "expandable": false, @@ -323,7 +323,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -350,7 +350,7 @@ async function retrieveProducts (ids: string[], title: string, skip: number, tak { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx index b3ffdfa9da..87156c89ed 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCategories.mdx @@ -191,7 +191,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta }, { "name": "parent_category_id", - "type": "``null`` \\| `string` \\| `string`[]", + "type": "`null` \\| `string` \\| `string`[]", "description": "Filter product categories by their parent category's ID.", "optional": true, "defaultValue": "", @@ -285,7 +285,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -312,7 +312,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx index 77a10f22dd..478852819d 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountCollections.mdx @@ -138,7 +138,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, { "name": "handle", "type": "`string` \\| `string`[]", - "description": "", + "description": "The handles to filter product collections by.", "optional": true, "defaultValue": "", "expandable": false, @@ -249,7 +249,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -276,7 +276,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx index 14f8e566be..75bf9ee2d2 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountOptions.mdx @@ -249,7 +249,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -276,7 +276,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx index 894bc47ae2..b234c2a78e 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTags.mdx @@ -240,7 +240,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -267,7 +267,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx index 0e078b766e..11dfe4a76e 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountTypes.mdx @@ -240,7 +240,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -267,7 +267,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx index 3dd95601df..23fe2c3485 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listAndCountVariants.mdx @@ -155,7 +155,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "id", "type": "`string`[]", - "description": "", + "description": "IDs to filter options by.", "optional": true, "defaultValue": "", "expandable": false, @@ -268,7 +268,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -295,7 +295,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx index bf746c39df..8ba796567b 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCategories.mdx @@ -191,7 +191,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta }, { "name": "parent_category_id", - "type": "``null`` \\| `string` \\| `string`[]", + "type": "`null` \\| `string` \\| `string`[]", "description": "Filter product categories by their parent category's ID.", "optional": true, "defaultValue": "", @@ -285,7 +285,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -312,7 +312,7 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -353,10 +353,10 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -425,10 +425,10 @@ async function retrieveCategories (ids: string[], name: string, skip: number, ta { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx index 2b13f635a3..5bee9ef4c4 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listCollections.mdx @@ -138,7 +138,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, { "name": "handle", "type": "`string` \\| `string`[]", - "description": "", + "description": "The handles to filter product collections by.", "optional": true, "defaultValue": "", "expandable": false, @@ -249,7 +249,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -276,7 +276,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -343,7 +343,7 @@ async function retrieveCollections (ids: string[], title: string, skip: number, }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -353,10 +353,10 @@ async function retrieveCollections (ids: string[], title: string, skip: number, { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx index 8d343d2a63..ba0cf9672e 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listOptions.mdx @@ -249,7 +249,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -276,7 +276,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -334,7 +334,7 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -344,10 +344,10 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -362,10 +362,10 @@ async function retrieveProductOptions (ids: string[], title: string, skip: numbe { "name": "values", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx index 15bef49660..17b2b7529e 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTags.mdx @@ -240,7 +240,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -267,7 +267,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -316,7 +316,7 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -326,10 +326,10 @@ async function retrieveProductTag (tagIds: string[], value: string, skip: number { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx index 143f2112e2..b31f7332f2 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listTypes.mdx @@ -240,7 +240,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -267,7 +267,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -325,7 +325,7 @@ async function retrieveProductTypes (ids: string[], value: string, skip: number, }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx index 33df895072..7af1e5320c 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.listVariants.mdx @@ -155,7 +155,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "id", "type": "`string`[]", - "description": "", + "description": "IDs to filter options by.", "optional": true, "defaultValue": "", "expandable": false, @@ -268,7 +268,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -295,7 +295,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -344,8 +344,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -371,8 +371,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -380,8 +380,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -389,8 +389,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -416,8 +416,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -434,8 +434,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -443,7 +443,7 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -452,8 +452,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -462,16 +462,16 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "options", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -480,10 +480,10 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -497,8 +497,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -515,8 +515,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -533,8 +533,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -542,8 +542,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -551,8 +551,8 @@ async function retrieveProductVariants (ids: string[], sku: string, skip: number }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx index a844edbdd9..ad048e28e8 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restore.mdx @@ -75,7 +75,7 @@ async function restoreProducts (ids: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -102,7 +102,7 @@ async function restoreProducts (ids: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx index 0954da378d..19df3e140c 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.restoreVariants.mdx @@ -55,7 +55,7 @@ This documentation provides a reference to the restoreVariants method. This belo { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -82,7 +82,7 @@ This documentation provides a reference to the restoreVariants method. This belo { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieve.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieve.mdx index 50dc460bc4..95a9beffe6 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieve.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieve.mdx @@ -37,20 +37,17 @@ To specify relations that should be retrieved: ```ts import { - initialize as initializePricingModule, -} from "@medusajs/pricing" + initialize as initializeProductModule, +} from "@medusajs/product" -async function retrievePriceSet (priceSetId: string) { - const pricingService = await initializePricingModule() +async function retrieveProduct (id: string) { + const productModule = await initializeProductModule() - const priceSet = await pricingService.retrieve( - priceSetId, - { - relations: ["money_amounts"] - } - ) + const product = await productModule.retrieve(id, { + relations: ["categories"] + }) - // do something with the price set or return it + // do something with the product or return it } ``` @@ -151,7 +148,7 @@ async function retrievePriceSet (priceSetId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -178,7 +175,7 @@ async function retrievePriceSet (priceSetId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -210,20 +207,20 @@ async function retrievePriceSet (priceSetId: string) { "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -254,7 +251,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -264,10 +261,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -301,8 +298,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -319,7 +316,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -328,8 +325,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -337,8 +334,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -346,8 +343,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -365,10 +362,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "images", "type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -390,7 +387,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -419,8 +416,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -428,8 +425,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -438,7 +435,7 @@ async function retrievePriceSet (priceSetId: string) { { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -446,8 +443,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -456,10 +453,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -481,7 +478,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -491,10 +488,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -509,18 +506,18 @@ async function retrievePriceSet (priceSetId: string) { { "name": "values", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -529,14 +526,14 @@ async function retrievePriceSet (priceSetId: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "", "optional": true, "defaultValue": "", @@ -545,7 +542,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "", "optional": true, "defaultValue": "", @@ -554,7 +551,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "", "optional": true, "defaultValue": "", @@ -563,7 +560,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "", "optional": true, "defaultValue": "", @@ -574,8 +571,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -584,10 +581,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -600,7 +597,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -610,10 +607,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -629,8 +626,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -648,10 +645,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -673,7 +670,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -703,10 +700,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -719,8 +716,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -746,8 +743,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -755,8 +752,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -764,8 +761,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -791,8 +788,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -809,8 +806,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -818,7 +815,7 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -827,8 +824,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -837,16 +834,16 @@ async function retrievePriceSet (priceSetId: string) { { "name": "options", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -855,10 +852,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -872,8 +869,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -890,8 +887,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -908,8 +905,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -917,8 +914,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -926,8 +923,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -937,8 +934,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -946,8 +943,8 @@ async function retrievePriceSet (priceSetId: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCategory.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCategory.mdx index 4a651dac45..cb125299bd 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCategory.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCategory.mdx @@ -148,7 +148,7 @@ async function retrieveCategory (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveCategory (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -208,18 +208,18 @@ async function retrieveCategory (id: string) { { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -288,10 +288,10 @@ async function retrieveCategory (id: string) { { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -380,18 +380,18 @@ async function retrieveCategory (id: string) { { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -460,10 +460,10 @@ async function retrieveCategory (id: string) { { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCollection.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCollection.mdx index 1ed0e7cf45..14d7f55c2e 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCollection.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveCollection.mdx @@ -148,7 +148,7 @@ async function retrieveCollection (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveCollection (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -234,7 +234,7 @@ async function retrieveCollection (id: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -244,27 +244,27 @@ async function retrieveCollection (id: string) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -287,8 +287,8 @@ async function retrieveCollection (id: string) { }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -305,7 +305,7 @@ async function retrieveCollection (id: string) { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -314,8 +314,8 @@ async function retrieveCollection (id: string) { }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -323,8 +323,8 @@ async function retrieveCollection (id: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -332,8 +332,8 @@ async function retrieveCollection (id: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -351,10 +351,10 @@ async function retrieveCollection (id: string) { { "name": "images", "type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -368,8 +368,8 @@ async function retrieveCollection (id: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -377,8 +377,8 @@ async function retrieveCollection (id: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -387,7 +387,7 @@ async function retrieveCollection (id: string) { { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -395,8 +395,8 @@ async function retrieveCollection (id: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -405,16 +405,16 @@ async function retrieveCollection (id: string) { { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -423,7 +423,7 @@ async function retrieveCollection (id: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -431,8 +431,8 @@ async function retrieveCollection (id: string) { }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -441,16 +441,16 @@ async function retrieveCollection (id: string) { { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -468,10 +468,10 @@ async function retrieveCollection (id: string) { { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -486,16 +486,16 @@ async function retrieveCollection (id: string) { { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -503,8 +503,8 @@ async function retrieveCollection (id: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveOption.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveOption.mdx index e77e3046cf..649d246d36 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveOption.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveOption.mdx @@ -148,7 +148,7 @@ async function retrieveProductOption (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveProductOption (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -225,7 +225,7 @@ async function retrieveProductOption (id: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -235,27 +235,27 @@ async function retrieveProductOption (id: string) { { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -278,8 +278,8 @@ async function retrieveProductOption (id: string) { }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -296,7 +296,7 @@ async function retrieveProductOption (id: string) { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -305,8 +305,8 @@ async function retrieveProductOption (id: string) { }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -314,8 +314,8 @@ async function retrieveProductOption (id: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -323,8 +323,8 @@ async function retrieveProductOption (id: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -342,10 +342,10 @@ async function retrieveProductOption (id: string) { { "name": "images", "type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -359,8 +359,8 @@ async function retrieveProductOption (id: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -368,8 +368,8 @@ async function retrieveProductOption (id: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -378,7 +378,7 @@ async function retrieveProductOption (id: string) { { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -386,8 +386,8 @@ async function retrieveProductOption (id: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -396,16 +396,16 @@ async function retrieveProductOption (id: string) { { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -414,7 +414,7 @@ async function retrieveProductOption (id: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -422,8 +422,8 @@ async function retrieveProductOption (id: string) { }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -432,16 +432,16 @@ async function retrieveProductOption (id: string) { { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -459,10 +459,10 @@ async function retrieveProductOption (id: string) { { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -477,16 +477,16 @@ async function retrieveProductOption (id: string) { { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -494,8 +494,8 @@ async function retrieveProductOption (id: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -515,10 +515,10 @@ async function retrieveProductOption (id: string) { { "name": "values", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -540,7 +540,7 @@ async function retrieveProductOption (id: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -550,10 +550,10 @@ async function retrieveProductOption (id: string) { { "name": "option", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -568,10 +568,10 @@ async function retrieveProductOption (id: string) { { "name": "variant", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveTag.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveTag.mdx index 56be591e9c..3dfa5c9556 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveTag.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveTag.mdx @@ -148,7 +148,7 @@ async function retrieveProductTag (tagId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveProductTag (tagId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -216,7 +216,7 @@ async function retrieveProductTag (tagId: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -226,27 +226,27 @@ async function retrieveProductTag (tagId: string) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -269,8 +269,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -287,7 +287,7 @@ async function retrieveProductTag (tagId: string) { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -296,8 +296,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -305,8 +305,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -314,8 +314,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -333,10 +333,10 @@ async function retrieveProductTag (tagId: string) { { "name": "images", "type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -350,8 +350,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -359,8 +359,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -369,7 +369,7 @@ async function retrieveProductTag (tagId: string) { { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -377,8 +377,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -387,16 +387,16 @@ async function retrieveProductTag (tagId: string) { { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -405,7 +405,7 @@ async function retrieveProductTag (tagId: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -413,8 +413,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -423,16 +423,16 @@ async function retrieveProductTag (tagId: string) { { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -450,10 +450,10 @@ async function retrieveProductTag (tagId: string) { { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -468,16 +468,16 @@ async function retrieveProductTag (tagId: string) { { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -485,8 +485,8 @@ async function retrieveProductTag (tagId: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveType.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveType.mdx index ca1e4b5853..04be60c6dc 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveType.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveType.mdx @@ -148,7 +148,7 @@ async function retrieveProductType (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveProductType (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -225,7 +225,7 @@ async function retrieveProductType (id: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveVariant.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveVariant.mdx index 8d32c903dc..6190d627f3 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveVariant.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.retrieveVariant.mdx @@ -148,7 +148,7 @@ async function retrieveProductVariant (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveProductVariant (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -216,8 +216,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -243,8 +243,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -252,8 +252,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -261,8 +261,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -288,8 +288,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -306,8 +306,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -315,7 +315,7 @@ async function retrieveProductVariant (id: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -324,8 +324,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -334,10 +334,10 @@ async function retrieveProductVariant (id: string) { { "name": "options", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -359,7 +359,7 @@ async function retrieveProductVariant (id: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -369,10 +369,10 @@ async function retrieveProductVariant (id: string) { { "name": "option", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -387,18 +387,18 @@ async function retrieveProductVariant (id: string) { { "name": "variant", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -407,27 +407,27 @@ async function retrieveProductVariant (id: string) { { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -450,8 +450,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -468,7 +468,7 @@ async function retrieveProductVariant (id: string) { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -477,8 +477,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -486,8 +486,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -495,8 +495,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -514,10 +514,10 @@ async function retrieveProductVariant (id: string) { { "name": "images", "type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -531,8 +531,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -540,8 +540,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -550,7 +550,7 @@ async function retrieveProductVariant (id: string) { { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -558,8 +558,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -568,16 +568,16 @@ async function retrieveProductVariant (id: string) { { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -586,7 +586,7 @@ async function retrieveProductVariant (id: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -594,8 +594,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -604,16 +604,16 @@ async function retrieveProductVariant (id: string) { { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -631,10 +631,10 @@ async function retrieveProductVariant (id: string) { { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -649,16 +649,16 @@ async function retrieveProductVariant (id: string) { { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -666,8 +666,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -686,8 +686,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -704,8 +704,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -722,8 +722,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -731,8 +731,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -740,8 +740,8 @@ async function retrieveProductVariant (id: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.softDelete.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.softDelete.mdx index 6125273395..9536fa0faa 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.softDelete.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.softDelete.mdx @@ -75,7 +75,7 @@ async function deleteProducts (ids: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -102,7 +102,7 @@ async function deleteProducts (ids: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.update.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.update.mdx index 814d85ae65..c0520f77cb 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.update.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.update.mdx @@ -49,7 +49,7 @@ async function updateProduct (id: string, title: string) { "children": [ { "name": "categories", - "type": "`{ id: string }`[]", + "type": "``{ id: string }``[]", "description": "The product categories to associate with the product.", "optional": true, "defaultValue": "", @@ -68,7 +68,7 @@ async function updateProduct (id: string, title: string) { }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The product collection to be associated with the product.", "optional": true, "defaultValue": "", @@ -131,7 +131,7 @@ async function updateProduct (id: string, title: string) { }, { "name": "images", - "type": "`string`[] \\| `{ id?: string ; url: string }`[]", + "type": "`string`[] \\| ``{ id?: string ; url: string }``[]", "description": "The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`.", "optional": true, "defaultValue": "", @@ -223,14 +223,14 @@ async function updateProduct (id: string, title: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": true, "defaultValue": "", "expandable": false, "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "", "optional": true, "defaultValue": "", @@ -239,7 +239,7 @@ async function updateProduct (id: string, title: string) { }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "", "optional": true, "defaultValue": "", @@ -248,7 +248,7 @@ async function updateProduct (id: string, title: string) { }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "", "optional": true, "defaultValue": "", @@ -257,7 +257,7 @@ async function updateProduct (id: string, title: string) { }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "", "optional": true, "defaultValue": "", @@ -351,7 +351,7 @@ async function updateProduct (id: string, title: string) { }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The product type to be associated with the product.", "optional": true, "defaultValue": "", @@ -398,7 +398,7 @@ async function updateProduct (id: string, title: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -425,7 +425,7 @@ async function updateProduct (id: string, title: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -465,20 +465,20 @@ async function updateProduct (id: string, title: string) { "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](../../interfaces/ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -501,8 +501,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -519,7 +519,7 @@ async function updateProduct (id: string, title: string) { }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -528,8 +528,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -537,8 +537,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -546,8 +546,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -565,10 +565,10 @@ async function updateProduct (id: string, title: string) { { "name": "images", "type": "[ProductImageDTO](../../interfaces/ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -582,8 +582,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -591,8 +591,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -601,7 +601,7 @@ async function updateProduct (id: string, title: string) { { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -609,8 +609,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -619,16 +619,16 @@ async function updateProduct (id: string, title: string) { { "name": "options", "type": "[ProductOptionDTO](../../interfaces/ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -637,7 +637,7 @@ async function updateProduct (id: string, title: string) { { "name": "status", "type": "[ProductStatus](../../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -645,8 +645,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -655,16 +655,16 @@ async function updateProduct (id: string, title: string) { { "name": "tags", "type": "[ProductTagDTO](../../interfaces/ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -682,10 +682,10 @@ async function updateProduct (id: string, title: string) { { "name": "type", "type": "[ProductTypeDTO](../../interfaces/ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -700,16 +700,16 @@ async function updateProduct (id: string, title: string) { { "name": "variants", "type": "[ProductVariantDTO](../../interfaces/ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -717,8 +717,8 @@ async function updateProduct (id: string, title: string) { }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCategory.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCategory.mdx index 97400e3f35..d5da7a5647 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCategory.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCategory.mdx @@ -100,8 +100,8 @@ async function updateCategory (id: string, name: string) { }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", - "description": "The ID of the parent product category, if it has any. It may also be `null`.", + "type": "`null` \\| `string`", + "description": "The ID of the parent product category, if it has any.", "optional": true, "defaultValue": "", "expandable": false, @@ -129,7 +129,7 @@ async function updateCategory (id: string, name: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -156,7 +156,7 @@ async function updateCategory (id: string, name: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -189,18 +189,18 @@ async function updateCategory (id: string, name: string) { { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -269,10 +269,10 @@ async function updateCategory (id: string, name: string) { { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -361,18 +361,18 @@ async function updateCategory (id: string, name: string) { { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "category_children", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -441,10 +441,10 @@ async function updateCategory (id: string, name: string) { { "name": "parent_category", "type": "[ProductCategoryDTO](../../interfaces/ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCollections.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCollections.mdx index 89c8bbdf72..a7cab606c5 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCollections.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateCollections.mdx @@ -114,7 +114,7 @@ async function updateCollection (id: string, title: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -141,7 +141,7 @@ async function updateCollection (id: string, title: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -208,7 +208,7 @@ async function updateCollection (id: string, title: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -218,10 +218,10 @@ async function updateCollection (id: string, title: string) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateOptions.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateOptions.mdx index 3705c7d9fb..d458794a76 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateOptions.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateOptions.mdx @@ -87,7 +87,7 @@ async function updateProductOption (id: string, title: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -114,7 +114,7 @@ async function updateProductOption (id: string, title: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -172,7 +172,7 @@ async function updateProductOption (id: string, title: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -182,10 +182,10 @@ async function updateProductOption (id: string, title: string) { { "name": "product", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -200,10 +200,10 @@ async function updateProductOption (id: string, title: string) { { "name": "values", "type": "[ProductOptionValueDTO](../../interfaces/ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTags.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTags.mdx index 3dd604c25a..6190123721 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTags.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTags.mdx @@ -78,7 +78,7 @@ async function updateProductTag (id: string, value: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -105,7 +105,7 @@ async function updateProductTag (id: string, value: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -154,7 +154,7 @@ async function updateProductTag (id: string, value: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -164,10 +164,10 @@ async function updateProductTag (id: string, value: string) { { "name": "products", "type": "[ProductDTO](../../interfaces/ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTypes.mdx b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTypes.mdx index 246d83d702..cad57a7b42 100644 --- a/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTypes.mdx +++ b/www/apps/docs/content/references/product/IProductModuleService/methods/IProductModuleService.updateTypes.mdx @@ -87,7 +87,7 @@ async function updateProductType (id: string, value: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -114,7 +114,7 @@ async function updateProductType (id: string, value: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -172,7 +172,7 @@ async function updateProductType (id: string, value: string) { }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/SharedArrayBuffer/methods/SharedArrayBuffer.slice.mdx b/www/apps/docs/content/references/product/SharedArrayBuffer/methods/SharedArrayBuffer.slice.mdx index 56b4a76aa5..5861785630 100644 --- a/www/apps/docs/content/references/product/SharedArrayBuffer/methods/SharedArrayBuffer.slice.mdx +++ b/www/apps/docs/content/references/product/SharedArrayBuffer/methods/SharedArrayBuffer.slice.mdx @@ -67,7 +67,7 @@ Returns a section of an SharedArrayBuffer. }, { "name": "[toStringTag]", - "type": "``\"SharedArrayBuffer\"``", + "type": "`\"SharedArrayBuffer\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/interfaces/Buffer.mdx b/www/apps/docs/content/references/product/interfaces/Buffer.mdx index c020d37297..6012f3334f 100644 --- a/www/apps/docs/content/references/product/interfaces/Buffer.mdx +++ b/www/apps/docs/content/references/product/interfaces/Buffer.mdx @@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"Uint8Array\"``", + "type": "`\"Uint8Array\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx b/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx index 88111c469b..9e8cf99fb4 100644 --- a/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx +++ b/www/apps/docs/content/references/product/interfaces/BufferConstructor.mdx @@ -174,7 +174,7 @@ Copies the passed {buffer} data onto a new {Buffer} instance }, { "name": "[toStringTag]", - "type": "``\"Uint8Array\"``", + "type": "`\"Uint8Array\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/interfaces/Context.mdx b/www/apps/docs/content/references/product/interfaces/Context.mdx index f0aee3690b..23c2ef50e6 100644 --- a/www/apps/docs/content/references/product/interfaces/Context.mdx +++ b/www/apps/docs/content/references/product/interfaces/Context.mdx @@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Context -The interface tag is used to ensure that the type is documented similar to interfaces. - A shared context object that is used to share resources between the application and the module. ## Type parameters @@ -30,7 +28,7 @@ A shared context object that is used to share resources between the application { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -57,7 +55,7 @@ A shared context object that is used to share resources between the application { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/CreateProductCategoryDTO.mdx b/www/apps/docs/content/references/product/interfaces/CreateProductCategoryDTO.mdx index b0e85c42d4..e95befd27c 100644 --- a/www/apps/docs/content/references/product/interfaces/CreateProductCategoryDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/CreateProductCategoryDTO.mdx @@ -58,8 +58,8 @@ A product category to create. }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", - "description": "The ID of the parent product category, if it has any. It may also be `null`.", + "type": "`null` \\| `string`", + "description": "The ID of the parent product category, if it has any.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/CreateProductCollectionDTO.mdx b/www/apps/docs/content/references/product/interfaces/CreateProductCollectionDTO.mdx index 376ffde84f..7eada3f4a3 100644 --- a/www/apps/docs/content/references/product/interfaces/CreateProductCollectionDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/CreateProductCollectionDTO.mdx @@ -32,7 +32,7 @@ A product collection to create. { "name": "product_ids", "type": "`string`[]", - "description": "", + "description": "The products to associate with the collection.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/CreateProductDTO.mdx b/www/apps/docs/content/references/product/interfaces/CreateProductDTO.mdx index 02fe2bcbca..2c99a99dfa 100644 --- a/www/apps/docs/content/references/product/interfaces/CreateProductDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/CreateProductDTO.mdx @@ -13,7 +13,7 @@ A product to create. `", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -50,27 +50,27 @@ A product collection's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -101,7 +101,7 @@ A product collection's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -111,10 +111,10 @@ A product collection's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -148,8 +148,8 @@ A product collection's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -166,7 +166,7 @@ A product collection's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -175,8 +175,8 @@ A product collection's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -184,8 +184,8 @@ A product collection's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -193,8 +193,8 @@ A product collection's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -212,10 +212,10 @@ A product collection's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -237,7 +237,7 @@ A product collection's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -266,8 +266,8 @@ A product collection's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -275,8 +275,8 @@ A product collection's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -285,7 +285,7 @@ A product collection's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -293,8 +293,8 @@ A product collection's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -303,10 +303,10 @@ A product collection's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -328,7 +328,7 @@ A product collection's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -338,10 +338,10 @@ A product collection's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -356,18 +356,18 @@ A product collection's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -376,14 +376,14 @@ A product collection's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "", "optional": true, "defaultValue": "", @@ -392,7 +392,7 @@ A product collection's data. }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "", "optional": true, "defaultValue": "", @@ -401,7 +401,7 @@ A product collection's data. }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "", "optional": true, "defaultValue": "", @@ -410,7 +410,7 @@ A product collection's data. }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "", "optional": true, "defaultValue": "", @@ -421,8 +421,8 @@ A product collection's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -431,10 +431,10 @@ A product collection's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -447,7 +447,7 @@ A product collection's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -457,10 +457,10 @@ A product collection's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -476,8 +476,8 @@ A product collection's data. }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -495,10 +495,10 @@ A product collection's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -520,7 +520,7 @@ A product collection's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -550,10 +550,10 @@ A product collection's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -566,8 +566,8 @@ A product collection's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -593,8 +593,8 @@ A product collection's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -602,8 +602,8 @@ A product collection's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -611,8 +611,8 @@ A product collection's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -638,8 +638,8 @@ A product collection's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -656,8 +656,8 @@ A product collection's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -665,7 +665,7 @@ A product collection's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -674,8 +674,8 @@ A product collection's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -684,16 +684,16 @@ A product collection's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -702,10 +702,10 @@ A product collection's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -719,8 +719,8 @@ A product collection's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -737,8 +737,8 @@ A product collection's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -755,8 +755,8 @@ A product collection's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -764,8 +764,8 @@ A product collection's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -773,8 +773,8 @@ A product collection's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -784,8 +784,8 @@ A product collection's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -793,8 +793,8 @@ A product collection's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/ProductDTO.mdx b/www/apps/docs/content/references/product/interfaces/ProductDTO.mdx index 451105ec67..761e575e7e 100644 --- a/www/apps/docs/content/references/product/interfaces/ProductDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/ProductDTO.mdx @@ -13,20 +13,20 @@ A product's data. `", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -67,27 +67,27 @@ A product's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -110,8 +110,8 @@ A product's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -128,7 +128,7 @@ A product's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -137,8 +137,8 @@ A product's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -146,8 +146,8 @@ A product's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -155,8 +155,8 @@ A product's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -174,10 +174,10 @@ A product's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -191,8 +191,8 @@ A product's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -200,8 +200,8 @@ A product's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -210,7 +210,7 @@ A product's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -218,8 +218,8 @@ A product's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -228,16 +228,16 @@ A product's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -246,7 +246,7 @@ A product's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -254,8 +254,8 @@ A product's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -264,16 +264,16 @@ A product's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -291,10 +291,10 @@ A product's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -309,16 +309,16 @@ A product's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -326,8 +326,8 @@ A product's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -366,8 +366,8 @@ A product's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -384,7 +384,7 @@ A product's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -393,8 +393,8 @@ A product's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -402,8 +402,8 @@ A product's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -411,8 +411,8 @@ A product's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -430,10 +430,10 @@ A product's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -455,7 +455,7 @@ A product's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -484,8 +484,8 @@ A product's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -493,8 +493,8 @@ A product's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -503,7 +503,7 @@ A product's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -511,8 +511,8 @@ A product's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -521,10 +521,10 @@ A product's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -546,7 +546,7 @@ A product's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -556,27 +556,27 @@ A product's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -599,8 +599,8 @@ A product's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -617,7 +617,7 @@ A product's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -626,8 +626,8 @@ A product's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -635,8 +635,8 @@ A product's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -644,8 +644,8 @@ A product's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -663,10 +663,10 @@ A product's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -680,8 +680,8 @@ A product's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -689,8 +689,8 @@ A product's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -699,7 +699,7 @@ A product's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -707,8 +707,8 @@ A product's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -717,16 +717,16 @@ A product's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -735,7 +735,7 @@ A product's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -743,8 +743,8 @@ A product's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -753,16 +753,16 @@ A product's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -780,10 +780,10 @@ A product's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -798,16 +798,16 @@ A product's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -815,8 +815,8 @@ A product's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -836,10 +836,10 @@ A product's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -861,7 +861,7 @@ A product's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -871,10 +871,10 @@ A product's data. { "name": "option", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -889,10 +889,10 @@ A product's data. { "name": "variant", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] @@ -901,8 +901,8 @@ A product's data. }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -911,14 +911,14 @@ A product's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "", "optional": true, "defaultValue": "", @@ -927,7 +927,7 @@ A product's data. }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "", "optional": true, "defaultValue": "", @@ -936,7 +936,7 @@ A product's data. }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "", "optional": true, "defaultValue": "", @@ -945,7 +945,7 @@ A product's data. }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "", "optional": true, "defaultValue": "", @@ -956,8 +956,8 @@ A product's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -966,10 +966,10 @@ A product's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -982,7 +982,7 @@ A product's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -992,27 +992,27 @@ A product's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1035,8 +1035,8 @@ A product's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1053,7 +1053,7 @@ A product's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -1062,8 +1062,8 @@ A product's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -1071,8 +1071,8 @@ A product's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1080,8 +1080,8 @@ A product's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1099,10 +1099,10 @@ A product's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1116,8 +1116,8 @@ A product's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1125,8 +1125,8 @@ A product's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1135,7 +1135,7 @@ A product's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -1143,8 +1143,8 @@ A product's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1153,16 +1153,16 @@ A product's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1171,7 +1171,7 @@ A product's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -1179,8 +1179,8 @@ A product's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1189,16 +1189,16 @@ A product's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -1216,10 +1216,10 @@ A product's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1234,16 +1234,16 @@ A product's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1251,8 +1251,8 @@ A product's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1273,8 +1273,8 @@ A product's data. }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -1292,10 +1292,10 @@ A product's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -1317,7 +1317,7 @@ A product's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -1347,10 +1347,10 @@ A product's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -1363,8 +1363,8 @@ A product's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1390,8 +1390,8 @@ A product's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1399,8 +1399,8 @@ A product's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1408,8 +1408,8 @@ A product's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1435,8 +1435,8 @@ A product's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1453,8 +1453,8 @@ A product's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1462,7 +1462,7 @@ A product's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -1471,8 +1471,8 @@ A product's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1481,10 +1481,10 @@ A product's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -1506,7 +1506,7 @@ A product's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -1516,10 +1516,10 @@ A product's data. { "name": "option", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1534,18 +1534,18 @@ A product's data. { "name": "variant", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1554,27 +1554,27 @@ A product's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1597,8 +1597,8 @@ A product's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1615,7 +1615,7 @@ A product's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -1624,8 +1624,8 @@ A product's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -1633,8 +1633,8 @@ A product's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1642,8 +1642,8 @@ A product's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1661,10 +1661,10 @@ A product's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1678,8 +1678,8 @@ A product's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1687,8 +1687,8 @@ A product's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1697,7 +1697,7 @@ A product's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -1705,8 +1705,8 @@ A product's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1715,16 +1715,16 @@ A product's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1733,7 +1733,7 @@ A product's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -1741,8 +1741,8 @@ A product's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1751,16 +1751,16 @@ A product's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -1778,10 +1778,10 @@ A product's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1796,16 +1796,16 @@ A product's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1813,8 +1813,8 @@ A product's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1833,8 +1833,8 @@ A product's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1851,8 +1851,8 @@ A product's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1869,8 +1869,8 @@ A product's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1878,8 +1878,8 @@ A product's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1887,8 +1887,8 @@ A product's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1898,8 +1898,8 @@ A product's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1907,8 +1907,8 @@ A product's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/ProductImageDTO.mdx b/www/apps/docs/content/references/product/interfaces/ProductImageDTO.mdx index ea0895c43c..330395f18d 100644 --- a/www/apps/docs/content/references/product/interfaces/ProductImageDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/ProductImageDTO.mdx @@ -31,7 +31,7 @@ The product image's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/interfaces/ProductOptionDTO.mdx b/www/apps/docs/content/references/product/interfaces/ProductOptionDTO.mdx index 61b4e29b1f..f699fc7450 100644 --- a/www/apps/docs/content/references/product/interfaces/ProductOptionDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/ProductOptionDTO.mdx @@ -31,7 +31,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -41,27 +41,27 @@ A product option's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -92,7 +92,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -102,10 +102,10 @@ A product option's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -139,8 +139,8 @@ A product option's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -157,7 +157,7 @@ A product option's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -166,8 +166,8 @@ A product option's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,8 +175,8 @@ A product option's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -184,8 +184,8 @@ A product option's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -203,10 +203,10 @@ A product option's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -228,7 +228,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -257,8 +257,8 @@ A product option's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -266,8 +266,8 @@ A product option's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -276,7 +276,7 @@ A product option's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -284,8 +284,8 @@ A product option's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -294,10 +294,10 @@ A product option's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -319,7 +319,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -329,10 +329,10 @@ A product option's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -347,18 +347,18 @@ A product option's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -367,14 +367,14 @@ A product option's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "", "optional": true, "defaultValue": "", @@ -383,7 +383,7 @@ A product option's data. }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "", "optional": true, "defaultValue": "", @@ -392,7 +392,7 @@ A product option's data. }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "", "optional": true, "defaultValue": "", @@ -401,7 +401,7 @@ A product option's data. }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "", "optional": true, "defaultValue": "", @@ -412,8 +412,8 @@ A product option's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -422,10 +422,10 @@ A product option's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -438,7 +438,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -448,10 +448,10 @@ A product option's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -467,8 +467,8 @@ A product option's data. }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -486,10 +486,10 @@ A product option's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -511,7 +511,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -541,10 +541,10 @@ A product option's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -557,8 +557,8 @@ A product option's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -584,8 +584,8 @@ A product option's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -593,8 +593,8 @@ A product option's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -602,8 +602,8 @@ A product option's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -629,8 +629,8 @@ A product option's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -647,8 +647,8 @@ A product option's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -656,7 +656,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -665,8 +665,8 @@ A product option's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -675,16 +675,16 @@ A product option's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -693,10 +693,10 @@ A product option's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -710,8 +710,8 @@ A product option's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -728,8 +728,8 @@ A product option's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -746,8 +746,8 @@ A product option's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -755,8 +755,8 @@ A product option's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -764,8 +764,8 @@ A product option's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -775,8 +775,8 @@ A product option's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -784,8 +784,8 @@ A product option's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -805,10 +805,10 @@ A product option's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -830,7 +830,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -840,10 +840,10 @@ A product option's data. { "name": "option", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -865,7 +865,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -875,10 +875,10 @@ A product option's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -893,10 +893,10 @@ A product option's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] @@ -913,10 +913,10 @@ A product option's data. { "name": "variant", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -929,8 +929,8 @@ A product option's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -956,8 +956,8 @@ A product option's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -965,8 +965,8 @@ A product option's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -974,8 +974,8 @@ A product option's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1001,8 +1001,8 @@ A product option's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1019,8 +1019,8 @@ A product option's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1028,7 +1028,7 @@ A product option's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -1037,8 +1037,8 @@ A product option's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1047,16 +1047,16 @@ A product option's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1065,10 +1065,10 @@ A product option's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1082,8 +1082,8 @@ A product option's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1100,8 +1100,8 @@ A product option's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1118,8 +1118,8 @@ A product option's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1127,8 +1127,8 @@ A product option's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1136,8 +1136,8 @@ A product option's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/ProductOptionValueDTO.mdx b/www/apps/docs/content/references/product/interfaces/ProductOptionValueDTO.mdx index 86d1ca5809..425bf79552 100644 --- a/www/apps/docs/content/references/product/interfaces/ProductOptionValueDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/ProductOptionValueDTO.mdx @@ -31,7 +31,7 @@ The product option value's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -41,10 +41,10 @@ The product option value's data. { "name": "option", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -66,7 +66,7 @@ The product option value's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -76,27 +76,27 @@ The product option value's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -119,8 +119,8 @@ The product option value's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -137,7 +137,7 @@ The product option value's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -146,8 +146,8 @@ The product option value's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -155,8 +155,8 @@ The product option value's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -164,8 +164,8 @@ The product option value's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -183,10 +183,10 @@ The product option value's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -200,8 +200,8 @@ The product option value's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -209,8 +209,8 @@ The product option value's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -219,7 +219,7 @@ The product option value's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -227,8 +227,8 @@ The product option value's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -237,16 +237,16 @@ The product option value's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -255,7 +255,7 @@ The product option value's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -263,8 +263,8 @@ The product option value's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -273,16 +273,16 @@ The product option value's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -300,10 +300,10 @@ The product option value's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -318,16 +318,16 @@ The product option value's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -335,8 +335,8 @@ The product option value's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -356,10 +356,10 @@ The product option value's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -381,7 +381,7 @@ The product option value's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -391,10 +391,10 @@ The product option value's data. { "name": "option", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -409,10 +409,10 @@ The product option value's data. { "name": "variant", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] @@ -431,10 +431,10 @@ The product option value's data. { "name": "variant", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -447,8 +447,8 @@ The product option value's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -474,8 +474,8 @@ The product option value's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -483,8 +483,8 @@ The product option value's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -492,8 +492,8 @@ The product option value's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -519,8 +519,8 @@ The product option value's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -537,8 +537,8 @@ The product option value's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -546,7 +546,7 @@ The product option value's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -555,8 +555,8 @@ The product option value's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -565,10 +565,10 @@ The product option value's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -590,7 +590,7 @@ The product option value's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -600,10 +600,10 @@ The product option value's data. { "name": "option", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -618,18 +618,18 @@ The product option value's data. { "name": "variant", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -638,27 +638,27 @@ The product option value's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -681,8 +681,8 @@ The product option value's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -699,7 +699,7 @@ The product option value's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -708,8 +708,8 @@ The product option value's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -717,8 +717,8 @@ The product option value's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -726,8 +726,8 @@ The product option value's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -745,10 +745,10 @@ The product option value's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -762,8 +762,8 @@ The product option value's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -771,8 +771,8 @@ The product option value's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -781,7 +781,7 @@ The product option value's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -789,8 +789,8 @@ The product option value's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -799,16 +799,16 @@ The product option value's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -817,7 +817,7 @@ The product option value's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -825,8 +825,8 @@ The product option value's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -835,16 +835,16 @@ The product option value's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -862,10 +862,10 @@ The product option value's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -880,16 +880,16 @@ The product option value's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -897,8 +897,8 @@ The product option value's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -917,8 +917,8 @@ The product option value's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -935,8 +935,8 @@ The product option value's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -953,8 +953,8 @@ The product option value's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -962,8 +962,8 @@ The product option value's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -971,8 +971,8 @@ The product option value's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/ProductTagDTO.mdx b/www/apps/docs/content/references/product/interfaces/ProductTagDTO.mdx index 61f8a82a08..7a861aa6e5 100644 --- a/www/apps/docs/content/references/product/interfaces/ProductTagDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/ProductTagDTO.mdx @@ -22,7 +22,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -32,27 +32,27 @@ A product tag's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -83,7 +83,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -93,10 +93,10 @@ A product tag's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -130,8 +130,8 @@ A product tag's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -148,7 +148,7 @@ A product tag's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -157,8 +157,8 @@ A product tag's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -166,8 +166,8 @@ A product tag's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,8 +175,8 @@ A product tag's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -194,10 +194,10 @@ A product tag's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -219,7 +219,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -248,8 +248,8 @@ A product tag's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -257,8 +257,8 @@ A product tag's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -267,7 +267,7 @@ A product tag's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -275,8 +275,8 @@ A product tag's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -285,10 +285,10 @@ A product tag's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -310,7 +310,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -320,10 +320,10 @@ A product tag's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -338,18 +338,18 @@ A product tag's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -358,14 +358,14 @@ A product tag's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "", "optional": true, "defaultValue": "", @@ -374,7 +374,7 @@ A product tag's data. }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "", "optional": true, "defaultValue": "", @@ -383,7 +383,7 @@ A product tag's data. }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "", "optional": true, "defaultValue": "", @@ -392,7 +392,7 @@ A product tag's data. }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "", "optional": true, "defaultValue": "", @@ -403,8 +403,8 @@ A product tag's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -413,10 +413,10 @@ A product tag's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -429,7 +429,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -439,10 +439,10 @@ A product tag's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -458,8 +458,8 @@ A product tag's data. }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -477,10 +477,10 @@ A product tag's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -502,7 +502,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -532,10 +532,10 @@ A product tag's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -548,8 +548,8 @@ A product tag's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -575,8 +575,8 @@ A product tag's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -584,8 +584,8 @@ A product tag's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -593,8 +593,8 @@ A product tag's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -620,8 +620,8 @@ A product tag's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -638,8 +638,8 @@ A product tag's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -647,7 +647,7 @@ A product tag's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -656,8 +656,8 @@ A product tag's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -666,16 +666,16 @@ A product tag's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -684,10 +684,10 @@ A product tag's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -701,8 +701,8 @@ A product tag's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -719,8 +719,8 @@ A product tag's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -737,8 +737,8 @@ A product tag's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -746,8 +746,8 @@ A product tag's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -755,8 +755,8 @@ A product tag's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -766,8 +766,8 @@ A product tag's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -775,8 +775,8 @@ A product tag's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/ProductTypeDTO.mdx b/www/apps/docs/content/references/product/interfaces/ProductTypeDTO.mdx index fc6b109083..f4f7f56c9e 100644 --- a/www/apps/docs/content/references/product/interfaces/ProductTypeDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/ProductTypeDTO.mdx @@ -31,7 +31,7 @@ A product type's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/interfaces/ProductVariantDTO.mdx b/www/apps/docs/content/references/product/interfaces/ProductVariantDTO.mdx index fa9bd6ba7b..49c350be6a 100644 --- a/www/apps/docs/content/references/product/interfaces/ProductVariantDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/ProductVariantDTO.mdx @@ -22,8 +22,8 @@ A product variant's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -49,8 +49,8 @@ A product variant's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -58,8 +58,8 @@ A product variant's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -67,8 +67,8 @@ A product variant's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -94,8 +94,8 @@ A product variant's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -112,8 +112,8 @@ A product variant's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -121,7 +121,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -130,8 +130,8 @@ A product variant's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -140,10 +140,10 @@ A product variant's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -165,7 +165,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -175,10 +175,10 @@ A product variant's data. { "name": "option", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -200,7 +200,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -210,10 +210,10 @@ A product variant's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -228,10 +228,10 @@ A product variant's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] @@ -248,10 +248,10 @@ A product variant's data. { "name": "variant", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -264,8 +264,8 @@ A product variant's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -291,8 +291,8 @@ A product variant's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -300,8 +300,8 @@ A product variant's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -309,8 +309,8 @@ A product variant's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -336,8 +336,8 @@ A product variant's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -354,8 +354,8 @@ A product variant's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -363,7 +363,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -372,8 +372,8 @@ A product variant's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -382,16 +382,16 @@ A product variant's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -400,10 +400,10 @@ A product variant's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -417,8 +417,8 @@ A product variant's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -435,8 +435,8 @@ A product variant's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -453,8 +453,8 @@ A product variant's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -462,8 +462,8 @@ A product variant's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -471,8 +471,8 @@ A product variant's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -484,8 +484,8 @@ A product variant's data. }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -494,27 +494,27 @@ A product variant's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "categories", - "type": "``null`` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "type": "`null` \\| [ProductCategoryDTO](ProductCategoryDTO.mdx)[]", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -545,7 +545,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -555,10 +555,10 @@ A product variant's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -592,8 +592,8 @@ A product variant's data. }, { "name": "description", - "type": "``null`` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -610,7 +610,7 @@ A product variant's data. }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.", "optional": true, "defaultValue": "", @@ -619,8 +619,8 @@ A product variant's data. }, { "name": "handle", - "type": "``null`` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -628,8 +628,8 @@ A product variant's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -637,8 +637,8 @@ A product variant's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -656,10 +656,10 @@ A product variant's data. { "name": "images", "type": "[ProductImageDTO](ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -681,7 +681,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -710,8 +710,8 @@ A product variant's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -719,8 +719,8 @@ A product variant's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -729,7 +729,7 @@ A product variant's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -737,8 +737,8 @@ A product variant's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -747,10 +747,10 @@ A product variant's data. { "name": "options", "type": "[ProductOptionDTO](ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -772,7 +772,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -782,10 +782,10 @@ A product variant's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -800,18 +800,18 @@ A product variant's data. { "name": "values", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -820,14 +820,14 @@ A product variant's data. { "name": "status", "type": "[ProductStatus](../enums/ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "DRAFT", - "type": "``\"draft\"``", + "type": "`\"draft\"`", "description": "", "optional": true, "defaultValue": "", @@ -836,7 +836,7 @@ A product variant's data. }, { "name": "PROPOSED", - "type": "``\"proposed\"``", + "type": "`\"proposed\"`", "description": "", "optional": true, "defaultValue": "", @@ -845,7 +845,7 @@ A product variant's data. }, { "name": "PUBLISHED", - "type": "``\"published\"``", + "type": "`\"published\"`", "description": "", "optional": true, "defaultValue": "", @@ -854,7 +854,7 @@ A product variant's data. }, { "name": "REJECTED", - "type": "``\"rejected\"``", + "type": "`\"rejected\"`", "description": "", "optional": true, "defaultValue": "", @@ -865,8 +865,8 @@ A product variant's data. }, { "name": "subtitle", - "type": "``null`` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -875,10 +875,10 @@ A product variant's data. { "name": "tags", "type": "[ProductTagDTO](ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -891,7 +891,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -901,10 +901,10 @@ A product variant's data. { "name": "products", "type": "[ProductDTO](ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -920,8 +920,8 @@ A product variant's data. }, { "name": "thumbnail", - "type": "``null`` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -939,10 +939,10 @@ A product variant's data. { "name": "type", "type": "[ProductTypeDTO](ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "deleted_at", @@ -964,7 +964,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -994,10 +994,10 @@ A product variant's data. { "name": "variants", "type": "[ProductVariantDTO](ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "allow_backorder", @@ -1010,8 +1010,8 @@ A product variant's data. }, { "name": "barcode", - "type": "``null`` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1037,8 +1037,8 @@ A product variant's data. }, { "name": "ean", - "type": "``null`` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1046,8 +1046,8 @@ A product variant's data. }, { "name": "height", - "type": "``null`` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1055,8 +1055,8 @@ A product variant's data. }, { "name": "hs_code", - "type": "``null`` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1082,8 +1082,8 @@ A product variant's data. }, { "name": "length", - "type": "``null`` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1100,8 +1100,8 @@ A product variant's data. }, { "name": "material", - "type": "``null`` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1109,7 +1109,7 @@ A product variant's data. }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", @@ -1118,8 +1118,8 @@ A product variant's data. }, { "name": "mid_code", - "type": "``null`` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1128,16 +1128,16 @@ A product variant's data. { "name": "options", "type": "[ProductOptionValueDTO](ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", - "type": "``null`` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1146,10 +1146,10 @@ A product variant's data. { "name": "product", "type": "[ProductDTO](ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -1163,8 +1163,8 @@ A product variant's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1181,8 +1181,8 @@ A product variant's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1199,8 +1199,8 @@ A product variant's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1208,8 +1208,8 @@ A product variant's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1217,8 +1217,8 @@ A product variant's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1228,8 +1228,8 @@ A product variant's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1237,8 +1237,8 @@ A product variant's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1257,8 +1257,8 @@ A product variant's data. }, { "name": "sku", - "type": "``null`` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1275,8 +1275,8 @@ A product variant's data. }, { "name": "upc", - "type": "``null`` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "type": "`null` \\| `string`", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1293,8 +1293,8 @@ A product variant's data. }, { "name": "variant_rank", - "type": "``null`` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -1302,8 +1302,8 @@ A product variant's data. }, { "name": "weight", - "type": "``null`` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -1311,8 +1311,8 @@ A product variant's data. }, { "name": "width", - "type": "``null`` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "type": "`null` \\| `number`", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/SharedArrayBuffer.mdx b/www/apps/docs/content/references/product/interfaces/SharedArrayBuffer.mdx index 44fb4121d4..8bb8dcd772 100644 --- a/www/apps/docs/content/references/product/interfaces/SharedArrayBuffer.mdx +++ b/www/apps/docs/content/references/product/interfaces/SharedArrayBuffer.mdx @@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"SharedArrayBuffer\"``", + "type": "`\"SharedArrayBuffer\"`", "description": "", "optional": false, "defaultValue": "", @@ -60,7 +60,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"SharedArrayBuffer\"``", + "type": "`\"SharedArrayBuffer\"`", "description": "", "optional": false, "defaultValue": "", @@ -80,7 +80,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"SharedArrayBuffer\"``", + "type": "`\"SharedArrayBuffer\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/interfaces/SharedArrayBufferConstructor.mdx b/www/apps/docs/content/references/product/interfaces/SharedArrayBufferConstructor.mdx index be91cfe1b1..84b5c727db 100644 --- a/www/apps/docs/content/references/product/interfaces/SharedArrayBufferConstructor.mdx +++ b/www/apps/docs/content/references/product/interfaces/SharedArrayBufferConstructor.mdx @@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"SharedArrayBuffer\"``", + "type": "`\"SharedArrayBuffer\"`", "description": "", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"SharedArrayBuffer\"``", + "type": "`\"SharedArrayBuffer\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/product/interfaces/UpdateProductCategoryDTO.mdx b/www/apps/docs/content/references/product/interfaces/UpdateProductCategoryDTO.mdx index fb4f73ca6e..3ebed98b3f 100644 --- a/www/apps/docs/content/references/product/interfaces/UpdateProductCategoryDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/UpdateProductCategoryDTO.mdx @@ -58,8 +58,8 @@ The data to update in a product category. }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", - "description": "The ID of the parent product category, if it has any. It may also be `null`.", + "type": "`null` \\| `string`", + "description": "The ID of the parent product category, if it has any.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/product/interfaces/UpdateProductDTO.mdx b/www/apps/docs/content/references/product/interfaces/UpdateProductDTO.mdx index 9019cff691..d409e8265a 100644 --- a/www/apps/docs/content/references/product/interfaces/UpdateProductDTO.mdx +++ b/www/apps/docs/content/references/product/interfaces/UpdateProductDTO.mdx @@ -13,7 +13,7 @@ The data to update in a product. The `id` is used to identify which product to u `: T extends U ? never : T + **Exclude**``: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U diff --git a/www/apps/docs/content/references/product/types/ExpandScalar.mdx b/www/apps/docs/content/references/product/types/ExpandScalar.mdx index 0b61fe923e..434f465713 100644 --- a/www/apps/docs/content/references/product/types/ExpandScalar.mdx +++ b/www/apps/docs/content/references/product/types/ExpandScalar.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ExpandScalar - **ExpandScalar**``: `null` \| T extends string ? string \| RegExp : T extends Date ? Date \| string : T + **ExpandScalar**``: `null` \| `T` extends `string` ? `string` \| `RegExp` : `T` extends `Date` ? `Date` \| `string` : `T` ### Type parameters diff --git a/www/apps/docs/content/references/product/types/FilterQuery.mdx b/www/apps/docs/content/references/product/types/FilterQuery.mdx index e5cd3777c5..6a69bf3dd5 100644 --- a/www/apps/docs/content/references/product/types/FilterQuery.mdx +++ b/www/apps/docs/content/references/product/types/FilterQuery.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterQuery - **FilterQuery**``: Prev extends never ? never : { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]> : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery<Partial<V>, PrevLimit[Prev]> : never : never : never } + **FilterQuery**``: `Prev` extends `never` ? `never` : { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]> : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery<Partial<V>, PrevLimit[Prev]> : never : never : never } ### Type parameters diff --git a/www/apps/docs/content/references/product/types/FilterValue2.mdx b/www/apps/docs/content/references/product/types/FilterValue2.mdx index 0fb31280a2..ea1aff8df0 100644 --- a/www/apps/docs/content/references/product/types/FilterValue2.mdx +++ b/www/apps/docs/content/references/product/types/FilterValue2.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterValue2 - **FilterValue2**``: T \| [ExpandScalar](ExpandScalar.mdx)<T> \| [Primary](Primary.mdx)<T> + **FilterValue2**``: `T` \| [ExpandScalar](ExpandScalar.mdx)<T> \| [Primary](Primary.mdx)<T> ### Type parameters diff --git a/www/apps/docs/content/references/product/types/ModuleJoinerConfig.mdx b/www/apps/docs/content/references/product/types/ModuleJoinerConfig.mdx index 704f6f6b4e..f0d2df2285 100644 --- a/www/apps/docs/content/references/product/types/ModuleJoinerConfig.mdx +++ b/www/apps/docs/content/references/product/types/ModuleJoinerConfig.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerConfig - **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), `"serviceName"` \| `"primaryKeys"` \| `"relationships"` \| `"extends"`> & { databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: `"date"` \| `"time"` \| `"datetime"` \| `"bigint"` \| `"blob"` \| `"uint8array"` \| `"array"` \| `"enumArray"` \| `"enum"` \| `"json"` \| `"integer"` \| `"smallint"` \| `"tinyint"` \| `"mediumint"` \| `"float"` \| `"double"` \| `"boolean"` \| `"decimal"` \| `"string"` \| `"uuid"` \| `"text"` }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string } + **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & ``{ databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: "date" \| "time" \| "datetime" \| bigint \| "blob" \| "uint8array" \| "array" \| "enumArray" \| "enum" \| "json" \| "integer" \| "smallint" \| "tinyint" \| "mediumint" \| "float" \| "double" \| "boolean" \| "decimal" \| "string" \| "uuid" \| "text" }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }`` diff --git a/www/apps/docs/content/references/product/types/ModuleJoinerRelationship.mdx b/www/apps/docs/content/references/product/types/ModuleJoinerRelationship.mdx index aec86d8515..9e8a5aea46 100644 --- a/www/apps/docs/content/references/product/types/ModuleJoinerRelationship.mdx +++ b/www/apps/docs/content/references/product/types/ModuleJoinerRelationship.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerRelationship - **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & { deleteCascade?: boolean ; isInternalService?: boolean } + **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & ``{ deleteCascade?: boolean ; isInternalService?: boolean }`` diff --git a/www/apps/docs/content/references/product/types/PrevLimit.mdx b/www/apps/docs/content/references/product/types/PrevLimit.mdx index 23011ec467..0cb6b27120 100644 --- a/www/apps/docs/content/references/product/types/PrevLimit.mdx +++ b/www/apps/docs/content/references/product/types/PrevLimit.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PrevLimit - **PrevLimit**: [never, `1`, `2`, `3`] + **PrevLimit**: [`never`, `1`, `2`, `3`] diff --git a/www/apps/docs/content/references/product/types/Primary.mdx b/www/apps/docs/content/references/product/types/Primary.mdx index 03b8e12fd5..049cc08435 100644 --- a/www/apps/docs/content/references/product/types/Primary.mdx +++ b/www/apps/docs/content/references/product/types/Primary.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Primary - **Primary**``: T extends { [PrimaryKeyType]?: infer PK } ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : T extends { _id?: infer PK } ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> \| string : T extends { uuid?: infer PK } ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : T extends { id?: infer PK } ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : never + **Primary**``: `T` extends ``{ [PrimaryKeyType]?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `T` extends ``{ _id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> \| `string` : `T` extends ``{ uuid?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `T` extends ``{ id?: infer PK }`` ? [ReadonlyPrimary](ReadonlyPrimary.mdx)<PK> : `never` ### Type parameters diff --git a/www/apps/docs/content/references/product/types/Query.mdx b/www/apps/docs/content/references/product/types/Query.mdx index 3cf90e9638..253c709127 100644 --- a/www/apps/docs/content/references/product/types/Query.mdx +++ b/www/apps/docs/content/references/product/types/Query.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Query - **Query**``: T extends object ? T extends [Scalar](Scalar.mdx) ? never : [FilterQuery](FilterQuery.mdx)<T> : [FilterValue](FilterValue.mdx)<T> + **Query**``: `T` extends `object` ? `T` extends [Scalar](Scalar.mdx) ? `never` : [FilterQuery](FilterQuery.mdx)<T> : [FilterValue](FilterValue.mdx)<T> ### Type parameters diff --git a/www/apps/docs/content/references/product/types/ReadonlyPrimary.mdx b/www/apps/docs/content/references/product/types/ReadonlyPrimary.mdx index 2f4df29cb4..6ff454965e 100644 --- a/www/apps/docs/content/references/product/types/ReadonlyPrimary.mdx +++ b/www/apps/docs/content/references/product/types/ReadonlyPrimary.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ReadonlyPrimary - **ReadonlyPrimary**``: T extends any[] ? [Readonly](Readonly.mdx)<T> : T + **ReadonlyPrimary**``: `T` extends `any`[] ? [Readonly](Readonly.mdx)<T> : `T` ### Type parameters diff --git a/www/apps/docs/content/references/product/types/Scalar.mdx b/www/apps/docs/content/references/product/types/Scalar.mdx index 7f92ca85b4..c6c9d7ff7a 100644 --- a/www/apps/docs/content/references/product/types/Scalar.mdx +++ b/www/apps/docs/content/references/product/types/Scalar.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Scalar - **Scalar**: boolean \| number \| string \| bigint \| symbol \| Date \| RegExp \| [Buffer](../variables/Buffer-1.mdx) \| { toHexString: Method toHexString } + **Scalar**: `boolean` \| `number` \| `string` \| `bigint` \| `symbol` \| `Date` \| `RegExp` \| [Buffer](../variables/Buffer-1.mdx) \| ``{ toHexString: Method toHexString }`` diff --git a/www/apps/docs/content/references/product/types/TypedArray.mdx b/www/apps/docs/content/references/product/types/TypedArray.mdx index 359d8cac0d..6829a04f92 100644 --- a/www/apps/docs/content/references/product/types/TypedArray.mdx +++ b/www/apps/docs/content/references/product/types/TypedArray.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # TypedArray - **TypedArray**: Uint8Array \| Uint8ClampedArray \| Uint16Array \| Uint32Array \| Int8Array \| Int16Array \| Int32Array \| BigUint64Array \| BigInt64Array \| Float32Array \| Float64Array + **TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array` diff --git a/www/apps/docs/content/references/product/types/WithImplicitCoercion.mdx b/www/apps/docs/content/references/product/types/WithImplicitCoercion.mdx index 27bc6eceee..4e4d2ce745 100644 --- a/www/apps/docs/content/references/product/types/WithImplicitCoercion.mdx +++ b/www/apps/docs/content/references/product/types/WithImplicitCoercion.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # WithImplicitCoercion - **WithImplicitCoercion**``: T \| { valueOf: Method valueOf } + **WithImplicitCoercion**``: `T` \| ``{ valueOf: Method valueOf }`` ### Type parameters diff --git a/www/apps/docs/content/references/services/classes/AbstractBatchJobStrategy.mdx b/www/apps/docs/content/references/services/classes/AbstractBatchJobStrategy.mdx index f2c5f29fa5..27d14fdd87 100644 --- a/www/apps/docs/content/references/services/classes/AbstractBatchJobStrategy.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractBatchJobStrategy.mdx @@ -495,7 +495,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx b/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx index 21ac1f8860..df2237129a 100644 --- a/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx @@ -349,7 +349,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx b/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx index 0d48b2c822..f533650379 100644 --- a/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx @@ -696,7 +696,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx b/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx index e005e9a90e..0c0d2d8ad3 100644 --- a/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx +++ b/www/apps/docs/content/references/services/classes/AbstractSearchService.mdx @@ -388,7 +388,7 @@ Used to search for a document in an index }, { "name": "query", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "the search query", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Address.mdx b/www/apps/docs/content/references/services/classes/Address.mdx index d9f99fe5a9..8b7e8b7d03 100644 --- a/www/apps/docs/content/references/services/classes/Address.mdx +++ b/www/apps/docs/content/references/services/classes/Address.mdx @@ -21,7 +21,7 @@ An address is used across the Medusa backend within other schemas and object typ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/AuthService.mdx b/www/apps/docs/content/references/services/classes/AuthService.mdx index 311eb0bbc1..163d75f16d 100644 --- a/www/apps/docs/content/references/services/classes/AuthService.mdx +++ b/www/apps/docs/content/references/services/classes/AuthService.mdx @@ -389,7 +389,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/BatchJob.mdx b/www/apps/docs/content/references/services/classes/BatchJob.mdx index d7177a09cf..c022cb13d9 100644 --- a/www/apps/docs/content/references/services/classes/BatchJob.mdx +++ b/www/apps/docs/content/references/services/classes/BatchJob.mdx @@ -66,7 +66,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "created_by", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique identifier of the user that created the batch job.", "optional": false, "defaultValue": "", @@ -84,7 +84,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -138,7 +138,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat }, { "name": "result", - "type": "`{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] }` & `Record`", + "type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] }`` & `Record`", "description": "The result of the batch job.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/BatchJobService.mdx b/www/apps/docs/content/references/services/classes/BatchJobService.mdx index a54e1a7165..b5d5fafe54 100644 --- a/www/apps/docs/content/references/services/classes/BatchJobService.mdx +++ b/www/apps/docs/content/references/services/classes/BatchJobService.mdx @@ -701,7 +701,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -746,7 +746,7 @@ ___ }, { "name": "data", - "type": "[Partial](../types/Partial.mdx)<[Pick](../types/Pick.mdx)<[BatchJob](BatchJob.mdx), `\"context\"` \\| `\"result\"`>>", + "type": "[Partial](../types/Partial.mdx)<[Pick](../types/Pick.mdx)<[BatchJob](BatchJob.mdx), \"context\" \\| \"result\">>", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Cart.mdx b/www/apps/docs/content/references/services/classes/Cart.mdx index 1e8fe8083f..6301a79165 100644 --- a/www/apps/docs/content/references/services/classes/Cart.mdx +++ b/www/apps/docs/content/references/services/classes/Cart.mdx @@ -84,7 +84,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -165,7 +165,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", @@ -192,7 +192,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "object", - "type": "``\"cart\"``", + "type": "`\"cart\"`", "description": "", "optional": false, "defaultValue": "\"cart\"", @@ -228,7 +228,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "payment_session", - "type": "``null`` \\| [PaymentSession](PaymentSession.mdx)", + "type": "`null` \\| [PaymentSession](PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", @@ -300,7 +300,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", @@ -309,7 +309,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "shipping_address", - "type": "``null`` \\| [Address](Address.mdx)", + "type": "`null` \\| [Address](Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", @@ -336,7 +336,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", @@ -363,7 +363,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/CartService.mdx b/www/apps/docs/content/references/services/classes/CartService.mdx index deaf18223b..e451fb0afc 100644 --- a/www/apps/docs/content/references/services/classes/CartService.mdx +++ b/www/apps/docs/content/references/services/classes/CartService.mdx @@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cartRepository_", - "type": "Repository<[Cart](Cart.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Cart](Cart.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -139,7 +139,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "lineItemRepository_", - "type": "Repository<[LineItem](LineItem.mdx)> & `{ findByReturn: Method findByReturn }`", + "type": "Repository<[LineItem](LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``", "description": "", "optional": false, "defaultValue": "", @@ -872,7 +872,7 @@ set the payment on the cart. }, { "name": "context", - "type": "`Record` & `{ cart_id: string }`", + "type": "`Record` & ``{ cart_id: string }``", "description": "object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling.", "optional": false, "defaultValue": "", @@ -1013,7 +1013,7 @@ ___ ### decorateTotals -`**decorateTotals**(cart, totalsConfig?): Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), `"total"`>>` +`**decorateTotals**(cart, totalsConfig?): Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), "total">>` #### Parameters @@ -1040,12 +1040,12 @@ ___ #### Returns -Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), `"total"`>> +Promise<[WithRequiredProperty](../types/WithRequiredProperty.mdx)<[Cart](Cart.mdx), "total">> ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -2049,12 +2049,12 @@ ___ #### Returns -[FindConfig](../interfaces/FindConfig.mdx)<[Cart](Cart.mdx)> & `{ totalsToSelect: [TotalField](../types/TotalField.mdx)[] }` +[FindConfig](../interfaces/FindConfig.mdx)<[Cart](Cart.mdx)> & ``{ totalsToSelect: [TotalField](../types/TotalField.mdx)[] }`` ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ClaimService.mdx b/www/apps/docs/content/references/services/classes/ClaimService.mdx index 1ddc56435c..7d840fc458 100644 --- a/www/apps/docs/content/references/services/classes/ClaimService.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimService.mdx @@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "lineItemRepository_", - "type": "Repository<[LineItem](LineItem.mdx)> & `{ findByReturn: Method findByReturn }`", + "type": "Repository<[LineItem](LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``", "description": "", "optional": false, "defaultValue": "", @@ -597,7 +597,7 @@ ___ }, { "name": "trackingLinks", - "type": "`{ tracking_number: string }`[]", + "type": "``{ tracking_number: string }``[]", "description": "", "optional": false, "defaultValue": "[]", @@ -840,7 +840,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ClaimTag.mdx b/www/apps/docs/content/references/services/classes/ClaimTag.mdx index 6343845cec..ebb3a3d651 100644 --- a/www/apps/docs/content/references/services/classes/ClaimTag.mdx +++ b/www/apps/docs/content/references/services/classes/ClaimTag.mdx @@ -30,7 +30,7 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Country.mdx b/www/apps/docs/content/references/services/classes/Country.mdx index 2da278f834..11d711d28e 100644 --- a/www/apps/docs/content/references/services/classes/Country.mdx +++ b/www/apps/docs/content/references/services/classes/Country.mdx @@ -84,7 +84,7 @@ Country details }, { "name": "region_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/CurrencyService.mdx b/www/apps/docs/content/references/services/classes/CurrencyService.mdx index a284683372..dcfbb383f1 100644 --- a/www/apps/docs/content/references/services/classes/CurrencyService.mdx +++ b/www/apps/docs/content/references/services/classes/CurrencyService.mdx @@ -319,7 +319,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx b/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx index 2eaa1e5856..4c3003f377 100644 --- a/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx +++ b/www/apps/docs/content/references/services/classes/CustomShippingOption.mdx @@ -48,7 +48,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx b/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx index 356e533ad3..6cda8f294c 100644 --- a/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx +++ b/www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx @@ -350,7 +350,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Customer.mdx b/www/apps/docs/content/references/services/classes/Customer.mdx index f4198febc0..9db4b0174e 100644 --- a/www/apps/docs/content/references/services/classes/Customer.mdx +++ b/www/apps/docs/content/references/services/classes/Customer.mdx @@ -30,7 +30,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "billing_address_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", @@ -48,7 +48,7 @@ A customer can make purchases in your store and manage their profile. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/CustomerGroup.mdx b/www/apps/docs/content/references/services/classes/CustomerGroup.mdx index 7409c5b347..f033385eae 100644 --- a/www/apps/docs/content/references/services/classes/CustomerGroup.mdx +++ b/www/apps/docs/content/references/services/classes/CustomerGroup.mdx @@ -39,7 +39,7 @@ A customer group that can be used to organize customers into groups of similar t }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx b/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx index 0323104c9b..dc756c9070 100644 --- a/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx +++ b/www/apps/docs/content/references/services/classes/CustomerGroupService.mdx @@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "customerGroupRepository_", - "type": "Repository<[CustomerGroup](CustomerGroup.mdx)> & `{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }`", + "type": "Repository<[CustomerGroup](CustomerGroup.mdx)> & ``{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }``", "description": "", "optional": false, "defaultValue": "", @@ -385,7 +385,7 @@ List customer groups. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/CustomerService.mdx b/www/apps/docs/content/references/services/classes/CustomerService.mdx index 876681fb2d..c66628423e 100644 --- a/www/apps/docs/content/references/services/classes/CustomerService.mdx +++ b/www/apps/docs/content/references/services/classes/CustomerService.mdx @@ -69,7 +69,7 @@ Provides layer to manipulate customers. }, { "name": "customerRepository_", - "type": "Repository<[Customer](Customer.mdx)> & `{ listAndCount: Method listAndCount }`", + "type": "Repository<[Customer](Customer.mdx)> & ``{ listAndCount: Method listAndCount }``", "description": "", "optional": false, "defaultValue": "", @@ -481,7 +481,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Discount.mdx b/www/apps/docs/content/references/services/classes/Discount.mdx index c8db99e6e2..d4704c3785 100644 --- a/www/apps/docs/content/references/services/classes/Discount.mdx +++ b/www/apps/docs/content/references/services/classes/Discount.mdx @@ -39,7 +39,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -48,7 +48,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", @@ -165,7 +165,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "usage_limit", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", @@ -174,7 +174,7 @@ A discount can be applied to a cart for promotional purposes. }, { "name": "valid_duration", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/DiscountCondition.mdx b/www/apps/docs/content/references/services/classes/DiscountCondition.mdx index cc59199f89..7b80472b07 100644 --- a/www/apps/docs/content/references/services/classes/DiscountCondition.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountCondition.mdx @@ -39,7 +39,7 @@ Holds rule conditions for when a discount is applicable }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx b/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx index a71ccbad76..3db4f464f5 100644 --- a/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx +++ b/www/apps/docs/content/references/services/classes/DiscountConditionService.mdx @@ -62,7 +62,7 @@ Provides layer to manipulate discount conditions. }, { "name": "discountConditionRepository_", - "type": "Repository<[DiscountCondition](DiscountCondition.mdx)> & `{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }`", + "type": "Repository<[DiscountCondition](DiscountCondition.mdx)> & ``{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }``", "description": "", "optional": false, "defaultValue": "", @@ -246,7 +246,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -455,12 +455,12 @@ ___ #### Returns -`undefined` \| `{ resource_ids: (string \| { id: string })[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) }` +`undefined` \| ``{ resource_ids: (string \| { id: string })[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) }`` ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/DraftOrderService.mdx b/www/apps/docs/content/references/services/classes/DraftOrderService.mdx index 3aad94c823..6deb4733d6 100644 --- a/www/apps/docs/content/references/services/classes/DraftOrderService.mdx +++ b/www/apps/docs/content/references/services/classes/DraftOrderService.mdx @@ -116,7 +116,7 @@ Handles draft orders }, { "name": "orderRepository_", - "type": "Repository<[Order](Order.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Order](Order.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -611,7 +611,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/EventBusService.mdx b/www/apps/docs/content/references/services/classes/EventBusService.mdx index 40fb6cae49..c1da5707ba 100644 --- a/www/apps/docs/content/references/services/classes/EventBusService.mdx +++ b/www/apps/docs/content/references/services/classes/EventBusService.mdx @@ -452,7 +452,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx b/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx index bec2f9f7a1..a8ba1db384 100644 --- a/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx +++ b/www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx @@ -82,7 +82,7 @@ Filters to apply on the retrieved price lists. }, { "name": "status", - "type": "[PriceListStatus](../enums/PriceListStatus.mdx)[]", + "type": "[PriceListStatus](../enums/PriceListStatus-1.mdx)[]", "description": "Statuses to filter price lists by.", "optional": true, "defaultValue": "", @@ -91,7 +91,7 @@ Filters to apply on the retrieved price lists. }, { "name": "type", - "type": "[PriceListType](../enums/PriceListType.mdx)[]", + "type": "[PriceListType](../enums/PriceListType-1.mdx)[]", "description": "Types to filter price lists by.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/FlagRouter.mdx b/www/apps/docs/content/references/services/classes/FlagRouter.mdx index 5aa80e94d4..d892d1c82e 100644 --- a/www/apps/docs/content/references/services/classes/FlagRouter.mdx +++ b/www/apps/docs/content/references/services/classes/FlagRouter.mdx @@ -101,7 +101,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/FulfillmentService.mdx b/www/apps/docs/content/references/services/classes/FulfillmentService.mdx index a282cdc3be..bd39bc2308 100644 --- a/www/apps/docs/content/references/services/classes/FulfillmentService.mdx +++ b/www/apps/docs/content/references/services/classes/FulfillmentService.mdx @@ -78,7 +78,7 @@ Handles Fulfillments }, { "name": "lineItemRepository_", - "type": "Repository<[LineItem](LineItem.mdx)> & `{ findByReturn: Method findByReturn }`", + "type": "Repository<[LineItem](LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``", "description": "", "optional": false, "defaultValue": "", @@ -373,7 +373,7 @@ tracking links and potentially more metadata. }, { "name": "trackingLinks", - "type": "`{ tracking_number: string }`[]", + "type": "``{ tracking_number: string }``[]", "description": "tracking links for the shipment", "optional": true, "defaultValue": "", @@ -411,7 +411,7 @@ ___ ### getFulfillmentItems\_ -`**getFulfillmentItems_**(order, items): Promise<(`null` \| [LineItem](LineItem.mdx))[]>` +`**getFulfillmentItems_**(order, items): Promise<(null \| [LineItem](LineItem.mdx))[]>` Retrieves the order line items, given an array of items. @@ -440,12 +440,12 @@ Retrieves the order line items, given an array of items. #### Returns -Promise<(`null` \| [LineItem](LineItem.mdx))[]> +Promise<(null \| [LineItem](LineItem.mdx))[]> ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -586,7 +586,7 @@ ___ ### validateFulfillmentLineItem\_ -`**validateFulfillmentLineItem_**(item, quantity): `null` \| [LineItem](LineItem.mdx)` +`**validateFulfillmentLineItem_**(item, quantity): null \| [LineItem](LineItem.mdx)` Checks that a given quantity of a line item can be fulfilled. Fails if the fulfillable quantity is lower than the requested fulfillment quantity. @@ -618,12 +618,12 @@ quantity from the quantity that was originally purchased. #### Returns -``null`` \| [LineItem](LineItem.mdx) +`null` \| [LineItem](LineItem.mdx) ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -719,7 +719,7 @@ ___ ### resolveTaxRate -`Static Protected **resolveTaxRate**(giftCardTaxRate, region): `null` \| number` +`Static Protected **resolveTaxRate**(giftCardTaxRate, region): null \| number` The tax\_rate of the giftcard can depend on whether regions tax gift cards, an input provided by the user or the tax rate. Based on these conditions, tax\_rate changes. @@ -729,7 +729,7 @@ provided by the user or the tax rate. Based on these conditions, tax\_rate chang ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Image.mdx b/www/apps/docs/content/references/services/classes/Image.mdx index 8a1c74f78a..e573d5a78f 100644 --- a/www/apps/docs/content/references/services/classes/Image.mdx +++ b/www/apps/docs/content/references/services/classes/Image.mdx @@ -30,7 +30,7 @@ An Image is used to store details about uploaded images. Images are uploaded by }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/LineItem.mdx b/www/apps/docs/content/references/services/classes/LineItem.mdx index 8041792f25..5e1cdbc423 100644 --- a/www/apps/docs/content/references/services/classes/LineItem.mdx +++ b/www/apps/docs/content/references/services/classes/LineItem.mdx @@ -84,7 +84,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -93,7 +93,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", @@ -102,7 +102,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "fulfilled_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "gift_card_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", @@ -120,7 +120,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "has_shipping", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", @@ -184,7 +184,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "order_edit", - "type": "``null`` \\| [OrderEdit](OrderEdit.mdx)", + "type": "`null` \\| [OrderEdit](OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", @@ -193,7 +193,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "order_edit_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", @@ -202,7 +202,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", @@ -211,7 +211,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "original_item_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", @@ -220,7 +220,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "original_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", @@ -229,7 +229,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "original_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", @@ -238,7 +238,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "product_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "", "optional": false, "defaultValue": "", @@ -256,7 +256,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "raw_discount_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", @@ -265,7 +265,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "refundable", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", @@ -274,7 +274,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "returned_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", @@ -283,7 +283,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "shipped_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", @@ -301,7 +301,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "subtotal", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", @@ -337,7 +337,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", @@ -346,7 +346,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", @@ -364,7 +364,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", @@ -400,7 +400,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu }, { "name": "variant_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx b/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx index 969a5175e4..63734041db 100644 --- a/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx +++ b/www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx @@ -342,7 +342,7 @@ Deletes line item adjustments matching a selector ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/LineItemService.mdx b/www/apps/docs/content/references/services/classes/LineItemService.mdx index c508a30a66..6b040c9275 100644 --- a/www/apps/docs/content/references/services/classes/LineItemService.mdx +++ b/www/apps/docs/content/references/services/classes/LineItemService.mdx @@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cartRepository_", - "type": "Repository<[Cart](Cart.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Cart](Cart.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "itemTaxLineRepo_", - "type": "Repository<[LineItemTaxLine](LineItemTaxLine.mdx)> & `{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`", + "type": "Repository<[LineItemTaxLine](LineItemTaxLine.mdx)> & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }``", "description": "", "optional": false, "defaultValue": "", @@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "lineItemRepository_", - "type": "Repository<[LineItem](LineItem.mdx)> & `{ findByReturn: Method findByReturn }`", + "type": "Repository<[LineItem](LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``", "description": "", "optional": false, "defaultValue": "", @@ -479,7 +479,7 @@ ___ ### delete -`**delete**(id): Promise<undefined \| `null` \| [LineItem](LineItem.mdx)>` +`**delete**(id): Promise<undefined \| null \| [LineItem](LineItem.mdx)>` Deletes a line item. @@ -499,12 +499,12 @@ Deletes a line item. #### Returns -Promise<undefined \| `null` \| [LineItem](LineItem.mdx)> +Promise<undefined \| null \| [LineItem](LineItem.mdx)> ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx b/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx index 985099fbce..b3cb91360b 100644 --- a/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx +++ b/www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx @@ -21,7 +21,7 @@ A Line Item Tax Line represents the taxes applied on a line item. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Note.mdx b/www/apps/docs/content/references/services/classes/Note.mdx index 1893bc13e2..ed4b30718f 100644 --- a/www/apps/docs/content/references/services/classes/Note.mdx +++ b/www/apps/docs/content/references/services/classes/Note.mdx @@ -48,7 +48,7 @@ A Note is an element that can be used in association with different resources to }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/NoteService.mdx b/www/apps/docs/content/references/services/classes/NoteService.mdx index af06d6cec6..419d445a05 100644 --- a/www/apps/docs/content/references/services/classes/NoteService.mdx +++ b/www/apps/docs/content/references/services/classes/NoteService.mdx @@ -477,7 +477,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Notification.mdx b/www/apps/docs/content/references/services/classes/Notification.mdx index 6b42d1a6eb..12c93616c1 100644 --- a/www/apps/docs/content/references/services/classes/Notification.mdx +++ b/www/apps/docs/content/references/services/classes/Notification.mdx @@ -39,7 +39,7 @@ A notification is an alert sent, typically to customers, using the installed Not }, { "name": "customer_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/NotificationService.mdx b/www/apps/docs/content/references/services/classes/NotificationService.mdx index dab7346d00..0ea2ce4a4c 100644 --- a/www/apps/docs/content/references/services/classes/NotificationService.mdx +++ b/www/apps/docs/content/references/services/classes/NotificationService.mdx @@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "container_", - "type": "[InjectedDependencies](../types/InjectedDependencies-17.mdx) & `{}`", + "type": "[InjectedDependencies](../types/InjectedDependencies-17.mdx) & ``{}``", "description": "", "optional": false, "defaultValue": "", @@ -653,7 +653,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/OauthService.mdx b/www/apps/docs/content/references/services/classes/OauthService.mdx index 27976154ea..c8d2852f42 100644 --- a/www/apps/docs/content/references/services/classes/OauthService.mdx +++ b/www/apps/docs/content/references/services/classes/OauthService.mdx @@ -512,7 +512,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Order.mdx b/www/apps/docs/content/references/services/classes/Order.mdx index f1ac435040..a56b6adc27 100644 --- a/www/apps/docs/content/references/services/classes/Order.mdx +++ b/www/apps/docs/content/references/services/classes/Order.mdx @@ -183,7 +183,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", @@ -264,7 +264,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "item_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", @@ -300,7 +300,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "object", - "type": "``\"order\"``", + "type": "`\"order\"`", "description": "", "optional": false, "defaultValue": "\"order\"", @@ -417,7 +417,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", @@ -453,7 +453,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "shipping_tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", @@ -498,7 +498,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "tax_rate", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", @@ -507,7 +507,7 @@ An order is a purchase made by a customer. It holds details about payment and fu }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/OrderEdit.mdx b/www/apps/docs/content/references/services/classes/OrderEdit.mdx index 5a2e2c8d33..3e2ea7b6a9 100644 --- a/www/apps/docs/content/references/services/classes/OrderEdit.mdx +++ b/www/apps/docs/content/references/services/classes/OrderEdit.mdx @@ -255,7 +255,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele }, { "name": "tax_total", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx b/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx index a9825dce9e..3a960290e2 100644 --- a/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx +++ b/www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx @@ -413,7 +413,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/OrderEditService.mdx b/www/apps/docs/content/references/services/classes/OrderEditService.mdx index 9d091f5336..09b553b4cc 100644 --- a/www/apps/docs/content/references/services/classes/OrderEditService.mdx +++ b/www/apps/docs/content/references/services/classes/OrderEditService.mdx @@ -822,7 +822,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/OrderItemChange.mdx b/www/apps/docs/content/references/services/classes/OrderItemChange.mdx index c6681f6595..bd076b2a1f 100644 --- a/www/apps/docs/content/references/services/classes/OrderItemChange.mdx +++ b/www/apps/docs/content/references/services/classes/OrderItemChange.mdx @@ -30,7 +30,7 @@ An order item change is a change made within an order edit to an order's items. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/OrderService.mdx b/www/apps/docs/content/references/services/classes/OrderService.mdx index dd6287c75b..cefa20c637 100644 --- a/www/apps/docs/content/references/services/classes/OrderService.mdx +++ b/www/apps/docs/content/references/services/classes/OrderService.mdx @@ -184,7 +184,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "orderRepository_", - "type": "Repository<[Order](Order.mdx)> & `{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`", + "type": "Repository<[Order](Order.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``", "description": "", "optional": false, "defaultValue": "", @@ -1794,7 +1794,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -2032,7 +2032,7 @@ ___ ### validateFulfillmentLineItem -`Protected **validateFulfillmentLineItem**(item, quantity): `null` \| [LineItem](LineItem.mdx)` +`Protected **validateFulfillmentLineItem**(item, quantity): null \| [LineItem](LineItem.mdx)` Checks that a given quantity of a line item can be fulfilled. Fails if the fulfillable quantity is lower than the requested fulfillment quantity. @@ -2064,12 +2064,12 @@ quantity from the quantity that was originally purchased. #### Returns -``null`` \| [LineItem](LineItem.mdx) +`null` \| [LineItem](LineItem.mdx) ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx b/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx index c815433ef5..03e4470812 100644 --- a/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentProviderService.mdx @@ -367,7 +367,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/PaymentService.mdx b/www/apps/docs/content/references/services/classes/PaymentService.mdx index 38bbe43816..a8e6102108 100644 --- a/www/apps/docs/content/references/services/classes/PaymentService.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentService.mdx @@ -466,7 +466,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/PaymentSession.mdx b/www/apps/docs/content/references/services/classes/PaymentSession.mdx index 2db7190b18..41b41b653f 100644 --- a/www/apps/docs/content/references/services/classes/PaymentSession.mdx +++ b/www/apps/docs/content/references/services/classes/PaymentSession.mdx @@ -39,7 +39,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "cart_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", @@ -93,7 +93,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c }, { "name": "is_selected", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/PriceList.mdx b/www/apps/docs/content/references/services/classes/PriceList.mdx index 9b3b655b22..2f15d6b95d 100644 --- a/www/apps/docs/content/references/services/classes/PriceList.mdx +++ b/www/apps/docs/content/references/services/classes/PriceList.mdx @@ -39,7 +39,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -57,7 +57,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "ends_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ A Price List represents a set of prices that override the default price for one }, { "name": "starts_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/PriceListService.mdx b/www/apps/docs/content/references/services/classes/PriceListService.mdx index ccdd249e71..c52bba0fd0 100644 --- a/www/apps/docs/content/references/services/classes/PriceListService.mdx +++ b/www/apps/docs/content/references/services/classes/PriceListService.mdx @@ -87,7 +87,7 @@ Provides layer to manipulate product tags. }, { "name": "moneyAmountRepo_", - "type": "Repository<[MoneyAmount](MoneyAmount.mdx)> & `{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }`", + "type": "Repository<[MoneyAmount](MoneyAmount.mdx)> & ``{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }``", "description": "", "optional": false, "defaultValue": "", @@ -96,7 +96,7 @@ Provides layer to manipulate product tags. }, { "name": "priceListRepo_", - "type": "Repository<[PriceList](PriceList.mdx)> & `{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }`", + "type": "Repository<[PriceList](PriceList.mdx)> & ``{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }``", "description": "", "optional": false, "defaultValue": "", @@ -923,7 +923,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1015,7 +1015,7 @@ ___ }, { "name": "customerGroups", - "type": "`{ id: string }`[]", + "type": "``{ id: string }``[]", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/PricingService.mdx b/www/apps/docs/content/references/services/classes/PricingService.mdx index ba5ce28ea9..6bb3e40a8c 100644 --- a/www/apps/docs/content/references/services/classes/PricingService.mdx +++ b/www/apps/docs/content/references/services/classes/PricingService.mdx @@ -156,6 +156,15 @@ ___ [IPricingModuleService](../interfaces/IPricingModuleService.mdx) Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "addPrices", "type": "(`data`: [AddPricesDTO](../interfaces/AddPricesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)>(`data`: [AddPricesDTO](../interfaces/AddPricesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceSetDTO](../interfaces/PriceSetDTO.mdx)[]>", @@ -210,6 +219,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "createPriceListRules", + "type": "(`data`: [CreatePriceListRuleDTO](../interfaces/CreatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "createPriceLists", + "type": "(`data`: [CreatePriceListDTO](../interfaces/CreatePriceListDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "createPriceRules", "type": "(`data`: [CreatePriceRuleDTO](../interfaces/CreatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]>", @@ -264,6 +291,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "deletePriceListRules", + "type": "(`priceListRuleIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "deletePriceLists", + "type": "(`priceListIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "deletePriceRules", "type": "(`priceRuleIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", @@ -327,6 +372,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "listAndCountPriceListRules", + "type": "(`filters?`: [FilterablePriceListRuleProps](../interfaces/FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[], number]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "listAndCountPriceLists", + "type": "(`filters?`: [FilterablePriceListProps](../interfaces/FilterablePriceListProps-1.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListDTO](../interfaces/PriceListDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceListDTO](../interfaces/PriceListDTO.mdx)[], number]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "listAndCountPriceRules", "type": "(`filters?`: [FilterablePriceRuleProps](../interfaces/FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[], number]>", @@ -381,6 +444,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "listPriceListRules", + "type": "(`filters?`: [FilterablePriceListRuleProps](../interfaces/FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "listPriceLists", + "type": "(`filters?`: [FilterablePriceListProps](../interfaces/FilterablePriceListProps-1.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListDTO](../interfaces/PriceListDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "listPriceRules", "type": "(`filters?`: [FilterablePriceRuleProps](../interfaces/FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]>", @@ -417,6 +498,15 @@ ___ "expandable": false, "children": [] }, + { + "name": "removePriceListRules", + "type": "(`data`: [RemovePriceListRulesDTO](../interfaces/RemovePriceListRulesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "removeRules", "type": "(`data`: [RemovePriceSetRulesDTO](../interfaces/RemovePriceSetRulesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<void>", @@ -453,6 +543,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "retrievePriceList", + "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListDTO](../interfaces/PriceListDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "retrievePriceListRule", + "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "retrievePriceRule", "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)>", @@ -480,6 +588,15 @@ ___ "expandable": false, "children": [] }, + { + "name": "setPriceListRules", + "type": "(`data`: [SetPriceListRulesDTO](../interfaces/SetPriceListRulesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "updateCurrencies", "type": "(`data`: [UpdateCurrencyDTO](../interfaces/UpdateCurrencyDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[CurrencyDTO](../interfaces/CurrencyDTO.mdx)[]>", @@ -498,6 +615,24 @@ ___ "expandable": false, "children": [] }, + { + "name": "updatePriceListRules", + "type": "(`data`: [UpdatePriceListRuleDTO](../interfaces/UpdatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "updatePriceLists", + "type": "(`data`: [UpdatePriceListDTO](../interfaces/UpdatePriceListDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceListDTO](../interfaces/PriceListDTO.mdx)[]>", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "updatePriceRules", "type": "(`data`: [UpdatePriceRuleDTO](../interfaces/UpdatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise<[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]>", @@ -540,7 +675,7 @@ ___ `) => Promise<any> \\| ``null``", + "type": "(`query`: `string` \\| [RemoteJoinerQuery](../interfaces/RemoteJoinerQuery.mdx) \\| `object`, `variables?`: `Record`) => Promise<any> \\| `null`", "description": "", "optional": false, "defaultValue": "", @@ -764,7 +899,7 @@ be fetched. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Product.mdx b/www/apps/docs/content/references/services/classes/Product.mdx index 758f92003b..3f9d989247 100644 --- a/www/apps/docs/content/references/services/classes/Product.mdx +++ b/www/apps/docs/content/references/services/classes/Product.mdx @@ -40,7 +40,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "collection_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", @@ -58,7 +58,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -67,7 +67,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", @@ -85,7 +85,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "external_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", @@ -94,7 +94,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "handle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", @@ -103,7 +103,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -112,7 +112,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -148,7 +148,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -157,7 +157,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -166,7 +166,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -175,7 +175,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -193,7 +193,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -247,7 +247,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "subtitle", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", @@ -265,7 +265,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "thumbnail", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", @@ -292,7 +292,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "type_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", @@ -319,7 +319,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -328,7 +328,7 @@ A product is a saleable item that holds general information such as name or desc }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductCategory.mdx b/www/apps/docs/content/references/services/classes/ProductCategory.mdx index 940e6a9858..2ce933d0c9 100644 --- a/www/apps/docs/content/references/services/classes/ProductCategory.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCategory.mdx @@ -93,7 +93,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category", - "type": "``null`` \\| [ProductCategory](ProductCategory.mdx)", + "type": "`null` \\| [ProductCategory](ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A product category can be used to categorize products into a hierarchy of catego }, { "name": "parent_category_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", diff --git a/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx b/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx index e4ef83ea0a..3794171eba 100644 --- a/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCategoryService.mdx @@ -78,7 +78,7 @@ Provides layer to manipulate product categories. }, { "name": "productCategoryRepo_", - "type": "TreeRepository<[ProductCategory](ProductCategory.mdx)> & `{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }`", + "type": "TreeRepository<[ProductCategory](ProductCategory.mdx)> & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``", "description": "", "optional": false, "defaultValue": "", @@ -478,7 +478,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductCollection.mdx b/www/apps/docs/content/references/services/classes/ProductCollection.mdx index 2a01d58faf..2cc5d884b5 100644 --- a/www/apps/docs/content/references/services/classes/ProductCollection.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCollection.mdx @@ -30,7 +30,7 @@ A Product Collection allows grouping together products for promotional purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx b/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx index fe135f6518..097f9ad3b3 100644 --- a/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCollectionService.mdx @@ -78,7 +78,7 @@ Provides layer to manipulate product collections. }, { "name": "productCollectionRepository_", - "type": "Repository<[ProductCollection](ProductCollection.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }`", + "type": "Repository<[ProductCollection](ProductCollection.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }``", "description": "", "optional": false, "defaultValue": "", @@ -87,7 +87,7 @@ Provides layer to manipulate product collections. }, { "name": "productRepository_", - "type": "Repository<[Product](Product.mdx)> & `{ _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }`", + "type": "Repository<[Product](Product.mdx)> & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``", "description": "", "optional": false, "defaultValue": "", @@ -394,7 +394,7 @@ Lists product collections ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductOption.mdx b/www/apps/docs/content/references/services/classes/ProductOption.mdx index 6a61b9cd23..6d1f7da9a5 100644 --- a/www/apps/docs/content/references/services/classes/ProductOption.mdx +++ b/www/apps/docs/content/references/services/classes/ProductOption.mdx @@ -30,7 +30,7 @@ A Product Option defines properties that may vary between different variants of }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx b/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx index 92a285cc8b..b8ea4865d2 100644 --- a/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx +++ b/www/apps/docs/content/references/services/classes/ProductOptionValue.mdx @@ -30,7 +30,7 @@ An option value is one of the possible values of a Product Option. Product Varia }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductService.mdx b/www/apps/docs/content/references/services/classes/ProductService.mdx index fd1189111e..6577f7365e 100644 --- a/www/apps/docs/content/references/services/classes/ProductService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductService.mdx @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "imageRepository_", - "type": "Repository<[Image](Image.mdx)> & `{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }`", + "type": "Repository<[Image](Image.mdx)> & ``{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }``", "description": "", "optional": false, "defaultValue": "", @@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productCategoryRepository_", - "type": "TreeRepository<[ProductCategory](ProductCategory.mdx)> & `{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }`", + "type": "TreeRepository<[ProductCategory](ProductCategory.mdx)> & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``", "description": "", "optional": false, "defaultValue": "", @@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productRepository_", - "type": "Repository<[Product](Product.mdx)> & `{ _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }`", + "type": "Repository<[Product](Product.mdx)> & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``", "description": "", "optional": false, "defaultValue": "", @@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productTagRepository_", - "type": "Repository<[ProductTag](ProductTag.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }`", + "type": "Repository<[ProductTag](ProductTag.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }``", "description": "", "optional": false, "defaultValue": "", @@ -130,7 +130,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "productTypeRepository_", - "type": "Repository<[ProductType](ProductType.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }`", + "type": "Repository<[ProductType](ProductType.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }``", "description": "", "optional": false, "defaultValue": "", @@ -211,7 +211,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "IndexName", - "type": "``\"products\"``", + "type": "`\"products\"`", "description": "", "optional": false, "defaultValue": "", @@ -1056,7 +1056,7 @@ ___ ### retrieveOptionByTitle -`**retrieveOptionByTitle**(title, productId): Promise<`null` \| [ProductOption](ProductOption.mdx)>` +`**retrieveOptionByTitle**(title, productId): Promise<null \| [ProductOption](ProductOption.mdx)>` Retrieve product's option by title. @@ -1085,12 +1085,12 @@ Retrieve product's option by title. #### Returns -Promise<`null` \| [ProductOption](ProductOption.mdx)> +Promise<null \| [ProductOption](ProductOption.mdx)> ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1358,7 +1358,7 @@ Assign a product to a profile, if a profile id null is provided then detach the }, { "name": "profileId", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "Shipping profile ID to update the shipping options with", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductTag.mdx b/www/apps/docs/content/references/services/classes/ProductTag.mdx index 3bb3993b60..bfe3e99fc5 100644 --- a/www/apps/docs/content/references/services/classes/ProductTag.mdx +++ b/www/apps/docs/content/references/services/classes/ProductTag.mdx @@ -30,7 +30,7 @@ A Product Tag can be added to Products for easy filtering and grouping. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductType.mdx b/www/apps/docs/content/references/services/classes/ProductType.mdx index 2f19388350..caee14a56b 100644 --- a/www/apps/docs/content/references/services/classes/ProductType.mdx +++ b/www/apps/docs/content/references/services/classes/ProductType.mdx @@ -30,7 +30,7 @@ A Product Type can be added to Products for filtering and reporting purposes. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductTypeService.mdx b/www/apps/docs/content/references/services/classes/ProductTypeService.mdx index 11e0637d8d..fdaa6d428c 100644 --- a/www/apps/docs/content/references/services/classes/ProductTypeService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductTypeService.mdx @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "typeRepository_", - "type": "Repository<[ProductType](ProductType.mdx)> & `{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }`", + "type": "Repository<[ProductType](ProductType.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }``", "description": "", "optional": false, "defaultValue": "", @@ -199,7 +199,7 @@ Lists product types ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductVariant.mdx b/www/apps/docs/content/references/services/classes/ProductVariant.mdx index ee86f5b4b9..1a15da7fc6 100644 --- a/www/apps/docs/content/references/services/classes/ProductVariant.mdx +++ b/www/apps/docs/content/references/services/classes/ProductVariant.mdx @@ -30,7 +30,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "barcode", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -48,7 +48,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -57,7 +57,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "ean", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -66,7 +66,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "height", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -75,7 +75,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "hs_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "length", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -129,7 +129,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "material", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -138,7 +138,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -147,7 +147,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "mid_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -165,7 +165,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "origin_country", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", @@ -210,7 +210,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "sku", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", @@ -228,7 +228,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "upc", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", @@ -246,7 +246,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "variant_rank", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", @@ -255,7 +255,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "weight", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", @@ -264,7 +264,7 @@ A Product Variant represents a Product with a specific set of Product Option con }, { "name": "width", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx b/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx index f917db4327..497188e7a0 100644 --- a/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx +++ b/www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx @@ -30,7 +30,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx b/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx index 0a1f011c73..68606ee9d2 100644 --- a/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx +++ b/www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx @@ -145,18 +145,9 @@ ___ [IInventoryService](../interfaces/IInventoryService.mdx) [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "adjustInventory", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -165,7 +156,7 @@ ___ }, { "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<boolean>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -174,7 +165,7 @@ ___ }, { "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", + "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -183,7 +174,7 @@ ___ }, { "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>", + "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -192,7 +183,7 @@ ___ }, { "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -201,7 +192,7 @@ ___ }, { "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", + "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -210,7 +201,7 @@ ___ }, { "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", + "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -219,7 +210,7 @@ ___ }, { "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>", + "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -228,7 +219,7 @@ ___ }, { "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -237,7 +228,7 @@ ___ }, { "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -246,7 +237,7 @@ ___ }, { "name": "deleteInventoryLevel", - "type": "(`inventoryLevelId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -255,7 +246,7 @@ ___ }, { "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -264,7 +255,7 @@ ___ }, { "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -273,7 +264,7 @@ ___ }, { "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -282,7 +273,7 @@ ___ }, { "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../types/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryItemProps](../interfaces/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -291,7 +282,7 @@ ___ }, { "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../types/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryLevelProps](../interfaces/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -300,7 +291,7 @@ ___ }, { "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../types/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableReservationItemProps](../interfaces/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -309,7 +300,7 @@ ___ }, { "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -318,7 +309,7 @@ ___ }, { "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -327,7 +318,7 @@ ___ }, { "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -336,7 +327,7 @@ ___ }, { "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -345,7 +336,7 @@ ___ }, { "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", + "type": "(`reservationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -354,7 +345,7 @@ ___ }, { "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -363,7 +354,7 @@ ___ }, { "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -372,7 +363,7 @@ ___ }, { "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/Partial.mdx)<[CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -381,7 +372,7 @@ ___ }, { "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../interfaces/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -390,7 +381,7 @@ ___ }, { "name": "updateInventoryLevels", - "type": "(`updates`: `{ inventory_item_id: string ; location_id: string }` & [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", + "type": "(`updates`: [BulkUpdateInventoryLevelInput](../interfaces/BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -399,7 +390,7 @@ ___ }, { "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../types/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", + "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../interfaces/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -419,18 +410,9 @@ ___ [IStockLocationService](../interfaces/IStockLocationService.mdx) [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "create", - "type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", + "type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -439,7 +421,7 @@ ___ }, { "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`id`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -448,7 +430,7 @@ ___ }, { "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]>", + "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -457,7 +439,7 @@ ___ }, { "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -466,7 +448,7 @@ ___ }, { "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -475,7 +457,7 @@ ___ }, { "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -697,7 +679,7 @@ Attach a variant to an inventory item ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1447,7 +1429,7 @@ Validate stock at a location for fulfillment items ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -987,7 +987,7 @@ Updates a collection of variant. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1099,7 +1099,7 @@ the id can be passed to check that country updates are allowed. `", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -93,7 +93,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "no_notification", - "type": "``null`` \\| `boolean`", + "type": "`null` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", @@ -111,7 +111,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", @@ -174,7 +174,7 @@ A Return holds information about Line Items that a Customer wishes to send back, }, { "name": "swap_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ReturnReason.mdx b/www/apps/docs/content/references/services/classes/ReturnReason.mdx index 22b41c230d..aefbd8b891 100644 --- a/www/apps/docs/content/references/services/classes/ReturnReason.mdx +++ b/www/apps/docs/content/references/services/classes/ReturnReason.mdx @@ -30,7 +30,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -75,7 +75,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason", - "type": "``null`` \\| [ReturnReason](ReturnReason.mdx)", + "type": "`null` \\| [ReturnReason](ReturnReason.mdx)", "description": "The details of the parent reason.", "optional": false, "defaultValue": "", @@ -84,7 +84,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i }, { "name": "parent_return_reason_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the parent reason.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx b/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx index 436b0bad98..e2d2a1828d 100644 --- a/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx +++ b/www/apps/docs/content/references/services/classes/ReturnReasonService.mdx @@ -361,7 +361,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ReturnService.mdx b/www/apps/docs/content/references/services/classes/ReturnService.mdx index ac840d3cfd..1a997b157c 100644 --- a/www/apps/docs/content/references/services/classes/ReturnService.mdx +++ b/www/apps/docs/content/references/services/classes/ReturnService.mdx @@ -728,7 +728,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/SalesChannel.mdx b/www/apps/docs/content/references/services/classes/SalesChannel.mdx index 1321e11b1e..d183127cce 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannel.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannel.mdx @@ -30,7 +30,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", @@ -39,7 +39,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "description", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", @@ -75,7 +75,7 @@ A Sales Channel is a method a business offers its products for purchase for the }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx b/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx index 0914f3aea0..5e5686e0ba 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx @@ -127,18 +127,9 @@ ___ [IInventoryService](../interfaces/IInventoryService.mdx) [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "adjustInventory", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -147,7 +138,7 @@ ___ }, { "name": "confirmInventory", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<boolean>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<boolean>", "description": "", "optional": false, "defaultValue": "", @@ -156,7 +147,7 @@ ___ }, { "name": "createInventoryItem", - "type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", + "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -165,7 +156,7 @@ ___ }, { "name": "createInventoryItems", - "type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>", + "type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -174,7 +165,7 @@ ___ }, { "name": "createInventoryLevel", - "type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -183,7 +174,7 @@ ___ }, { "name": "createInventoryLevels", - "type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", + "type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -192,7 +183,7 @@ ___ }, { "name": "createReservationItem", - "type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", + "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -201,7 +192,7 @@ ___ }, { "name": "createReservationItems", - "type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>", + "type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -210,7 +201,7 @@ ___ }, { "name": "deleteInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -219,7 +210,7 @@ ___ }, { "name": "deleteInventoryItemLevelByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -228,7 +219,7 @@ ___ }, { "name": "deleteInventoryLevel", - "type": "(`inventoryLevelId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -237,7 +228,7 @@ ___ }, { "name": "deleteReservationItem", - "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -246,7 +237,7 @@ ___ }, { "name": "deleteReservationItemByLocationId", - "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -255,7 +246,7 @@ ___ }, { "name": "deleteReservationItemsByLineItem", - "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -264,7 +255,7 @@ ___ }, { "name": "listInventoryItems", - "type": "(`selector`: [FilterableInventoryItemProps](../types/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryItemProps](../interfaces/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -273,7 +264,7 @@ ___ }, { "name": "listInventoryLevels", - "type": "(`selector`: [FilterableInventoryLevelProps](../types/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableInventoryLevelProps](../interfaces/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -282,7 +273,7 @@ ___ }, { "name": "listReservationItems", - "type": "(`selector`: [FilterableReservationItemProps](../types/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableReservationItemProps](../interfaces/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -291,7 +282,7 @@ ___ }, { "name": "restoreInventoryItem", - "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -300,7 +291,7 @@ ___ }, { "name": "retrieveAvailableQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -309,7 +300,7 @@ ___ }, { "name": "retrieveInventoryItem", - "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -318,7 +309,7 @@ ___ }, { "name": "retrieveInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -327,7 +318,7 @@ ___ }, { "name": "retrieveReservationItem", - "type": "(`reservationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", + "type": "(`reservationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -336,7 +327,7 @@ ___ }, { "name": "retrieveReservedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -345,7 +336,7 @@ ___ }, { "name": "retrieveStockedQuantity", - "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<number>", + "type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<number>", "description": "", "optional": false, "defaultValue": "", @@ -354,7 +345,7 @@ ___ }, { "name": "updateInventoryItem", - "type": "(`inventoryItemId`: `string`, `input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/Partial.mdx)<[CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryItemDTO](../types/InventoryItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -363,7 +354,7 @@ ___ }, { "name": "updateInventoryLevel", - "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", + "type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../interfaces/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -372,7 +363,7 @@ ___ }, { "name": "updateInventoryLevels", - "type": "(`updates`: `{ inventory_item_id: string ; location_id: string }` & [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", + "type": "(`updates`: [BulkUpdateInventoryLevelInput](../interfaces/BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -381,7 +372,7 @@ ___ }, { "name": "updateReservationItem", - "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../types/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", + "type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../interfaces/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[ReservationItemDTO](../types/ReservationItemDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -527,7 +518,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx b/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx index 64852b4341..a7ebb91433 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx @@ -30,7 +30,7 @@ This represents the association between a sales channel and a stock locations. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx b/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx index 2d0fcbbc27..730cc58e3d 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx @@ -129,18 +129,9 @@ ___ [IStockLocationService](../interfaces/IStockLocationService.mdx) [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)", - "description": "", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "create", - "type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", + "type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -149,7 +140,7 @@ ___ }, { "name": "delete", - "type": "(`id`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<void>", + "type": "(`id`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<void>", "description": "", "optional": false, "defaultValue": "", @@ -158,7 +149,7 @@ ___ }, { "name": "list", - "type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]>", + "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)[]>", "description": "", "optional": false, "defaultValue": "", @@ -167,7 +158,7 @@ ___ }, { "name": "listAndCount", - "type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]>", + "type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]>", "description": "", "optional": false, "defaultValue": "", @@ -176,7 +167,7 @@ ___ }, { "name": "retrieve", - "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)<[StockLocationDTO](../types/StockLocationDTO.mdx)>, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -185,7 +176,7 @@ ___ }, { "name": "update", - "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", + "type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>", "description": "", "optional": false, "defaultValue": "", @@ -454,7 +445,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/SalesChannelService.mdx b/www/apps/docs/content/references/services/classes/SalesChannelService.mdx index db57c27e79..9f94071731 100644 --- a/www/apps/docs/content/references/services/classes/SalesChannelService.mdx +++ b/www/apps/docs/content/references/services/classes/SalesChannelService.mdx @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "salesChannelRepository_", - "type": "Repository<[SalesChannel](SalesChannel.mdx)> & `{ addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }`", + "type": "Repository<[SalesChannel](SalesChannel.mdx)> & ``{ addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }``", "description": "", "optional": false, "defaultValue": "", @@ -701,7 +701,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ShippingMethod.mdx b/www/apps/docs/content/references/services/classes/ShippingMethod.mdx index 25095fff3c..4d7c2eaedc 100644 --- a/www/apps/docs/content/references/services/classes/ShippingMethod.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingMethod.mdx @@ -48,7 +48,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S }, { "name": "claim_order_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx b/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx index f7c048335d..5207dc9eb3 100644 --- a/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx +++ b/www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx @@ -21,7 +21,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -869,7 +869,7 @@ ___ ### validateAndMutatePrice -`Private **validateAndMutatePrice**(option, priceInput): Promise<[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)<[ShippingOption](ShippingOption.mdx), `"beforeInsert"`>>` +`Private **validateAndMutatePrice**(option, priceInput): Promise<[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)<[ShippingOption](ShippingOption.mdx), "beforeInsert">>` #### Parameters @@ -896,12 +896,12 @@ ___ #### Returns -Promise<[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)<[ShippingOption](ShippingOption.mdx), `"beforeInsert"`>> +Promise<[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)<[ShippingOption](ShippingOption.mdx), "beforeInsert">> ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx b/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx index 063f9ff196..336f5a13a4 100644 --- a/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx +++ b/www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx @@ -28,7 +28,7 @@ Base abstract entity for all entities }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/StagedJobService.mdx b/www/apps/docs/content/references/services/classes/StagedJobService.mdx index 45bfe65f3c..77463aecf6 100644 --- a/www/apps/docs/content/references/services/classes/StagedJobService.mdx +++ b/www/apps/docs/content/references/services/classes/StagedJobService.mdx @@ -69,7 +69,7 @@ Provides layer to manipulate users. }, { "name": "stagedJobRepository_", - "type": "Repository<[StagedJob](StagedJob.mdx)> & `{ insertBulk: Method insertBulk }`", + "type": "Repository<[StagedJob](StagedJob.mdx)> & ``{ insertBulk: Method insertBulk }``", "description": "", "optional": false, "defaultValue": "", @@ -307,7 +307,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Store.mdx b/www/apps/docs/content/references/services/classes/Store.mdx index 23fd710b65..88824504e9 100644 --- a/www/apps/docs/content/references/services/classes/Store.mdx +++ b/www/apps/docs/content/references/services/classes/Store.mdx @@ -75,7 +75,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "default_sales_channel_id", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The ID of the store's default sales channel.", "optional": false, "defaultValue": "", @@ -93,7 +93,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "invite_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Invite links from", "optional": false, "defaultValue": "", @@ -102,7 +102,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "metadata", - "type": "``null`` \\| `Record`", + "type": "`null` \\| `Record`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", @@ -120,7 +120,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "payment_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Payment links from. Use {{cart\\_id}} to include the payment's `cart\\_id` in the link.", "optional": false, "defaultValue": "", @@ -129,7 +129,7 @@ A store holds the main settings of the commerce shop. By default, only one store }, { "name": "swap_link_template", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "A template to generate Swap links from. Use {{cart\\_id}} to include the Swap's `cart\\_id` in the link.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/StoreService.mdx b/www/apps/docs/content/references/services/classes/StoreService.mdx index 7af1e5b847..bf90a053a9 100644 --- a/www/apps/docs/content/references/services/classes/StoreService.mdx +++ b/www/apps/docs/content/references/services/classes/StoreService.mdx @@ -391,7 +391,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx b/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx index 55658ace3f..c61ec34a95 100644 --- a/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx +++ b/www/apps/docs/content/references/services/classes/StrategyResolverService.mdx @@ -233,7 +233,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/Swap.mdx b/www/apps/docs/content/references/services/classes/Swap.mdx index 5dd72b2cd2..87bef51638 100644 --- a/www/apps/docs/content/references/services/classes/Swap.mdx +++ b/www/apps/docs/content/references/services/classes/Swap.mdx @@ -84,7 +84,7 @@ A swap can be created when a Customer wishes to exchange Products that they have }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/SwapService.mdx b/www/apps/docs/content/references/services/classes/SwapService.mdx index c4a183d7cc..094c2ef11c 100644 --- a/www/apps/docs/content/references/services/classes/SwapService.mdx +++ b/www/apps/docs/content/references/services/classes/SwapService.mdx @@ -318,7 +318,7 @@ EntityManager ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", @@ -1200,7 +1200,7 @@ ___ ### transformQueryForCart -`Protected **transformQueryForCart**(config): [Omit](../types/Omit.mdx)<[FindConfig](../interfaces/FindConfig.mdx)<[Swap](Swap.mdx)>, `"select"`> & { select?: string[] } & { cartRelations: undefined \| string[] ; cartSelects: undefined \| keyof [Cart](Cart.mdx)[] }` +`Protected **transformQueryForCart**(config): [Omit](../types/Omit.mdx)<[FindConfig](../interfaces/FindConfig.mdx)<[Swap](Swap.mdx)>, "select"> & { select?: string[] } & { cartRelations: undefined \| string[] ; cartSelects: undefined \| keyof [Cart](Cart.mdx)[] }` Transform find config object for retrieval. @@ -1209,7 +1209,7 @@ Transform find config object for retrieval. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/TaxLine.mdx b/www/apps/docs/content/references/services/classes/TaxLine.mdx index 081da8a73a..dbeea4ee44 100644 --- a/www/apps/docs/content/references/services/classes/TaxLine.mdx +++ b/www/apps/docs/content/references/services/classes/TaxLine.mdx @@ -21,7 +21,7 @@ A tax line represents the taxes amount applied to a line item. ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/TaxRate.mdx b/www/apps/docs/content/references/services/classes/TaxRate.mdx index 4d07ea8eb9..45344f68a4 100644 --- a/www/apps/docs/content/references/services/classes/TaxRate.mdx +++ b/www/apps/docs/content/references/services/classes/TaxRate.mdx @@ -21,7 +21,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products, ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/TotalsService.mdx b/www/apps/docs/content/references/services/classes/TotalsService.mdx index 544403dcbb..836950ebff 100644 --- a/www/apps/docs/content/references/services/classes/TotalsService.mdx +++ b/www/apps/docs/content/references/services/classes/TotalsService.mdx @@ -1239,7 +1239,7 @@ ___ ### getTaxTotal -`**getTaxTotal**(cartOrOrder, forceTaxes?): Promise<`null` \| number>` +`**getTaxTotal**(cartOrOrder, forceTaxes?): Promise<null \| number>` Calculates tax total Currently based on the Danish tax system @@ -1269,12 +1269,12 @@ Currently based on the Danish tax system #### Returns -Promise<`null` \| number> +Promise<null \| number> ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/TrackingLink.mdx b/www/apps/docs/content/references/services/classes/TrackingLink.mdx index 6e85c70bb3..15d2b639d1 100644 --- a/www/apps/docs/content/references/services/classes/TrackingLink.mdx +++ b/www/apps/docs/content/references/services/classes/TrackingLink.mdx @@ -30,7 +30,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx b/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx index 8a6bf5f078..b38ed2f874 100644 --- a/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx +++ b/www/apps/docs/content/references/services/classes/TransactionBaseService.mdx @@ -206,7 +206,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/User.mdx b/www/apps/docs/content/references/services/classes/User.mdx index 154a695020..1bd5b71b3e 100644 --- a/www/apps/docs/content/references/services/classes/User.mdx +++ b/www/apps/docs/content/references/services/classes/User.mdx @@ -39,7 +39,7 @@ A User is an administrator who can manage store settings and data. }, { "name": "deleted_at", - "type": "``null`` \\| `Date`", + "type": "`null` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/classes/UserService.mdx b/www/apps/docs/content/references/services/classes/UserService.mdx index 5403996849..fb72e0aed0 100644 --- a/www/apps/docs/content/references/services/classes/UserService.mdx +++ b/www/apps/docs/content/references/services/classes/UserService.mdx @@ -675,7 +675,7 @@ ___ ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/enums/PriceListStatus-1.mdx b/www/apps/docs/content/references/services/enums/PriceListStatus-1.mdx new file mode 100644 index 0000000000..0e117081f7 --- /dev/null +++ b/www/apps/docs/content/references/services/enums/PriceListStatus-1.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListStatus + +The status of a price list. + +## Enumeration Members + +### ACTIVE + + **ACTIVE** = `"active"` + +The price list is active, meaning its prices are applied to customers. + +___ + +### DRAFT + + **DRAFT** = `"draft"` + +The price list is a draft, meaning its not yet applied to customers. diff --git a/www/apps/docs/content/references/services/enums/PriceListStatus-2.mdx b/www/apps/docs/content/references/services/enums/PriceListStatus-2.mdx new file mode 100644 index 0000000000..02ce053c8d --- /dev/null +++ b/www/apps/docs/content/references/services/enums/PriceListStatus-2.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListStatus + +The price list's status. + +## Enumeration Members + +### ACTIVE + + **ACTIVE** = `"active"` + +The price list is enabled and its prices can be used. + +___ + +### DRAFT + + **DRAFT** = `"draft"` + +The price list is disabled, meaning its prices can't be used yet. diff --git a/www/apps/docs/content/references/services/enums/PriceListStatus.mdx b/www/apps/docs/content/references/services/enums/PriceListStatus.mdx index 0e117081f7..1b1db889a2 100644 --- a/www/apps/docs/content/references/services/enums/PriceListStatus.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListStatus.mdx @@ -6,20 +6,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PriceListStatus -The status of a price list. - ## Enumeration Members ### ACTIVE **ACTIVE** = `"active"` -The price list is active, meaning its prices are applied to customers. - ___ ### DRAFT **DRAFT** = `"draft"` - -The price list is a draft, meaning its not yet applied to customers. diff --git a/www/apps/docs/content/references/services/enums/PriceListType-1.mdx b/www/apps/docs/content/references/services/enums/PriceListType-1.mdx new file mode 100644 index 0000000000..7a4d7b7aea --- /dev/null +++ b/www/apps/docs/content/references/services/enums/PriceListType-1.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListType + +The type of price list. + +## Enumeration Members + +### OVERRIDE + + **OVERRIDE** = `"override"` + +The price list is used to override original prices for specific conditions. + +___ + +### SALE + + **SALE** = `"sale"` + +The price list is used for a sale. diff --git a/www/apps/docs/content/references/services/enums/PriceListType-2.mdx b/www/apps/docs/content/references/services/enums/PriceListType-2.mdx new file mode 100644 index 0000000000..dd2976d8d6 --- /dev/null +++ b/www/apps/docs/content/references/services/enums/PriceListType-2.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListType + +The price list's type. + +## Enumeration Members + +### OVERRIDE + + **OVERRIDE** = `"override"` + +The price list's prices override original prices. This affects the calculated price of associated price sets. + +___ + +### SALE + + **SALE** = `"sale"` + +The price list's prices are used for a sale. diff --git a/www/apps/docs/content/references/services/enums/PriceListType.mdx b/www/apps/docs/content/references/services/enums/PriceListType.mdx index 7a4d7b7aea..ba777803f1 100644 --- a/www/apps/docs/content/references/services/enums/PriceListType.mdx +++ b/www/apps/docs/content/references/services/enums/PriceListType.mdx @@ -6,20 +6,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # PriceListType -The type of price list. - ## Enumeration Members ### OVERRIDE **OVERRIDE** = `"override"` -The price list is used to override original prices for specific conditions. - ___ ### SALE **SALE** = `"sale"` - -The price list is used for a sale. diff --git a/www/apps/docs/content/references/services/index.md b/www/apps/docs/content/references/services/index.md index 5145d1bb3c..3f62f82c94 100644 --- a/www/apps/docs/content/references/services/index.md +++ b/www/apps/docs/content/references/services/index.md @@ -38,7 +38,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [PaymentStatus](enums/PaymentStatus.mdx) - [PaymentStatus](enums/PaymentStatus-1.mdx) - [PriceListStatus](enums/PriceListStatus.mdx) +- [PriceListStatus](enums/PriceListStatus-1.mdx) +- [PriceListStatus](enums/PriceListStatus-2.mdx) - [PriceListType](enums/PriceListType.mdx) +- [PriceListType](enums/PriceListType-1.mdx) +- [PriceListType](enums/PriceListType-2.mdx) - [ProductStatus](enums/ProductStatus.mdx) - [RequirementType](enums/RequirementType.mdx) - [ReturnStatus](enums/ReturnStatus.mdx) @@ -218,6 +222,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Interfaces +- [AddPriceListPricesDTO](interfaces/AddPriceListPricesDTO.mdx) - [AddPricesDTO](interfaces/AddPricesDTO.mdx) - [AddRulesDTO](interfaces/AddRulesDTO.mdx) - [ArrayLike](interfaces/ArrayLike.mdx) @@ -225,25 +230,38 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [Boolean](interfaces/Boolean.mdx) - [Buffer](interfaces/Buffer.mdx) - [BufferConstructor](interfaces/BufferConstructor.mdx) +- [BulkUpdateInventoryLevelInput](interfaces/BulkUpdateInventoryLevelInput.mdx) - [CalculatedPriceSetDTO](interfaces/CalculatedPriceSetDTO.mdx) - [Context](interfaces/Context.mdx) - [CreateCurrencyDTO](interfaces/CreateCurrencyDTO.mdx) +- [CreateInventoryItemInput](interfaces/CreateInventoryItemInput.mdx) +- [CreateInventoryLevelInput](interfaces/CreateInventoryLevelInput.mdx) - [CreateMoneyAmountDTO](interfaces/CreateMoneyAmountDTO.mdx) - [CreateNoteInput](interfaces/CreateNoteInput.mdx) +- [CreatePriceListDTO](interfaces/CreatePriceListDTO.mdx) +- [CreatePriceListRuleDTO](interfaces/CreatePriceListRuleDTO.mdx) +- [CreatePriceListRules](interfaces/CreatePriceListRules.mdx) - [CreatePriceRuleDTO](interfaces/CreatePriceRuleDTO.mdx) - [CreatePriceSetDTO](interfaces/CreatePriceSetDTO.mdx) - [CreatePriceSetMoneyAmountRulesDTO](interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx) - [CreatePricesDTO](interfaces/CreatePricesDTO.mdx) +- [CreateReservationItemInput](interfaces/CreateReservationItemInput.mdx) - [CreateRuleTypeDTO](interfaces/CreateRuleTypeDTO.mdx) - [CreateUserInput](interfaces/CreateUserInput.mdx) - [CurrencyDTO](interfaces/CurrencyDTO.mdx) - [FilterableCurrencyProps](interfaces/FilterableCurrencyProps.mdx) +- [FilterableInventoryItemProps](interfaces/FilterableInventoryItemProps.mdx) +- [FilterableInventoryLevelProps](interfaces/FilterableInventoryLevelProps.mdx) - [FilterableMoneyAmountProps](interfaces/FilterableMoneyAmountProps.mdx) +- [FilterablePriceListProps](interfaces/FilterablePriceListProps-1.mdx) +- [FilterablePriceListRuleProps](interfaces/FilterablePriceListRuleProps.mdx) - [FilterablePriceRuleProps](interfaces/FilterablePriceRuleProps.mdx) - [FilterablePriceSetMoneyAmountProps](interfaces/FilterablePriceSetMoneyAmountProps.mdx) - [FilterablePriceSetMoneyAmountRulesProps](interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) - [FilterablePriceSetProps](interfaces/FilterablePriceSetProps.mdx) +- [FilterableReservationItemProps](interfaces/FilterableReservationItemProps.mdx) - [FilterableRuleTypeProps](interfaces/FilterableRuleTypeProps.mdx) +- [FilterableStockLocationProps](interfaces/FilterableStockLocationProps.mdx) - [FindConfig](interfaces/FindConfig.mdx) - [FindConfig](interfaces/FindConfig-1.mdx) - [IBatchJobStrategy](interfaces/IBatchJobStrategy.mdx) @@ -273,6 +291,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [NumericalComparisonOperator](interfaces/NumericalComparisonOperator-1.mdx) - [PaymentProcessor](interfaces/PaymentProcessor.mdx) - [PaymentProcessorError](interfaces/PaymentProcessorError.mdx) +- [PriceListDTO](interfaces/PriceListDTO.mdx) +- [PriceListPriceDTO](interfaces/PriceListPriceDTO.mdx) +- [PriceListRuleDTO](interfaces/PriceListRuleDTO.mdx) +- [PriceListRuleValueDTO](interfaces/PriceListRuleValueDTO.mdx) - [PriceRuleDTO](interfaces/PriceRuleDTO.mdx) - [PriceSetDTO](interfaces/PriceSetDTO.mdx) - [PriceSetMoneyAmountDTO](interfaces/PriceSetMoneyAmountDTO.mdx) @@ -280,16 +302,23 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [PricingContext](interfaces/PricingContext.mdx) - [PricingFilters](interfaces/PricingFilters.mdx) - [RemoteJoinerQuery](interfaces/RemoteJoinerQuery.mdx) +- [RemovePriceListRulesDTO](interfaces/RemovePriceListRulesDTO.mdx) - [RemovePriceSetRulesDTO](interfaces/RemovePriceSetRulesDTO.mdx) - [RuleTypeDTO](interfaces/RuleTypeDTO.mdx) +- [SetPriceListRulesDTO](interfaces/SetPriceListRulesDTO.mdx) - [SharedArrayBuffer](interfaces/SharedArrayBuffer.mdx) - [SharedArrayBufferConstructor](interfaces/SharedArrayBufferConstructor.mdx) +- [SharedContext](interfaces/SharedContext.mdx) - [StringComparisonOperator](interfaces/StringComparisonOperator-1.mdx) - [UpdateCurrencyDTO](interfaces/UpdateCurrencyDTO.mdx) +- [UpdateInventoryLevelInput](interfaces/UpdateInventoryLevelInput.mdx) - [UpdateMoneyAmountDTO](interfaces/UpdateMoneyAmountDTO.mdx) +- [UpdatePriceListDTO](interfaces/UpdatePriceListDTO.mdx) +- [UpdatePriceListRuleDTO](interfaces/UpdatePriceListRuleDTO.mdx) - [UpdatePriceRuleDTO](interfaces/UpdatePriceRuleDTO.mdx) - [UpdatePriceSetDTO](interfaces/UpdatePriceSetDTO.mdx) - [UpdatePriceSetMoneyAmountRulesDTO](interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx) +- [UpdateReservationItemInput](interfaces/UpdateReservationItemInput.mdx) - [UpdateRuleTypeDTO](interfaces/UpdateRuleTypeDTO.mdx) - [UpdateUserInput](interfaces/UpdateUserInput.mdx) @@ -331,8 +360,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [CreateGiftCardInput](types/CreateGiftCardInput.mdx) - [CreateGiftCardTransactionInput](types/CreateGiftCardTransactionInput.mdx) - [CreateIdempotencyKeyInput](types/CreateIdempotencyKeyInput.mdx) -- [CreateInventoryItemInput](types/CreateInventoryItemInput.mdx) -- [CreateInventoryLevelInput](types/CreateInventoryLevelInput.mdx) - [CreateOauthInput](types/CreateOauthInput.mdx) - [CreateOrderEditInput](types/CreateOrderEditInput.mdx) - [CreateOrderEditItemChangeInput](types/CreateOrderEditItemChangeInput.mdx) @@ -351,7 +378,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [CreateProductProductVariantPriceInput](types/CreateProductProductVariantPriceInput.mdx) - [CreateProductVariantInput](types/CreateProductVariantInput.mdx) - [CreateRegionInput](types/CreateRegionInput.mdx) -- [CreateReservationItemInput](types/CreateReservationItemInput.mdx) - [CreateReturnInput](types/CreateReturnInput.mdx) - [CreateReturnReason](types/CreateReturnReason.mdx) - [CreateReturnType](types/CreateReturnType.mdx) @@ -378,10 +404,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [ExtendedFindConfig](types/ExtendedFindConfig-1.mdx) - [ExternalModuleDeclaration](types/ExternalModuleDeclaration.mdx) - [FeatureFlagsResponse](types/FeatureFlagsResponse.mdx) -- [FilterableInventoryItemProps](types/FilterableInventoryItemProps.mdx) -- [FilterableInventoryLevelProps](types/FilterableInventoryLevelProps.mdx) -- [FilterableReservationItemProps](types/FilterableReservationItemProps.mdx) -- [FilterableStockLocationProps](types/FilterableStockLocationProps.mdx) - [FilterableTaxRateProps](types/FilterableTaxRateProps.mdx) - [FilterableUserProps](types/FilterableUserProps.mdx) - [FindProductConfig](types/FindProductConfig.mdx) @@ -517,7 +539,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [ReturnedData](types/ReturnedData.mdx) - [Selector](types/Selector.mdx) - [SessionOptions](types/SessionOptions.mdx) -- [SharedContext](types/SharedContext.mdx) - [ShippingMethod](types/ShippingMethod-1.mdx) - [ShippingMethodTotals](types/ShippingMethodTotals.mdx) - [ShippingMethodTotals](types/ShippingMethodTotals-1.mdx) @@ -555,7 +576,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [UpdateDiscountInput](types/UpdateDiscountInput.mdx) - [UpdateDiscountRuleInput](types/UpdateDiscountRuleInput.mdx) - [UpdateGiftCardInput](types/UpdateGiftCardInput.mdx) -- [UpdateInventoryLevelInput](types/UpdateInventoryLevelInput.mdx) - [UpdateOauthInput](types/UpdateOauthInput.mdx) - [UpdateOrderInput](types/UpdateOrderInput.mdx) - [UpdatePriceListInput](types/UpdatePriceListInput.mdx) @@ -566,7 +586,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [UpdateProductVariantData](types/UpdateProductVariantData.mdx) - [UpdateProductVariantInput](types/UpdateProductVariantInput.mdx) - [UpdateRegionInput](types/UpdateRegionInput.mdx) -- [UpdateReservationItemInput](types/UpdateReservationItemInput.mdx) - [UpdateReturnInput](types/UpdateReturnInput.mdx) - [UpdateReturnReason](types/UpdateReturnReason.mdx) - [UpdateShippingOptionInput](types/UpdateShippingOptionInput.mdx) @@ -639,7 +658,7 @@ ___ ### CartRepository - `Const` **CartRepository**: Repository<[Cart](classes/Cart.mdx)> & { findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations } + `Const` **CartRepository**: Repository<[Cart](classes/Cart.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`` ___ @@ -669,19 +688,19 @@ ___ ### CustomerGroupRepository - `Const` **CustomerGroupRepository**: Repository<[CustomerGroup](classes/CustomerGroup.mdx)> & { addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers } + `Const` **CustomerGroupRepository**: Repository<[CustomerGroup](classes/CustomerGroup.mdx)> & ``{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }`` ___ ### CustomerRepository - `Const` **CustomerRepository**: Repository<[Customer](classes/Customer.mdx)> & { listAndCount: Method listAndCount } + `Const` **CustomerRepository**: Repository<[Customer](classes/Customer.mdx)> & ``{ listAndCount: Method listAndCount }`` ___ ### DiscountConditionRepository - `Const` **DiscountConditionRepository**: Repository<[DiscountCondition](classes/DiscountCondition.mdx)> & { addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources } + `Const` **DiscountConditionRepository**: Repository<[DiscountCondition](classes/DiscountCondition.mdx)> & ``{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }`` ___ @@ -705,7 +724,7 @@ ___ ### GiftCardRepository - `Const` **GiftCardRepository**: Repository<[GiftCard](classes/GiftCard.mdx)> & { listGiftCardsAndCount: Method listGiftCardsAndCount } + `Const` **GiftCardRepository**: Repository<[GiftCard](classes/GiftCard.mdx)> & ``{ listGiftCardsAndCount: Method listGiftCardsAndCount }`` ___ @@ -723,7 +742,7 @@ ___ ### ImageRepository - `Const` **ImageRepository**: Repository<[Image](classes/Image.mdx)> & { insertBulk: Method insertBulk ; upsertImages: Method upsertImages } + `Const` **ImageRepository**: Repository<[Image](classes/Image.mdx)> & ``{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }`` ___ @@ -735,19 +754,19 @@ ___ ### LineItemRepository - `Const` **LineItemRepository**: Repository<[LineItem](classes/LineItem.mdx)> & { findByReturn: Method findByReturn } + `Const` **LineItemRepository**: Repository<[LineItem](classes/LineItem.mdx)> & ``{ findByReturn: Method findByReturn }`` ___ ### LineItemTaxLineRepository - `Const` **LineItemTaxLineRepository**: Repository<[LineItemTaxLine](classes/LineItemTaxLine.mdx)> & { deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines } + `Const` **LineItemTaxLineRepository**: Repository<[LineItemTaxLine](classes/LineItemTaxLine.mdx)> & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }`` ___ ### MoneyAmountRepository - `Const` **MoneyAmountRepository**: Repository<[MoneyAmount](classes/MoneyAmount.mdx)> & { addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice } + `Const` **MoneyAmountRepository**: Repository<[MoneyAmount](classes/MoneyAmount.mdx)> & ``{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }`` ___ @@ -789,13 +808,13 @@ ___ ### OrderRepository - `Const` **OrderRepository**: Repository<[Order](classes/Order.mdx)> & { findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations } + `Const` **OrderRepository**: Repository<[Order](classes/Order.mdx)> & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }`` ___ ### PaymentCollectionRepository - `Const` **PaymentCollectionRepository**: Repository<[PaymentCollection](classes/PaymentCollection.mdx)> & { getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId } + `Const` **PaymentCollectionRepository**: Repository<[PaymentCollection](classes/PaymentCollection.mdx)> & ``{ getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId }`` ___ @@ -819,7 +838,7 @@ ___ ### PriceListRepository - `Const` **PriceListRepository**: Repository<[PriceList](classes/PriceList.mdx)> & { listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap } + `Const` **PriceListRepository**: Repository<[PriceList](classes/PriceList.mdx)> & ``{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }`` ___ @@ -841,7 +860,7 @@ ___ }, { "name": "OVERRIDE", - "type": "[OVERRIDE](enums/PriceListType.mdx#override)", + "type": "[OVERRIDE](enums/PriceListType-1.mdx#override)", "description": "", "optional": false, "defaultValue": "\"override\"", @@ -850,7 +869,7 @@ ___ }, { "name": "SALE", - "type": "[SALE](enums/PriceListType.mdx#sale)", + "type": "[SALE](enums/PriceListType-1.mdx#sale)", "description": "", "optional": false, "defaultValue": "\"sale\"", @@ -863,13 +882,13 @@ ___ ### ProductCategoryRepository - `Const` **ProductCategoryRepository**: TreeRepository<[ProductCategory](classes/ProductCategory.mdx)> & { addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts } + `Const` **ProductCategoryRepository**: TreeRepository<[ProductCategory](classes/ProductCategory.mdx)> & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }`` ___ ### ProductCollectionRepository - `Const` **ProductCollectionRepository**: Repository<[ProductCollection](classes/ProductCollection.mdx)> & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId } + `Const` **ProductCollectionRepository**: Repository<[ProductCollection](classes/ProductCollection.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }`` ___ @@ -881,19 +900,19 @@ ___ ### ProductRepository - `Const` **ProductRepository**: Repository<[Product](classes/Product.mdx)> & { _applyCategoriesQuery: Method \_applyCategoriesQuery ; _findWithRelations: Method \_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds } + `Const` **ProductRepository**: Repository<[Product](classes/Product.mdx)> & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }`` ___ ### ProductTagRepository - `Const` **ProductTagRepository**: Repository<[ProductTag](classes/ProductTag.mdx)> & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags } + `Const` **ProductTagRepository**: Repository<[ProductTag](classes/ProductTag.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }`` ___ ### ProductTypeRepository - `Const` **ProductTypeRepository**: Repository<[ProductType](classes/ProductType.mdx)> & { findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType } + `Const` **ProductTypeRepository**: Repository<[ProductType](classes/ProductType.mdx)> & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }`` ___ @@ -935,7 +954,7 @@ ___ ### SalesChannelRepository - `Const` **SalesChannelRepository**: Repository<[SalesChannel](classes/SalesChannel.mdx)> & { addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts } + `Const` **SalesChannelRepository**: Repository<[SalesChannel](classes/SalesChannel.mdx)> & ``{ addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }`` ___ @@ -953,7 +972,7 @@ ___ ### ShippingOptionRepository - `Const` **ShippingOptionRepository**: Repository<[ShippingOption](classes/ShippingOption.mdx)> & { upsertShippingProfile: Method upsertShippingProfile } + `Const` **ShippingOptionRepository**: Repository<[ShippingOption](classes/ShippingOption.mdx)> & ``{ upsertShippingProfile: Method upsertShippingProfile }`` ___ @@ -965,13 +984,13 @@ ___ ### ShippingProfileRepository - `Const` **ShippingProfileRepository**: Repository<[ShippingProfile](classes/ShippingProfile.mdx)> & { findByProducts: Method findByProducts } + `Const` **ShippingProfileRepository**: Repository<[ShippingProfile](classes/ShippingProfile.mdx)> & ``{ findByProducts: Method findByProducts }`` ___ ### StagedJobRepository - `Const` **StagedJobRepository**: Repository<[StagedJob](classes/StagedJob.mdx)> & { insertBulk: Method insertBulk } + `Const` **StagedJobRepository**: Repository<[StagedJob](classes/StagedJob.mdx)> & ``{ insertBulk: Method insertBulk }`` ___ diff --git a/www/apps/docs/content/references/services/interfaces/AddPriceListPricesDTO.mdx b/www/apps/docs/content/references/services/interfaces/AddPriceListPricesDTO.mdx new file mode 100644 index 0000000000..1aac7759f6 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/AddPriceListPricesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AddPriceListPricesDTO + +The prices to be added to a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/AddRulesDTO.mdx b/www/apps/docs/content/references/services/interfaces/AddRulesDTO.mdx index bcd929c160..4a94d70289 100644 --- a/www/apps/docs/content/references/services/interfaces/AddRulesDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/AddRulesDTO.mdx @@ -22,8 +22,8 @@ The rules to add to a price set. }, { "name": "rules", - "type": "`{ attribute: string }`[]", - "description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ attribute: string }``[]", + "description": "The rules to add to a price set.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/Buffer.mdx b/www/apps/docs/content/references/services/interfaces/Buffer.mdx index b3a96fa122..573e7f0dd3 100644 --- a/www/apps/docs/content/references/services/interfaces/Buffer.mdx +++ b/www/apps/docs/content/references/services/interfaces/Buffer.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"Uint8Array\"``", + "type": "`\"Uint8Array\"`", "description": "", "optional": false, "defaultValue": "", @@ -129,7 +129,7 @@ ___ ### compare -`**compare**(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): `0` \| `1` \| `-1`` +`**compare**(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): 0 \| 1 \| -1` Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order. Comparison is based on the actual sequence of bytes in each `Buffer`. @@ -230,12 +230,12 @@ console.log(buf1.compare(buf2, 5, 6, 5)); #### Returns -``0`` \| ``1`` \| ``-1`` +`0` \| `1` \| `-1` diff --git a/www/apps/docs/content/references/services/interfaces/Context.mdx b/www/apps/docs/content/references/services/interfaces/Context.mdx index 6cd7e8ae75..0acfa56922 100644 --- a/www/apps/docs/content/references/services/interfaces/Context.mdx +++ b/www/apps/docs/content/references/services/interfaces/Context.mdx @@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Context -The interface tag is used to ensure that the type is documented similar to interfaces. - A shared context object that is used to share resources between the application and the module. ## Type parameters diff --git a/www/apps/docs/content/references/services/types/CreateInventoryItemInput.mdx b/www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx similarity index 60% rename from www/apps/docs/content/references/services/types/CreateInventoryItemInput.mdx rename to www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx index 610e6cd88f..08c89f0993 100644 --- a/www/apps/docs/content/references/services/types/CreateInventoryItemInput.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx @@ -6,15 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreateInventoryItemInput - **CreateInventoryItemInput**: `Object` +The details of the inventory item to be created. -### Type declaration +## Properties ` \\| ``null``", - "description": "", + "type": "`null` \\| `Record`", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -67,8 +67,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "mid_code", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The MID code of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -76,8 +76,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "origin_country", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The origin country of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -94,8 +94,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "sku", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The SKU of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -103,8 +103,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "thumbnail", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The thumbnail of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -112,8 +112,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "title", - "type": "`string` \\| ``null``", - "description": "", + "type": "`null` \\| `string`", + "description": "The title of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -121,8 +121,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "weight", - "type": "`number` \\| ``null``", - "description": "", + "type": "`null` \\| `number`", + "description": "The weight of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, @@ -130,8 +130,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "width", - "type": "`number` \\| ``null``", - "description": "", + "type": "`null` \\| `number`", + "description": "The width of the inventory item.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/CreateInventoryLevelInput.mdx b/www/apps/docs/content/references/services/interfaces/CreateInventoryLevelInput.mdx new file mode 100644 index 0000000000..7d3207d6e2 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/CreateInventoryLevelInput.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreateInventoryLevelInput + +The details of the inventory level to be created. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/CreateMoneyAmountDTO.mdx b/www/apps/docs/content/references/services/interfaces/CreateMoneyAmountDTO.mdx index fc4da4a664..13de2d639f 100644 --- a/www/apps/docs/content/references/services/interfaces/CreateMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreateMoneyAmountDTO.mdx @@ -15,7 +15,7 @@ The money amount to create. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -49,7 +49,7 @@ The money amount to create. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -58,7 +58,7 @@ The money amount to create. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/interfaces/CreatePriceListDTO.mdx b/www/apps/docs/content/references/services/interfaces/CreatePriceListDTO.mdx new file mode 100644 index 0000000000..7c5f754be2 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/CreatePriceListDTO.mdx @@ -0,0 +1,95 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListDTO + +The price list to create. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/CreatePriceListRuleDTO.mdx b/www/apps/docs/content/references/services/interfaces/CreatePriceListRuleDTO.mdx new file mode 100644 index 0000000000..94786139ea --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/CreatePriceListRuleDTO.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRuleDTO + +The price list rule to create. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx b/www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx new file mode 100644 index 0000000000..6369db3cf9 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/CreatePriceListRules.mdx @@ -0,0 +1,10 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRules + +The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value + * is the values of the rule. diff --git a/www/apps/docs/content/references/services/interfaces/CreatePriceRuleDTO.mdx b/www/apps/docs/content/references/services/interfaces/CreatePriceRuleDTO.mdx index cf3cc8befd..c33528c768 100644 --- a/www/apps/docs/content/references/services/interfaces/CreatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreatePriceRuleDTO.mdx @@ -20,15 +20,6 @@ A price rule to create. "expandable": false, "children": [] }, - { - "name": "price_list_id", - "type": "`string`", - "description": "The ID of the associated price list.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "price_set_id", "type": "`string`", @@ -41,7 +32,7 @@ A price rule to create. { "name": "price_set_money_amount_id", "type": "`string`", - "description": "The ID of the associated price set money amount.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -50,7 +41,7 @@ A price rule to create. { "name": "priority", "type": "`number`", - "description": "The priority of the price rule in comparison to other applicable price rules.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/CreatePriceSetDTO.mdx b/www/apps/docs/content/references/services/interfaces/CreatePriceSetDTO.mdx index e287e6858b..45cf421958 100644 --- a/www/apps/docs/content/references/services/interfaces/CreatePriceSetDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreatePriceSetDTO.mdx @@ -22,8 +22,8 @@ A price set to create. }, { "name": "rules", - "type": "`{ rule_attribute: string }`[]", - "description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ rule_attribute: string }``[]", + "description": "The rules to associate with the price set.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/CreatePricesDTO.mdx b/www/apps/docs/content/references/services/interfaces/CreatePricesDTO.mdx index 37dc3d59e4..df508bc746 100644 --- a/www/apps/docs/content/references/services/interfaces/CreatePricesDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreatePricesDTO.mdx @@ -15,7 +15,7 @@ The prices to create part of a price set. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -49,7 +49,7 @@ The prices to create part of a price set. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -58,7 +58,7 @@ The prices to create part of a price set. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/CreateReservationItemInput.mdx b/www/apps/docs/content/references/services/interfaces/CreateReservationItemInput.mdx similarity index 66% rename from www/apps/docs/content/references/services/types/CreateReservationItemInput.mdx rename to www/apps/docs/content/references/services/interfaces/CreateReservationItemInput.mdx index 8dd9d1a507..69d98679d0 100644 --- a/www/apps/docs/content/references/services/types/CreateReservationItemInput.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreateReservationItemInput.mdx @@ -6,15 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreateReservationItemInput - **CreateReservationItemInput**: `Object` +The details of the reservation item to be created. -### Type declaration +## Properties ` \\| ``null``", - "description": "", + "type": "`null` \\| `Record`", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -77,7 +77,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" { "name": "quantity", "type": "`number`", - "description": "", + "description": "The reserved quantity.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/types/FilterableInventoryItemProps.mdx b/www/apps/docs/content/references/services/interfaces/FilterableInventoryItemProps.mdx similarity index 67% rename from www/apps/docs/content/references/services/types/FilterableInventoryItemProps.mdx rename to www/apps/docs/content/references/services/interfaces/FilterableInventoryItemProps.mdx index d5c63d3f3d..2af278f47e 100644 --- a/www/apps/docs/content/references/services/types/FilterableInventoryItemProps.mdx +++ b/www/apps/docs/content/references/services/interfaces/FilterableInventoryItemProps.mdx @@ -6,15 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterableInventoryItemProps - **FilterableInventoryItemProps**: `Object` +The filters to apply on retrieved inventory items. -### Type declaration +## Properties diff --git a/www/apps/docs/content/references/services/interfaces/FilterablePriceListRuleProps.mdx b/www/apps/docs/content/references/services/interfaces/FilterablePriceListRuleProps.mdx new file mode 100644 index 0000000000..45012a3c7a --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/FilterablePriceListRuleProps.mdx @@ -0,0 +1,68 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterablePriceListRuleProps + +Filters to apply on price list rules. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/FilterablePriceRuleProps.mdx b/www/apps/docs/content/references/services/interfaces/FilterablePriceRuleProps.mdx index d47924fb30..1a27272442 100644 --- a/www/apps/docs/content/references/services/interfaces/FilterablePriceRuleProps.mdx +++ b/www/apps/docs/content/references/services/interfaces/FilterablePriceRuleProps.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterablePriceRuleProps -Filters to apply to price rules. +Filters to apply on price rules. ## Properties diff --git a/www/apps/docs/content/references/services/interfaces/FilterablePriceSetMoneyAmountProps.mdx b/www/apps/docs/content/references/services/interfaces/FilterablePriceSetMoneyAmountProps.mdx index 4f2911a353..79ae7ec109 100644 --- a/www/apps/docs/content/references/services/interfaces/FilterablePriceSetMoneyAmountProps.mdx +++ b/www/apps/docs/content/references/services/interfaces/FilterablePriceSetMoneyAmountProps.mdx @@ -38,6 +38,15 @@ Filters to apply on price set money amounts. "expandable": false, "children": [] }, + { + "name": "price_list_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount's associated price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "price_set_id", "type": "`string`[]", diff --git a/www/apps/docs/content/references/services/types/FilterableReservationItemProps.mdx b/www/apps/docs/content/references/services/interfaces/FilterableReservationItemProps.mdx similarity index 59% rename from www/apps/docs/content/references/services/types/FilterableReservationItemProps.mdx rename to www/apps/docs/content/references/services/interfaces/FilterableReservationItemProps.mdx index 89e0b2f413..3fe8239f38 100644 --- a/www/apps/docs/content/references/services/types/FilterableReservationItemProps.mdx +++ b/www/apps/docs/content/references/services/interfaces/FilterableReservationItemProps.mdx @@ -6,15 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterableReservationItemProps - **FilterableReservationItemProps**: `Object` +The filters to apply on retrieved reservation items. -### Type declaration +## Properties ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/interfaces/ICacheService.mdx b/www/apps/docs/content/references/services/interfaces/ICacheService.mdx index c2119f22d2..d08715d8fd 100644 --- a/www/apps/docs/content/references/services/interfaces/ICacheService.mdx +++ b/www/apps/docs/content/references/services/interfaces/ICacheService.mdx @@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### get -`**get**(key): Promise<`null` \| T>` +`**get**(key): Promise<null \| T>` - -___ - ### adjustInventory `**adjustInventory**(inventoryItemId, locationId, adjustment, context?): Promise<[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)>` +This method is used to adjust the inventory level's stocked quantity. The inventory level is identified by the IDs of its associated inventory item and location. + +#### Example + +```ts +import { + initialize as initializeInventoryModule, +} from "@medusajs/inventory" + +async function adjustInventory ( + inventoryItemId: string, + locationId: string, + adjustment: number +) { + const inventoryModule = await initializeInventoryModule({}) + + const inventoryLevel = await inventoryModule.adjustInventory( + inventoryItemId, + locationId, + adjustment + ) + + // do something with the inventory level or return it. +} +``` + #### Parameters ` \\| `{ code: string }`", + "type": "`Record` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx b/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx index cb5f760ef7..7398c36935 100644 --- a/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx +++ b/www/apps/docs/content/references/services/interfaces/IPriceSelectionStrategy.mdx @@ -20,7 +20,7 @@ circumstances described in the context. + +#### Returns + +Promise<[PriceListDTO](PriceListDTO.mdx)[]> + + + +___ + ### addPrices `**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](PriceSetDTO.mdx)>` @@ -873,6 +943,140 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> ___ +### createPriceListRules + +`**createPriceListRules**(data, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]>` + +This method is used to create price list rules. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function createPriceListRules (items: { + rule_type_id: string + price_list_id: string +}[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.createPriceListRules(items) + + // do something with the price list rule or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> + + + +___ + +### createPriceLists + +`**createPriceLists**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)[]>` + +This method is used to create price lists. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function createPriceList (items: { + title: string + description: string + starts_at?: string + ends_at?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.createPriceLists(items) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListDTO](PriceListDTO.mdx)[]> + + + +___ + ### createPriceRules `**createPriceRules**(data, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]>` @@ -1271,6 +1475,128 @@ Promise<void> ___ +### deletePriceListRules + +`**deletePriceListRules**(priceListRuleIds, sharedContext?): Promise<void>` + +This method is used to delete price list rules. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function deletePriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + await pricingService.deletePriceListRules(priceListRuleIds) +} +``` + +#### Parameters + + + +#### Returns + +Promise<void> + + + +___ + +### deletePriceLists + +`**deletePriceLists**(priceListIds, sharedContext?): Promise<void>` + +This method is used to delete price lists. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function deletePriceLists (ids: string[]) { + const pricingService = await initializePricingModule() + + await pricingService.deletePriceLists(ids) +} +``` + +#### Parameters + + + +#### Returns + +Promise<void> + + + +___ + ### deletePriceRules `**deletePriceRules**(priceRuleIds, sharedContext?): Promise<void>` @@ -2060,6 +2386,322 @@ Promise<[[MoneyAmountDTO](MoneyAmountDTO.mdx)[], number]> ___ +### listAndCountPriceListRules + +`**listAndCountPriceListRules**(filters?, config?, sharedContext?): Promise<[[PriceListRuleDTO](PriceListRuleDTO.mdx)[], number]>` + +This method is used to retrieve a paginated list of price list ruless along with the total count of available price list ruless satisfying the provided filters. + +#### Example + +To retrieve a list of price list vs using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + ) + + // do something with the price list rules or return them +} +``` + +To specify relations that should be retrieved within the price list rules: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"] + } + ) + + // do something with the price list rules or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + $and: [ + { + id: priceListRuleIds + }, + { + rule_types: ruleTypeIDs + } + ] + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[[PriceListRuleDTO](PriceListRuleDTO.mdx)[], number]> + + + +___ + +### listAndCountPriceLists + +`**listAndCountPriceLists**(filters?, config?, sharedContext?): Promise<[[PriceListDTO](PriceListDTO.mdx)[], number]>` + +This method is used to retrieve a paginated list of price lists along with the total count of available price lists satisfying the provided filters. + +#### Example + +To retrieve a list of price lists using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + ) + + // do something with the price lists or return them +} +``` + +To specify relations that should be retrieved within the price lists: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price lists or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + $and: [ + { + id: priceListIds + }, + { + title: titles + } + ] + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[[PriceListDTO](PriceListDTO.mdx)[], number]> + + + +___ + ### listAndCountPriceRules `**listAndCountPriceRules**(filters?, config?, sharedContext?): Promise<[[PriceRuleDTO](PriceRuleDTO.mdx)[], number]>` @@ -2940,6 +3582,322 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> ___ +### listPriceListRules + +`**listPriceListRules**(filters?, config?, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]>` + +This method is used to retrieve a paginated list of price list rules based on optional filters and configuration. + +#### Example + +To retrieve a list of price list vs using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + ) + + // do something with the price list rules or return them +} +``` + +To specify relations that should be retrieved within the price list rules: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"] + } + ) + + // do something with the price list rules or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + $and: [ + { + id: priceListRuleIds + }, + { + rule_types: ruleTypeIDs + } + ] + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> + + + +___ + +### listPriceLists + +`**listPriceLists**(filters?, config?, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)[]>` + +This method is used to retrieve a paginated list of price lists based on optional filters and configuration. + +#### Example + +To retrieve a list of price lists using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + ) + + // do something with the price lists or return them +} +``` + +To specify relations that should be retrieved within the price lists: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price lists or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + $and: [ + { + id: priceListIds + }, + { + title: titles + } + ] + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListDTO](PriceListDTO.mdx)[]> + + + +___ + ### listPriceRules `**listPriceRules**(filters?, config?, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]>` @@ -3534,6 +4492,72 @@ Promise<[RuleTypeDTO](RuleTypeDTO.mdx)[]> ___ +### removePriceListRules + +`**removePriceListRules**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)>` + +This method is used to remove rules from a price list. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function setPriceListRules (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.removePriceListRules({ + priceListId, + rules: ["region_id"] + }) + + // do something with the price list or return it +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListDTO](PriceListDTO.mdx)> + + + +___ + ### removeRules `**removeRules**(data, sharedContext?): Promise<void>` @@ -3604,7 +4628,7 @@ ___ `**retrieve**(id, config?, sharedContext?): Promise<[PriceSetDTO](PriceSetDTO.mdx)>` -This method is used to retrieves a price set by its ID. +This method is used to retrieve a price set by its ID. #### Example @@ -3891,6 +4915,200 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)> ___ +### retrievePriceList + +`**retrievePriceList**(id, config?, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)>` + +This method is used to retrieve a price list by its ID. + +#### Example + +A simple example that retrieves a price list by its ID: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceList (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.retrievePriceList( + priceListId + ) + + // do something with the price list or return it +} +``` + +To specify relations that should be retrieved: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceList (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.retrievePriceList( + priceListId, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price list or return it +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListDTO](PriceListDTO.mdx)> + + + +___ + +### retrievePriceListRule + +`**retrievePriceListRule**(id, config?, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)>` + +This method is used to retrieve a price list rule by its ID. + +#### Example + +A simple example that retrieves a price list rule by its ID: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceListRule (priceListRuleId: string) { + const pricingService = await initializePricingModule() + + const priceListRule = await pricingService.retrievePriceListRule( + priceListRuleId + ) + + // do something with the price list rule or return it +} +``` + +To specify relations that should be retrieved: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceListRule (priceListRuleId: string) { + const pricingService = await initializePricingModule() + + const priceListRule = await pricingService.retrievePriceListRule( + priceListRuleId, + { + relations: ["price_list"] + } + ) + + // do something with the price list rule or return it +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)> + + + +___ + ### retrievePriceRule `**retrievePriceRule**(id, config?, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)>` @@ -4167,6 +5385,74 @@ Promise<[RuleTypeDTO](RuleTypeDTO.mdx)> ___ +### setPriceListRules + +`**setPriceListRules**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)>` + +This method is used to set the rules of a price list. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function setPriceListRules (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.setPriceListRules({ + priceListId, + rules: { + region_id: "US" + } + }) + + // do something with the price list or return it +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListDTO](PriceListDTO.mdx)> + + + +___ + ### updateCurrencies `**updateCurrencies**(data, sharedContext?): Promise<[CurrencyDTO](CurrencyDTO.mdx)[]>` @@ -4301,6 +5587,142 @@ Promise<[MoneyAmountDTO](MoneyAmountDTO.mdx)[]> ___ +### updatePriceListRules + +`**updatePriceListRules**(data, sharedContext?): Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]>` + +This method is used to update price list rules. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function updatePriceListRules (items: { + id: string + rule_type_id?: string + price_list_id?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.updatePriceListRules(items) + + // do something with the price list rule or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListRuleDTO](PriceListRuleDTO.mdx)[]> + + + +___ + +### updatePriceLists + +`**updatePriceLists**(data, sharedContext?): Promise<[PriceListDTO](PriceListDTO.mdx)[]>` + +This method is used to update price lists. + +#### Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function updatePriceLists (items: { + id: string + title: string + description: string + starts_at?: string + ends_at?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.updatePriceLists(items) + + // do something with the price lists or return them +} +``` + +#### Parameters + + + +#### Returns + +Promise<[PriceListDTO](PriceListDTO.mdx)[]> + + + +___ + ### updatePriceRules `**updatePriceRules**(data, sharedContext?): Promise<[PriceRuleDTO](PriceRuleDTO.mdx)[]>` diff --git a/www/apps/docs/content/references/services/interfaces/ISearchService.mdx b/www/apps/docs/content/references/services/interfaces/ISearchService.mdx index 0caf1b1484..67d7056c1b 100644 --- a/www/apps/docs/content/references/services/interfaces/ISearchService.mdx +++ b/www/apps/docs/content/references/services/interfaces/ISearchService.mdx @@ -324,7 +324,7 @@ Used to search for a document in an index }, { "name": "query", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "the search query", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx b/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx index 9d26cbd48b..78f08d379d 100644 --- a/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx +++ b/www/apps/docs/content/references/services/interfaces/IStockLocationService.mdx @@ -8,39 +8,37 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Methods -### \_\_joinerConfig - -`**__joinerConfig**(): [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)` - -#### Returns - -[ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx) - - - -___ - ### create `**create**(input, context?): Promise<[StockLocationDTO](../types/StockLocationDTO.mdx)>` +This method is used to create a stock location. + +#### Example + +```ts +import { + initialize as initializeStockLocationModule, +} from "@medusajs/stock-location" + +async function createStockLocation (name: string) { + const stockLocationModule = await initializeStockLocationModule({}) + + const stockLocation = await stockLocationModule.create({ + name + }) + + // do something with the stock location or return it +} +``` + #### Parameters diff --git a/www/apps/docs/content/references/services/interfaces/PriceListDTO.mdx b/www/apps/docs/content/references/services/interfaces/PriceListDTO.mdx new file mode 100644 index 0000000000..dc01953552 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/PriceListDTO.mdx @@ -0,0 +1,113 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListDTO + +A price list's details. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/PriceListPriceDTO.mdx b/www/apps/docs/content/references/services/interfaces/PriceListPriceDTO.mdx new file mode 100644 index 0000000000..339531ad50 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/PriceListPriceDTO.mdx @@ -0,0 +1,77 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListPriceDTO + +The prices associated with a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/PriceListRuleDTO.mdx b/www/apps/docs/content/references/services/interfaces/PriceListRuleDTO.mdx new file mode 100644 index 0000000000..84fd80a168 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/PriceListRuleDTO.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListRuleDTO + +The price list rule's details. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/PriceListRuleValueDTO.mdx b/www/apps/docs/content/references/services/interfaces/PriceListRuleValueDTO.mdx new file mode 100644 index 0000000000..da8e48fb10 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/PriceListRuleValueDTO.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListRuleValueDTO + +The price list rule value's details. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/PriceRuleDTO.mdx b/www/apps/docs/content/references/services/interfaces/PriceRuleDTO.mdx index 2db8854f8c..b9a4dc2e2b 100644 --- a/www/apps/docs/content/references/services/interfaces/PriceRuleDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/PriceRuleDTO.mdx @@ -32,10 +32,10 @@ A price rule's data. { "name": "price_set", "type": "[PriceSetDTO](PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -68,10 +68,10 @@ A price rule's data. { "name": "rule_type", "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountDTO.mdx b/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountDTO.mdx index ac4a9771e5..80548bbe9d 100644 --- a/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountDTO.mdx @@ -23,34 +23,43 @@ A price set money amount's data. { "name": "money_amount", "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)", - "description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.", + "description": "The money amount associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, "children": [] }, { "name": "price_rules", "type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]", - "description": "", + "description": "The price rules associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set", "type": "[PriceSetDTO](PriceSetDTO.mdx)", - "description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.", + "description": "The price set associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set_id", "type": "`string`", - "description": "", + "description": "The ID of the associated price set.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountRulesDTO.mdx b/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountRulesDTO.mdx index 616de83097..ebd5ce0189 100644 --- a/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountRulesDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/PriceSetMoneyAmountRulesDTO.mdx @@ -23,19 +23,19 @@ A price set money amount rule's data. { "name": "price_set_money_amount", "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", - "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "description": "The associated price set money amount.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "rule_type", "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/services/interfaces/RemoteJoinerQuery.mdx b/www/apps/docs/content/references/services/interfaces/RemoteJoinerQuery.mdx index ac96b79736..86115b03ba 100644 --- a/www/apps/docs/content/references/services/interfaces/RemoteJoinerQuery.mdx +++ b/www/apps/docs/content/references/services/interfaces/RemoteJoinerQuery.mdx @@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "expands", - "type": "`{ args?: [JoinerArgument](JoinerArgument.mdx)[] ; directives?: { [field: string]: [JoinerDirective](JoinerDirective.mdx)[]; } ; fields: string[] ; property: string }`[]", + "type": "``{ args?: [JoinerArgument](JoinerArgument.mdx)[] ; directives?: { [field: string]: [JoinerDirective](JoinerDirective.mdx)[]; } ; fields: string[] ; property: string }``[]", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/interfaces/RemovePriceListRulesDTO.mdx b/www/apps/docs/content/references/services/interfaces/RemovePriceListRulesDTO.mdx new file mode 100644 index 0000000000..78b3fd28b4 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/RemovePriceListRulesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RemovePriceListRulesDTO + +The rules to remove from a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/SetPriceListRulesDTO.mdx b/www/apps/docs/content/references/services/interfaces/SetPriceListRulesDTO.mdx new file mode 100644 index 0000000000..51eba52784 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/SetPriceListRulesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SetPriceListRulesDTO + +The rules to add to a price list. + +## Properties + +`", + "description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value is the value(s) of the rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx b/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx index 326ff780d5..f973298ce7 100644 --- a/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx +++ b/www/apps/docs/content/references/services/interfaces/SharedArrayBuffer.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "[toStringTag]", - "type": "``\"SharedArrayBuffer\"``", + "type": "`\"SharedArrayBuffer\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/SharedContext.mdx b/www/apps/docs/content/references/services/interfaces/SharedContext.mdx similarity index 59% rename from www/apps/docs/content/references/services/types/SharedContext.mdx rename to www/apps/docs/content/references/services/interfaces/SharedContext.mdx index 6e94dae297..260fc8d6ce 100644 --- a/www/apps/docs/content/references/services/types/SharedContext.mdx +++ b/www/apps/docs/content/references/services/interfaces/SharedContext.mdx @@ -6,15 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # SharedContext - **SharedContext**: `Object` +A shared context object that is used to share resources between the application and the module. -### Type declaration +## Properties diff --git a/www/apps/docs/content/references/services/interfaces/UpdatePriceListRuleDTO.mdx b/www/apps/docs/content/references/services/interfaces/UpdatePriceListRuleDTO.mdx new file mode 100644 index 0000000000..c2b97d5363 --- /dev/null +++ b/www/apps/docs/content/references/services/interfaces/UpdatePriceListRuleDTO.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: servicesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListRuleDTO + +The attributes to update in a price list rule. + +## Properties + + diff --git a/www/apps/docs/content/references/services/interfaces/UpdatePriceRuleDTO.mdx b/www/apps/docs/content/references/services/interfaces/UpdatePriceRuleDTO.mdx index 14331304b9..3e0f08eff6 100644 --- a/www/apps/docs/content/references/services/interfaces/UpdatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/UpdatePriceRuleDTO.mdx @@ -14,7 +14,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "id", "type": "`string`", - "description": "The ID of the price rule to update.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -32,7 +32,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "price_set_id", "type": "`string`", - "description": "The ID of the associated price set.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -59,7 +59,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "rule_type_id", "type": "`string`", - "description": "The ID of the associated rule type.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/types/UpdateReservationItemInput.mdx b/www/apps/docs/content/references/services/interfaces/UpdateReservationItemInput.mdx similarity index 68% rename from www/apps/docs/content/references/services/types/UpdateReservationItemInput.mdx rename to www/apps/docs/content/references/services/interfaces/UpdateReservationItemInput.mdx index 01fc890e26..c85a8131a6 100644 --- a/www/apps/docs/content/references/services/types/UpdateReservationItemInput.mdx +++ b/www/apps/docs/content/references/services/interfaces/UpdateReservationItemInput.mdx @@ -6,15 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpdateReservationItemInput - **UpdateReservationItemInput**: `Object` +The attributes to update in a reservation item. -### Type declaration +## Properties ` \\| ``null``", - "description": "", + "type": "`null` \\| `Record`", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" { "name": "quantity", "type": "`number`", - "description": "", + "description": "The reserved quantity.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/types/ArrayBufferLike.mdx b/www/apps/docs/content/references/services/types/ArrayBufferLike.mdx index 0f042ca4b4..c437099742 100644 --- a/www/apps/docs/content/references/services/types/ArrayBufferLike.mdx +++ b/www/apps/docs/content/references/services/types/ArrayBufferLike.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ArrayBufferLike - **ArrayBufferLike**: ArrayBufferTypes[keyof ArrayBufferTypes] + **ArrayBufferLike**: `ArrayBufferTypes`[keyof `ArrayBufferTypes`] diff --git a/www/apps/docs/content/references/services/types/ArrayBufferView.mdx b/www/apps/docs/content/references/services/types/ArrayBufferView.mdx index e5685f279a..d3f16e228a 100644 --- a/www/apps/docs/content/references/services/types/ArrayBufferView.mdx +++ b/www/apps/docs/content/references/services/types/ArrayBufferView.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ArrayBufferView - **ArrayBufferView**: [TypedArray](TypedArray.mdx) \| DataView + **ArrayBufferView**: [TypedArray](TypedArray.mdx) \| `DataView` diff --git a/www/apps/docs/content/references/services/types/BatchJobCreateProps.mdx b/www/apps/docs/content/references/services/types/BatchJobCreateProps.mdx index a544400b19..58f9c0326a 100644 --- a/www/apps/docs/content/references/services/types/BatchJobCreateProps.mdx +++ b/www/apps/docs/content/references/services/types/BatchJobCreateProps.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # BatchJobCreateProps - **BatchJobCreateProps**: [Pick](Pick.mdx)<[BatchJob](../classes/BatchJob.mdx), `"context"` \| `"type"` \| `"created_by"` \| `"dry_run"`> + **BatchJobCreateProps**: [Pick](Pick.mdx)<[BatchJob](../classes/BatchJob.mdx), "context" \| "type" \| "created_by" \| "dry_run"> diff --git a/www/apps/docs/content/references/services/types/CalculationContextData.mdx b/www/apps/docs/content/references/services/types/CalculationContextData.mdx index 8a02d31866..449aa2aee9 100644 --- a/www/apps/docs/content/references/services/types/CalculationContextData.mdx +++ b/www/apps/docs/content/references/services/types/CalculationContextData.mdx @@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "shipping_address", - "type": "[Address](../classes/Address.mdx) \\| ``null``", + "type": "[Address](../classes/Address.mdx) \\| `null`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/CartUpdateProps.mdx b/www/apps/docs/content/references/services/types/CartUpdateProps.mdx index 0bdf40409d..5248a1dbb9 100644 --- a/www/apps/docs/content/references/services/types/CartUpdateProps.mdx +++ b/www/apps/docs/content/references/services/types/CartUpdateProps.mdx @@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "payment_authorized_at", - "type": "`Date` \\| ``null``", + "type": "`Date` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/ConfigModule.mdx b/www/apps/docs/content/references/services/types/ConfigModule.mdx index 97b8a9d9e9..a2961bb757 100644 --- a/www/apps/docs/content/references/services/types/ConfigModule.mdx +++ b/www/apps/docs/content/references/services/types/ConfigModule.mdx @@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "plugins", - "type": "(`{ options: Record<string, unknown> ; resolve: string }` \\| `string`)[]", + "type": "(``{ options: Record<string, unknown> ; resolve: string }`` \\| `string`)[]", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/CreateFulfillmentOrder.mdx b/www/apps/docs/content/references/services/types/CreateFulfillmentOrder.mdx index edf4e6afe1..dc8fa9d931 100644 --- a/www/apps/docs/content/references/services/types/CreateFulfillmentOrder.mdx +++ b/www/apps/docs/content/references/services/types/CreateFulfillmentOrder.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # CreateFulfillmentOrder - **CreateFulfillmentOrder**: [Omit](Omit.mdx)<[ClaimOrder](../classes/ClaimOrder.mdx), `"beforeInsert"`> & { billing_address: [Address](../classes/Address.mdx) ; currency_code: string ; discounts: [Discount](../classes/Discount.mdx)[] ; display_id: number ; email?: string ; is_claim?: boolean ; is_swap?: boolean ; items: [LineItem](../classes/LineItem.mdx)[] ; no_notification: boolean ; payments: [Payment](../classes/Payment.mdx)[] ; region?: [Region](../classes/Region.mdx) ; region_id: string ; shipping_methods: [ShippingMethod](../classes/ShippingMethod.mdx)[] ; tax_rate: number \| `null` } + **CreateFulfillmentOrder**: [Omit](Omit.mdx)<[ClaimOrder](../classes/ClaimOrder.mdx), "beforeInsert"> & ``{ billing_address: [Address](../classes/Address.mdx) ; currency_code: string ; discounts: [Discount](../classes/Discount.mdx)[] ; display_id: number ; email?: string ; is_claim?: boolean ; is_swap?: boolean ; items: [LineItem](../classes/LineItem.mdx)[] ; no_notification: boolean ; payments: [Payment](../classes/Payment.mdx)[] ; region?: [Region](../classes/Region.mdx) ; region_id: string ; shipping_methods: [ShippingMethod](../classes/ShippingMethod.mdx)[] ; tax_rate: number \| null }`` diff --git a/www/apps/docs/content/references/services/types/CreateGiftCardInput.mdx b/www/apps/docs/content/references/services/types/CreateGiftCardInput.mdx index 268340f278..ee9bda1850 100644 --- a/www/apps/docs/content/references/services/types/CreateGiftCardInput.mdx +++ b/www/apps/docs/content/references/services/types/CreateGiftCardInput.mdx @@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "tax_rate", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/CreateGiftCardTransactionInput.mdx b/www/apps/docs/content/references/services/types/CreateGiftCardTransactionInput.mdx index 143c2d24c5..7034455033 100644 --- a/www/apps/docs/content/references/services/types/CreateGiftCardTransactionInput.mdx +++ b/www/apps/docs/content/references/services/types/CreateGiftCardTransactionInput.mdx @@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "tax_rate", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/CreatePriceListInput.mdx b/www/apps/docs/content/references/services/types/CreatePriceListInput.mdx index 0918c1c060..af22e4d418 100644 --- a/www/apps/docs/content/references/services/types/CreatePriceListInput.mdx +++ b/www/apps/docs/content/references/services/types/CreatePriceListInput.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ` diff --git a/www/apps/docs/content/references/services/types/DefaultWithoutRelations-1.mdx b/www/apps/docs/content/references/services/types/DefaultWithoutRelations-1.mdx index c3f091014c..bd7f1d9245 100644 --- a/www/apps/docs/content/references/services/types/DefaultWithoutRelations-1.mdx +++ b/www/apps/docs/content/references/services/types/DefaultWithoutRelations-1.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # DefaultWithoutRelations - **DefaultWithoutRelations**: [Omit](Omit.mdx)<[ExtendedFindConfig](ExtendedFindConfig-1.mdx)<[Product](../classes/Product.mdx)>, `"relations"`> + **DefaultWithoutRelations**: [Omit](Omit.mdx)<[ExtendedFindConfig](ExtendedFindConfig-1.mdx)<[Product](../classes/Product.mdx)>, "relations"> diff --git a/www/apps/docs/content/references/services/types/DefaultWithoutRelations.mdx b/www/apps/docs/content/references/services/types/DefaultWithoutRelations.mdx index acd9be7c9f..e81feb810d 100644 --- a/www/apps/docs/content/references/services/types/DefaultWithoutRelations.mdx +++ b/www/apps/docs/content/references/services/types/DefaultWithoutRelations.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # DefaultWithoutRelations - **DefaultWithoutRelations**: [Omit](Omit.mdx)<[ExtendedFindConfig](ExtendedFindConfig.mdx)<[CustomerGroup](../classes/CustomerGroup.mdx)>, `"relations"`> + **DefaultWithoutRelations**: [Omit](Omit.mdx)<[ExtendedFindConfig](ExtendedFindConfig.mdx)<[CustomerGroup](../classes/CustomerGroup.mdx)>, "relations"> diff --git a/www/apps/docs/content/references/services/types/DiscountConditionInput.mdx b/www/apps/docs/content/references/services/types/DiscountConditionInput.mdx index 8b03cf22bb..5474c521a0 100644 --- a/www/apps/docs/content/references/services/types/DiscountConditionInput.mdx +++ b/www/apps/docs/content/references/services/types/DiscountConditionInput.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" `: T extends U ? never : T + **Exclude**``: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U diff --git a/www/apps/docs/content/references/services/types/ExtendedFindConfig-1.mdx b/www/apps/docs/content/references/services/types/ExtendedFindConfig-1.mdx index f7e44d9178..411aff3902 100644 --- a/www/apps/docs/content/references/services/types/ExtendedFindConfig-1.mdx +++ b/www/apps/docs/content/references/services/types/ExtendedFindConfig-1.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ExtendedFindConfig - **ExtendedFindConfig**``: [Omit](Omit.mdx)<FindOneOptions<TEntity>, `"where"` \| `"relations"` \| `"select"`> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, `"where"` \| `"relations"` \| `"select"`> & { order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] } + **ExtendedFindConfig**``: [Omit](Omit.mdx)<FindOneOptions<TEntity>, "where" \| "relations" \| "select"> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, "where" \| "relations" \| "select"> & ``{ order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] }`` ### Type parameters diff --git a/www/apps/docs/content/references/services/types/ExtendedFindConfig.mdx b/www/apps/docs/content/references/services/types/ExtendedFindConfig.mdx index f7e44d9178..411aff3902 100644 --- a/www/apps/docs/content/references/services/types/ExtendedFindConfig.mdx +++ b/www/apps/docs/content/references/services/types/ExtendedFindConfig.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ExtendedFindConfig - **ExtendedFindConfig**``: [Omit](Omit.mdx)<FindOneOptions<TEntity>, `"where"` \| `"relations"` \| `"select"`> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, `"where"` \| `"relations"` \| `"select"`> & { order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] } + **ExtendedFindConfig**``: [Omit](Omit.mdx)<FindOneOptions<TEntity>, "where" \| "relations" \| "select"> \| [Omit](Omit.mdx)<FindManyOptions<TEntity>, "where" \| "relations" \| "select"> & ``{ order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> \| FindOptionsWhere<TEntity>[] }`` ### Type parameters diff --git a/www/apps/docs/content/references/services/types/ExternalModuleDeclaration.mdx b/www/apps/docs/content/references/services/types/ExternalModuleDeclaration.mdx index d984d928c7..6e89d5ebd2 100644 --- a/www/apps/docs/content/references/services/types/ExternalModuleDeclaration.mdx +++ b/www/apps/docs/content/references/services/types/ExternalModuleDeclaration.mdx @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "server.type", - "type": "``\"http\"``", + "type": "`\"http\"`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/FeatureFlagsResponse.mdx b/www/apps/docs/content/references/services/types/FeatureFlagsResponse.mdx index 7326c7242f..b2b9d1af68 100644 --- a/www/apps/docs/content/references/services/types/FeatureFlagsResponse.mdx +++ b/www/apps/docs/content/references/services/types/FeatureFlagsResponse.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FeatureFlagsResponse - **FeatureFlagsResponse**: { key: string ; value: boolean \| Record<string, boolean> }[] + **FeatureFlagsResponse**: ``{ key: string ; value: boolean \| Record<string, boolean> }``[] diff --git a/www/apps/docs/content/references/services/types/FilterableUserProps.mdx b/www/apps/docs/content/references/services/types/FilterableUserProps.mdx index bb1b345aac..7bd4c2ff91 100644 --- a/www/apps/docs/content/references/services/types/FilterableUserProps.mdx +++ b/www/apps/docs/content/references/services/types/FilterableUserProps.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterableUserProps - **FilterableUserProps**: [PartialPick](PartialPick.mdx)<[User](../classes/User.mdx), `"email"` \| `"first_name"` \| `"last_name"` \| `"created_at"` \| `"updated_at"` \| `"deleted_at"`> + **FilterableUserProps**: [PartialPick](PartialPick.mdx)<[User](../classes/User.mdx), "email" \| "first_name" \| "last_name" \| "created_at" \| "updated_at" \| "deleted_at"> diff --git a/www/apps/docs/content/references/services/types/FindWithRelationsOptions.mdx b/www/apps/docs/content/references/services/types/FindWithRelationsOptions.mdx index 59b756ed59..c460773ade 100644 --- a/www/apps/docs/content/references/services/types/FindWithRelationsOptions.mdx +++ b/www/apps/docs/content/references/services/types/FindWithRelationsOptions.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FindWithRelationsOptions - **FindWithRelationsOptions**: FindManyOptions<[ProductVariant](../classes/ProductVariant.mdx)> & { order?: FindOptionsOrder<[ProductVariant](../classes/ProductVariant.mdx)> ; withDeleted?: boolean } + **FindWithRelationsOptions**: FindManyOptions<[ProductVariant](../classes/ProductVariant.mdx)> & ``{ order?: FindOptionsOrder<[ProductVariant](../classes/ProductVariant.mdx)> ; withDeleted?: boolean }`` diff --git a/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions-1.mdx b/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions-1.mdx index e07354c0e5..651d7df98b 100644 --- a/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions-1.mdx +++ b/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions-1.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FindWithoutRelationsOptions - **FindWithoutRelationsOptions**: [DefaultWithoutRelations](DefaultWithoutRelations-1.mdx) & { where: [DefaultWithoutRelations](DefaultWithoutRelations-1.mdx)[`"where"`] & { categories?: FindOptionsWhere<[ProductCategory](../classes/ProductCategory.mdx)> ; category_id?: [CategoryQueryParams](CategoryQueryParams.mdx) ; discount_condition_id?: string ; include_category_children?: boolean ; price_list_id?: FindOperator<[PriceList](../classes/PriceList.mdx)> ; sales_channel_id?: FindOperator<[SalesChannel](../classes/SalesChannel.mdx)> ; tags?: FindOperator<[ProductTag](../classes/ProductTag.mdx)> } } + **FindWithoutRelationsOptions**: [DefaultWithoutRelations](DefaultWithoutRelations-1.mdx) & ``{ where: [DefaultWithoutRelations](DefaultWithoutRelations-1.mdx)["where"] & { categories?: FindOptionsWhere<[ProductCategory](../classes/ProductCategory.mdx)> ; category_id?: [CategoryQueryParams](CategoryQueryParams.mdx) ; discount_condition_id?: string ; include_category_children?: boolean ; price_list_id?: FindOperator<[PriceList](../classes/PriceList.mdx)> ; sales_channel_id?: FindOperator<[SalesChannel](../classes/SalesChannel.mdx)> ; tags?: FindOperator<[ProductTag](../classes/ProductTag.mdx)> } }`` diff --git a/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions.mdx b/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions.mdx index 296ed3a078..49a983ecc9 100644 --- a/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions.mdx +++ b/www/apps/docs/content/references/services/types/FindWithoutRelationsOptions.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FindWithoutRelationsOptions - **FindWithoutRelationsOptions**: [DefaultWithoutRelations](DefaultWithoutRelations.mdx) & { where: [DefaultWithoutRelations](DefaultWithoutRelations.mdx)[`"where"`] & { discount_condition_id?: string \| FindOperator<string> } } + **FindWithoutRelationsOptions**: [DefaultWithoutRelations](DefaultWithoutRelations.mdx) & ``{ where: [DefaultWithoutRelations](DefaultWithoutRelations.mdx)["where"] & { discount_condition_id?: string \| FindOperator<string> } }`` diff --git a/www/apps/docs/content/references/services/types/FulfillmentProviderContainer.mdx b/www/apps/docs/content/references/services/types/FulfillmentProviderContainer.mdx index 9349ac4670..4a151ac6c6 100644 --- a/www/apps/docs/content/references/services/types/FulfillmentProviderContainer.mdx +++ b/www/apps/docs/content/references/services/types/FulfillmentProviderContainer.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FulfillmentProviderContainer - **FulfillmentProviderContainer**: [MedusaContainer](MedusaContainer.mdx) & { fulfillmentProviderRepository: typeof [FulfillmentProviderRepository](../index.md#fulfillmentproviderrepository) ; manager: EntityManager } & { [key in \`${FulfillmentProviderKey}\`]: typeof "medusa-interfaces" } + **FulfillmentProviderContainer**: [MedusaContainer](MedusaContainer.mdx) & ``{ fulfillmentProviderRepository: typeof [FulfillmentProviderRepository](../index.md#fulfillmentproviderrepository) ; manager: EntityManager }`` & { [key in \`${FulfillmentProviderKey}\`]: typeof "medusa-interfaces" } diff --git a/www/apps/docs/content/references/services/types/GiftCardTransaction-1.mdx b/www/apps/docs/content/references/services/types/GiftCardTransaction-1.mdx index a6087c54bd..05b69f8da2 100644 --- a/www/apps/docs/content/references/services/types/GiftCardTransaction-1.mdx +++ b/www/apps/docs/content/references/services/types/GiftCardTransaction-1.mdx @@ -33,7 +33,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "is_taxable", - "type": "`boolean` \\| ``null``", + "type": "`boolean` \\| `null`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", @@ -42,7 +42,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t }, { "name": "tax_rate", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/InjectedDependencies-18.mdx b/www/apps/docs/content/references/services/types/InjectedDependencies-18.mdx index 283a3b18cd..3b779accc0 100644 --- a/www/apps/docs/content/references/services/types/InjectedDependencies-18.mdx +++ b/www/apps/docs/content/references/services/types/InjectedDependencies-18.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # InjectedDependencies - **InjectedDependencies**: [MedusaContainer](MedusaContainer.mdx) & { eventBusService: [EventBusService](../classes/EventBusService.mdx) ; manager: EntityManager ; oauthRepository: typeof [OauthRepository](../index.md#oauthrepository) } + **InjectedDependencies**: [MedusaContainer](MedusaContainer.mdx) & ``{ eventBusService: [EventBusService](../classes/EventBusService.mdx) ; manager: EntityManager ; oauthRepository: typeof [OauthRepository](../index.md#oauthrepository) }`` diff --git a/www/apps/docs/content/references/services/types/InjectedDependencies-24.mdx b/www/apps/docs/content/references/services/types/InjectedDependencies-24.mdx index aec8e620c0..f3b650740a 100644 --- a/www/apps/docs/content/references/services/types/InjectedDependencies-24.mdx +++ b/www/apps/docs/content/references/services/types/InjectedDependencies-24.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # InjectedDependencies - **InjectedDependencies**: { customerService: [CustomerService](../classes/CustomerService.mdx) ; featureFlagRouter: [FlagRouter](../classes/FlagRouter.mdx) ; logger: [Logger](Logger-1.mdx) ; manager: EntityManager ; paymentProviderRepository: typeof [PaymentProviderRepository](../index.md#paymentproviderrepository) ; paymentRepository: typeof [PaymentRepository](../index.md#paymentrepository) ; paymentService: [PaymentService](../classes/PaymentService.mdx) ; paymentSessionRepository: typeof [PaymentSessionRepository](../index.md#paymentsessionrepository) ; refundRepository: typeof [RefundRepository](../index.md#refundrepository) } & { [key in \`${PaymentProviderKey}\`]: AbstractPaymentService \| typeof "medusa-interfaces" } + **InjectedDependencies**: ``{ customerService: [CustomerService](../classes/CustomerService.mdx) ; featureFlagRouter: [FlagRouter](../classes/FlagRouter.mdx) ; logger: [Logger](Logger-1.mdx) ; manager: EntityManager ; paymentProviderRepository: typeof [PaymentProviderRepository](../index.md#paymentproviderrepository) ; paymentRepository: typeof [PaymentRepository](../index.md#paymentrepository) ; paymentService: [PaymentService](../classes/PaymentService.mdx) ; paymentSessionRepository: typeof [PaymentSessionRepository](../index.md#paymentsessionrepository) ; refundRepository: typeof [RefundRepository](../index.md#refundrepository) }`` & { [key in \`${PaymentProviderKey}\`]: AbstractPaymentService \| typeof "medusa-interfaces" } diff --git a/www/apps/docs/content/references/services/types/InventoryItemDTO.mdx b/www/apps/docs/content/references/services/types/InventoryItemDTO.mdx index 6711cf96da..bc79cbf6c4 100644 --- a/www/apps/docs/content/references/services/types/InventoryItemDTO.mdx +++ b/www/apps/docs/content/references/services/types/InventoryItemDTO.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `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": "", diff --git a/www/apps/docs/content/references/services/types/InventoryLevelDTO.mdx b/www/apps/docs/content/references/services/types/InventoryLevelDTO.mdx index 3920601032..0a0b77fc30 100644 --- a/www/apps/docs/content/references/services/types/InventoryLevelDTO.mdx +++ b/www/apps/docs/content/references/services/types/InventoryLevelDTO.mdx @@ -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` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/LineAllocationsMap.mdx b/www/apps/docs/content/references/services/types/LineAllocationsMap.mdx index f3093370e5..150d68d211 100644 --- a/www/apps/docs/content/references/services/types/LineAllocationsMap.mdx +++ b/www/apps/docs/content/references/services/types/LineAllocationsMap.mdx @@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # LineAllocationsMap - **LineAllocationsMap**: object + **LineAllocationsMap**: `object` A map of line item ids and its corresponding gift card and discount allocations ### Index signature -▪ [K: `string`]: `{ discount?: [DiscountAllocation](DiscountAllocation.mdx) ; gift_card?: [GiftCardAllocation](GiftCardAllocation.mdx) }` +▪ [K: `string`]: ``{ discount?: [DiscountAllocation](DiscountAllocation.mdx) ; gift_card?: [GiftCardAllocation](GiftCardAllocation.mdx) }`` diff --git a/www/apps/docs/content/references/services/types/ListAndCountSelector.mdx b/www/apps/docs/content/references/services/types/ListAndCountSelector.mdx index bbeabf95f6..55e3cee92d 100644 --- a/www/apps/docs/content/references/services/types/ListAndCountSelector.mdx +++ b/www/apps/docs/content/references/services/types/ListAndCountSelector.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ListAndCountSelector - **ListAndCountSelector**: [Selector](Selector.mdx)<[ProductCollection](../classes/ProductCollection.mdx)> & { discount_condition_id?: string ; q?: string } + **ListAndCountSelector**: [Selector](Selector.mdx)<[ProductCollection](../classes/ProductCollection.mdx)> & ``{ discount_condition_id?: string ; q?: string }`` diff --git a/www/apps/docs/content/references/services/types/MedusaContainer-1.mdx b/www/apps/docs/content/references/services/types/MedusaContainer-1.mdx index 75174d2eaa..cbe0ddf6e3 100644 --- a/www/apps/docs/content/references/services/types/MedusaContainer-1.mdx +++ b/www/apps/docs/content/references/services/types/MedusaContainer-1.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # MedusaContainer - **MedusaContainer**: AwilixContainer & { createScope: () => [MedusaContainer](MedusaContainer-1.mdx) ; registerAdd: <T>(name: string, registration: T) => [MedusaContainer](MedusaContainer-1.mdx) } + **MedusaContainer**: `AwilixContainer` & ``{ createScope: () => [MedusaContainer](MedusaContainer-1.mdx) ; registerAdd: <T>(name: string, registration: T) => [MedusaContainer](MedusaContainer-1.mdx) }`` diff --git a/www/apps/docs/content/references/services/types/ModuleDefinition.mdx b/www/apps/docs/content/references/services/types/ModuleDefinition.mdx index 8db02de81d..061551198c 100644 --- a/www/apps/docs/content/references/services/types/ModuleDefinition.mdx +++ b/www/apps/docs/content/references/services/types/ModuleDefinition.mdx @@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "defaultPackage", - "type": "`string` \\| ``false``", + "type": "`string` \\| `false`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/ModuleJoinerConfig.mdx b/www/apps/docs/content/references/services/types/ModuleJoinerConfig.mdx index 71d95bb66c..fe2b6a9e28 100644 --- a/www/apps/docs/content/references/services/types/ModuleJoinerConfig.mdx +++ b/www/apps/docs/content/references/services/types/ModuleJoinerConfig.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerConfig - **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), `"serviceName"` \| `"primaryKeys"` \| `"relationships"` \| `"extends"`> & { databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: `"date"` \| `"time"` \| `"datetime"` \| `"bigint"` \| `"blob"` \| `"uint8array"` \| `"array"` \| `"enumArray"` \| `"enum"` \| `"json"` \| `"integer"` \| `"smallint"` \| `"tinyint"` \| `"mediumint"` \| `"float"` \| `"double"` \| `"boolean"` \| `"decimal"` \| `"string"` \| `"uuid"` \| `"text"` }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string } + **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & ``{ databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: "date" \| "time" \| "datetime" \| bigint \| "blob" \| "uint8array" \| "array" \| "enumArray" \| "enum" \| "json" \| "integer" \| "smallint" \| "tinyint" \| "mediumint" \| "float" \| "double" \| "boolean" \| "decimal" \| "string" \| "uuid" \| "text" }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }`` diff --git a/www/apps/docs/content/references/services/types/ModuleJoinerRelationship.mdx b/www/apps/docs/content/references/services/types/ModuleJoinerRelationship.mdx index 4468700caa..566bf49300 100644 --- a/www/apps/docs/content/references/services/types/ModuleJoinerRelationship.mdx +++ b/www/apps/docs/content/references/services/types/ModuleJoinerRelationship.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerRelationship - **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & { deleteCascade?: boolean ; isInternalService?: boolean } + **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & ``{ deleteCascade?: boolean ; isInternalService?: boolean }`` diff --git a/www/apps/docs/content/references/services/types/PaymentContext.mdx b/www/apps/docs/content/references/services/types/PaymentContext.mdx index 09ed79d451..c231074e8c 100644 --- a/www/apps/docs/content/references/services/types/PaymentContext.mdx +++ b/www/apps/docs/content/references/services/types/PaymentContext.mdx @@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cart.billing_address", - "type": "[Address](../classes/Address.mdx) \\| ``null``", + "type": "[Address](../classes/Address.mdx) \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cart.shipping_address", - "type": "[Address](../classes/Address.mdx) \\| ``null``", + "type": "[Address](../classes/Address.mdx) \\| `null`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/PaymentProcessorContext.mdx b/www/apps/docs/content/references/services/types/PaymentProcessorContext.mdx index 66617cab64..38dec99fac 100644 --- a/www/apps/docs/content/references/services/types/PaymentProcessorContext.mdx +++ b/www/apps/docs/content/references/services/types/PaymentProcessorContext.mdx @@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "billing_address", - "type": "[Address](../classes/Address.mdx) \\| ``null``", + "type": "[Address](../classes/Address.mdx) \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/PaymentSessionInput.mdx b/www/apps/docs/content/references/services/types/PaymentSessionInput.mdx index c5b9380e18..f2af9ee5ea 100644 --- a/www/apps/docs/content/references/services/types/PaymentSessionInput.mdx +++ b/www/apps/docs/content/references/services/types/PaymentSessionInput.mdx @@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "cart", - "type": "[Cart](../classes/Cart.mdx) \\| `{ billing_address?: [Address](../classes/Address.mdx) \\| `null` ; context: Record<string, unknown> ; email: string ; id: string ; shipping_address: [Address](../classes/Address.mdx) \\| `null` ; shipping_methods: [ShippingMethod](../classes/ShippingMethod.mdx)[] }`", + "type": "[Cart](../classes/Cart.mdx) \\| ``{ billing_address?: [Address](../classes/Address.mdx) \\| null ; context: Record<string, unknown> ; email: string ; id: string ; shipping_address: [Address](../classes/Address.mdx) \\| null ; shipping_methods: [ShippingMethod](../classes/ShippingMethod.mdx)[] }``", "description": "", "optional": false, "defaultValue": "", @@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "customer", - "type": "[Customer](../classes/Customer.mdx) \\| ``null``", + "type": "[Customer](../classes/Customer.mdx) \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/Price.mdx b/www/apps/docs/content/references/services/types/Price.mdx index e18722d88d..7bd7f46307 100644 --- a/www/apps/docs/content/references/services/types/Price.mdx +++ b/www/apps/docs/content/references/services/types/Price.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Price - **Price**: [Partial](Partial.mdx)<[Omit](Omit.mdx)<[MoneyAmount](../classes/MoneyAmount.mdx), `"created_at"` \| `"updated_at"` \| `"deleted_at"`>> & { amount: number } + **Price**: [Partial](Partial.mdx)<[Omit](Omit.mdx)<[MoneyAmount](../classes/MoneyAmount.mdx), "created_at" \| "updated_at" \| "deleted_at">> & ``{ amount: number }`` diff --git a/www/apps/docs/content/references/services/types/PriceSelectionResult.mdx b/www/apps/docs/content/references/services/types/PriceSelectionResult.mdx index 26dbda1ac2..99b09e4ad5 100644 --- a/www/apps/docs/content/references/services/types/PriceSelectionResult.mdx +++ b/www/apps/docs/content/references/services/types/PriceSelectionResult.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ` & `{ ssl: { rejectUnauthorized: `false` } }`", + "type": "`Record` & ``{ ssl: { rejectUnauthorized: false } }``", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/ProviderLineItemTaxLine.mdx b/www/apps/docs/content/references/services/types/ProviderLineItemTaxLine.mdx index 03e9bb74ee..a8fcb69925 100644 --- a/www/apps/docs/content/references/services/types/ProviderLineItemTaxLine.mdx +++ b/www/apps/docs/content/references/services/types/ProviderLineItemTaxLine.mdx @@ -15,7 +15,7 @@ The tax line properties for a given line item. `: [Selector](Selector.mdx)<TEntity> & { q?: string } + **QuerySelector**``: [Selector](Selector.mdx)<TEntity> & ``{ q?: string }`` ### Type parameters diff --git a/www/apps/docs/content/references/services/types/RegionDetails.mdx b/www/apps/docs/content/references/services/types/RegionDetails.mdx index cfaed9707e..c6de7473a0 100644 --- a/www/apps/docs/content/references/services/types/RegionDetails.mdx +++ b/www/apps/docs/content/references/services/types/RegionDetails.mdx @@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "tax_rate", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/RemoteQueryFunction.mdx b/www/apps/docs/content/references/services/types/RemoteQueryFunction.mdx index 1eafe25046..44fafc7338 100644 --- a/www/apps/docs/content/references/services/types/RemoteQueryFunction.mdx +++ b/www/apps/docs/content/references/services/types/RemoteQueryFunction.mdx @@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # RemoteQueryFunction - **RemoteQueryFunction**: (query: string \| [RemoteJoinerQuery](../interfaces/RemoteJoinerQuery.mdx) \| object, variables?: Record<string, unknown>) => Promise<any> \| `null` + **RemoteQueryFunction**: (`query`: `string` \| [RemoteJoinerQuery](../interfaces/RemoteJoinerQuery.mdx) \| `object`, `variables?`: `Record`) => Promise<any> \| `null` ### Type declaration -`(query, variables?): Promise<any> \| `null`` +`(query, variables?): Promise<any> \| null` ##### Parameters @@ -37,12 +37,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ##### Returns -Promise<any> \| ``null`` +Promise<any> \| `null` ` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/ReserveQuantityContext.mdx b/www/apps/docs/content/references/services/types/ReserveQuantityContext.mdx index ae6a3b3bb7..56006a6e7a 100644 --- a/www/apps/docs/content/references/services/types/ReserveQuantityContext.mdx +++ b/www/apps/docs/content/references/services/types/ReserveQuantityContext.mdx @@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "salesChannelId", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/ShippingMethodUpdate.mdx b/www/apps/docs/content/references/services/types/ShippingMethodUpdate.mdx index bd5a6dcfef..49e348e7e4 100644 --- a/www/apps/docs/content/references/services/types/ShippingMethodUpdate.mdx +++ b/www/apps/docs/content/references/services/types/ShippingMethodUpdate.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -96,7 +96,7 @@ Represents a Stock Location Address }, { "name": "phone", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' phone number", "optional": true, "defaultValue": "", @@ -105,7 +105,7 @@ Represents a Stock Location Address }, { "name": "postal_code", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' postal code", "optional": true, "defaultValue": "", @@ -114,7 +114,7 @@ Represents a Stock Location Address }, { "name": "province", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' province", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/StockLocationDTO.mdx b/www/apps/docs/content/references/services/types/StockLocationDTO.mdx index e4fb559ec9..52953f422f 100644 --- a/www/apps/docs/content/references/services/types/StockLocationDTO.mdx +++ b/www/apps/docs/content/references/services/types/StockLocationDTO.mdx @@ -42,7 +42,7 @@ Represents 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": "", @@ -60,7 +60,7 @@ Represents a Stock Location }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/Subscriber.mdx b/www/apps/docs/content/references/services/types/Subscriber.mdx index 06e2496715..a085e67879 100644 --- a/www/apps/docs/content/references/services/types/Subscriber.mdx +++ b/www/apps/docs/content/references/services/types/Subscriber.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Subscriber - **Subscriber**``: (data: T, eventName: string) => Promise<void> + **Subscriber**``: (`data`: `T`, `eventName`: `string`) => Promise<void> ### Type parameters diff --git a/www/apps/docs/content/references/services/types/TaxCalculationContext.mdx b/www/apps/docs/content/references/services/types/TaxCalculationContext.mdx index ecdd04d4b1..ac15226c89 100644 --- a/www/apps/docs/content/references/services/types/TaxCalculationContext.mdx +++ b/www/apps/docs/content/references/services/types/TaxCalculationContext.mdx @@ -52,7 +52,7 @@ the items are going. }, { "name": "shipping_address", - "type": "[Address](../classes/Address.mdx) \\| ``null``", + "type": "[Address](../classes/Address.mdx) \\| `null`", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/TaxServiceRate.mdx b/www/apps/docs/content/references/services/types/TaxServiceRate.mdx index 6f122d0e3f..d15095d7d8 100644 --- a/www/apps/docs/content/references/services/types/TaxServiceRate.mdx +++ b/www/apps/docs/content/references/services/types/TaxServiceRate.mdx @@ -17,7 +17,7 @@ plugin. Promise<DeepPartial<[LineItem](../classes/LineItem.mdx)>> \| DeepPartial<[LineItem](../classes/LineItem.mdx)> + **Transformer**: (`item?`: [LineItem](../classes/LineItem.mdx), `quantity?`: `number`, `additional?`: [OrdersReturnItem](../classes/OrdersReturnItem.mdx)) => Promise<DeepPartial<[LineItem](../classes/LineItem.mdx)>> \| DeepPartial<[LineItem](../classes/LineItem.mdx)> ### Type declaration diff --git a/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx b/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx index e228750b70..2e42dd0997 100644 --- a/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx +++ b/www/apps/docs/content/references/services/types/TreeQuerySelector.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # TreeQuerySelector - **TreeQuerySelector**``: [QuerySelector](QuerySelector.mdx)<TEntity> & { include_descendants_tree?: boolean } + **TreeQuerySelector**``: [QuerySelector](QuerySelector.mdx)<TEntity> & ``{ include_descendants_tree?: boolean }`` ### Type parameters diff --git a/www/apps/docs/content/references/services/types/TypedArray.mdx b/www/apps/docs/content/references/services/types/TypedArray.mdx index e92224e8e6..55b51a4736 100644 --- a/www/apps/docs/content/references/services/types/TypedArray.mdx +++ b/www/apps/docs/content/references/services/types/TypedArray.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # TypedArray - **TypedArray**: Uint8Array \| Uint8ClampedArray \| Uint16Array \| Uint32Array \| Int8Array \| Int16Array \| Int32Array \| BigUint64Array \| BigInt64Array \| Float32Array \| Float64Array + **TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array` diff --git a/www/apps/docs/content/references/services/types/UpdateCustomerInput.mdx b/www/apps/docs/content/references/services/types/UpdateCustomerInput.mdx index 50fb616aed..17088254a1 100644 --- a/www/apps/docs/content/references/services/types/UpdateCustomerInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateCustomerInput.mdx @@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "groups", - "type": "`{ id: string }`[]", + "type": "``{ id: string }``[]", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/UpdateDiscountInput.mdx b/www/apps/docs/content/references/services/types/UpdateDiscountInput.mdx index bcea50e377..68588d486e 100644 --- a/www/apps/docs/content/references/services/types/UpdateDiscountInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateDiscountInput.mdx @@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "ends_at", - "type": "`Date` \\| ``null``", + "type": "`Date` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "usage_limit", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": true, "defaultValue": "", @@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "valid_duration", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/UpdateGiftCardInput.mdx b/www/apps/docs/content/references/services/types/UpdateGiftCardInput.mdx index 35e84a5e5d..8251cb5db8 100644 --- a/www/apps/docs/content/references/services/types/UpdateGiftCardInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateGiftCardInput.mdx @@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "ends_at", - "type": "`Date` \\| ``null``", + "type": "`Date` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/UpdateOrderInput.mdx b/www/apps/docs/content/references/services/types/UpdateOrderInput.mdx index 52b9f000d7..be58b7d389 100644 --- a/www/apps/docs/content/references/services/types/UpdateOrderInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateOrderInput.mdx @@ -148,7 +148,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "shipping_method", - "type": "`{ data?: Record<string, unknown> ; items?: Record<string, unknown>[] ; price?: number ; profile_id?: string ; provider_id?: string }`[]", + "type": "``{ data?: Record<string, unknown> ; items?: Record<string, unknown>[] ; price?: number ; profile_id?: string ; provider_id?: string }``[]", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/UpdatePriceListInput.mdx b/www/apps/docs/content/references/services/types/UpdatePriceListInput.mdx index 8a9c0886ac..1738790a1d 100644 --- a/www/apps/docs/content/references/services/types/UpdatePriceListInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdatePriceListInput.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpdatePriceListInput - **UpdatePriceListInput**: [Partial](Partial.mdx)<[Pick](Pick.mdx)<[PriceList](../classes/PriceList.mdx), `"name"` \| `"description"` \| `"starts_at"` \| `"ends_at"` \| `"status"` \| `"type"` \| `"includes_tax"`>> & { customer_groups?: { id: string }[] ; prices?: [AdminPriceListPricesUpdateReq](../classes/AdminPriceListPricesUpdateReq.mdx)[] } + **UpdatePriceListInput**: [Partial](Partial.mdx)<[Pick](Pick.mdx)<[PriceList](../classes/PriceList.mdx), "name" \| "description" \| "starts_at" \| "ends_at" \| "status" \| "type" \| "includes_tax">> & ``{ customer_groups?: { id: string }[] ; prices?: [AdminPriceListPricesUpdateReq](../classes/AdminPriceListPricesUpdateReq.mdx)[] }`` diff --git a/www/apps/docs/content/references/services/types/UpdateProductCategoryInput.mdx b/www/apps/docs/content/references/services/types/UpdateProductCategoryInput.mdx index 565a776e9b..524e82ccc3 100644 --- a/www/apps/docs/content/references/services/types/UpdateProductCategoryInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateProductCategoryInput.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpdateProductCategoryInput - **UpdateProductCategoryInput**: [ProductCategoryInput](ProductCategoryInput.mdx) & { name?: string } + **UpdateProductCategoryInput**: [ProductCategoryInput](ProductCategoryInput.mdx) & ``{ name?: string }`` diff --git a/www/apps/docs/content/references/services/types/UpdateProductInput.mdx b/www/apps/docs/content/references/services/types/UpdateProductInput.mdx index fe5e8a9409..e9573804e5 100644 --- a/www/apps/docs/content/references/services/types/UpdateProductInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateProductInput.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpdateProductInput - **UpdateProductInput**: [Omit](Omit.mdx)<[Partial](Partial.mdx)<[CreateProductInput](CreateProductInput.mdx)>, `"variants"`> & { variants?: [UpdateProductProductVariantDTO](UpdateProductProductVariantDTO.mdx)[] } + **UpdateProductInput**: [Omit](Omit.mdx)<[Partial](Partial.mdx)<[CreateProductInput](CreateProductInput.mdx)>, "variants"> & ``{ variants?: [UpdateProductProductVariantDTO](UpdateProductProductVariantDTO.mdx)[] }`` diff --git a/www/apps/docs/content/references/services/types/UpdateProductProductVariantDTO.mdx b/www/apps/docs/content/references/services/types/UpdateProductProductVariantDTO.mdx index b953f7638e..9d053e90d8 100644 --- a/www/apps/docs/content/references/services/types/UpdateProductProductVariantDTO.mdx +++ b/www/apps/docs/content/references/services/types/UpdateProductProductVariantDTO.mdx @@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "options", - "type": "`{ option_id: string ; value: string }`[]", + "type": "``{ option_id: string ; value: string }``[]", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/UpdateRegionInput.mdx b/www/apps/docs/content/references/services/types/UpdateRegionInput.mdx index 749f54ae09..8bc5019079 100644 --- a/www/apps/docs/content/references/services/types/UpdateRegionInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateRegionInput.mdx @@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "tax_provider_id", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/UpdateTaxRateInput.mdx b/www/apps/docs/content/references/services/types/UpdateTaxRateInput.mdx index 165e67eab4..724a639141 100644 --- a/www/apps/docs/content/references/services/types/UpdateTaxRateInput.mdx +++ b/www/apps/docs/content/references/services/types/UpdateTaxRateInput.mdx @@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "rate", - "type": "`number` \\| ``null``", + "type": "`number` \\| `null`", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/services/types/UpsertTagsInput.mdx b/www/apps/docs/content/references/services/types/UpsertTagsInput.mdx index e89f836862..b0978a034e 100644 --- a/www/apps/docs/content/references/services/types/UpsertTagsInput.mdx +++ b/www/apps/docs/content/references/services/types/UpsertTagsInput.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpsertTagsInput - **UpsertTagsInput**: [Partial](Partial.mdx)<[ProductTag](../classes/ProductTag.mdx)> & { value: string }[] + **UpsertTagsInput**: [Partial](Partial.mdx)<[ProductTag](../classes/ProductTag.mdx)> & ``{ value: string }``[] diff --git a/www/apps/docs/content/references/services/types/UpsertTypeInput.mdx b/www/apps/docs/content/references/services/types/UpsertTypeInput.mdx index c04dfa47e5..650cb2acea 100644 --- a/www/apps/docs/content/references/services/types/UpsertTypeInput.mdx +++ b/www/apps/docs/content/references/services/types/UpsertTypeInput.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpsertTypeInput - **UpsertTypeInput**: [Partial](Partial.mdx)<[ProductType](../classes/ProductType.mdx)> & { value: string } + **UpsertTypeInput**: [Partial](Partial.mdx)<[ProductType](../classes/ProductType.mdx)> & ``{ value: string }`` diff --git a/www/apps/docs/content/references/services/types/WithImplicitCoercion.mdx b/www/apps/docs/content/references/services/types/WithImplicitCoercion.mdx index c862cc3cdc..ed0b8872a3 100644 --- a/www/apps/docs/content/references/services/types/WithImplicitCoercion.mdx +++ b/www/apps/docs/content/references/services/types/WithImplicitCoercion.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # WithImplicitCoercion - **WithImplicitCoercion**``: T \| { valueOf: Method valueOf } + **WithImplicitCoercion**``: `T` \| ``{ valueOf: Method valueOf }`` ### Type parameters diff --git a/www/apps/docs/content/references/services/types/WithRequiredProperty.mdx b/www/apps/docs/content/references/services/types/WithRequiredProperty.mdx index b2ffca11ff..c2c1da9388 100644 --- a/www/apps/docs/content/references/services/types/WithRequiredProperty.mdx +++ b/www/apps/docs/content/references/services/types/WithRequiredProperty.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # WithRequiredProperty - **WithRequiredProperty**``: T & { [Property in K]-?: T[Property] } + **WithRequiredProperty**``: `T` & { [Property in K]-?: T[Property] } Utility type used to remove some optional attributes (coming from K) from a type T diff --git a/www/apps/docs/content/references/services/types/middlewareHandlerType.mdx b/www/apps/docs/content/references/services/types/middlewareHandlerType.mdx index 51542c6da9..ff3b3001e5 100644 --- a/www/apps/docs/content/references/services/types/middlewareHandlerType.mdx +++ b/www/apps/docs/content/references/services/types/middlewareHandlerType.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # middlewareHandlerType - **middlewareHandlerType**: (options: Record<string, unknown>) => RequestHandler + **middlewareHandlerType**: (`options`: `Record`) => `RequestHandler` ### Type declaration diff --git a/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.create.mdx b/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.create.mdx index 33755a0c81..3ad332e409 100644 --- a/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.create.mdx +++ b/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.create.mdx @@ -157,7 +157,7 @@ async function createStockLocation (name: 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": "", @@ -175,7 +175,7 @@ async function createStockLocation (name: string) { }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.retrieve.mdx b/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.retrieve.mdx index 042a42f74c..ac6708a44c 100644 --- a/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.retrieve.mdx +++ b/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.retrieve.mdx @@ -212,7 +212,7 @@ async function retrieveStockLocation (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": "", @@ -230,7 +230,7 @@ async function retrieveStockLocation (id: string) { }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.update.mdx b/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.update.mdx index dfc7f9d994..64050439d8 100644 --- a/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.update.mdx +++ b/www/apps/docs/content/references/stock-location/IStockLocationService/methods/IStockLocationService.update.mdx @@ -239,7 +239,7 @@ async function updateStockLocation (id:string, name: 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": "", @@ -257,7 +257,7 @@ async function updateStockLocation (id:string, name: string) { }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/stock-location/interfaces/JoinerServiceConfig.mdx b/www/apps/docs/content/references/stock-location/interfaces/JoinerServiceConfig.mdx index ebdcae936b..cb440b9833 100644 --- a/www/apps/docs/content/references/stock-location/interfaces/JoinerServiceConfig.mdx +++ b/www/apps/docs/content/references/stock-location/interfaces/JoinerServiceConfig.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "extends", - "type": "`{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }`[]", + "type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/stock-location/types/Exclude.mdx b/www/apps/docs/content/references/stock-location/types/Exclude.mdx index 32178ecb71..13163b096a 100644 --- a/www/apps/docs/content/references/stock-location/types/Exclude.mdx +++ b/www/apps/docs/content/references/stock-location/types/Exclude.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Exclude - **Exclude**``: T extends U ? never : T + **Exclude**``: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U diff --git a/www/apps/docs/content/references/stock-location/types/ModuleJoinerConfig.mdx b/www/apps/docs/content/references/stock-location/types/ModuleJoinerConfig.mdx index 8c03e537d0..984a6b01c7 100644 --- a/www/apps/docs/content/references/stock-location/types/ModuleJoinerConfig.mdx +++ b/www/apps/docs/content/references/stock-location/types/ModuleJoinerConfig.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerConfig - **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), `"serviceName"` \| `"primaryKeys"` \| `"relationships"` \| `"extends"`> & { databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: `"date"` \| `"time"` \| `"datetime"` \| `"bigint"` \| `"blob"` \| `"uint8array"` \| `"array"` \| `"enumArray"` \| `"enum"` \| `"json"` \| `"integer"` \| `"smallint"` \| `"tinyint"` \| `"mediumint"` \| `"float"` \| `"double"` \| `"boolean"` \| `"decimal"` \| `"string"` \| `"uuid"` \| `"text"` }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string } + **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & ``{ databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: "date" \| "time" \| "datetime" \| bigint \| "blob" \| "uint8array" \| "array" \| "enumArray" \| "enum" \| "json" \| "integer" \| "smallint" \| "tinyint" \| "mediumint" \| "float" \| "double" \| "boolean" \| "decimal" \| "string" \| "uuid" \| "text" }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }`` diff --git a/www/apps/docs/content/references/stock-location/types/ModuleJoinerRelationship.mdx b/www/apps/docs/content/references/stock-location/types/ModuleJoinerRelationship.mdx index 84391270af..1f7db26f7e 100644 --- a/www/apps/docs/content/references/stock-location/types/ModuleJoinerRelationship.mdx +++ b/www/apps/docs/content/references/stock-location/types/ModuleJoinerRelationship.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerRelationship - **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & { deleteCascade?: boolean ; isInternalService?: boolean } + **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & ``{ deleteCascade?: boolean ; isInternalService?: boolean }`` diff --git a/www/apps/docs/content/references/stock-location/types/StockLocationAddressDTO.mdx b/www/apps/docs/content/references/stock-location/types/StockLocationAddressDTO.mdx index ac0faede1d..a3335c1cfa 100644 --- a/www/apps/docs/content/references/stock-location/types/StockLocationAddressDTO.mdx +++ b/www/apps/docs/content/references/stock-location/types/StockLocationAddressDTO.mdx @@ -24,7 +24,7 @@ Represents a Stock Location Address }, { "name": "address_2", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' complement", "optional": true, "defaultValue": "", @@ -33,7 +33,7 @@ Represents a Stock Location Address }, { "name": "city", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' city", "optional": true, "defaultValue": "", @@ -42,7 +42,7 @@ Represents a Stock Location Address }, { "name": "company", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location company' name", "optional": true, "defaultValue": "", @@ -69,7 +69,7 @@ Represents a Stock Location Address }, { "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": "", @@ -87,7 +87,7 @@ Represents a Stock Location Address }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -96,7 +96,7 @@ Represents a Stock Location Address }, { "name": "phone", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' phone number", "optional": true, "defaultValue": "", @@ -105,7 +105,7 @@ Represents a Stock Location Address }, { "name": "postal_code", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' postal code", "optional": true, "defaultValue": "", @@ -114,7 +114,7 @@ Represents a Stock Location Address }, { "name": "province", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' province", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/stock-location/types/StockLocationDTO.mdx b/www/apps/docs/content/references/stock-location/types/StockLocationDTO.mdx index 74b383fb5d..783ca49e94 100644 --- a/www/apps/docs/content/references/stock-location/types/StockLocationDTO.mdx +++ b/www/apps/docs/content/references/stock-location/types/StockLocationDTO.mdx @@ -32,7 +32,7 @@ Represents a Stock Location }, { "name": "address_2", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' complement", "optional": true, "defaultValue": "", @@ -41,7 +41,7 @@ Represents a Stock Location }, { "name": "city", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' city", "optional": true, "defaultValue": "", @@ -50,7 +50,7 @@ Represents a Stock Location }, { "name": "company", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location company' name", "optional": true, "defaultValue": "", @@ -77,7 +77,7 @@ Represents 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": "", @@ -95,7 +95,7 @@ Represents a Stock Location }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", @@ -104,7 +104,7 @@ Represents a Stock Location }, { "name": "phone", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' phone number", "optional": true, "defaultValue": "", @@ -113,7 +113,7 @@ Represents a Stock Location }, { "name": "postal_code", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' postal code", "optional": true, "defaultValue": "", @@ -122,7 +122,7 @@ Represents a Stock Location }, { "name": "province", - "type": "`string` \\| ``null``", + "type": "`string` \\| `null`", "description": "Stock location address' province", "optional": true, "defaultValue": "", @@ -160,7 +160,7 @@ Represents 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": "", @@ -178,7 +178,7 @@ Represents a Stock Location }, { "name": "metadata", - "type": "`Record` \\| ``null``", + "type": "`Record` \\| `null`", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "",