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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
www/apps/docs/content/references/services/classes/ShippingProfileService.mdx
View File

@@ -14,14 +14,14 @@ Provides layer to manipulate profiles.
### constructor
**new ShippingProfileService**(`«destructured»`)
`**new ShippingProfileService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-38.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-38.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -35,7 +35,7 @@ Provides layer to manipulate profiles.
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -53,7 +53,7 @@ Provides layer to manipulate profiles.
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -62,7 +62,7 @@ Provides layer to manipulate profiles.
},
{
"name": "customShippingOptionService_",
"type": "[`CustomShippingOptionService`](CustomShippingOptionService.mdx)",
"type": "[CustomShippingOptionService](CustomShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -71,7 +71,7 @@ Provides layer to manipulate profiles.
},
{
"name": "featureFlagRouter_",
"type": "[`FlagRouter`](FlagRouter.mdx)",
"type": "[FlagRouter](FlagRouter.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -80,7 +80,7 @@ Provides layer to manipulate profiles.
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -89,7 +89,7 @@ Provides layer to manipulate profiles.
},
{
"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&#60;[Product](Product.mdx)&#62; & `&#123; _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 &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -98,7 +98,7 @@ Provides layer to manipulate profiles.
},
{
"name": "productService_",
"type": "[`ProductService`](ProductService.mdx)",
"type": "[ProductService](ProductService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -107,7 +107,7 @@ Provides layer to manipulate profiles.
},
{
"name": "shippingOptionService_",
"type": "[`ShippingOptionService`](ShippingOptionService.mdx)",
"type": "[ShippingOptionService](ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -116,7 +116,7 @@ Provides layer to manipulate profiles.
},
{
"name": "shippingProfileRepository_",
"type": "`Repository`<[`ShippingProfile`](ShippingProfile.mdx)\\> & { `findByProducts`: Method findByProducts }",
"type": "Repository&#60;[ShippingProfile](ShippingProfile.mdx)&#62; & `&#123; findByProducts: Method findByProducts &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -125,7 +125,7 @@ Provides layer to manipulate profiles.
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -138,16 +138,16 @@ Provides layer to manipulate profiles.
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -160,7 +160,7 @@ Provides layer to manipulate profiles.
### addProduct
**addProduct**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**addProduct**(profileId, productId): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
#### Parameters
@@ -187,12 +187,12 @@ Provides layer to manipulate profiles.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -209,7 +209,7 @@ ___
### addProducts
**addProducts**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**addProducts**(profileId, productId): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
Adds a product or an array of products to the profile.
@@ -238,12 +238,12 @@ Adds a product or an array of products to the profile.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
@@ -256,7 +256,7 @@ ___
### addShippingOption
**addShippingOption**(`profileId`, `optionId`): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**addShippingOption**(profileId, optionId): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
Adds a shipping option to the profile. The shipping option can be used to
fulfill the products in the products field.
@@ -286,12 +286,12 @@ fulfill the products in the products field.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the model update operation",
@@ -304,7 +304,7 @@ ___
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -336,7 +336,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -345,7 +345,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -354,7 +354,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -365,12 +365,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -383,7 +383,7 @@ ___
### create
**create**(`profile`): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**create**(profile): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
Creates a new shipping profile.
@@ -392,7 +392,7 @@ Creates a new shipping profile.
<ParameterTypes parameters={[
{
"name": "profile",
"type": "[`CreateShippingProfile`](../types/CreateShippingProfile.mdx)",
"type": "[CreateShippingProfile](../types/CreateShippingProfile.mdx)",
"description": "the shipping profile to create from",
"optional": false,
"defaultValue": "",
@@ -403,12 +403,12 @@ Creates a new shipping profile.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
@@ -421,18 +421,18 @@ ___
### createDefault
**createDefault**(): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**createDefault**(): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
Creates a default shipping profile, if this does not already exist.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile",
@@ -445,19 +445,19 @@ ___
### createGiftCardDefault
**createGiftCardDefault**(): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**createGiftCardDefault**(): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
Creates a default shipping profile, for gift cards if unless it already
exists.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile",
@@ -470,7 +470,7 @@ ___
### delete
**delete**(`profileId`): `Promise`<`void`\>
`**delete**(profileId): Promise&#60;void&#62;`
Deletes a profile with a given profile id.
@@ -490,12 +490,12 @@ Deletes a profile with a given profile id.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation.",
@@ -508,7 +508,7 @@ ___
### fetchCartOptions
**fetchCartOptions**(`cart`): `Promise`<[`ShippingOption`](ShippingOption.mdx)[]\>
`**fetchCartOptions**(cart): Promise&#60;[ShippingOption](ShippingOption.mdx)[]&#62;`
Finds all the shipping profiles that cover the products in a cart, and
validates all options that are available for the cart.
@@ -529,12 +529,12 @@ validates all options that are available for the cart.
#### Returns
`Promise`<[`ShippingOption`](ShippingOption.mdx)[]\>
Promise&#60;[ShippingOption](ShippingOption.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingOption`](ShippingOption.mdx)[]\\>",
"type": "Promise&#60;[ShippingOption](ShippingOption.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a list of the available shipping options",
@@ -547,7 +547,7 @@ ___
### getMapProfileIdsByProductIds
**getMapProfileIdsByProductIds**(`productIds`): `Promise`<`Map`<`string`, `string`\>\>
`**getMapProfileIdsByProductIds**(productIds): Promise&#60;Map&#60;string, string&#62;&#62;`
#### Parameters
@@ -565,12 +565,12 @@ ___
#### Returns
`Promise`<`Map`<`string`, `string`\>\>
Promise&#60;Map&#60;string, string&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`Map`<`string`, `string`\\>\\>",
"type": "Promise&#60;Map&#60;string, string&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -583,7 +583,7 @@ ___
### getProfilesInCart
`Protected` **getProfilesInCart**(`cart`): `Promise`<`string`[]\>
`Protected **getProfilesInCart**(cart): Promise&#60;string[]&#62;`
Returns a list of all the productIds in the cart.
@@ -592,7 +592,7 @@ Returns a list of all the productIds in the cart.
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "the cart to extract products from",
"optional": false,
"defaultValue": "",
@@ -603,12 +603,12 @@ Returns a list of all the productIds in the cart.
#### Returns
`Promise`<`string`[]\>
Promise&#60;string[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`[]\\>",
"type": "Promise&#60;string[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a list of product ids",
@@ -621,14 +621,14 @@ ___
### list
**list**(`selector?`, `config?`): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)[]\>
`**list**(selector?, config?): Promise&#60;[ShippingProfile](ShippingProfile.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -637,7 +637,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"description": "the config object for find",
"optional": false,
"defaultValue": "",
@@ -648,12 +648,12 @@ ___
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)[]\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)[]\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
@@ -666,7 +666,7 @@ ___
### removeProducts
**removeProducts**(`profileId`, `productId`): `Promise`<`void` \| [`ShippingProfile`](ShippingProfile.mdx)\>
`**removeProducts**(profileId, productId): Promise&#60;void \| [ShippingProfile](ShippingProfile.mdx)&#62;`
Removes a product or an array of products from the profile.
@@ -695,12 +695,12 @@ Removes a product or an array of products from the profile.
#### Returns
`Promise`<`void` \| [`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;void \| [ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| [`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;void \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
@@ -713,7 +713,7 @@ ___
### retrieve
**retrieve**(`profileId`, `options?`): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**retrieve**(profileId, options?): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
Gets a profile by id.
Throws in case of DB Error and if profile was not found.
@@ -732,7 +732,7 @@ Throws in case of DB Error and if profile was not found.
},
{
"name": "options",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"description": "options opf the query.",
"optional": false,
"defaultValue": "{}",
@@ -743,12 +743,12 @@ Throws in case of DB Error and if profile was not found.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the profile document.",
@@ -761,16 +761,16 @@ ___
### retrieveDefault
**retrieveDefault**(): `Promise`<``null`` \| [`ShippingProfile`](ShippingProfile.mdx)\>
`**retrieveDefault**(): Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;`
#### Returns
`Promise`<``null`` \| [`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<``null`` \\| [`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;`null` \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -783,7 +783,7 @@ ___
### retrieveForProducts
**retrieveForProducts**(`productIds`): `Promise`<{ `[product_id: string]`: [`ShippingProfile`](ShippingProfile.mdx)[]; }\>
`**retrieveForProducts**(productIds): Promise&#60;&#123; [product_id: string]: [ShippingProfile](ShippingProfile.mdx)[]; &#125;&#62;`
#### Parameters
@@ -801,12 +801,12 @@ ___
#### Returns
`Promise`<{ `[product_id: string]`: [`ShippingProfile`](ShippingProfile.mdx)[]; }\>
Promise&#60;&#123; [product_id: string]: [ShippingProfile](ShippingProfile.mdx)[]; &#125;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<{ `[product_id: string]`: [`ShippingProfile`](ShippingProfile.mdx)[]; }\\>",
"type": "Promise&#60;&#123; [product_id: string]: [ShippingProfile](ShippingProfile.mdx)[]; &#125;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -819,18 +819,18 @@ ___
### retrieveGiftCardDefault
**retrieveGiftCardDefault**(): `Promise`<``null`` \| [`ShippingProfile`](ShippingProfile.mdx)\>
`**retrieveGiftCardDefault**(): Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;`
Retrieves the default gift card profile
#### Returns
`Promise`<``null`` \| [`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<``null`` \\| [`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;`null` \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile for gift cards",
@@ -843,14 +843,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -879,7 +879,7 @@ ___
### update
**update**(`profileId`, `update`): `Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
`**update**(profileId, update): Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;`
Updates a profile. Metadata updates and product updates should use
dedicated methods, e.g. `setMetadata`, `addProduct`, etc. The function
@@ -899,7 +899,7 @@ will throw errors if metadata or product updates are attempted.
},
{
"name": "update",
"type": "[`UpdateShippingProfile`](../types/UpdateShippingProfile.mdx)",
"type": "[UpdateShippingProfile](../types/UpdateShippingProfile.mdx)",
"description": "an object with the update values.",
"optional": false,
"defaultValue": "",
@@ -910,12 +910,12 @@ will throw errors if metadata or product updates are attempted.
#### Returns
`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\>
Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`ShippingProfile`](ShippingProfile.mdx)\\>",
"type": "Promise&#60;[ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the update result.",
@@ -928,14 +928,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`ShippingProfileService`](ShippingProfileService.mdx)
`**withTransaction**(transactionManager?): [ShippingProfileService](ShippingProfileService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -946,12 +946,12 @@ ___
#### Returns
[`ShippingProfileService`](ShippingProfileService.mdx)
[ShippingProfileService](ShippingProfileService.mdx)
<ParameterTypes parameters={[
{
"name": "ShippingProfileService",
"type": "[`ShippingProfileService`](ShippingProfileService.mdx)",
"type": "[ShippingProfileService](ShippingProfileService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",