02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
212 lines
5.5 KiB
Markdown
212 lines
5.5 KiB
Markdown
# Namespace: internal
|
|
|
|
## Classes
|
|
|
|
- [AdminGetProductsParams](../classes/internal-16.AdminGetProductsParams.md)
|
|
- [AdminPostProductsProductMetadataReq](../classes/internal-16.AdminPostProductsProductMetadataReq.md)
|
|
- [AdminPostProductsProductOptionsOption](../classes/internal-16.AdminPostProductsProductOptionsOption.md)
|
|
- [AdminPostProductsProductOptionsReq](../classes/internal-16.AdminPostProductsProductOptionsReq.md)
|
|
- [AdminPostProductsProductReq](../classes/internal-16.AdminPostProductsProductReq.md)
|
|
- [AdminPostProductsProductVariantsReq](../classes/internal-16.AdminPostProductsProductVariantsReq.md)
|
|
- [AdminPostProductsProductVariantsVariantReq](../classes/internal-16.AdminPostProductsProductVariantsVariantReq.md)
|
|
- [AdminPostProductsReq](../classes/internal-16.AdminPostProductsReq.md)
|
|
- [FilterableProductProps](../classes/internal-16.FilterableProductProps.md)
|
|
- [ProductOptionReq](../classes/internal-16.ProductOptionReq.md)
|
|
- [ProductSalesChannelReq](../classes/internal-16.ProductSalesChannelReq.md)
|
|
- [ProductTagReq](../classes/internal-16.ProductTagReq.md)
|
|
- [ProductTypeReq](../classes/internal-16.ProductTypeReq.md)
|
|
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq.md)
|
|
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-1.md)
|
|
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-2.md)
|
|
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-3.md)
|
|
- [ProductVariantPricesCreateReq](../classes/internal-16.ProductVariantPricesCreateReq.md)
|
|
- [ProductVariantPricesUpdateReq](../classes/internal-16.ProductVariantPricesUpdateReq.md)
|
|
- [ProductVariantReq](../classes/internal-16.ProductVariantReq.md)
|
|
- [ProductVariantReq](../classes/internal-16.ProductVariantReq-1.md)
|
|
|
|
## Type Aliases
|
|
|
|
### AdminProductsDeleteOptionRes
|
|
|
|
Ƭ **AdminProductsDeleteOptionRes**: `Object`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `deleted` | `boolean` |
|
|
| `object` | ``"option"`` |
|
|
| `option_id` | `string` |
|
|
| `product` | [`Product`](../classes/internal.Product.md) |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/api/routes/admin/products/index.d.ts:13
|
|
|
|
___
|
|
|
|
### AdminProductsDeleteRes
|
|
|
|
Ƭ **AdminProductsDeleteRes**: `Object`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `deleted` | `boolean` |
|
|
| `id` | `string` |
|
|
| `object` | ``"product"`` |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/api/routes/admin/products/index.d.ts:25
|
|
|
|
___
|
|
|
|
### AdminProductsDeleteVariantRes
|
|
|
|
Ƭ **AdminProductsDeleteVariantRes**: `Object`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `deleted` | `boolean` |
|
|
| `object` | ``"product-variant"`` |
|
|
| `product` | [`Product`](../classes/internal.Product.md) |
|
|
| `variant_id` | `string` |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/api/routes/admin/products/index.d.ts:19
|
|
|
|
___
|
|
|
|
### AdminProductsListRes
|
|
|
|
Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-16.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] }
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/api/routes/admin/products/index.d.ts:30
|
|
|
|
___
|
|
|
|
### AdminProductsListTagsRes
|
|
|
|
Ƭ **AdminProductsListTagsRes**: `Object`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/api/routes/admin/products/index.d.ts:36
|
|
|
|
___
|
|
|
|
### AdminProductsListTypesRes
|
|
|
|
Ƭ **AdminProductsListTypesRes**: `Object`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `types` | [`ProductType`](../classes/internal.ProductType.md)[] |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/api/routes/admin/products/index.d.ts:33
|
|
|
|
___
|
|
|
|
### AdminProductsRes
|
|
|
|
Ƭ **AdminProductsRes**: `Object`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `product` | [`Product`](../classes/internal.Product.md) |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/api/routes/admin/products/index.d.ts:39
|
|
|
|
___
|
|
|
|
### PricedProduct
|
|
|
|
Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-16.md#pricedvariant)[] }
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/types/pricing.d.ts:28
|
|
|
|
___
|
|
|
|
### PricedVariant
|
|
|
|
Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-16.md#productvariantpricing)
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/types/pricing.d.ts:27
|
|
|
|
___
|
|
|
|
### ProductVariantPricing
|
|
|
|
Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-16.md#taxedpricing)
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/types/pricing.d.ts:4
|
|
|
|
___
|
|
|
|
### TaxServiceRate
|
|
|
|
Ƭ **TaxServiceRate**: `Object`
|
|
|
|
The tax rate object as configured in Medusa. These may have an unspecified
|
|
numerical rate as they may be used for lookup purposes in the tax provider
|
|
plugin.
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `code` | `string` \| ``null`` |
|
|
| `name` | `string` |
|
|
| `rate?` | `number` \| ``null`` |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/types/tax-service.d.ts:6
|
|
|
|
___
|
|
|
|
### TaxedPricing
|
|
|
|
Ƭ **TaxedPricing**: `Object`
|
|
|
|
#### Type declaration
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `calculated_price_incl_tax` | `number` \| ``null`` |
|
|
| `calculated_tax` | `number` \| ``null`` |
|
|
| `original_price_incl_tax` | `number` \| ``null`` |
|
|
| `original_tax` | `number` \| ``null`` |
|
|
| `tax_rates` | [`TaxServiceRate`](internal-16.md#taxservicerate)[] \| ``null`` |
|
|
|
|
#### Defined in
|
|
|
|
medusa/dist/types/pricing.d.ts:10
|