docs: generate medusa-react reference (#6004)
* add new plugin for better organization * added handling in theme for mutations and query types * added tsdoc to hooks * added tsdocs to utility functions * added tsdoc to providers * generated reference * general fixes for generated reference * generated api reference specs + general fixes * add missing import react * split utilities into different directories * added overview page * added link to customer authentication section * fix lint errors * added changeset * fix readme * fixed build error * added expand fields + other sections to overview * updated what's new section * general refactoring * remove unnecessary query field * fix links * added ignoreApi option
This commit is contained in:
Shahed Nasser
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The customers to remove from the customer group.
|
||||
required:
|
||||
- customer_ids
|
||||
properties:
|
||||
|
||||
+2
-1
@@ -1,7 +1,8 @@
|
||||
type: object
|
||||
description: The details of the prices to delete.
|
||||
properties:
|
||||
price_ids:
|
||||
description: The price IDs of the Money Amounts to delete.
|
||||
description: The IDs of the prices to delete.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the products' prices to delete.
|
||||
properties:
|
||||
product_ids:
|
||||
description: The IDs of the products to delete their associated prices.
|
||||
|
||||
+2
-1
@@ -1,9 +1,10 @@
|
||||
type: object
|
||||
description: The details of the products to delete from the product category.
|
||||
required:
|
||||
- product_ids
|
||||
properties:
|
||||
product_ids:
|
||||
description: The IDs of the products to delete from the Product Category.
|
||||
description: The IDs of the products to delete from the product category.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the products to remove from the collection.
|
||||
required:
|
||||
- product_ids
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the sales channels to remove from the publishable API key.
|
||||
required:
|
||||
- sales_channel_ids
|
||||
properties:
|
||||
|
||||
+2
-1
@@ -1,9 +1,10 @@
|
||||
type: object
|
||||
description: The details of the products to delete from the sales channel.
|
||||
required:
|
||||
- product_ids
|
||||
properties:
|
||||
product_ids:
|
||||
description: The IDs of the products to remove from the Sales Channel.
|
||||
description: The IDs of the products to remove from the sales channel.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the products to remove their associated with the tax rate.
|
||||
required:
|
||||
- products
|
||||
properties:
|
||||
|
||||
+3
@@ -1,4 +1,7 @@
|
||||
type: object
|
||||
description: >-
|
||||
The details of the shipping options to remove their associate with the tax
|
||||
rate.
|
||||
required:
|
||||
- shipping_options
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the file to delete.
|
||||
required:
|
||||
- file_key
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The payment collection's details.
|
||||
x-expanded-relations:
|
||||
field: payment_collection
|
||||
relations:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The admin's credentials used to log in.
|
||||
required:
|
||||
- email
|
||||
- password
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the batch job to create.
|
||||
required:
|
||||
- type
|
||||
- context
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The product collection's details to update.
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The product collection's details.
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update in the currency
|
||||
properties:
|
||||
includes_tax:
|
||||
type: boolean
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The customers to add to the customer group.
|
||||
required:
|
||||
- customer_ids
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update in the customer group.
|
||||
properties:
|
||||
name:
|
||||
description: Name of the customer group
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the customer group to create.
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the customer to update.
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the customer to create.
|
||||
required:
|
||||
- email
|
||||
- first_name
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the resources to add.
|
||||
required:
|
||||
- resources
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the dynamic discount to create.
|
||||
required:
|
||||
- code
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the discount to update.
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the discount to create.
|
||||
required:
|
||||
- code
|
||||
- rule
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the line item.
|
||||
properties:
|
||||
unit_price:
|
||||
description: >-
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the line item to create.
|
||||
required:
|
||||
- quantity
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the draft order to update.
|
||||
properties:
|
||||
region_id:
|
||||
type: string
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the draft order to create.
|
||||
required:
|
||||
- email
|
||||
- region_id
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the gift card.
|
||||
properties:
|
||||
balance:
|
||||
type: integer
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the gift card to create.
|
||||
required:
|
||||
- region_id
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the location level to create.
|
||||
required:
|
||||
- location_id
|
||||
- stocked_quantity
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the inventory item to create.
|
||||
required:
|
||||
- variant_id
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the note.
|
||||
required:
|
||||
- value
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the note to be created.
|
||||
required:
|
||||
- resource_id
|
||||
- resource_type
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The resend details.
|
||||
properties:
|
||||
to:
|
||||
description: >-
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to create or update of the line item change.
|
||||
required:
|
||||
- quantity
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the line item change to create.
|
||||
required:
|
||||
- variant_id
|
||||
- quantity
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the order edit.
|
||||
properties:
|
||||
internal_note:
|
||||
description: An optional note to create or update in the order edit.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the order edit to create.
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the order refund.
|
||||
required:
|
||||
- amount
|
||||
- reason
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the order.
|
||||
properties:
|
||||
email:
|
||||
description: The email associated with the order
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the requested return.
|
||||
required:
|
||||
- items
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the shipment to create.
|
||||
required:
|
||||
- fulfillment_id
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the swap to create.
|
||||
required:
|
||||
- return_items
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the refund to create.
|
||||
required:
|
||||
- amount
|
||||
- reason
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the prices to add.
|
||||
properties:
|
||||
prices:
|
||||
description: The prices to update or add.
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the payment collection.
|
||||
properties:
|
||||
name:
|
||||
description: The name of the Price List
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the price list to create.
|
||||
required:
|
||||
- name
|
||||
- description
|
||||
|
||||
+2
-1
@@ -1,9 +1,10 @@
|
||||
type: object
|
||||
description: The details of the products to add to the product category.
|
||||
required:
|
||||
- product_ids
|
||||
properties:
|
||||
product_ids:
|
||||
description: The IDs of the products to add to the Product Category
|
||||
description: The IDs of the products to add to the product category
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the product category.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the product category to create.
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the product option to create.
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the product.
|
||||
properties:
|
||||
title:
|
||||
description: The title of the Product
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the product variant to create.
|
||||
required:
|
||||
- title
|
||||
- prices
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the product to create.
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the products to add to the collection.
|
||||
required:
|
||||
- product_ids
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the sales channels to add to the publishable API key.
|
||||
required:
|
||||
- sales_channel_ids
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the publishable API key.
|
||||
properties:
|
||||
title:
|
||||
description: The title of the Publishable API Key.
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the publishable API key to create.
|
||||
required:
|
||||
- title
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the country to add to the region.
|
||||
required:
|
||||
- country_code
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the fulfillment provider to add to the region.
|
||||
required:
|
||||
- provider_id
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the payment provider to add to the region.
|
||||
required:
|
||||
- provider_id
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the regions.
|
||||
properties:
|
||||
name:
|
||||
description: The name of the Region
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the region to create.
|
||||
required:
|
||||
- name
|
||||
- currency_code
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the reservation to create.
|
||||
required:
|
||||
- location_id
|
||||
- inventory_item_id
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the reservation.
|
||||
properties:
|
||||
location_id:
|
||||
description: The ID of the location associated with the reservation.
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the return reason.
|
||||
properties:
|
||||
label:
|
||||
description: The label to display to the Customer.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the return reason to create.
|
||||
required:
|
||||
- label
|
||||
- value
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the received return.
|
||||
required:
|
||||
- items
|
||||
properties:
|
||||
|
||||
+2
-1
@@ -1,9 +1,10 @@
|
||||
type: object
|
||||
description: The details of the products to add to the sales channel.
|
||||
required:
|
||||
- product_ids
|
||||
properties:
|
||||
product_ids:
|
||||
description: The IDs of the products to add to the Sales Channel
|
||||
description: The IDs of the products to add to the sales channel
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the sales channel to create.
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the sales channel.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the shipping option.
|
||||
required:
|
||||
- requirements
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the shipping option to create.
|
||||
required:
|
||||
- name
|
||||
- region_id
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The detail to update of the shipping profile.
|
||||
properties:
|
||||
name:
|
||||
description: The name of the Shipping Profile
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the shipping profile to create.
|
||||
required:
|
||||
- name
|
||||
- type
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the stock location.
|
||||
properties:
|
||||
name:
|
||||
description: the name of the stock location
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the stock location to create.
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the store.
|
||||
properties:
|
||||
name:
|
||||
description: The name of the Store
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the tax rate to create.
|
||||
required:
|
||||
- code
|
||||
- name
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the products to associat with the tax rate.
|
||||
required:
|
||||
- products
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the tax rate.
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the shipping options to associate with the tax rate.
|
||||
required:
|
||||
- shipping_options
|
||||
properties:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the file to retrieve its download URL.
|
||||
required:
|
||||
- file_key
|
||||
properties:
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the password reset request.
|
||||
required:
|
||||
- token
|
||||
- password
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details of the password reset token request.
|
||||
required:
|
||||
- email
|
||||
properties:
|
||||
|
||||
@@ -8,6 +8,7 @@ required:
|
||||
properties:
|
||||
stock_locations:
|
||||
type: array
|
||||
description: The list of stock locations.
|
||||
items:
|
||||
$ref: ./StockLocationExpandedDTO.yaml
|
||||
count:
|
||||
|
||||
+1
@@ -1,4 +1,5 @@
|
||||
type: object
|
||||
description: The details to update of the payment collection.
|
||||
properties:
|
||||
description:
|
||||
description: A description to create or update the payment collection.
|
||||
|
||||
Reference in New Issue
Block a user