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

chore(docs): Generated JS Client Reference (#5421)

Browse Source 
* chore(docs): Generated JS Client Reference (automated)

* fix js client reference

* fix links

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-10-20 14:01:27 +03:00
committed by GitHub
co-authored by olivermrbl Shahed nasser
parent 83f46b9b32
commit 9dcd62c731
1604 changed files with 211689 additions and 151746 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx
+418
View File
@@ -0,0 +1,418 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminCollectionsResource
[admin/collections](../../modules/admin_collections.mdx).AdminCollectionsResource
## Methods
### addProducts
▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the Collection",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "payload",
"type": "[`AdminPostProductsToCollectionReq`](../../internal/classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx)",
"description": "an object which contains an array of Product IDs to add to the Product Collection",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
Updates products associated with a Product Collection
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`AdminPostCollectionsReq`](../../internal/classes/admin_collections.internal.AdminPostCollectionsReq.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\\>",
"optional": false,
"defaultValue": "",
"description": "Created collection.",
"children": [
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
Creates a collection.
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of collection to delete.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\\>",
"optional": false,
"defaultValue": "",
"description": "Deleted response",
"children": [
{
"name": "DeleteResponse",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
deletes a collection
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "query",
"type": "[`AdminGetCollectionsParams`](../../internal/classes/admin_collections.internal.AdminGetCollectionsParams.mdx)",
"description": "Query for searching collections",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\\>",
"optional": false,
"defaultValue": "",
"description": "a list of collections matching the query.",
"children": [
{
"name": "AdminCollectionsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
Lists collections matching a query
___
### removeProducts
▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the Collection",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "payload",
"type": "[`AdminDeleteProductsFromCollectionReq`](../../internal/classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx)",
"description": "an object which contains an array of Product IDs to add to the Product Collection",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "AdminDeleteProductsFromCollectionRes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
Removes products associated with a Product Collection
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the collection to retrieve.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\\>",
"optional": false,
"defaultValue": "",
"description": "the collection with the given id",
"children": [
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
get a collection
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the collection to update.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "payload",
"type": "[`AdminPostCollectionsCollectionReq`](../../internal/classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx)",
"description": "update to apply to collection.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\\>",
"optional": false,
"defaultValue": "",
"description": "the updated collection.",
"children": [
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
#### Description
Updates a collection
www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx
+261
View File
@@ -0,0 +1,261 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# internal
## Enumerations
- [AllocationType](../../internal/enums/admin_collections.internal.AllocationType.mdx)
- [CartType](../../internal/enums/admin_collections.internal.CartType.mdx)
- [ClaimFulfillmentStatus](../../internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx)
- [ClaimPaymentStatus](../../internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx)
- [ClaimReason](../../internal/enums/admin_collections.internal.ClaimReason.mdx)
- [ClaimType](../../internal/enums/admin_collections.internal.ClaimType.mdx)
- [DiscountConditionOperator](../../internal/enums/admin_collections.internal.DiscountConditionOperator.mdx)
- [DiscountConditionType](../../internal/enums/admin_collections.internal.DiscountConditionType.mdx)
- [DiscountRuleType](../../internal/enums/admin_collections.internal.DiscountRuleType.mdx)
- [DraftOrderStatus](../../internal/enums/admin_collections.internal.DraftOrderStatus.mdx)
- [FulfillmentStatus](../../internal/enums/admin_collections.internal.FulfillmentStatus.mdx)
- [OrderEditItemChangeType](../../internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx)
- [OrderEditStatus](../../internal/enums/admin_collections.internal.OrderEditStatus.mdx)
- [OrderStatus](../../internal/enums/admin_collections.internal.OrderStatus.mdx)
- [PaymentCollectionStatus](../../internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx)
- [PaymentStatus](../../internal/enums/admin_collections.internal.PaymentStatus.mdx)
- [PriceListStatus](../../internal/enums/admin_collections.internal.PriceListStatus.mdx)
- [PriceListType](../../internal/enums/admin_collections.internal.PriceListType.mdx)
- [ProductStatus](../../internal/enums/admin_collections.internal.ProductStatus.mdx)
- [RequirementType](../../internal/enums/admin_collections.internal.RequirementType.mdx)
- [ReturnStatus](../../internal/enums/admin_collections.internal.ReturnStatus.mdx)
- [ShippingOptionPriceType](../../internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx)
- [ShippingProfileType](../../internal/enums/admin_collections.internal.ShippingProfileType.mdx)
- [SwapFulfillmentStatus](../../internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx)
- [SwapPaymentStatus](../../internal/enums/admin_collections.internal.SwapPaymentStatus.mdx)
## Classes
- [Address](../../internal/classes/admin_collections.internal.Address.mdx)
- [AdminDeleteProductsFromCollectionReq](../../internal/classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx)
- [AdminGetCollectionsPaginationParams](../../internal/classes/admin_collections.internal.AdminGetCollectionsPaginationParams.mdx)
- [AdminGetCollectionsParams](../../internal/classes/admin_collections.internal.AdminGetCollectionsParams.mdx)
- [AdminPostCollectionsCollectionReq](../../internal/classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx)
- [AdminPostCollectionsReq](../../internal/classes/admin_collections.internal.AdminPostCollectionsReq.mdx)
- [AdminPostProductsToCollectionReq](../../internal/classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx)
- [Cart](../../internal/classes/admin_collections.internal.Cart.mdx)
- [ClaimImage](../../internal/classes/admin_collections.internal.ClaimImage.mdx)
- [ClaimItem](../../internal/classes/admin_collections.internal.ClaimItem.mdx)
- [ClaimOrder](../../internal/classes/admin_collections.internal.ClaimOrder.mdx)
- [ClaimTag](../../internal/classes/admin_collections.internal.ClaimTag.mdx)
- [Country](../../internal/classes/admin_collections.internal.Country.mdx)
- [Currency](../../internal/classes/admin_collections.internal.Currency.mdx)
- [Customer](../../internal/classes/admin_collections.internal.Customer.mdx)
- [CustomerGroup](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)
- [Discount](../../internal/classes/admin_collections.internal.Discount.mdx)
- [DiscountCondition](../../internal/classes/admin_collections.internal.DiscountCondition.mdx)
- [DiscountRule](../../internal/classes/admin_collections.internal.DiscountRule.mdx)
- [DraftOrder](../../internal/classes/admin_collections.internal.DraftOrder.mdx)
- [Fulfillment](../../internal/classes/admin_collections.internal.Fulfillment.mdx)
- [FulfillmentItem](../../internal/classes/admin_collections.internal.FulfillmentItem.mdx)
- [FulfillmentProvider](../../internal/classes/admin_collections.internal.FulfillmentProvider.mdx)
- [GiftCard](../../internal/classes/admin_collections.internal.GiftCard.mdx)
- [GiftCardTransaction](../../internal/classes/admin_collections.internal.GiftCardTransaction.mdx)
- [Image](../../internal/classes/admin_collections.internal.Image.mdx)
- [LineItem](../../internal/classes/admin_collections.internal.LineItem.mdx)
- [LineItemAdjustment](../../internal/classes/admin_collections.internal.LineItemAdjustment.mdx)
- [LineItemTaxLine](../../internal/classes/admin_collections.internal.LineItemTaxLine.mdx)
- [MoneyAmount](../../internal/classes/admin_collections.internal.MoneyAmount.mdx)
- [Order](../../internal/classes/admin_collections.internal.Order.mdx)
- [OrderEdit](../../internal/classes/admin_collections.internal.OrderEdit.mdx)
- [OrderItemChange](../../internal/classes/admin_collections.internal.OrderItemChange.mdx)
- [Payment](../../internal/classes/admin_collections.internal.Payment.mdx)
- [PaymentCollection](../../internal/classes/admin_collections.internal.PaymentCollection.mdx)
- [PaymentProvider](../../internal/classes/admin_collections.internal.PaymentProvider.mdx)
- [PaymentSession](../../internal/classes/admin_collections.internal.PaymentSession.mdx)
- [PriceList](../../internal/classes/admin_collections.internal.PriceList.mdx)
- [Product](../../internal/classes/admin_collections.internal.Product.mdx)
- [ProductCategory](../../internal/classes/admin_collections.internal.ProductCategory.mdx)
- [ProductCollection](../../internal/classes/admin_collections.internal.ProductCollection.mdx)
- [ProductOption](../../internal/classes/admin_collections.internal.ProductOption.mdx)
- [ProductOptionValue](../../internal/classes/admin_collections.internal.ProductOptionValue.mdx)
- [ProductTag](../../internal/classes/admin_collections.internal.ProductTag.mdx)
- [ProductType](../../internal/classes/admin_collections.internal.ProductType.mdx)
- [ProductVariant](../../internal/classes/admin_collections.internal.ProductVariant.mdx)
- [ProductVariantInventoryItem](../../internal/classes/admin_collections.internal.ProductVariantInventoryItem.mdx)
- [Refund](../../internal/classes/admin_collections.internal.Refund.mdx)
- [Region](../../internal/classes/admin_collections.internal.Region.mdx)
- [Return](../../internal/classes/admin_collections.internal.Return.mdx)
- [ReturnItem](../../internal/classes/admin_collections.internal.ReturnItem.mdx)
- [ReturnReason](../../internal/classes/admin_collections.internal.ReturnReason.mdx)
- [SalesChannel](../../internal/classes/admin_collections.internal.SalesChannel.mdx)
- [SalesChannelLocation](../../internal/classes/admin_collections.internal.SalesChannelLocation.mdx)
- [ShippingMethod](../../internal/classes/admin_collections.internal.ShippingMethod.mdx)
- [ShippingMethodTaxLine](../../internal/classes/admin_collections.internal.ShippingMethodTaxLine.mdx)
- [ShippingOption](../../internal/classes/admin_collections.internal.ShippingOption.mdx)
- [ShippingOptionRequirement](../../internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx)
- [ShippingProfile](../../internal/classes/admin_collections.internal.ShippingProfile.mdx)
- [Swap](../../internal/classes/admin_collections.internal.Swap.mdx)
- [TaxLine](../../internal/classes/admin_collections.internal.TaxLine.mdx)
- [TaxProvider](../../internal/classes/admin_collections.internal.TaxProvider.mdx)
- [TaxRate](../../internal/classes/admin_collections.internal.TaxRate.mdx)
- [TrackingLink](../../internal/classes/admin_collections.internal.TrackingLink.mdx)
## Interfaces
- [Boolean](../../internal/interfaces/admin_collections.internal.Boolean.mdx)
## Enumeration Members
### ORDER\_EDIT
• **ORDER\_EDIT**: ``"order_edit"``
## Type Aliases
### AdminCollectionsListRes
Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }
#### Schema
AdminCollectionsListRes
type: object
required:
- collections
- count
- offset
- limit
properties:
collections:
type: array
description: an array of collection details
items:
$ref: "#/components/schemas/ProductCollection"
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of product collections skipped when retrieving the product collections.
limit:
type: integer
description: The number of items per page
___
### AdminCollectionsRes
Ƭ **AdminCollectionsRes**: `Object`
#### Schema
AdminCollectionsRes
type: object
x-expanded-relations:
field: collection
relations:
- products
required:
- collection
properties:
collection:
type: "Product Collection details."
$ref: "#/components/schemas/ProductCollection"
#### Type declaration
<ParameterTypes parameters={[
{
"name": "collection",
"type": "[`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
___
### AdminDeleteProductsFromCollectionRes
Ƭ **AdminDeleteProductsFromCollectionRes**: `Object`
#### Schema
The ID of the collection
#### Type declaration
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "object",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "removed_products",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
## Functions
### Boolean
▸ **Boolean**<`T`\>(`value?`): `boolean`
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "value",
"type": "`T`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`boolean`
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />