Commit Graph

80 Commits

Author SHA1 Message Date
github-actions[bot]
d6d7d14a6a chore(docs): Generated References (automated) (#14471)
Generated the following references:
- `analytics`
- `analytics_provider`
- `api_key`
- `api_key_models`
- `auth`
- `auth_models`
- `cart`
- `cart_models`
- `core_flows`
- `currency`
- `currency_models`
- `customer`
- `customer_models`
- `event`
- `events`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `fulfillment_provider`
- `inventory_next`
- `inventory_next_models`
- `js_sdk`
- `medusa`
- `module_events`
- `modules`
- `modules_sdk`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region`
- `region_models`
- `sales_channel`
- `sales_channel_models`
- `stock_location_next`
- `stock_location_next_models`
- `store`
- `store_models`
- `tax`
- `tax_models`
- `tax_provider`
- `translation`
- `translation_models`
- `types`
- `user`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> No changes to summarize — the provided diff was empty.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit fe58b669976b04475e6d0f16eb185976cb527d3b. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2026-01-06 17:30:16 +00:00
Shahed Nasser
1c4c4b8e9a docs: generate references manually for 2.12.3 (#14340) 2025-12-17 18:20:19 +02:00
Shahed Nasser
c1a5390fc6 docs: translation module (#14271)
* docs: translation module

* fix link in JS SDK

* add translations user guides [WIP]

* updates

* fix broken link

* remove mentions of default locale

* change header

* updates

* updated user guides

* handle todos

* fix build error

* fix lint errors
2025-12-17 13:07:43 +02:00
github-actions[bot]
21f61ec160 chore(docs): Generated References (automated) (#14182)
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `helper_steps`
- `inventory_next_models`
- `js_sdk`
- `module_events`
- `modules`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values.
> 
> - **Docs Generation**:
>   - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples.
> - **Fulfillment Workflows/Steps**:
>   - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`).
>   - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag.
>   - Refreshed example snippets and sample values.
> - **Notification Step** (`sendNotificationsStep`):
>   - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional.
>   - Output includes `provider_data` and `attachments` fields.
> - **Order Steps/Workflows**:
>   - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions.
>   - Example payloads adjusted (IDs, currencies, amounts).
> - **Meta**:
>   - Updated `<SourceCodeLink>` URLs to new commit hashes throughout.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-12-02 06:59:52 +00:00
Shahed Nasser
cdbb4b925b docs: fixes to recipes and examples following latest update (#13933) 2025-11-03 17:22:59 +02:00
github-actions[bot]
fffc1be1e7 chore(docs): Generated References (automated) (#13921)
* chore(docs): Generated References (automated)

* fix error + generate references

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-10-31 15:32:21 +02:00
github-actions[bot]
858b3e3b9b chore(docs): Generated References (automated) (#13793)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-10-21 11:56:37 +03:00
Shahed Nasser
76f9da5ef4 docs: Caching Module (#13701)
* standard docs for caching module + deprecated cache module

* added guides for creating + using, and overall changes from cache to caching

* fix details related to redis provider

* fix build errors

* fix build error

* fixes

* add guides to sidebar

* add sidebar util

* document query + index

* moved cache tag conventions

* fix build errors

* added migration guide

* added memcached guide

* fixes

* general fixes and updates

* updated reference

* document medusa cache

* small fix

* fixes

* remove cloud cache

* revert edit dates changes

* revert edit dates

* small update
2025-10-21 10:34:27 +03:00
github-actions[bot]
138e340917 chore(docs): Generated References (automated) (#13544)
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `modules`
- `order`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-09-19 06:21:46 +00:00
Shahed Nasser
55cf7a7b97 docs: regenerate core-flows reference to pick up locking steps (#13502) 2025-09-15 13:29:03 +03:00
github-actions[bot]
c066fe993f chore(docs): Generated References (automated) (#13492)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-09-15 11:57:03 +03:00
Shahed Nasser
f39ba53fd3 docs: document scheduled jobs interval (#13350) 2025-08-29 15:14:26 +03:00
github-actions[bot]
f8c0bd887e chore(docs): Generated References (automated) (#12672)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-06-10 09:33:54 +03:00
Shahed Nasser
40e73c6ea2 docs: fix broken links utility + uncaught broken links (#12637)
* fix broken links

* update broken links utility

* add missing payment evens

* generate llms

* fix segment link
2025-05-28 17:13:27 +03:00
github-actions[bot]
6725bee130 chore(docs): Generated References (automated) (#12580)
Generated the following references:
- `_index.mdx`
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file_service`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `medusa`
- `modules`
- `modules_sdk`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-05-22 12:35:49 +00:00
Shahed Nasser
04e0b43ed8 docs: document analytics module (#12563) 2025-05-22 15:05:04 +03:00
github-actions[bot]
aaf5407d29 chore(docs): Generated References (automated) (#12511)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-05-16 15:29:29 +03:00
Shahed Nasser
22cdcedddc docs: improve payment related guides (#12502)
* improve guide

* update guides

* small change
2025-05-15 18:40:21 +03:00
github-actions[bot]
e81d2333bc chore(docs): Generated References (automated) (#12492)
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `modules`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-05-15 08:36:24 +00:00
github-actions[bot]
5c36bafc1d chore(docs): Generated References (automated) (#12460)
Generated the following references:
- `_index.mdx`
- `api_key`
- `api_key_models`
- `auth`
- `auth_models`
- `auth_provider`
- `cart`
- `cart_models`
- `core_flows`
- `currency`
- `currency_models`
- `customer`
- `customer_models`
- `events`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `fulfillment_provider`
- `inventory_next`
- `inventory_next_models`
- `js_sdk`
- `locking`
- `medusa`
- `module_events`
- `modules`
- `modules_sdk`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region`
- `region_models`
- `sales_channel`
- `sales_channel_models`
- `stock_location_next`
- `stock_location_next_models`
- `store`
- `store_models`
- `tax`
- `tax_models`
- `tax_provider`
- `types`
- `user`
- `user_models`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-05-13 13:31:57 +00:00
Shahed Nasser
70a99a2434 docs: generate events reference (#12341)
* docs: generate events reference

* change link in navbar

* fix redirect
2025-05-01 19:39:53 +03:00
Shahed Nasser
4946b67152 docs: regenerate core-flows reference + OAS for draft order updates (#12280)
* docs: regenerate core-flows reference for updates in draft orders

* generate OAS
2025-04-24 12:01:46 +03:00
Shahed Nasser
7d498227d1 docs: fix core flows reference not generating (#12274) 2025-04-23 19:46:54 +03:00
github-actions[bot]
94e98190ff chore(docs): Generated References (automated) (#12154)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `cart_models`
- `core_flows`
- `currency`
- `customer`
- `event`
- `file_service`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `js_sdk`
- `locking`
- `medusa`
- `modules`
- `modules_sdk`
- `notification_service`
- `order`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-04-11 11:15:08 +00:00
Shahed Nasser
cb68a9e67b docs: added how-to guides for architectural modules (#11883)
* added initial how-tos

* finished changes

* generated sidebars
2025-03-18 09:49:19 +02:00
Shahed Nasser
28b0d08591 docs: add documentation for Locking Module (#11824)
* add locking docs

* fix main navbar

* added implementation example links

* generate refs

* update architecture

* fix vale error
2025-03-13 12:20:24 +02:00
Shahed Nasser
a26f48fde2 finalize changes 2025-03-11 12:18:40 +02:00
github-actions[bot]
af613bbc4e chore(docs): Generated References (automated) (#11718)
Generated the following references:
- `cart`
- `cart_models`
- `core_flows`
- `fulfillment`
- `js_sdk`
- `medusa`
- `modules`
- `order`
- `payment`
- `payment_provider`
- `types`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-03-04 14:14:00 +00:00
github-actions[bot]
41f070be9a chore(docs): Generated References (automated) (#11579)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-02-24 13:47:40 +02:00
github-actions[bot]
dc94e62a6a chore(docs): Generated References (automated) (#11395)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `utils`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-02-11 12:02:30 +00:00
Shahed Nasser
4ccb489dbe docs: generate references manually for 2.4.0 (#11171) 2025-01-27 17:00:42 +02:00
Shahed Nasser
45847fef19 docs: generate references for v2.3.0 (#11035) 2025-01-17 19:05:02 +02:00
Shahed Nasser
d9ea65dfc4 chore(docs): generate references following latest workflows reference changes (#10943) 2025-01-13 19:48:33 +02:00
github-actions[bot]
5216ad2f15 chore(docs): Generated References (automated) (#10866)
Generated the following references:
- `auth`
- `auth_provider`
- `core_flows`
- `fulfillment`
- `fulfillment_provider`
- `js_sdk`
- `medusa`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `stock_location_next`
- `stock_location_next_models`
- `types`
- `utils`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-01-07 13:14:10 +00:00
Shahed Nasser
870cb6e88c docs: update typedoc, convert packages to esm, generate references (#10699) 2024-12-23 15:20:09 +02:00
Shahed Nasser
0f5d640736 docs: generate references manually for v2.1.2 (#10639)
* docs: manually generate references for v2.1.2

* more changes
2024-12-17 19:20:44 +02:00
Shahed Nasser
ab1bfb966d docs: generate references manually for 2.1.1 (#10534)
* docs: generate references manually for 2.1.1

* re-generate for core-flows

* Revert "re-generate for core-flows"

This reverts commit ff785c80214dc6125e2da4c6e8a674a87b03e9dd.
2024-12-10 18:49:30 +02:00
github-actions[bot]
9534751b5c chore(docs): Generated References (automated) (#10508)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2024-12-09 15:27:01 +02:00
Shahed Nasser
1cb885d566 docs: generate references manually (#10438) 2024-12-04 21:37:07 +02:00
Shahed Nasser
030b0cc095 docs: generate references manually (#10325)
* docs: generate references

* prep changes
2024-11-27 19:27:25 +02:00
Shahed Nasser
e10fb34eb9 docs: fix slugs pointing to admin rather than store routes (#10063) 2024-11-13 10:42:58 +02:00
github-actions[bot]
fc01ae68c0 chore(docs): Generated References (automated) (#9961)
Generated the following references:
- `api_key`
- `cart`
- `cart_models`
- `core_flows`
- `customer`
- `fulfillment`
- `inventory_next`
- `js_sdk`
- `medusa_config`
- `modules`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `stock_location_next`
- `tax`
- `tax_provider`
- `types`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-11-11 08:17:50 +00:00
github-actions[bot]
c4cd2c2d7c chore(docs): Generated References (automated) (#9803)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-26 16:33:31 +02:00
github-actions[bot]
5deeae060a chore(docs): Generated References (automated) (#9727)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:41:14 +00:00
Shahed Nasser
a1190b7208 docs: generate + configure js sdk reference (#9714)
Manually generate the JS SDK reference + add it to the sidebar
2024-10-22 17:31:32 +00:00
github-actions[bot]
f2d662efca chore(docs): Generated References (automated) (#9567)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-14 19:59:14 +02:00
github-actions[bot]
224e530453 chore(docs): Generated References (#9551)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `modules`
- `modules_sdk`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-10-14 10:33:21 +00:00
github-actions[bot]
c536f7caf5 chore(docs): Generated References (automated) (#9436)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-10-03 11:03:35 +03:00
github-actions[bot]
175ca30f4f chore(docs): Generated References (#9153)
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `customer_models`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`
2024-09-17 07:17:55 +00:00
github-actions[bot]
95a3ac045d chore(docs): Generated References (#9034)
Generated the following references:
- `auth`
- `core_flows`
- `fulfillment`
- `modules`
- `modules_sdk`
- `order`
- `types`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:39:45 +00:00