From edd93bbecb01ceb39d5d9c6ed032675035896d85 Mon Sep 17 00:00:00 2001 From: Noru Date: Mon, 8 Aug 2022 13:02:56 +0530 Subject: [PATCH 01/19] docs: fixed Next.js link in S3 plugin documentation (#2006) --- docs/content/add-plugins/s3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/add-plugins/s3.md b/docs/content/add-plugins/s3.md index 13277caf64..35ff63d287 100644 --- a/docs/content/add-plugins/s3.md +++ b/docs/content/add-plugins/s3.md @@ -150,7 +150,7 @@ You can also check that the image was uploaded on the S3 bucket’s page. ## Next.js Storefront Configuration -If you’re using a [Next.js](../starters/nextjs-medusa-starter.md storefront, you need to add an additional configuration that adds the S3 bucket domain name into the configured images’ domain names. This is because all URLs of product images will be from the S3 bucket. +If you’re using a [Next.js](../starters/nextjs-medusa-starter.md) storefront, you need to add an additional configuration that adds the S3 bucket domain name into the configured images’ domain names. This is because all URLs of product images will be from the S3 bucket. If this configuration is not added, you’ll receive the error ["next/image Un-configured Host”](https://nextjs.org/docs/messages/next-image-unconfigured-host). From 1c6fcb2ede9b7b8ea67a87d4e2fdecf0f3bb7c6c Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 8 Aug 2022 11:27:48 +0300 Subject: [PATCH 02/19] docs: added video track event (#2010) --- www/docs/src/theme/Layout/index.js | 37 ++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 www/docs/src/theme/Layout/index.js diff --git a/www/docs/src/theme/Layout/index.js b/www/docs/src/theme/Layout/index.js new file mode 100644 index 0000000000..4c36cc6004 --- /dev/null +++ b/www/docs/src/theme/Layout/index.js @@ -0,0 +1,37 @@ +import React, { useEffect } from 'react'; + +import Layout from '@theme-original/Layout'; +import useIsBrowser from '@docusaurus/useIsBrowser'; +import {useLocation} from '@docusaurus/router'; + +export default function LayoutWrapper(props) { + + const isBrowser = useIsBrowser(); + const location = useLocation(); + + useEffect(() => { + if (isBrowser) { + if (window.analytics) { + function handlePlay() { + window.analytics.track('video_played'); + } + + const videos = document.querySelectorAll('video'); + videos.forEach((video) => video.addEventListener('play', handlePlay, { + once: true, + capture: true + })) + + return () => { + videos.forEach((video) => video.removeEventListener('play', handlePlay)); + } + } + } + }, [isBrowser, location.pathname]); + + return ( + <> + + + ); +} From cef081d2f22e065a839aad4b89bb8ffc33c66a3b Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 8 Aug 2022 17:35:13 +0300 Subject: [PATCH 03/19] docs: Change `:id` to `{id}` in OAS comments (#2015) --- docs/api/admin-spec3.json | 1967 +++++++------- docs/api/admin-spec3.yaml | 517 ++-- docs/api/admin/openapi.yaml | 34 +- ...ts.yaml => price-lists_{id}_products.yaml} | 6 + docs/api/admin/paths/tax-rates_:id.yaml | 102 - docs/api/admin/paths/tax-rates_{id}.yaml | 114 + ...> tax-rates_{id}_product-types_batch.yaml} | 12 + ...aml => tax-rates_{id}_products_batch.yaml} | 12 + ...ax-rates_{id}_shipping-options_batch.yaml} | 12 + docs/api/store-spec3.json | 2374 ++++++++--------- docs/api/store-spec3.yaml | 900 +++---- docs/api/store/openapi.yaml | 44 +- .../price-lists/list-price-list-products.ts | 3 +- .../admin/tax-rates/add-to-product-types.ts | 5 +- .../routes/admin/tax-rates/add-to-products.ts | 5 +- .../tax-rates/add-to-shipping-options.ts | 5 +- .../routes/admin/tax-rates/get-tax-rate.ts | 3 +- .../tax-rates/remove-from-product-types.ts | 5 +- .../admin/tax-rates/remove-from-products.ts | 5 +- .../tax-rates/remove-from-shipping-options.ts | 5 +- .../routes/admin/tax-rates/update-tax-rate.ts | 3 +- 21 files changed, 3163 insertions(+), 2970 deletions(-) rename docs/api/admin/paths/{price-lists_:id_products.yaml => price-lists_{id}_products.yaml} (97%) delete mode 100644 docs/api/admin/paths/tax-rates_:id.yaml rename docs/api/admin/paths/{tax-rates_:id_product-types_batch.yaml => tax-rates_{id}_product-types_batch.yaml} (90%) rename docs/api/admin/paths/{tax-rates_:id_products_batch.yaml => tax-rates_{id}_products_batch.yaml} (90%) rename docs/api/admin/paths/{tax-rates_:id_shipping-options_batch.yaml => tax-rates_{id}_shipping-options_batch.yaml} (90%) diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index a494f08980..f077587a31 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -254,6 +254,102 @@ } } }, + "/auth": { + "post": { + "operationId": "PostAuth", + "summary": "Authenticate a User", + "x-authenticated": false, + "description": "Logs a User in and authorizes them to manage Store settings.", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "email", + "password" + ], + "properties": { + "email": { + "type": "string", + "description": "The User's email." + }, + "password": { + "type": "string", + "description": "The User's password." + } + } + } + } + } + }, + "tags": [ + "Auth" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "user": { + "$ref": "#/components/schemas/user" + } + } + } + } + } + }, + "401": { + "description": "The user doesn't exist or the credentials are incorrect." + } + } + }, + "delete": { + "operationId": "DeleteAuth", + "summary": "Delete Session", + "x-authenticated": true, + "description": "Deletes the current session for the logged in user.", + "tags": [ + "Auth" + ], + "responses": { + "200": { + "description": "OK" + } + } + }, + "get": { + "operationId": "GetAuth", + "summary": "Get Session", + "x-authenticated": true, + "description": "Gets the currently logged in User.", + "tags": [ + "Auth" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "user": { + "$ref": "#/components/schemas/user" + } + } + } + } + } + }, + "400": { + "description": "An error occurred." + } + } + } + }, "/batch-jobs/{id}/cancel": { "post": { "operationId": "PostBatchJobsBatchJobCancel", @@ -790,102 +886,6 @@ } } }, - "/auth": { - "post": { - "operationId": "PostAuth", - "summary": "Authenticate a User", - "x-authenticated": false, - "description": "Logs a User in and authorizes them to manage Store settings.", - "parameters": [], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "email", - "password" - ], - "properties": { - "email": { - "type": "string", - "description": "The User's email." - }, - "password": { - "type": "string", - "description": "The User's password." - } - } - } - } - } - }, - "tags": [ - "Auth" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "user": { - "$ref": "#/components/schemas/user" - } - } - } - } - } - }, - "401": { - "description": "The user doesn't exist or the credentials are incorrect." - } - } - }, - "delete": { - "operationId": "DeleteAuth", - "summary": "Delete Session", - "x-authenticated": true, - "description": "Deletes the current session for the logged in user.", - "tags": [ - "Auth" - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "get": { - "operationId": "GetAuth", - "summary": "Get Session", - "x-authenticated": true, - "description": "Gets the currently logged in User.", - "tags": [ - "Auth" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "user": { - "$ref": "#/components/schemas/user" - } - } - } - } - } - }, - "400": { - "description": "An error occurred." - } - } - } - }, "/collections/{id}/products/batch": { "post": { "operationId": "PostProductsToCollection", @@ -1385,308 +1385,6 @@ } } }, - "/customers": { - "post": { - "operationId": "PostCustomers", - "summary": "Create a Customer", - "description": "Creates a Customer.", - "x-authenticated": true, - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "email", - "first_name", - "last_name", - "password" - ], - "properties": { - "email": { - "type": "string", - "description": "The customer's email.", - "format": "email" - }, - "first_name": { - "type": "string", - "description": "The customer's first name." - }, - "last_name": { - "type": "string", - "description": "The customer's last name." - }, - "password": { - "type": "string", - "description": "The customer's password.", - "format": "password" - }, - "phone": { - "type": "string", - "description": "The customer's phone number." - }, - "metadata": { - "description": "An optional set of key-value pairs to hold additional information.", - "type": "object" - } - } - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - }, - "get": { - "operationId": "GetCustomers", - "summary": "List Customers", - "description": "Retrieves a list of Customers.", - "x-authenticated": true, - "parameters": [ - { - "in": "query", - "name": "limit", - "description": "The number of items to return.", - "schema": { - "type": "integer", - "default": 50 - } - }, - { - "in": "query", - "name": "offset", - "description": "The items to skip before result.", - "schema": { - "type": "integer", - "default": 0 - } - }, - { - "in": "query", - "name": "expand", - "description": "(Comma separated) Which fields should be expanded in each customer.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "q", - "description": "a search term to search email, first_name, and last_name.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/customer" - } - }, - "count": { - "type": "integer", - "description": "The total number of items available" - }, - "offset": { - "type": "integer", - "description": "The number of items skipped before these items" - }, - "limit": { - "type": "integer", - "description": "The number of items per page" - } - } - } - } - } - } - } - } - }, - "/customers/{id}": { - "get": { - "operationId": "GetCustomersCustomer", - "summary": "Retrieve a Customer", - "description": "Retrieves a Customer.", - "x-authenticated": true, - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The ID of the Customer.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "expand", - "description": "(Comma separated) Which fields should be expanded in the customer.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fields", - "description": "(Comma separated) Which fields should be included in the customer.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - }, - "post": { - "operationId": "PostCustomersCustomer", - "summary": "Update a Customer", - "description": "Updates a Customer.", - "x-authenticated": true, - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The ID of the Customer.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "expand", - "description": "(Comma separated) Which fields should be expanded in each customer.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fields", - "description": "(Comma separated) Which fields should be retrieved in each customer.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "email": { - "type": "string", - "description": "The Customer's email.", - "format": "email" - }, - "first_name": { - "type": "string", - "description": "The Customer's first name." - }, - "last_name": { - "type": "string", - "description": "The Customer's last name." - }, - "phone": { - "type": "string", - "description": "The Customer's phone number." - }, - "password": { - "type": "string", - "description": "The Customer's password.", - "format": "password" - }, - "groups": { - "type": "array", - "items": { - "required": [ - "id" - ], - "properties": { - "id": { - "description": "The ID of a customer group", - "type": "string" - } - } - }, - "description": "A list of customer groups to which the customer belongs." - }, - "metadata": { - "description": "An optional set of key-value pairs to hold additional information.", - "type": "object" - } - } - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - } - }, "/customer-groups/{id}/customers/batch": { "post": { "operationId": "PostCustomerGroupsGroupCustomersBatch", @@ -2277,6 +1975,308 @@ } } }, + "/customers": { + "post": { + "operationId": "PostCustomers", + "summary": "Create a Customer", + "description": "Creates a Customer.", + "x-authenticated": true, + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "email", + "first_name", + "last_name", + "password" + ], + "properties": { + "email": { + "type": "string", + "description": "The customer's email.", + "format": "email" + }, + "first_name": { + "type": "string", + "description": "The customer's first name." + }, + "last_name": { + "type": "string", + "description": "The customer's last name." + }, + "password": { + "type": "string", + "description": "The customer's password.", + "format": "password" + }, + "phone": { + "type": "string", + "description": "The customer's phone number." + }, + "metadata": { + "description": "An optional set of key-value pairs to hold additional information.", + "type": "object" + } + } + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + }, + "get": { + "operationId": "GetCustomers", + "summary": "List Customers", + "description": "Retrieves a list of Customers.", + "x-authenticated": true, + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "The number of items to return.", + "schema": { + "type": "integer", + "default": 50 + } + }, + { + "in": "query", + "name": "offset", + "description": "The items to skip before result.", + "schema": { + "type": "integer", + "default": 0 + } + }, + { + "in": "query", + "name": "expand", + "description": "(Comma separated) Which fields should be expanded in each customer.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "q", + "description": "a search term to search email, first_name, and last_name.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/customer" + } + }, + "count": { + "type": "integer", + "description": "The total number of items available" + }, + "offset": { + "type": "integer", + "description": "The number of items skipped before these items" + }, + "limit": { + "type": "integer", + "description": "The number of items per page" + } + } + } + } + } + } + } + } + }, + "/customers/{id}": { + "get": { + "operationId": "GetCustomersCustomer", + "summary": "Retrieve a Customer", + "description": "Retrieves a Customer.", + "x-authenticated": true, + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The ID of the Customer.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "expand", + "description": "(Comma separated) Which fields should be expanded in the customer.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fields", + "description": "(Comma separated) Which fields should be included in the customer.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + }, + "post": { + "operationId": "PostCustomersCustomer", + "summary": "Update a Customer", + "description": "Updates a Customer.", + "x-authenticated": true, + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The ID of the Customer.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "expand", + "description": "(Comma separated) Which fields should be expanded in each customer.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fields", + "description": "(Comma separated) Which fields should be retrieved in each customer.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "email": { + "type": "string", + "description": "The Customer's email.", + "format": "email" + }, + "first_name": { + "type": "string", + "description": "The Customer's first name." + }, + "last_name": { + "type": "string", + "description": "The Customer's last name." + }, + "phone": { + "type": "string", + "description": "The Customer's phone number." + }, + "password": { + "type": "string", + "description": "The Customer's password.", + "format": "password" + }, + "groups": { + "type": "array", + "items": { + "required": [ + "id" + ], + "properties": { + "id": { + "description": "The ID of a customer group", + "type": "string" + } + } + }, + "description": "A list of customer groups to which the customer belongs." + }, + "metadata": { + "description": "An optional set of key-value pairs to hold additional information.", + "type": "object" + } + } + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + } + }, "/discounts/{id}/regions/{region_id}": { "post": { "operationId": "PostDiscountsDiscountRegionsRegion", @@ -7302,167 +7302,6 @@ } } }, - "/product-types": { - "get": { - "operationId": "GetProductTypes", - "summary": "List Product Types", - "description": "Retrieve a list of Product Types.", - "x-authenticated": true, - "parameters": [ - { - "in": "query", - "name": "limit", - "description": "The number of types to return.", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "in": "query", - "name": "offset", - "description": "The number of items to skip before the results.", - "schema": { - "type": "integer", - "default": 0 - } - }, - { - "in": "query", - "name": "order", - "description": "The field to sort items by.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "value", - "style": "form", - "explode": false, - "description": "The type values to search for", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "in": "query", - "name": "id", - "style": "form", - "explode": false, - "description": "The type IDs to search for", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "in": "query", - "name": "q", - "description": "A query string to search values for", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "created_at", - "description": "Date comparison for when resulting product types were created.", - "schema": { - "type": "object", - "properties": { - "lt": { - "type": "string", - "description": "filter by dates less than this date", - "format": "date" - }, - "gt": { - "type": "string", - "description": "filter by dates greater than this date", - "format": "date" - }, - "lte": { - "type": "string", - "description": "filter by dates less than or equal to this date", - "format": "date" - }, - "gte": { - "type": "string", - "description": "filter by dates greater than or equal to this date", - "format": "date" - } - } - } - }, - { - "in": "query", - "name": "updated_at", - "description": "Date comparison for when resulting product types were updated.", - "schema": { - "type": "object", - "properties": { - "lt": { - "type": "string", - "description": "filter by dates less than this date", - "format": "date" - }, - "gt": { - "type": "string", - "description": "filter by dates greater than this date", - "format": "date" - }, - "lte": { - "type": "string", - "description": "filter by dates less than or equal to this date", - "format": "date" - }, - "gte": { - "type": "string", - "description": "filter by dates greater than or equal to this date", - "format": "date" - } - } - } - } - ], - "tags": [ - "Product Type" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "product_types": { - "$ref": "#/components/schemas/product_type" - }, - "count": { - "type": "integer", - "description": "The total number of items available" - }, - "offset": { - "type": "integer", - "description": "The number of items skipped before these items" - }, - "limit": { - "type": "integer", - "description": "The number of items per page" - } - } - } - } - } - } - } - } - }, "/price-lists/{id}/prices/batch": { "post": { "operationId": "PostPriceListsPriceListPricesBatch", @@ -8341,13 +8180,22 @@ } } }, - "/price-lists/:id/products": { + "/price-lists/{id}/products": { "get": { "operationId": "GetPriceListsPriceListProducts", "summary": "List Product in a Price List", "description": "Retrieves a list of Product that are part of a Price List", "x-authenticated": true, "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the price list.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "q", @@ -8618,6 +8466,167 @@ } } }, + "/product-types": { + "get": { + "operationId": "GetProductTypes", + "summary": "List Product Types", + "description": "Retrieve a list of Product Types.", + "x-authenticated": true, + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "The number of types to return.", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "in": "query", + "name": "offset", + "description": "The number of items to skip before the results.", + "schema": { + "type": "integer", + "default": 0 + } + }, + { + "in": "query", + "name": "order", + "description": "The field to sort items by.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "value", + "style": "form", + "explode": false, + "description": "The type values to search for", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "id", + "style": "form", + "explode": false, + "description": "The type IDs to search for", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "q", + "description": "A query string to search values for", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "created_at", + "description": "Date comparison for when resulting product types were created.", + "schema": { + "type": "object", + "properties": { + "lt": { + "type": "string", + "description": "filter by dates less than this date", + "format": "date" + }, + "gt": { + "type": "string", + "description": "filter by dates greater than this date", + "format": "date" + }, + "lte": { + "type": "string", + "description": "filter by dates less than or equal to this date", + "format": "date" + }, + "gte": { + "type": "string", + "description": "filter by dates greater than or equal to this date", + "format": "date" + } + } + } + }, + { + "in": "query", + "name": "updated_at", + "description": "Date comparison for when resulting product types were updated.", + "schema": { + "type": "object", + "properties": { + "lt": { + "type": "string", + "description": "filter by dates less than this date", + "format": "date" + }, + "gt": { + "type": "string", + "description": "filter by dates greater than this date", + "format": "date" + }, + "lte": { + "type": "string", + "description": "filter by dates less than or equal to this date", + "format": "date" + }, + "gte": { + "type": "string", + "description": "filter by dates greater than or equal to this date", + "format": "date" + } + } + } + } + ], + "tags": [ + "Product Type" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "product_types": { + "$ref": "#/components/schemas/product_type" + }, + "count": { + "type": "integer", + "description": "The total number of items available" + }, + "offset": { + "type": "integer", + "description": "The number of items skipped before these items" + }, + "limit": { + "type": "integer", + "description": "The number of items per page" + } + } + } + } + } + } + } + } + }, "/products/{id}/options": { "post": { "operationId": "PostProductsProductOptions", @@ -11194,6 +11203,178 @@ } } }, + "/returns/{id}/cancel": { + "post": { + "operationId": "PostReturnsReturnCancel", + "summary": "Cancel a Return", + "description": "Registers a Return as canceled.", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The ID of the Return.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Return" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "order": { + "$ref": "#/components/schemas/order" + } + } + } + } + } + } + } + } + }, + "/returns": { + "get": { + "operationId": "GetReturns", + "summary": "List Returns", + "description": "Retrieves a list of Returns", + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "The upper limit for the amount of responses returned.", + "schema": { + "type": "number", + "default": "50" + } + }, + { + "in": "query", + "name": "offset", + "description": "The offset of the list returned.", + "schema": { + "type": "number", + "default": "0" + } + } + ], + "tags": [ + "Return" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "returns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/return" + } + }, + "count": { + "type": "integer", + "description": "The total number of items available" + }, + "offset": { + "type": "integer", + "description": "The number of items skipped before these items" + }, + "limit": { + "type": "integer", + "description": "The number of items per page" + } + } + } + } + } + } + } + } + }, + "/returns/{id}/receive": { + "post": { + "operationId": "PostReturnsReturnReceive", + "summary": "Receive a Return", + "description": "Registers a Return as received. Updates statuses on Orders and Swaps accordingly.", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The ID of the Return.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "items" + ], + "properties": { + "items": { + "description": "The Line Items that have been received.", + "type": "array", + "items": { + "required": [ + "item_id", + "quantity" + ], + "properties": { + "item_id": { + "description": "The ID of the Line Item.", + "type": "string" + }, + "quantity": { + "description": "The quantity of the Line Item.", + "type": "integer" + } + } + } + }, + "refund": { + "description": "The amount to refund.", + "type": "number" + } + } + } + } + } + }, + "tags": [ + "Return" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "return": { + "$ref": "#/components/schemas/return" + } + } + } + } + } + } + } + } + }, "/return-reasons": { "post": { "operationId": "PostReturnReasons", @@ -11430,178 +11611,6 @@ } } }, - "/returns/{id}/cancel": { - "post": { - "operationId": "PostReturnsReturnCancel", - "summary": "Cancel a Return", - "description": "Registers a Return as canceled.", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The ID of the Return.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Return" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "order": { - "$ref": "#/components/schemas/order" - } - } - } - } - } - } - } - } - }, - "/returns": { - "get": { - "operationId": "GetReturns", - "summary": "List Returns", - "description": "Retrieves a list of Returns", - "parameters": [ - { - "in": "query", - "name": "limit", - "description": "The upper limit for the amount of responses returned.", - "schema": { - "type": "number", - "default": "50" - } - }, - { - "in": "query", - "name": "offset", - "description": "The offset of the list returned.", - "schema": { - "type": "number", - "default": "0" - } - } - ], - "tags": [ - "Return" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "returns": { - "type": "array", - "items": { - "$ref": "#/components/schemas/return" - } - }, - "count": { - "type": "integer", - "description": "The total number of items available" - }, - "offset": { - "type": "integer", - "description": "The number of items skipped before these items" - }, - "limit": { - "type": "integer", - "description": "The number of items per page" - } - } - } - } - } - } - } - } - }, - "/returns/{id}/receive": { - "post": { - "operationId": "PostReturnsReturnReceive", - "summary": "Receive a Return", - "description": "Registers a Return as received. Updates statuses on Orders and Swaps accordingly.", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The ID of the Return.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "items" - ], - "properties": { - "items": { - "description": "The Line Items that have been received.", - "type": "array", - "items": { - "required": [ - "item_id", - "quantity" - ], - "properties": { - "item_id": { - "description": "The ID of the Line Item.", - "type": "string" - }, - "quantity": { - "description": "The quantity of the Line Item.", - "type": "integer" - } - } - } - }, - "refund": { - "description": "The amount to refund.", - "type": "number" - } - } - } - } - } - }, - "tags": [ - "Return" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "return": { - "$ref": "#/components/schemas/return" - } - } - } - } - } - } - } - } - }, "/sales-channels/{id}/products/batch": { "post": { "operationId": "PostSalesChannelsChannelProductsBatch", @@ -12135,6 +12144,212 @@ } } }, + "/shipping-profiles": { + "post": { + "operationId": "PostShippingProfiles", + "summary": "Create a Shipping Profile", + "description": "Creates a Shipping Profile", + "x-authenticated": true, + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the Shipping Profile", + "type": "string" + } + } + } + } + } + }, + "tags": [ + "Shipping Profile" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "shipping_profile": { + "$ref": "#/components/schemas/shipping_profile" + } + } + } + } + } + } + } + }, + "get": { + "operationId": "GetShippingProfiles", + "summary": "List Shipping Profiles", + "description": "Retrieves a list of Shipping Profile.", + "x-authenticated": true, + "tags": [ + "Shipping Profile" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "shipping_profiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/shipping_profile" + } + } + } + } + } + } + } + } + } + }, + "/shipping-profiles/{id}": { + "delete": { + "operationId": "DeleteShippingProfilesProfile", + "summary": "Delete a Shipping Profile", + "description": "Deletes a Shipping Profile.", + "x-authenticated": true, + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The ID of the Shipping Profile.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Shipping Profile" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the deleted Shipping Profile." + }, + "object": { + "type": "string", + "description": "The type of the object that was deleted.", + "default": "shipping_profile" + }, + "deleted": { + "type": "boolean", + "description": "Whether or not the items were deleted.", + "default": true + } + } + } + } + } + } + } + }, + "get": { + "operationId": "GetShippingProfilesProfile", + "summary": "Retrieve a Shipping Profile", + "description": "Retrieves a Shipping Profile.", + "x-authenticated": true, + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The ID of the Shipping Profile.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Shipping Profile" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "shipping_profile": { + "$ref": "#/components/schemas/shipping_profile" + } + } + } + } + } + } + } + }, + "post": { + "operationId": "PostShippingProfilesProfile", + "summary": "Update a Shipping Profiles", + "description": "Updates a Shipping Profile", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The ID of the Shipping Profile.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "The name of the Shipping Profile", + "type": "string" + } + } + } + } + } + }, + "tags": [ + "Shipping Profile" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "shipping_profile": { + "$ref": "#/components/schemas/shipping_profile" + } + } + } + } + } + } + } + } + }, "/shipping-options": { "post": { "operationId": "PostShippingOptions", @@ -12485,212 +12700,6 @@ } } }, - "/shipping-profiles": { - "post": { - "operationId": "PostShippingProfiles", - "summary": "Create a Shipping Profile", - "description": "Creates a Shipping Profile", - "x-authenticated": true, - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "name" - ], - "properties": { - "name": { - "description": "The name of the Shipping Profile", - "type": "string" - } - } - } - } - } - }, - "tags": [ - "Shipping Profile" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "shipping_profile": { - "$ref": "#/components/schemas/shipping_profile" - } - } - } - } - } - } - } - }, - "get": { - "operationId": "GetShippingProfiles", - "summary": "List Shipping Profiles", - "description": "Retrieves a list of Shipping Profile.", - "x-authenticated": true, - "tags": [ - "Shipping Profile" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "shipping_profiles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/shipping_profile" - } - } - } - } - } - } - } - } - } - }, - "/shipping-profiles/{id}": { - "delete": { - "operationId": "DeleteShippingProfilesProfile", - "summary": "Delete a Shipping Profile", - "description": "Deletes a Shipping Profile.", - "x-authenticated": true, - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The ID of the Shipping Profile.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Shipping Profile" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "type": "string", - "description": "The ID of the deleted Shipping Profile." - }, - "object": { - "type": "string", - "description": "The type of the object that was deleted.", - "default": "shipping_profile" - }, - "deleted": { - "type": "boolean", - "description": "Whether or not the items were deleted.", - "default": true - } - } - } - } - } - } - } - }, - "get": { - "operationId": "GetShippingProfilesProfile", - "summary": "Retrieve a Shipping Profile", - "description": "Retrieves a Shipping Profile.", - "x-authenticated": true, - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The ID of the Shipping Profile.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Shipping Profile" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "shipping_profile": { - "$ref": "#/components/schemas/shipping_profile" - } - } - } - } - } - } - } - }, - "post": { - "operationId": "PostShippingProfilesProfile", - "summary": "Update a Shipping Profiles", - "description": "Updates a Shipping Profile", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The ID of the Shipping Profile.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "The name of the Shipping Profile", - "type": "string" - } - } - } - } - } - }, - "tags": [ - "Shipping Profile" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "shipping_profile": { - "$ref": "#/components/schemas/shipping_profile" - } - } - } - } - } - } - } - } - }, "/store/currencies/{code}": { "post": { "operationId": "PostStoreCurrenciesCode", @@ -13030,12 +13039,21 @@ } } }, - "/tax-rates/:id/product-types/batch": { + "/tax-rates/{id}/product-types/batch": { "post": { "operationId": "PostTaxRatesTaxRateProductTypes", "summary": "Add Tax Rate to Product Types", "description": "Associates a Tax Rate with a list of Product Types", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", @@ -13109,6 +13127,15 @@ "summary": "Remove Tax Rate from Product Types", "description": "Removes a Tax Rate from a list of Product Types", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", @@ -13178,12 +13205,21 @@ } } }, - "/tax-rates/:id/products/batch": { + "/tax-rates/{id}/products/batch": { "post": { "operationId": "PostTaxRatesTaxRateProducts", "summary": "Add Tax Rate to Products", "description": "Associates a Tax Rate with a list of Products", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", @@ -13257,6 +13293,15 @@ "summary": "Removes Tax Rate from Products", "description": "Removes a Tax Rate from a list of Products", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", @@ -13326,12 +13371,21 @@ } } }, - "/tax-rates/:id/shipping-options/batch": { + "/tax-rates/{id}/shipping-options/batch": { "post": { "operationId": "PostTaxRatesTaxRateShippingOptions", "summary": "Add Tax Rate to Product Types", "description": "Associates a Tax Rate with a list of Shipping Options", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", @@ -13405,6 +13459,15 @@ "summary": "Removes a Tax Rate from Product Types", "description": "Removes a Tax Rate from a list of Product Types", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", @@ -13785,14 +13848,21 @@ } } } - } - }, - "/tax-rates/:id": { + }, "get": { "operationId": "GetTaxRatesTaxRate", "summary": "Get Tax Rate", "description": "Retrieves a TaxRate", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", @@ -13846,6 +13916,15 @@ "summary": "Update a Tax Rate", "description": "Updates a Tax Rate", "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "ID of the tax rate.", + "schema": { + "type": "string" + } + }, { "in": "query", "name": "fields", diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index 70b30f6aa6..3af16e5f85 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -109,6 +109,60 @@ tags: servers: - url: 'https://api.medusa-commerce.com/admin' paths: + /apps/authorizations: + post: + operationId: PostApps + summary: Generates a token for an application. + description: Generates a token for an application. + x-authenticated: true + requestBody: + content: + application/json: + schema: + required: + - application_name + - state + - code + properties: + application_name: + type: string + description: Name of the application for the token to be generated for. + state: + type: string + description: State of the application. + code: + type: string + description: The code for the generated token. + tags: + - App + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + apps: + $ref: '#/components/schemas/OAuth' + /apps: + get: + operationId: GetApps + summary: List applications + description: Retrieve a list of applications. + x-authenticated: true + tags: + - App + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + apps: + type: array + items: + $ref: '#/components/schemas/OAuth' /auth: post: operationId: PostAuth @@ -1297,209 +1351,6 @@ paths: limit: type: integer description: The number of items per page - /customers: - post: - operationId: PostCustomers - summary: Create a Customer - description: Creates a Customer. - x-authenticated: true - requestBody: - content: - application/json: - schema: - required: - - email - - first_name - - last_name - - password - properties: - email: - type: string - description: The customer's email. - format: email - first_name: - type: string - description: The customer's first name. - last_name: - type: string - description: The customer's last name. - password: - type: string - description: The customer's password. - format: password - phone: - type: string - description: The customer's phone number. - metadata: - description: >- - An optional set of key-value pairs to hold additional - information. - type: object - tags: - - Customer - responses: - '201': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - get: - operationId: GetCustomers - summary: List Customers - description: Retrieves a list of Customers. - x-authenticated: true - parameters: - - in: query - name: limit - description: The number of items to return. - schema: - type: integer - default: 50 - - in: query - name: offset - description: The items to skip before result. - schema: - type: integer - default: 0 - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: q - description: 'a search term to search email, first_name, and last_name.' - schema: - type: string - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customers: - type: array - items: - $ref: '#/components/schemas/customer' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - '/customers/{id}': - get: - operationId: GetCustomersCustomer - summary: Retrieve a Customer - description: Retrieves a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the customer. - schema: - type: string - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - post: - operationId: PostCustomersCustomer - summary: Update a Customer - description: Updates a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in each customer. - schema: - type: string - requestBody: - content: - application/json: - schema: - properties: - email: - type: string - description: The Customer's email. - format: email - first_name: - type: string - description: The Customer's first name. - last_name: - type: string - description: The Customer's last name. - phone: - type: string - description: The Customer's phone number. - password: - type: string - description: The Customer's password. - format: password - groups: - type: array - items: - required: - - id - properties: - id: - description: The ID of a customer group - type: string - description: A list of customer groups to which the customer belongs. - metadata: - description: >- - An optional set of key-value pairs to hold additional - information. - type: object - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' '/discounts/{id}/regions/{region_id}': post: operationId: PostDiscountsDiscountRegionsRegion @@ -2414,49 +2265,85 @@ paths: properties: discount: $ref: '#/components/schemas/discount' - /apps/authorizations: + /customers: post: - operationId: PostApps - summary: Generates a token for an application. - description: Generates a token for an application. + operationId: PostCustomers + summary: Create a Customer + description: Creates a Customer. x-authenticated: true requestBody: content: application/json: schema: required: - - application_name - - state - - code + - email + - first_name + - last_name + - password properties: - application_name: + email: type: string - description: Name of the application for the token to be generated for. - state: + description: The customer's email. + format: email + first_name: type: string - description: State of the application. - code: + description: The customer's first name. + last_name: type: string - description: The code for the generated token. + description: The customer's last name. + password: + type: string + description: The customer's password. + format: password + phone: + type: string + description: The customer's phone number. + metadata: + description: >- + An optional set of key-value pairs to hold additional + information. + type: object tags: - - App + - Customer responses: - '200': + '201': description: OK content: application/json: schema: properties: - apps: - $ref: '#/components/schemas/OAuth' - /apps: + customer: + $ref: '#/components/schemas/customer' get: - operationId: GetApps - summary: List applications - description: Retrieve a list of applications. + operationId: GetCustomers + summary: List Customers + description: Retrieves a list of Customers. x-authenticated: true + parameters: + - in: query + name: limit + description: The number of items to return. + schema: + type: integer + default: 50 + - in: query + name: offset + description: The items to skip before result. + schema: + type: integer + default: 0 + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: q + description: 'a search term to search email, first_name, and last_name.' + schema: + type: string tags: - - App + - Customer responses: '200': description: OK @@ -2464,10 +2351,123 @@ paths: application/json: schema: properties: - apps: + customers: type: array items: - $ref: '#/components/schemas/OAuth' + $ref: '#/components/schemas/customer' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '/customers/{id}': + get: + operationId: GetCustomersCustomer + summary: Retrieve a Customer + description: Retrieves a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the customer. + schema: + type: string + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + post: + operationId: PostCustomersCustomer + summary: Update a Customer + description: Updates a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in each customer. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + email: + type: string + description: The Customer's email. + format: email + first_name: + type: string + description: The Customer's first name. + last_name: + type: string + description: The Customer's last name. + phone: + type: string + description: The Customer's phone number. + password: + type: string + description: The Customer's password. + format: password + groups: + type: array + items: + required: + - id + properties: + id: + description: The ID of a customer group + type: string + description: A list of customer groups to which the customer belongs. + metadata: + description: >- + An optional set of key-value pairs to hold additional + information. + type: object + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' /draft-orders: post: operationId: PostDraftOrders @@ -5657,13 +5657,19 @@ paths: type: boolean description: Whether or not the items were deleted. default: true - '/price-lists/:id/products': + '/price-lists/{id}/products': get: operationId: GetPriceListsPriceListProducts summary: List Product in a Price List description: Retrieves a list of Product that are part of a Price List x-authenticated: true parameters: + - in: path + name: id + required: true + description: ID of the price list. + schema: + type: string - in: query name: q description: >- @@ -9170,12 +9176,18 @@ paths: limit: type: integer description: The number of items per page - '/tax-rates/:id/product-types/batch': + '/tax-rates/{id}/product-types/batch': post: operationId: PostTaxRatesTaxRateProductTypes summary: Add Tax Rate to Product Types description: Associates a Tax Rate with a list of Product Types parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -9225,6 +9237,12 @@ paths: summary: Remove Tax Rate from Product Types description: Removes a Tax Rate from a list of Product Types parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -9269,12 +9287,18 @@ paths: properties: tax_rate: $ref: '#/components/schemas/tax_rate' - '/tax-rates/:id/products/batch': + '/tax-rates/{id}/products/batch': post: operationId: PostTaxRatesTaxRateProducts summary: Add Tax Rate to Products description: Associates a Tax Rate with a list of Products parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -9322,6 +9346,12 @@ paths: summary: Removes Tax Rate from Products description: Removes a Tax Rate from a list of Products parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -9366,12 +9396,18 @@ paths: properties: tax_rate: $ref: '#/components/schemas/tax_rate' - '/tax-rates/:id/shipping-options/batch': + '/tax-rates/{id}/shipping-options/batch': post: operationId: PostTaxRatesTaxRateShippingOptions summary: Add Tax Rate to Product Types description: Associates a Tax Rate with a list of Shipping Options parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -9421,6 +9457,12 @@ paths: summary: Removes a Tax Rate from Product Types description: Removes a Tax Rate from a list of Product Types parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -9675,12 +9717,17 @@ paths: type: boolean description: Whether or not the items were deleted. default: true - '/tax-rates/:id': get: operationId: GetTaxRatesTaxRate summary: Get Tax Rate description: Retrieves a TaxRate parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -9716,6 +9763,12 @@ paths: summary: Update a Tax Rate description: Updates a Tax Rate parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. diff --git a/docs/api/admin/openapi.yaml b/docs/api/admin/openapi.yaml index d374333fbb..d7ab861f96 100644 --- a/docs/api/admin/openapi.yaml +++ b/docs/api/admin/openapi.yaml @@ -109,6 +109,10 @@ tags: servers: - url: https://api.medusa-commerce.com/admin paths: + /apps/authorizations: + $ref: paths/apps_authorizations.yaml + /apps: + $ref: paths/apps.yaml /auth: $ref: paths/auth.yaml /batch-jobs/{id}/cancel: @@ -133,10 +137,6 @@ paths: $ref: paths/customer-groups_{id}.yaml /customer-groups/{id}/customers: $ref: paths/customer-groups_{id}_customers.yaml - /customers: - $ref: paths/customers.yaml - /customers/{id}: - $ref: paths/customers_{id}.yaml /discounts/{id}/regions/{region_id}: $ref: paths/discounts_{id}_regions_{region_id}.yaml /discounts/{discount_id}/conditions: @@ -153,10 +153,10 @@ paths: $ref: paths/discounts_{id}_dynamic-codes_{code}.yaml /discounts/code/{code}: $ref: paths/discounts_code_{code}.yaml - /apps/authorizations: - $ref: paths/apps_authorizations.yaml - /apps: - $ref: paths/apps.yaml + /customers: + $ref: paths/customers.yaml + /customers/{id}: + $ref: paths/customers_{id}.yaml /draft-orders: $ref: paths/draft-orders.yaml /draft-orders/{id}/line-items: @@ -249,8 +249,8 @@ paths: $ref: paths/price-lists_{id}_products_{product_id}_prices.yaml /price-lists/{id}/variants/{variant_id}/prices: $ref: paths/price-lists_{id}_variants_{variant_id}_prices.yaml - /price-lists/:id/products: - $ref: paths/price-lists_:id_products.yaml + /price-lists/{id}/products: + $ref: paths/price-lists_{id}_products.yaml /product-tags: $ref: paths/product-tags.yaml /product-types: @@ -327,18 +327,16 @@ paths: $ref: paths/swaps_{id}.yaml /swaps: $ref: paths/swaps.yaml - /tax-rates/:id/product-types/batch: - $ref: paths/tax-rates_:id_product-types_batch.yaml - /tax-rates/:id/products/batch: - $ref: paths/tax-rates_:id_products_batch.yaml - /tax-rates/:id/shipping-options/batch: - $ref: paths/tax-rates_:id_shipping-options_batch.yaml + /tax-rates/{id}/product-types/batch: + $ref: paths/tax-rates_{id}_product-types_batch.yaml + /tax-rates/{id}/products/batch: + $ref: paths/tax-rates_{id}_products_batch.yaml + /tax-rates/{id}/shipping-options/batch: + $ref: paths/tax-rates_{id}_shipping-options_batch.yaml /tax-rates: $ref: paths/tax-rates.yaml /tax-rates/{id}: $ref: paths/tax-rates_{id}.yaml - /tax-rates/:id: - $ref: paths/tax-rates_:id.yaml /uploads: $ref: paths/uploads.yaml /users: diff --git a/docs/api/admin/paths/price-lists_:id_products.yaml b/docs/api/admin/paths/price-lists_{id}_products.yaml similarity index 97% rename from docs/api/admin/paths/price-lists_:id_products.yaml rename to docs/api/admin/paths/price-lists_{id}_products.yaml index 1a0b37b37e..e22646befc 100644 --- a/docs/api/admin/paths/price-lists_:id_products.yaml +++ b/docs/api/admin/paths/price-lists_{id}_products.yaml @@ -4,6 +4,12 @@ get: description: Retrieves a list of Product that are part of a Price List x-authenticated: true parameters: + - in: path + name: id + required: true + description: ID of the price list. + schema: + type: string - in: query name: q description: >- diff --git a/docs/api/admin/paths/tax-rates_:id.yaml b/docs/api/admin/paths/tax-rates_:id.yaml deleted file mode 100644 index 84f1f79b65..0000000000 --- a/docs/api/admin/paths/tax-rates_:id.yaml +++ /dev/null @@ -1,102 +0,0 @@ -get: - operationId: GetTaxRatesTaxRate - summary: Get Tax Rate - description: Retrieves a TaxRate - parameters: - - in: query - name: fields - description: Which fields should be included in the result. - style: form - explode: false - schema: - type: array - items: - type: string - - in: query - name: expand - description: Which fields should be expanded and retrieved in the result. - style: form - explode: false - schema: - type: array - items: - type: string - x-authenticated: true - tags: - - Tax Rate - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - tax_rate: - $ref: ../components/schemas/tax_rate.yaml -post: - operationId: PostTaxRatesTaxRate - summary: Update a Tax Rate - description: Updates a Tax Rate - parameters: - - in: query - name: fields - description: Which fields should be included in the result. - style: form - explode: false - schema: - type: array - items: - type: string - - in: query - name: expand - description: Which fields should be expanded and retrieved in the result. - style: form - explode: false - schema: - type: array - items: - type: string - x-authenticated: true - requestBody: - content: - application/json: - schema: - properties: - code: - type: string - description: A code to identify the tax type by - name: - type: string - description: A human friendly name for the tax - region_id: - type: string - description: The ID of the Region that the rate belongs to - rate: - type: number - description: The numeric rate to charge - products: - type: array - description: The IDs of the products associated with this tax rate - items: - type: string - shipping_options: - type: array - description: The IDs of the shipping options associated with this tax rate - items: - type: string - product_types: - type: array - description: The IDs of the types of products associated with this tax rate - items: - type: string - tags: - - Tax Rate - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - tax_rate: - $ref: ../components/schemas/tax_rate.yaml diff --git a/docs/api/admin/paths/tax-rates_{id}.yaml b/docs/api/admin/paths/tax-rates_{id}.yaml index 38904fa17a..3bfc66b991 100644 --- a/docs/api/admin/paths/tax-rates_{id}.yaml +++ b/docs/api/admin/paths/tax-rates_{id}.yaml @@ -30,3 +30,117 @@ delete: type: boolean description: Whether or not the items were deleted. default: true +get: + operationId: GetTaxRatesTaxRate + summary: Get Tax Rate + description: Retrieves a TaxRate + parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string + - in: query + name: fields + description: Which fields should be included in the result. + style: form + explode: false + schema: + type: array + items: + type: string + - in: query + name: expand + description: Which fields should be expanded and retrieved in the result. + style: form + explode: false + schema: + type: array + items: + type: string + x-authenticated: true + tags: + - Tax Rate + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + tax_rate: + $ref: ../components/schemas/tax_rate.yaml +post: + operationId: PostTaxRatesTaxRate + summary: Update a Tax Rate + description: Updates a Tax Rate + parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string + - in: query + name: fields + description: Which fields should be included in the result. + style: form + explode: false + schema: + type: array + items: + type: string + - in: query + name: expand + description: Which fields should be expanded and retrieved in the result. + style: form + explode: false + schema: + type: array + items: + type: string + x-authenticated: true + requestBody: + content: + application/json: + schema: + properties: + code: + type: string + description: A code to identify the tax type by + name: + type: string + description: A human friendly name for the tax + region_id: + type: string + description: The ID of the Region that the rate belongs to + rate: + type: number + description: The numeric rate to charge + products: + type: array + description: The IDs of the products associated with this tax rate + items: + type: string + shipping_options: + type: array + description: The IDs of the shipping options associated with this tax rate + items: + type: string + product_types: + type: array + description: The IDs of the types of products associated with this tax rate + items: + type: string + tags: + - Tax Rate + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + tax_rate: + $ref: ../components/schemas/tax_rate.yaml diff --git a/docs/api/admin/paths/tax-rates_:id_product-types_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml similarity index 90% rename from docs/api/admin/paths/tax-rates_:id_product-types_batch.yaml rename to docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml index df938552fb..e679359cae 100644 --- a/docs/api/admin/paths/tax-rates_:id_product-types_batch.yaml +++ b/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml @@ -3,6 +3,12 @@ post: summary: Add Tax Rate to Product Types description: Associates a Tax Rate with a list of Product Types parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -50,6 +56,12 @@ delete: summary: Remove Tax Rate from Product Types description: Removes a Tax Rate from a list of Product Types parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. diff --git a/docs/api/admin/paths/tax-rates_:id_products_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml similarity index 90% rename from docs/api/admin/paths/tax-rates_:id_products_batch.yaml rename to docs/api/admin/paths/tax-rates_{id}_products_batch.yaml index 3162d0c75c..90cf42b2ae 100644 --- a/docs/api/admin/paths/tax-rates_:id_products_batch.yaml +++ b/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml @@ -3,6 +3,12 @@ post: summary: Add Tax Rate to Products description: Associates a Tax Rate with a list of Products parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -50,6 +56,12 @@ delete: summary: Removes Tax Rate from Products description: Removes a Tax Rate from a list of Products parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. diff --git a/docs/api/admin/paths/tax-rates_:id_shipping-options_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml similarity index 90% rename from docs/api/admin/paths/tax-rates_:id_shipping-options_batch.yaml rename to docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml index 27b1da8f5c..066ce03681 100644 --- a/docs/api/admin/paths/tax-rates_:id_shipping-options_batch.yaml +++ b/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml @@ -3,6 +3,12 @@ post: summary: Add Tax Rate to Product Types description: Associates a Tax Rate with a list of Shipping Options parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. @@ -50,6 +56,12 @@ delete: summary: Removes a Tax Rate from Product Types description: Removes a Tax Rate from a list of Product Types parameters: + - in: path + name: id + required: true + description: ID of the tax rate. + schema: + type: string - in: query name: fields description: Which fields should be included in the result. diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index 2e0a0924af..c3b6caba6e 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -211,6 +211,1193 @@ } } }, + "/gift-cards/{code}": { + "get": { + "operationId": "GetGiftCardsCode", + "summary": "Retrieve Gift Card by Code", + "description": "Retrieves a Gift Card by its associated unqiue code.", + "parameters": [ + { + "in": "path", + "name": "code", + "required": true, + "description": "The unique Gift Card code.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Gift Card" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "gift_card": { + "$ref": "#/components/schemas/gift_card" + } + } + } + } + } + } + } + } + }, + "/collections/{id}": { + "get": { + "operationId": "GetCollectionsCollection", + "summary": "Retrieve a Product Collection", + "description": "Retrieves a Product Collection.", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The id of the Product Collection", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Collection" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "collection": { + "$ref": "#/components/schemas/product_collection" + } + } + } + } + } + } + } + } + }, + "/collections": { + "get": { + "operationId": "GetCollections", + "summary": "List Product Collections", + "description": "Retrieve a list of Product Collection.", + "parameters": [ + { + "in": "query", + "name": "offset", + "description": "The number of collections to skip before starting to collect the collections set", + "schema": { + "type": "integer", + "default": 0 + } + }, + { + "in": "query", + "name": "limit", + "description": "The number of collections to return", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "in": "query", + "name": "created_at", + "description": "Date comparison for when resulting collections were created.", + "schema": { + "type": "object", + "properties": { + "lt": { + "type": "string", + "description": "filter by dates less than this date", + "format": "date" + }, + "gt": { + "type": "string", + "description": "filter by dates greater than this date", + "format": "date" + }, + "lte": { + "type": "string", + "description": "filter by dates less than or equal to this date", + "format": "date" + }, + "gte": { + "type": "string", + "description": "filter by dates greater than or equal to this date", + "format": "date" + } + } + } + }, + { + "in": "query", + "name": "updated_at", + "description": "Date comparison for when resulting collections were updated.", + "schema": { + "type": "object", + "properties": { + "lt": { + "type": "string", + "description": "filter by dates less than this date", + "format": "date" + }, + "gt": { + "type": "string", + "description": "filter by dates greater than this date", + "format": "date" + }, + "lte": { + "type": "string", + "description": "filter by dates less than or equal to this date", + "format": "date" + }, + "gte": { + "type": "string", + "description": "filter by dates greater than or equal to this date", + "format": "date" + } + } + } + } + ], + "tags": [ + "Collection" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "collections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/product_collection" + } + }, + "count": { + "type": "integer", + "description": "The total number of items available" + }, + "offset": { + "type": "integer", + "description": "The number of items skipped before these items" + }, + "limit": { + "type": "integer", + "description": "The number of items per page" + } + } + } + } + } + } + } + } + }, + "/customers/me/addresses": { + "post": { + "operationId": "PostCustomersCustomerAddresses", + "summary": "Add a Shipping Address", + "description": "Adds a Shipping Address to a Customer's saved addresses.", + "x-authenticated": true, + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "address" + ], + "properties": { + "address": { + "description": "The Address to add to the Customer.", + "anyOf": [ + { + "$ref": "#/components/schemas/address" + } + ] + } + } + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "A successful response", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + } + }, + "/customers": { + "post": { + "operationId": "PostCustomers", + "summary": "Create a Customer", + "description": "Creates a Customer account.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "first_name", + "last_name", + "email", + "password" + ], + "properties": { + "first_name": { + "description": "The Customer's first name.", + "type": "string" + }, + "last_name": { + "description": "The Customer's last name.", + "type": "string" + }, + "email": { + "description": "The email of the customer.", + "type": "string", + "format": "email" + }, + "password": { + "description": "The Customer's password.", + "type": "string", + "format": "password" + }, + "phone": { + "description": "The Customer's phone number.", + "type": "string" + } + } + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + }, + "422": { + "description": "A customer with the same email exists", + "content": { + "application/json": { + "schema": { + "properties": { + "code": { + "type": "string", + "description": "The error code" + }, + "type": { + "type": "string", + "description": "The type of error" + }, + "message": { + "type": "string", + "description": "Human-readable message with details about the error" + } + } + }, + "example": { + "code": "invalid_request_error", + "type": "duplicate_error", + "message": "A customer with the given email already has an account. Log in instead" + } + } + } + } + } + } + }, + "/customers/me/addresses/{address_id}": { + "delete": { + "operationId": "DeleteCustomersCustomerAddressesAddress", + "summary": "Delete an Address", + "description": "Removes an Address from the Customer's saved addresses.", + "x-authenticated": true, + "parameters": [ + { + "in": "path", + "name": "address_id", + "required": true, + "description": "The id of the Address to remove.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + }, + "post": { + "operationId": "PostCustomersCustomerAddressesAddress", + "summary": "Update a Shipping Address", + "description": "Updates a Customer's saved Shipping Address.", + "x-authenticated": true, + "parameters": [ + { + "in": "path", + "name": "address_id", + "required": true, + "description": "The id of the Address to update.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/address" + } + ] + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + } + }, + "/customers/me": { + "get": { + "operationId": "GetCustomersCustomer", + "summary": "Retrieves a Customer", + "description": "Retrieves a Customer - the Customer must be logged in to retrieve their details.", + "x-authenticated": true, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + }, + "post": { + "operationId": "PostCustomersCustomer", + "summary": "Update Customer details", + "description": "Updates a Customer's saved details.", + "x-authenticated": true, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "first_name": { + "description": "The Customer's first name.", + "type": "string" + }, + "last_name": { + "description": "The Customer's last name.", + "type": "string" + }, + "billing_address": { + "description": "The Address to be used for billing purposes.", + "anyOf": [ + { + "$ref": "#/components/schemas/address", + "description": "The full billing address object" + }, + { + "type": "string", + "description": "The ID of an existing billing address" + } + ] + }, + "password": { + "description": "The Customer's password.", + "type": "string" + }, + "phone": { + "description": "The Customer's phone number.", + "type": "string" + }, + "email": { + "description": "The email of the customer.", + "type": "string" + }, + "metadata": { + "description": "Metadata about the customer.", + "type": "object" + } + } + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + } + }, + "/customers/me/payment-methods": { + "get": { + "operationId": "GetCustomersCustomerPaymentMethods", + "summary": "Retrieve saved payment methods", + "description": "Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved methods.", + "x-authenticated": true, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "payment_methods": { + "type": "array", + "items": { + "properties": { + "provider_id": { + "type": "string", + "description": "The id of the Payment Provider where the payment method is saved." + }, + "data": { + "type": "object", + "description": "The data needed for the Payment Provider to use the saved payment method." + } + } + } + } + } + } + } + } + } + } + } + }, + "/customers/me/orders": { + "get": { + "operationId": "GetCustomersCustomerOrders", + "summary": "Retrieve Customer Orders", + "description": "Retrieves a list of a Customer's Orders.", + "x-authenticated": true, + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "How many orders to return.", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "in": "query", + "name": "offset", + "description": "The offset in the resulting orders.", + "schema": { + "type": "integer", + "default": 0 + } + }, + { + "in": "query", + "name": "fields", + "description": "(Comma separated string) Which fields should be included in the resulting orders.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "expand", + "description": "(Comma separated string) Which relations should be expanded in the resulting orders.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/order" + } + }, + "count": { + "type": "integer", + "description": "The total number of items available" + }, + "offset": { + "type": "integer", + "description": "The number of items skipped before these items" + }, + "limit": { + "type": "integer", + "description": "The number of items per page" + } + } + } + } + } + } + } + } + }, + "/customers/password-token": { + "post": { + "operationId": "PostCustomersCustomerPasswordToken", + "summary": "Creates a reset password token", + "description": "Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band e.g. via email and will not be returned.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "email" + ], + "properties": { + "email": { + "description": "The email of the customer.", + "type": "string", + "format": "email" + } + } + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "204": { + "description": "OK" + } + } + } + }, + "/customers/password-reset": { + "post": { + "operationId": "PostCustomersResetPassword", + "summary": "Resets Customer password", + "description": "Resets a Customer's password using a password token created by a previous /password-token request.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "email", + "password", + "token" + ], + "properties": { + "email": { + "description": "The email of the customer.", + "type": "string", + "format": "email" + }, + "password": { + "description": "The Customer's password.", + "type": "string", + "format": "password" + }, + "token": { + "description": "The reset password token", + "type": "string" + } + } + } + } + } + }, + "tags": [ + "Customer" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "customer": { + "$ref": "#/components/schemas/customer" + } + } + } + } + } + } + } + } + }, + "/orders/cart/{cart_id}": { + "get": { + "operationId": "GetOrdersOrderCartId", + "summary": "Retrieves Order by Cart id", + "description": "Retrieves an Order by the id of the Cart that was used to create the Order.", + "parameters": [ + { + "in": "path", + "name": "cart_id", + "required": true, + "description": "The ID of Cart.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Order" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "order": { + "$ref": "#/components/schemas/order" + } + } + } + } + } + } + } + } + }, + "/orders/{id}": { + "get": { + "operationId": "GetOrdersOrder", + "summary": "Retrieves an Order", + "description": "Retrieves an Order", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The id of the Order.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Order" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "order": { + "$ref": "#/components/schemas/order" + } + } + } + } + } + } + } + } + }, + "/orders": { + "get": { + "operationId": "GetOrders", + "summary": "Look Up an Order", + "description": "Look up an order using filters.", + "parameters": [ + { + "in": "query", + "name": "display_id", + "required": true, + "description": "The display id given to the Order.", + "schema": { + "type": "number" + } + }, + { + "in": "query", + "name": "email", + "style": "form", + "explode": false, + "description": "The email associated with this order.", + "required": true, + "schema": { + "type": "string", + "format": "email" + } + }, + { + "in": "query", + "name": "shipping_address", + "style": "form", + "explode": false, + "description": "The shipping address associated with this order.", + "schema": { + "type": "object", + "properties": { + "postal_code": { + "type": "string", + "description": "The postal code of the shipping address" + } + } + } + } + ], + "tags": [ + "Order" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "order": { + "$ref": "#/components/schemas/order" + } + } + } + } + } + } + } + } + }, + "/products/{id}": { + "get": { + "operationId": "GetProductsProduct", + "summary": "Retrieves a Product", + "description": "Retrieves a Product.", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "description": "The id of the Product.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Product" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "product": { + "$ref": "#/components/schemas/product" + } + } + } + } + } + } + } + } + }, + "/products": { + "get": { + "operationId": "GetProducts", + "summary": "List Products", + "description": "Retrieves a list of Products.", + "parameters": [ + { + "in": "query", + "name": "q", + "description": "Query used for searching products by title, description, variant's title, variant's sku, and collection's title", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "id", + "style": "form", + "explode": false, + "description": "product IDs to search for.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "in": "query", + "name": "collection_id", + "style": "form", + "explode": false, + "description": "Collection IDs to search for", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "tags", + "style": "form", + "explode": false, + "description": "Tag IDs to search for", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "in": "query", + "name": "title", + "description": "title to search for.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "description", + "description": "description to search for.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "handle", + "description": "handle to search for.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "is_giftcard", + "description": "Search for giftcards using is_giftcard=true.", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "name": "type", + "description": "type to search for.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "created_at", + "description": "Date comparison for when resulting products were created.", + "schema": { + "type": "object", + "properties": { + "lt": { + "type": "string", + "description": "filter by dates less than this date", + "format": "date" + }, + "gt": { + "type": "string", + "description": "filter by dates greater than this date", + "format": "date" + }, + "lte": { + "type": "string", + "description": "filter by dates less than or equal to this date", + "format": "date" + }, + "gte": { + "type": "string", + "description": "filter by dates greater than or equal to this date", + "format": "date" + } + } + } + }, + { + "in": "query", + "name": "updated_at", + "description": "Date comparison for when resulting products were updated.", + "schema": { + "type": "object", + "properties": { + "lt": { + "type": "string", + "description": "filter by dates less than this date", + "format": "date" + }, + "gt": { + "type": "string", + "description": "filter by dates greater than this date", + "format": "date" + }, + "lte": { + "type": "string", + "description": "filter by dates less than or equal to this date", + "format": "date" + }, + "gte": { + "type": "string", + "description": "filter by dates greater than or equal to this date", + "format": "date" + } + } + } + }, + { + "in": "query", + "name": "offset", + "description": "How many products to skip in the result.", + "schema": { + "type": "integer", + "default": 0 + } + }, + { + "in": "query", + "name": "limit", + "description": "Limit the number of products returned.", + "schema": { + "type": "integer", + "default": 100 + } + }, + { + "in": "query", + "name": "expand", + "description": "(Comma separated) Which fields should be expanded in each order of the result.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "fields", + "description": "(Comma separated) Which fields should be included in each order of the result.", + "schema": { + "type": "string" + } + } + ], + "tags": [ + "Product" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/product" + } + }, + "count": { + "type": "integer", + "description": "The total number of items available" + }, + "offset": { + "type": "integer", + "description": "The number of items skipped before these items" + }, + "limit": { + "type": "integer", + "description": "The number of items per page" + } + } + } + } + } + } + } + } + }, + "/products/search": { + "get": { + "operationId": "GetProductsSearch", + "summary": "Search Products", + "description": "Run a search query on products using the search engine installed on Medusa", + "parameters": [ + { + "in": "query", + "name": "q", + "required": true, + "description": "The query to run the search with.", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "offset", + "description": "How many products to skip in the result.", + "schema": { + "type": "integer" + } + }, + { + "in": "query", + "name": "limit", + "description": "Limit the number of products returned.", + "schema": { + "type": "integer" + } + } + ], + "tags": [ + "Product" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "properties": { + "hits": { + "type": "array", + "description": "Array of results. The format of the items depends on the search engine installed on the server." + } + } + } + } + } + } + } + } + }, "/carts/{id}/shipping-methods": { "post": { "operationId": "PostCartsCartShippingMethod", @@ -1098,1193 +2285,6 @@ } } }, - "/collections/{id}": { - "get": { - "operationId": "GetCollectionsCollection", - "summary": "Retrieve a Product Collection", - "description": "Retrieves a Product Collection.", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The id of the Product Collection", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Collection" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "collection": { - "$ref": "#/components/schemas/product_collection" - } - } - } - } - } - } - } - } - }, - "/collections": { - "get": { - "operationId": "GetCollections", - "summary": "List Product Collections", - "description": "Retrieve a list of Product Collection.", - "parameters": [ - { - "in": "query", - "name": "offset", - "description": "The number of collections to skip before starting to collect the collections set", - "schema": { - "type": "integer", - "default": 0 - } - }, - { - "in": "query", - "name": "limit", - "description": "The number of collections to return", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "in": "query", - "name": "created_at", - "description": "Date comparison for when resulting collections were created.", - "schema": { - "type": "object", - "properties": { - "lt": { - "type": "string", - "description": "filter by dates less than this date", - "format": "date" - }, - "gt": { - "type": "string", - "description": "filter by dates greater than this date", - "format": "date" - }, - "lte": { - "type": "string", - "description": "filter by dates less than or equal to this date", - "format": "date" - }, - "gte": { - "type": "string", - "description": "filter by dates greater than or equal to this date", - "format": "date" - } - } - } - }, - { - "in": "query", - "name": "updated_at", - "description": "Date comparison for when resulting collections were updated.", - "schema": { - "type": "object", - "properties": { - "lt": { - "type": "string", - "description": "filter by dates less than this date", - "format": "date" - }, - "gt": { - "type": "string", - "description": "filter by dates greater than this date", - "format": "date" - }, - "lte": { - "type": "string", - "description": "filter by dates less than or equal to this date", - "format": "date" - }, - "gte": { - "type": "string", - "description": "filter by dates greater than or equal to this date", - "format": "date" - } - } - } - } - ], - "tags": [ - "Collection" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "collections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/product_collection" - } - }, - "count": { - "type": "integer", - "description": "The total number of items available" - }, - "offset": { - "type": "integer", - "description": "The number of items skipped before these items" - }, - "limit": { - "type": "integer", - "description": "The number of items per page" - } - } - } - } - } - } - } - } - }, - "/customers/me/addresses": { - "post": { - "operationId": "PostCustomersCustomerAddresses", - "summary": "Add a Shipping Address", - "description": "Adds a Shipping Address to a Customer's saved addresses.", - "x-authenticated": true, - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "address" - ], - "properties": { - "address": { - "description": "The Address to add to the Customer.", - "anyOf": [ - { - "$ref": "#/components/schemas/address" - } - ] - } - } - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "A successful response", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - } - }, - "/customers": { - "post": { - "operationId": "PostCustomers", - "summary": "Create a Customer", - "description": "Creates a Customer account.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "first_name", - "last_name", - "email", - "password" - ], - "properties": { - "first_name": { - "description": "The Customer's first name.", - "type": "string" - }, - "last_name": { - "description": "The Customer's last name.", - "type": "string" - }, - "email": { - "description": "The email of the customer.", - "type": "string", - "format": "email" - }, - "password": { - "description": "The Customer's password.", - "type": "string", - "format": "password" - }, - "phone": { - "description": "The Customer's phone number.", - "type": "string" - } - } - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - }, - "422": { - "description": "A customer with the same email exists", - "content": { - "application/json": { - "schema": { - "properties": { - "code": { - "type": "string", - "description": "The error code" - }, - "type": { - "type": "string", - "description": "The type of error" - }, - "message": { - "type": "string", - "description": "Human-readable message with details about the error" - } - } - }, - "example": { - "code": "invalid_request_error", - "type": "duplicate_error", - "message": "A customer with the given email already has an account. Log in instead" - } - } - } - } - } - } - }, - "/customers/me/addresses/{address_id}": { - "delete": { - "operationId": "DeleteCustomersCustomerAddressesAddress", - "summary": "Delete an Address", - "description": "Removes an Address from the Customer's saved addresses.", - "x-authenticated": true, - "parameters": [ - { - "in": "path", - "name": "address_id", - "required": true, - "description": "The id of the Address to remove.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - }, - "post": { - "operationId": "PostCustomersCustomerAddressesAddress", - "summary": "Update a Shipping Address", - "description": "Updates a Customer's saved Shipping Address.", - "x-authenticated": true, - "parameters": [ - { - "in": "path", - "name": "address_id", - "required": true, - "description": "The id of the Address to update.", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/address" - } - ] - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - } - }, - "/customers/me": { - "get": { - "operationId": "GetCustomersCustomer", - "summary": "Retrieves a Customer", - "description": "Retrieves a Customer - the Customer must be logged in to retrieve their details.", - "x-authenticated": true, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - }, - "post": { - "operationId": "PostCustomersCustomer", - "summary": "Update Customer details", - "description": "Updates a Customer's saved details.", - "x-authenticated": true, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "first_name": { - "description": "The Customer's first name.", - "type": "string" - }, - "last_name": { - "description": "The Customer's last name.", - "type": "string" - }, - "billing_address": { - "description": "The Address to be used for billing purposes.", - "anyOf": [ - { - "$ref": "#/components/schemas/address", - "description": "The full billing address object" - }, - { - "type": "string", - "description": "The ID of an existing billing address" - } - ] - }, - "password": { - "description": "The Customer's password.", - "type": "string" - }, - "phone": { - "description": "The Customer's phone number.", - "type": "string" - }, - "email": { - "description": "The email of the customer.", - "type": "string" - }, - "metadata": { - "description": "Metadata about the customer.", - "type": "object" - } - } - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - } - }, - "/customers/me/payment-methods": { - "get": { - "operationId": "GetCustomersCustomerPaymentMethods", - "summary": "Retrieve saved payment methods", - "description": "Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved methods.", - "x-authenticated": true, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "payment_methods": { - "type": "array", - "items": { - "properties": { - "provider_id": { - "type": "string", - "description": "The id of the Payment Provider where the payment method is saved." - }, - "data": { - "type": "object", - "description": "The data needed for the Payment Provider to use the saved payment method." - } - } - } - } - } - } - } - } - } - } - } - }, - "/customers/me/orders": { - "get": { - "operationId": "GetCustomersCustomerOrders", - "summary": "Retrieve Customer Orders", - "description": "Retrieves a list of a Customer's Orders.", - "x-authenticated": true, - "parameters": [ - { - "in": "query", - "name": "limit", - "description": "How many orders to return.", - "schema": { - "type": "integer", - "default": 10 - } - }, - { - "in": "query", - "name": "offset", - "description": "The offset in the resulting orders.", - "schema": { - "type": "integer", - "default": 0 - } - }, - { - "in": "query", - "name": "fields", - "description": "(Comma separated string) Which fields should be included in the resulting orders.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "expand", - "description": "(Comma separated string) Which relations should be expanded in the resulting orders.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "orders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/order" - } - }, - "count": { - "type": "integer", - "description": "The total number of items available" - }, - "offset": { - "type": "integer", - "description": "The number of items skipped before these items" - }, - "limit": { - "type": "integer", - "description": "The number of items per page" - } - } - } - } - } - } - } - } - }, - "/customers/password-token": { - "post": { - "operationId": "PostCustomersCustomerPasswordToken", - "summary": "Creates a reset password token", - "description": "Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band e.g. via email and will not be returned.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "email" - ], - "properties": { - "email": { - "description": "The email of the customer.", - "type": "string", - "format": "email" - } - } - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "204": { - "description": "OK" - } - } - } - }, - "/customers/password-reset": { - "post": { - "operationId": "PostCustomersResetPassword", - "summary": "Resets Customer password", - "description": "Resets a Customer's password using a password token created by a previous /password-token request.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "required": [ - "email", - "password", - "token" - ], - "properties": { - "email": { - "description": "The email of the customer.", - "type": "string", - "format": "email" - }, - "password": { - "description": "The Customer's password.", - "type": "string", - "format": "password" - }, - "token": { - "description": "The reset password token", - "type": "string" - } - } - } - } - } - }, - "tags": [ - "Customer" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "customer": { - "$ref": "#/components/schemas/customer" - } - } - } - } - } - } - } - } - }, - "/gift-cards/{code}": { - "get": { - "operationId": "GetGiftCardsCode", - "summary": "Retrieve Gift Card by Code", - "description": "Retrieves a Gift Card by its associated unqiue code.", - "parameters": [ - { - "in": "path", - "name": "code", - "required": true, - "description": "The unique Gift Card code.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Gift Card" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "gift_card": { - "$ref": "#/components/schemas/gift_card" - } - } - } - } - } - } - } - } - }, - "/orders/cart/{cart_id}": { - "get": { - "operationId": "GetOrdersOrderCartId", - "summary": "Retrieves Order by Cart id", - "description": "Retrieves an Order by the id of the Cart that was used to create the Order.", - "parameters": [ - { - "in": "path", - "name": "cart_id", - "required": true, - "description": "The ID of Cart.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Order" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "order": { - "$ref": "#/components/schemas/order" - } - } - } - } - } - } - } - } - }, - "/orders/{id}": { - "get": { - "operationId": "GetOrdersOrder", - "summary": "Retrieves an Order", - "description": "Retrieves an Order", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The id of the Order.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Order" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "order": { - "$ref": "#/components/schemas/order" - } - } - } - } - } - } - } - } - }, - "/orders": { - "get": { - "operationId": "GetOrders", - "summary": "Look Up an Order", - "description": "Look up an order using filters.", - "parameters": [ - { - "in": "query", - "name": "display_id", - "required": true, - "description": "The display id given to the Order.", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "email", - "style": "form", - "explode": false, - "description": "The email associated with this order.", - "required": true, - "schema": { - "type": "string", - "format": "email" - } - }, - { - "in": "query", - "name": "shipping_address", - "style": "form", - "explode": false, - "description": "The shipping address associated with this order.", - "schema": { - "type": "object", - "properties": { - "postal_code": { - "type": "string", - "description": "The postal code of the shipping address" - } - } - } - } - ], - "tags": [ - "Order" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "order": { - "$ref": "#/components/schemas/order" - } - } - } - } - } - } - } - } - }, - "/products/{id}": { - "get": { - "operationId": "GetProductsProduct", - "summary": "Retrieves a Product", - "description": "Retrieves a Product.", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "description": "The id of the Product.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Product" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "product": { - "$ref": "#/components/schemas/product" - } - } - } - } - } - } - } - } - }, - "/products": { - "get": { - "operationId": "GetProducts", - "summary": "List Products", - "description": "Retrieves a list of Products.", - "parameters": [ - { - "in": "query", - "name": "q", - "description": "Query used for searching products by title, description, variant's title, variant's sku, and collection's title", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "id", - "style": "form", - "explode": false, - "description": "product IDs to search for.", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - }, - { - "in": "query", - "name": "collection_id", - "style": "form", - "explode": false, - "description": "Collection IDs to search for", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "in": "query", - "name": "tags", - "style": "form", - "explode": false, - "description": "Tag IDs to search for", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "in": "query", - "name": "title", - "description": "title to search for.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "description", - "description": "description to search for.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "handle", - "description": "handle to search for.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "is_giftcard", - "description": "Search for giftcards using is_giftcard=true.", - "schema": { - "type": "boolean" - } - }, - { - "in": "query", - "name": "type", - "description": "type to search for.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "created_at", - "description": "Date comparison for when resulting products were created.", - "schema": { - "type": "object", - "properties": { - "lt": { - "type": "string", - "description": "filter by dates less than this date", - "format": "date" - }, - "gt": { - "type": "string", - "description": "filter by dates greater than this date", - "format": "date" - }, - "lte": { - "type": "string", - "description": "filter by dates less than or equal to this date", - "format": "date" - }, - "gte": { - "type": "string", - "description": "filter by dates greater than or equal to this date", - "format": "date" - } - } - } - }, - { - "in": "query", - "name": "updated_at", - "description": "Date comparison for when resulting products were updated.", - "schema": { - "type": "object", - "properties": { - "lt": { - "type": "string", - "description": "filter by dates less than this date", - "format": "date" - }, - "gt": { - "type": "string", - "description": "filter by dates greater than this date", - "format": "date" - }, - "lte": { - "type": "string", - "description": "filter by dates less than or equal to this date", - "format": "date" - }, - "gte": { - "type": "string", - "description": "filter by dates greater than or equal to this date", - "format": "date" - } - } - } - }, - { - "in": "query", - "name": "offset", - "description": "How many products to skip in the result.", - "schema": { - "type": "integer", - "default": 0 - } - }, - { - "in": "query", - "name": "limit", - "description": "Limit the number of products returned.", - "schema": { - "type": "integer", - "default": 100 - } - }, - { - "in": "query", - "name": "expand", - "description": "(Comma separated) Which fields should be expanded in each order of the result.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "fields", - "description": "(Comma separated) Which fields should be included in each order of the result.", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "Product" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/product" - } - }, - "count": { - "type": "integer", - "description": "The total number of items available" - }, - "offset": { - "type": "integer", - "description": "The number of items skipped before these items" - }, - "limit": { - "type": "integer", - "description": "The number of items per page" - } - } - } - } - } - } - } - } - }, - "/products/search": { - "get": { - "operationId": "GetProductsSearch", - "summary": "Search Products", - "description": "Run a search query on products using the search engine installed on Medusa", - "parameters": [ - { - "in": "query", - "name": "q", - "required": true, - "description": "The query to run the search with.", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "offset", - "description": "How many products to skip in the result.", - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "description": "Limit the number of products returned.", - "schema": { - "type": "integer" - } - } - ], - "tags": [ - "Product" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "properties": { - "hits": { - "type": "array", - "description": "Array of results. The format of the items depends on the search engine installed on the server." - } - } - } - } - } - } - } - } - }, "/regions/{id}": { "get": { "operationId": "GetRegionsRegion", diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index ae016ea75f..1fa8c97e61 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -270,6 +270,456 @@ paths: properties: gift_card: $ref: '#/components/schemas/gift_card' + /customers/me/addresses: + post: + operationId: PostCustomersCustomerAddresses + summary: Add a Shipping Address + description: Adds a Shipping Address to a Customer's saved addresses. + x-authenticated: true + requestBody: + content: + application/json: + schema: + required: + - address + properties: + address: + description: The Address to add to the Customer. + anyOf: + - $ref: '#/components/schemas/address' + tags: + - Customer + responses: + '200': + description: A successful response + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + /customers: + post: + operationId: PostCustomers + summary: Create a Customer + description: Creates a Customer account. + requestBody: + content: + application/json: + schema: + required: + - first_name + - last_name + - email + - password + properties: + first_name: + description: The Customer's first name. + type: string + last_name: + description: The Customer's last name. + type: string + email: + description: The email of the customer. + type: string + format: email + password: + description: The Customer's password. + type: string + format: password + phone: + description: The Customer's phone number. + type: string + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + '422': + description: A customer with the same email exists + content: + application/json: + schema: + properties: + code: + type: string + description: The error code + type: + type: string + description: The type of error + message: + type: string + description: Human-readable message with details about the error + example: + code: invalid_request_error + type: duplicate_error + message: >- + A customer with the given email already has an account. Log in + instead + '/customers/me/addresses/{address_id}': + delete: + operationId: DeleteCustomersCustomerAddressesAddress + summary: Delete an Address + description: Removes an Address from the Customer's saved addresses. + x-authenticated: true + parameters: + - in: path + name: address_id + required: true + description: The id of the Address to remove. + schema: + type: string + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + post: + operationId: PostCustomersCustomerAddressesAddress + summary: Update a Shipping Address + description: Updates a Customer's saved Shipping Address. + x-authenticated: true + parameters: + - in: path + name: address_id + required: true + description: The id of the Address to update. + schema: + type: string + requestBody: + content: + application/json: + schema: + anyOf: + - $ref: '#/components/schemas/address' + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + /customers/me: + get: + operationId: GetCustomersCustomer + summary: Retrieves a Customer + description: >- + Retrieves a Customer - the Customer must be logged in to retrieve their + details. + x-authenticated: true + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + post: + operationId: PostCustomersCustomer + summary: Update Customer details + description: Updates a Customer's saved details. + x-authenticated: true + requestBody: + content: + application/json: + schema: + properties: + first_name: + description: The Customer's first name. + type: string + last_name: + description: The Customer's last name. + type: string + billing_address: + description: The Address to be used for billing purposes. + anyOf: + - $ref: '#/components/schemas/address' + description: The full billing address object + - type: string + description: The ID of an existing billing address + password: + description: The Customer's password. + type: string + phone: + description: The Customer's phone number. + type: string + email: + description: The email of the customer. + type: string + metadata: + description: Metadata about the customer. + type: object + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + /customers/me/payment-methods: + get: + operationId: GetCustomersCustomerPaymentMethods + summary: Retrieve saved payment methods + description: >- + Retrieves a list of a Customer's saved payment methods. Payment methods + are saved with Payment Providers and it is their responsibility to fetch + saved methods. + x-authenticated: true + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + payment_methods: + type: array + items: + properties: + provider_id: + type: string + description: >- + The id of the Payment Provider where the payment + method is saved. + data: + type: object + description: >- + The data needed for the Payment Provider to use the + saved payment method. + /customers/me/orders: + get: + operationId: GetCustomersCustomerOrders + summary: Retrieve Customer Orders + description: Retrieves a list of a Customer's Orders. + x-authenticated: true + parameters: + - in: query + name: limit + description: How many orders to return. + schema: + type: integer + default: 10 + - in: query + name: offset + description: The offset in the resulting orders. + schema: + type: integer + default: 0 + - in: query + name: fields + description: >- + (Comma separated string) Which fields should be included in the + resulting orders. + schema: + type: string + - in: query + name: expand + description: >- + (Comma separated string) Which relations should be expanded in the + resulting orders. + schema: + type: string + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + orders: + type: array + items: + $ref: '#/components/schemas/order' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + /customers/password-token: + post: + operationId: PostCustomersCustomerPasswordToken + summary: Creates a reset password token + description: >- + Creates a reset password token to be used in a subsequent + /reset-password request. The password token should be sent out of band + e.g. via email and will not be returned. + requestBody: + content: + application/json: + schema: + required: + - email + properties: + email: + description: The email of the customer. + type: string + format: email + tags: + - Customer + responses: + '204': + description: OK + /customers/password-reset: + post: + operationId: PostCustomersResetPassword + summary: Resets Customer password + description: >- + Resets a Customer's password using a password token created by a + previous /password-token request. + requestBody: + content: + application/json: + schema: + required: + - email + - password + - token + properties: + email: + description: The email of the customer. + type: string + format: email + password: + description: The Customer's password. + type: string + format: password + token: + description: The reset password token + type: string + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + customer: + $ref: '#/components/schemas/customer' + '/orders/cart/{cart_id}': + get: + operationId: GetOrdersOrderCartId + summary: Retrieves Order by Cart id + description: >- + Retrieves an Order by the id of the Cart that was used to create the + Order. + parameters: + - in: path + name: cart_id + required: true + description: The ID of Cart. + schema: + type: string + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order: + $ref: '#/components/schemas/order' + '/orders/{id}': + get: + operationId: GetOrdersOrder + summary: Retrieves an Order + description: Retrieves an Order + parameters: + - in: path + name: id + required: true + description: The id of the Order. + schema: + type: string + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order: + $ref: '#/components/schemas/order' + /orders: + get: + operationId: GetOrders + summary: Look Up an Order + description: Look up an order using filters. + parameters: + - in: query + name: display_id + required: true + description: The display id given to the Order. + schema: + type: number + - in: query + name: email + style: form + explode: false + description: The email associated with this order. + required: true + schema: + type: string + format: email + - in: query + name: shipping_address + style: form + explode: false + description: The shipping address associated with this order. + schema: + type: object + properties: + postal_code: + type: string + description: The postal code of the shipping address + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order: + $ref: '#/components/schemas/order' '/carts/{id}/shipping-methods': post: operationId: PostCartsCartShippingMethod @@ -889,456 +1339,6 @@ paths: provider_id: type: string description: The ID of the Payment Provider. - /customers/me/addresses: - post: - operationId: PostCustomersCustomerAddresses - summary: Add a Shipping Address - description: Adds a Shipping Address to a Customer's saved addresses. - x-authenticated: true - requestBody: - content: - application/json: - schema: - required: - - address - properties: - address: - description: The Address to add to the Customer. - anyOf: - - $ref: '#/components/schemas/address' - tags: - - Customer - responses: - '200': - description: A successful response - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - /customers: - post: - operationId: PostCustomers - summary: Create a Customer - description: Creates a Customer account. - requestBody: - content: - application/json: - schema: - required: - - first_name - - last_name - - email - - password - properties: - first_name: - description: The Customer's first name. - type: string - last_name: - description: The Customer's last name. - type: string - email: - description: The email of the customer. - type: string - format: email - password: - description: The Customer's password. - type: string - format: password - phone: - description: The Customer's phone number. - type: string - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - '422': - description: A customer with the same email exists - content: - application/json: - schema: - properties: - code: - type: string - description: The error code - type: - type: string - description: The type of error - message: - type: string - description: Human-readable message with details about the error - example: - code: invalid_request_error - type: duplicate_error - message: >- - A customer with the given email already has an account. Log in - instead - '/customers/me/addresses/{address_id}': - delete: - operationId: DeleteCustomersCustomerAddressesAddress - summary: Delete an Address - description: Removes an Address from the Customer's saved addresses. - x-authenticated: true - parameters: - - in: path - name: address_id - required: true - description: The id of the Address to remove. - schema: - type: string - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - post: - operationId: PostCustomersCustomerAddressesAddress - summary: Update a Shipping Address - description: Updates a Customer's saved Shipping Address. - x-authenticated: true - parameters: - - in: path - name: address_id - required: true - description: The id of the Address to update. - schema: - type: string - requestBody: - content: - application/json: - schema: - anyOf: - - $ref: '#/components/schemas/address' - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - /customers/me: - get: - operationId: GetCustomersCustomer - summary: Retrieves a Customer - description: >- - Retrieves a Customer - the Customer must be logged in to retrieve their - details. - x-authenticated: true - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - post: - operationId: PostCustomersCustomer - summary: Update Customer details - description: Updates a Customer's saved details. - x-authenticated: true - requestBody: - content: - application/json: - schema: - properties: - first_name: - description: The Customer's first name. - type: string - last_name: - description: The Customer's last name. - type: string - billing_address: - description: The Address to be used for billing purposes. - anyOf: - - $ref: '#/components/schemas/address' - description: The full billing address object - - type: string - description: The ID of an existing billing address - password: - description: The Customer's password. - type: string - phone: - description: The Customer's phone number. - type: string - email: - description: The email of the customer. - type: string - metadata: - description: Metadata about the customer. - type: object - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - /customers/me/payment-methods: - get: - operationId: GetCustomersCustomerPaymentMethods - summary: Retrieve saved payment methods - description: >- - Retrieves a list of a Customer's saved payment methods. Payment methods - are saved with Payment Providers and it is their responsibility to fetch - saved methods. - x-authenticated: true - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - payment_methods: - type: array - items: - properties: - provider_id: - type: string - description: >- - The id of the Payment Provider where the payment - method is saved. - data: - type: object - description: >- - The data needed for the Payment Provider to use the - saved payment method. - /customers/me/orders: - get: - operationId: GetCustomersCustomerOrders - summary: Retrieve Customer Orders - description: Retrieves a list of a Customer's Orders. - x-authenticated: true - parameters: - - in: query - name: limit - description: How many orders to return. - schema: - type: integer - default: 10 - - in: query - name: offset - description: The offset in the resulting orders. - schema: - type: integer - default: 0 - - in: query - name: fields - description: >- - (Comma separated string) Which fields should be included in the - resulting orders. - schema: - type: string - - in: query - name: expand - description: >- - (Comma separated string) Which relations should be expanded in the - resulting orders. - schema: - type: string - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - orders: - type: array - items: - $ref: '#/components/schemas/order' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - /customers/password-token: - post: - operationId: PostCustomersCustomerPasswordToken - summary: Creates a reset password token - description: >- - Creates a reset password token to be used in a subsequent - /reset-password request. The password token should be sent out of band - e.g. via email and will not be returned. - requestBody: - content: - application/json: - schema: - required: - - email - properties: - email: - description: The email of the customer. - type: string - format: email - tags: - - Customer - responses: - '204': - description: OK - /customers/password-reset: - post: - operationId: PostCustomersResetPassword - summary: Resets Customer password - description: >- - Resets a Customer's password using a password token created by a - previous /password-token request. - requestBody: - content: - application/json: - schema: - required: - - email - - password - - token - properties: - email: - description: The email of the customer. - type: string - format: email - password: - description: The Customer's password. - type: string - format: password - token: - description: The reset password token - type: string - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - customer: - $ref: '#/components/schemas/customer' - '/orders/cart/{cart_id}': - get: - operationId: GetOrdersOrderCartId - summary: Retrieves Order by Cart id - description: >- - Retrieves an Order by the id of the Cart that was used to create the - Order. - parameters: - - in: path - name: cart_id - required: true - description: The ID of Cart. - schema: - type: string - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - order: - $ref: '#/components/schemas/order' - '/orders/{id}': - get: - operationId: GetOrdersOrder - summary: Retrieves an Order - description: Retrieves an Order - parameters: - - in: path - name: id - required: true - description: The id of the Order. - schema: - type: string - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - order: - $ref: '#/components/schemas/order' - /orders: - get: - operationId: GetOrders - summary: Look Up an Order - description: Look up an order using filters. - parameters: - - in: query - name: display_id - required: true - description: The display id given to the Order. - schema: - type: number - - in: query - name: email - style: form - explode: false - description: The email associated with this order. - required: true - schema: - type: string - format: email - - in: query - name: shipping_address - style: form - explode: false - description: The shipping address associated with this order. - schema: - type: object - properties: - postal_code: - type: string - description: The postal code of the shipping address - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - properties: - order: - $ref: '#/components/schemas/order' '/products/{id}': get: operationId: GetProductsProduct diff --git a/docs/api/store/openapi.yaml b/docs/api/store/openapi.yaml index 09e3890872..cd393a3d88 100644 --- a/docs/api/store/openapi.yaml +++ b/docs/api/store/openapi.yaml @@ -62,6 +62,28 @@ paths: $ref: paths/collections.yaml /gift-cards/{code}: $ref: paths/gift-cards_{code}.yaml + /customers/me/addresses: + $ref: paths/customers_me_addresses.yaml + /customers: + $ref: paths/customers.yaml + /customers/me/addresses/{address_id}: + $ref: paths/customers_me_addresses_{address_id}.yaml + /customers/me: + $ref: paths/customers_me.yaml + /customers/me/payment-methods: + $ref: paths/customers_me_payment-methods.yaml + /customers/me/orders: + $ref: paths/customers_me_orders.yaml + /customers/password-token: + $ref: paths/customers_password-token.yaml + /customers/password-reset: + $ref: paths/customers_password-reset.yaml + /orders/cart/{cart_id}: + $ref: paths/orders_cart_{cart_id}.yaml + /orders/{id}: + $ref: paths/orders_{id}.yaml + /orders: + $ref: paths/orders.yaml /carts/{id}/shipping-methods: $ref: paths/carts_{id}_shipping-methods.yaml /carts/{id}/taxes: @@ -86,28 +108,6 @@ paths: $ref: paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml /carts/{id}/payment-session: $ref: paths/carts_{id}_payment-session.yaml - /customers/me/addresses: - $ref: paths/customers_me_addresses.yaml - /customers: - $ref: paths/customers.yaml - /customers/me/addresses/{address_id}: - $ref: paths/customers_me_addresses_{address_id}.yaml - /customers/me: - $ref: paths/customers_me.yaml - /customers/me/payment-methods: - $ref: paths/customers_me_payment-methods.yaml - /customers/me/orders: - $ref: paths/customers_me_orders.yaml - /customers/password-token: - $ref: paths/customers_password-token.yaml - /customers/password-reset: - $ref: paths/customers_password-reset.yaml - /orders/cart/{cart_id}: - $ref: paths/orders_cart_{cart_id}.yaml - /orders/{id}: - $ref: paths/orders_{id}.yaml - /orders: - $ref: paths/orders.yaml /products/{id}: $ref: paths/products_{id}.yaml /products: diff --git a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts b/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts index 02d326f7ca..726bfc65b2 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts @@ -19,12 +19,13 @@ import { Type } from "class-transformer" import { pickBy } from "lodash" /** - * @oas [get] /price-lists/:id/products + * @oas [get] /price-lists/{id}/products * operationId: "GetPriceListsPriceListProducts" * summary: "List Product in a Price List" * description: "Retrieves a list of Product that are part of a Price List" * x-authenticated: true * parameters: + * - (path) id=* {string} ID of the price list. * - (query) q {string} Query used for searching product title and description, variant title and sku, and collection title. * - (query) id {string} ID of the product to search for. * - in: query diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts index 1b4a88bd2c..0721ceca4c 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts @@ -1,17 +1,18 @@ import { IsArray, IsOptional } from "class-validator" import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config" +import { EntityManager } from "typeorm" import { TaxRate } from "../../../.." import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" -import { EntityManager } from "typeorm" /** - * @oas [post] /tax-rates/:id/product-types/batch + * @oas [post] /tax-rates/{id}/product-types/batch * operationId: "PostTaxRatesTaxRateProductTypes" * summary: "Add Tax Rate to Product Types" * description: "Associates a Tax Rate with a list of Product Types" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts index 4b6e761727..cc589dbc58 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts @@ -1,17 +1,18 @@ import { IsArray, IsOptional } from "class-validator" import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config" +import { EntityManager } from "typeorm" import { TaxRate } from "../../../.." import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" -import { EntityManager } from "typeorm" /** - * @oas [post] /tax-rates/:id/products/batch + * @oas [post] /tax-rates/{id}/products/batch * operationId: "PostTaxRatesTaxRateProducts" * summary: "Add Tax Rate to Products" * description: "Associates a Tax Rate with a list of Products" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts index ba0fb060d6..b12a722b27 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts @@ -1,17 +1,18 @@ import { IsArray, IsOptional } from "class-validator" import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config" +import { EntityManager } from "typeorm" import { TaxRate } from "../../../.." import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" -import { EntityManager } from "typeorm" /** - * @oas [post] /tax-rates/:id/shipping-options/batch + * @oas [post] /tax-rates/{id}/shipping-options/batch * operationId: "PostTaxRatesTaxRateShippingOptions" * summary: "Add Tax Rate to Product Types" * description: "Associates a Tax Rate with a list of Shipping Options" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." diff --git a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts index 71e80ac276..ff42468538 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts @@ -6,11 +6,12 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [get] /tax-rates/:id + * @oas [get] /tax-rates/{id} * operationId: "GetTaxRatesTaxRate" * summary: "Get Tax Rate" * description: "Retrieves a TaxRate" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts index c80190a803..83ec2c5b79 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts @@ -1,17 +1,18 @@ import { IsArray, IsOptional } from "class-validator" import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config" +import { EntityManager } from "typeorm" import { TaxRate } from "../../../.." import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" -import { EntityManager } from "typeorm" /** - * @oas [delete] /tax-rates/:id/product-types/batch + * @oas [delete] /tax-rates/{id}/product-types/batch * operationId: "DeleteTaxRatesTaxRateProductTypes" * summary: "Remove Tax Rate from Product Types" * description: "Removes a Tax Rate from a list of Product Types" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts index 1c3b6996ac..a32c292909 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts @@ -1,17 +1,18 @@ import { IsArray, IsOptional } from "class-validator" import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config" +import { EntityManager } from "typeorm" import { TaxRate } from "../../../.." import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" -import { EntityManager } from "typeorm" /** - * @oas [delete] /tax-rates/:id/products/batch + * @oas [delete] /tax-rates/{id}/products/batch * operationId: "DeleteTaxRatesTaxRateProducts" * summary: "Removes Tax Rate from Products" * description: "Removes a Tax Rate from a list of Products" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts index 0a1a13d6d8..74f773f58b 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts @@ -1,17 +1,18 @@ import { IsArray, IsOptional } from "class-validator" import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config" +import { EntityManager } from "typeorm" import { TaxRate } from "../../../.." import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" -import { EntityManager } from "typeorm" /** - * @oas [delete] /tax-rates/:id/shipping-options/batch + * @oas [delete] /tax-rates/{id}/shipping-options/batch * operationId: "DeleteTaxRatesTaxRateShippingOptions" * summary: "Removes a Tax Rate from Product Types" * description: "Removes a Tax Rate from a list of Product Types" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." diff --git a/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts index 2ed36a16e0..5d0e34e6f9 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts @@ -9,11 +9,12 @@ import { omit } from "lodash" import { validator } from "../../../../utils/validator" /** - * @oas [post] /tax-rates/:id + * @oas [post] /tax-rates/{id} * operationId: "PostTaxRatesTaxRate" * summary: "Update a Tax Rate" * description: "Updates a Tax Rate" * parameters: + * - (path) id=* {string} ID of the tax rate. * - in: query * name: fields * description: "Which fields should be included in the result." From 1bc517da6473005352929b5c3f53cba984b3e2f8 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 10 Aug 2022 14:54:15 +0300 Subject: [PATCH 04/19] docs: improved cart documentation (#2027) --- .../how-to-implement-checkout-flow.mdx | 3 + docs/content/guides/carts-in-medusa.md | 163 ------- docs/content/guides/carts-in-medusa.mdx | 404 ++++++++++++++++++ www/docs/sidebars.js | 8 +- www/docs/src/css/custom.css | 4 + 5 files changed, 415 insertions(+), 167 deletions(-) delete mode 100644 docs/content/guides/carts-in-medusa.md create mode 100644 docs/content/guides/carts-in-medusa.mdx diff --git a/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx b/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx index 724fa3c7bf..5c05cac164 100644 --- a/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx +++ b/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx @@ -18,6 +18,8 @@ It’s recommended to go through the [Shipping Architecture Overview](../backend This document assumes you’ve already taken care of the add-to-cart flow. So, you should have a [cart created](https://docs.medusajs.com/api/store/cart/create-a-cart) for the customer with at least [one product in it](https://docs.medusajs.com/api/store/cart/add-a-line-item). +You can learn how to implement the cart flow using [this documentation](../../guides/carts-in-medusa.mdx). + To follow along with this tutorial, you can make use of the [Medusa JS Client](https://www.npmjs.com/package/@medusajs/medusa-js). You can install it with this command: ```bash npm2yarn @@ -325,5 +327,6 @@ If the order is placed successfully, you can access the order data in `response. ## What’s Next 🚀 +- Learn more about the [JS Client and how to use it](../../js-client/overview.md). - Check out available plugins for popular payment providers such as [Stripe](../../add-plugins/stripe.md) and [PayPal](/add-plugins/paypal.md). - Learn more about the [Payment](../backend/payment/overview.md) and [Shipping](../backend/shipping/overview.md) Architectures. diff --git a/docs/content/guides/carts-in-medusa.md b/docs/content/guides/carts-in-medusa.md deleted file mode 100644 index 9c00b9d1cb..0000000000 --- a/docs/content/guides/carts-in-medusa.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: Carts ---- - -# Carts - -In Medusa a Cart serves the purpose of collecting the information needed to create an Order, including what products to purchase, what address to send the products to and which payment method the purchase will be processed by. - -To create a cart using the `@medusajs/medusa-js` SDK you can use: - -```javascript -const client = new Medusa({ baseUrl: "http://localhost:9000" }) -const { cart } = await client.carts.create() -``` - -A Cart will always belong to a Region and you may provide a `region_id` upon Cart creation. If no `region_id` is specified Medusa will assign the Cart to a random Region. Regions specify information about how the Cart should be taxed, what currency the Cart should be paid with and what payment and fulfillment options will be available at checkout. Below are some of the properties that can be found on the Cart response. For a full example of a Cart response [check our fixtures](https://github.com/medusajs/medusa/blob/docs/api/docs/api/fixtures/store/GetCartsCart.json). - -```json - "cart": { - "id": "cart_01FEWZSRFWT8QWMHJ7ZCPRP3BZ", - "email": null, - "billing_address": null, - "shipping_address": null, - "items": [ ... ], - "region": { - "id": "reg_01FEWZSRD7HVHBSQRC4KYMG5XM", - "name": "United States", - "currency_code": "usd", - "tax_rate": "0", - ... - }, - "discounts": [], - "gift_cards": [], - "customer_id": null, - "payment_sessions": [], - "payment": null, - "shipping_methods": [], - "type": "default", - "metadata": null, - "shipping_total": 0, - "discount_total": 0, - "tax_total": 0, - "gift_card_total": 0, - "subtotal": 1000, - "total": 1000, - ... - } -``` - -## Adding products to the Cart - -Customers can add products to the Cart in order to start gathering the items that will eventually be purchased. In Medusa adding a product to a Cart will result in a _Line Item_ being generated. To add a product using the SDK use: - -```javascript -const { cart } = await client.carts.lineItems.create(cartId, { - variant_id: "[id-of-variant-to-add]", - quantity: 1, -}) -``` - -The resulting response will look something like this: - -```json -{ - "cart": { - "id": "cart_01FEWZSRFWT8QWMHJ7ZCPRP3BZ", - "items": [ - { - "id": "item_01FEWZSRMBAN85SKPCRMM30N6W", - "cart_id": "cart_01FEWZSRFWT8QWMHJ7ZCPRP3BZ", - "title": "Basic Tee", - "description": "Small", - "thumbnail": null, - "is_giftcard": false, - "should_merge": true, - "allow_discounts": true, - "has_shipping": false, - "unit_price": 1000, - "variant": { - "id": "variant_01FEWZSRDNWABVFZTZ21JWKHRG", - "title": "Small", - "product_id": "prod_01FEWZSRDHDDSHQV6ATG6MS2MF", - "sku": null, - "barcode": null, - "ean": null, - "upc": null, - "allow_backorder": false, - "hs_code": null, - "origin_country": null, - "mid_code": null, - "material": null, - "weight": null, - "length": null, - "height": null, - "width": null, - "metadata": null, - ... - }, - "quantity": 1, - "metadata": {}, - ... - } - ], - ... - } -} -``` - -The properties stored on a Line Item are useful for explaining and displaying the contents of the Cart. For example, Line Items can have a thumbnail assigned which can be used to display a pack shot of the product that is being purchased, a title to show name the products in the cart and a description to give further details about the product. By default the Line Item will be generated with properties inherited from the Product that is being added to the Cart, but the behaviour can be customized for other purposes as well. - -## Adding Customer information to a Cart - -After adding products to the Cart, you should gather information about where to send the products, this is done using the `update` method in the SDK. - -```javascript -const { cart } = await client.carts.update(cartId, { - email: "jane.doe@mail.com", - shipping_address: { - first_name: "Jane", - last_name: "Doe", - address_1: "4242 Hollywood Dr", - postal_code: "12345", - country_code: "us", - city: "Los Angeles", - region: "CA", - }, -}) -``` - -Note that the country code in the shipping address must be the country code for one of the countries in a Region - otherwise this method will fail. - -## Initializing Payment Sessions - -In Medusa payments are handled through the long lived entities called _Payment Sessions_. Payment Sessions cary provider specific data that can later be used to authorize the payments, which is the step required before an order can be created. The SDK provides a `createPaymentSessions` method that can be used to initialize the payment sessions with the Payment Providers available in the Region. - -```javascript -const { cart } = await client.carts.createPaymentSessions(cartId) -``` - -You can read more about Payment Sessions in our [guide to checkouts](https://docs.medusajs.com/guides/checkouts). - -## Changing the Cart region - -To update the Region that the cart belongs to you should also use the `update` method from the SDK. - -```javascript -const { cart } = await client.carts.update(cartId, { - region_id: "[id-of-region-to-switch-to]", -}) -``` - -When changing the Cart region you should be aware of a couple of things: - -- If switching to a Region with a different currency the line item prices and cart totals will change -- If switching to a Region with a different tax rate prices and totals will change -- If switching to a Region serving only one country the `shipping_address.country_code` will automatically be set to that country -- If the Cart already has initialized payment sessions all of these will be canceled and a new call to `createPaymentSessions` will have to be made - -## What's next? - -Carts are at the core of the shopping process in Medusa and provide all the necessary functionality to gather products for purchase. If you want to read a more detailed guide about how to complete checkouts please go to our [Checkout Guide](https://docs.medusajs.com/guides/checkout). - -If you have questions or issues feel free to reach out via our [Discord server](https://discord.gg/xpCwq3Kfn8) for direct access to the Medusa engineering team. diff --git a/docs/content/guides/carts-in-medusa.mdx b/docs/content/guides/carts-in-medusa.mdx new file mode 100644 index 0000000000..589b2ee56b --- /dev/null +++ b/docs/content/guides/carts-in-medusa.mdx @@ -0,0 +1,404 @@ +# How to Add Cart Functionality + +This document guides you through how you can add cart-related functionalities to your storefront. That includes creating and updating a cart and managing items in the cart. + +## Overview + +Carts are necessary for ecommerce platforms to allow customers to buy products. Each customer, whether logged in or as a guest, should have a cart associated with them. The customer can then add products to the cart. + +This document helps you understand how to add the cart functionality to your storefront. This is helpful if you’re creating the storefront from scratch, or you want to understand how the process generally works in Medusa’s starter storefronts. + +:::note + +This document does not cover implementing the checkout flow. You can refer to [this documentation instead to learn how to implement the checkout flow](../advanced/storefront/how-to-implement-checkout-flow.mdx). + +::: + +### Glossary + +- **Line Item**: When products are added to the cart in Medusa, they are referred to as line items. Line items have, by default, the same properties and attributes as a product. However, you can customize line items specifically for a cart if necessary. + +## Prerequisites + +It is assumed you already have a Medusa server installed before following along with this tutorial. If not, you can get started in minutes by following the [quickstart guide](../quickstart/quick-start.md). + +It is also assumed you already have a storefront set up. It can be a custom storefront or one of Medusa’s storefronts. If you don’t have a storefront set up, you can install either the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts. + +## Install the JS Client + +It is recommended to use Medusa’s JS Client in your storefront. You can install it using the following command: + +```bash npm2yarn +npm install @medusajs/medusa-js +``` + +:::note + +This document alternatively shows code examples using [JavaScript’s Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch). Make sure to replace `` in those examples with your server URL. + +::: + +Then, initialize the Medusa JS Client in a single file that all of your components can access: + +```jsx +import Medusa from '@medusajs/medusa-js'; + +export const client = new Medusa({ + baseUrl: '', + maxRetries: 3 +}); +``` + +Where `` is the URL of your server. If you’re using a local server, it runs on `http://localhost:9000` by default. + +:::caution + +Make sure to include `http://` in the URL when sending requests to the local server. Otherwise, all requests will fail. + +::: + +## Create a Cart + +You can create a cart with the following code snippet: + + + + +```jsx +client.carts.create() +.then(({cart}) => { + localStorage.setItem('cart_id', cart.id); + //assuming you have a state variable to store the cart + setCart(cart); +}); +``` + + + + +```jsx +fetch(`/store/carts`, { + method: 'POST' +}) +.then((response) => response.json()) +.then(({cart}) => { + localStorage.setItem('cart_id', cart.id); + //assuming you have a state variable to store the cart + setCart(cart) +}); +``` + + + + +A cart will be created with a random region assigned to it. + +:::note + +The region a cart is associated with determines the currency the cart uses, the tax, payment, and fulfillment providers, and other details and options. So, make sure you use the correct region for a cart. + +::: + +Otherwise, you can assign it a specific region during creation: + + + + +```jsx +client.carts.create({ + region_id +}) +.then(({cart}) => { + localStorage.setItem('cart_id', cart.id); + //assuming you have a state variable to store the cart + setCart(cart); +}); +``` + + + + +```jsx +fetch(`/store/carts`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + region_id + }) +}) +.then((response) => response.json()) +.then(({cart}) => { + localStorage.setItem('cart_id', cart.id); + //assuming you have a state variable to store the cart + setCart(cart) +}); +``` + + + + +To learn about what parameters you can pass during the cart’s creation, check out the [JS Client Reference](../references/js-client/classes/CartsResource.md#create) or the [API Reference](/api/store#tag/Cart/operation/PostCart). + +## Retrieve a Cart + +Notice that in the previous code snippets, you set the cart’s ID in the local storage. This is helpful to persist the customer’s cart even when they leave the website and come back later. + +You can retrieve the cart at any given point using its ID with the following code snippet: + + + + +```jsx +const id = localStorage.getItem('cart_id'); + +if (id) { + client.carts.retrieve(id) + .then(({cart}) => setCart(cart)); +} +``` + + + + +```jsx +const id = localStorage.getItem('cart_id'); + +if (id) { + fetch(`/store/carts/${id}`) + .then((response) => response.json()) + .then(({cart}) => setCart(cart)); +} +``` + + + + +You can run this code snippet every time the storefront is opened. If a customer has a cart ID stored in their local storage, it’s loaded from the server. + +:::tip + +Make sure to remove the ID from the local storage after the customer places an order with this cart. + +::: + +## Update a Cart + +A cart has different data associated with it including the region, email, address, customer, and more. + +You can use the following snippet to update any of the cart’s data: + +```jsx +client.carts.update(cart.id, { + region_id +}) +.then(({cart}) => setCart(cart)); +``` + +```jsx +fetch(`/store/carts/${cart.id}`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + region_id + }) +}) +.then((response) => response.json()) +.then(({cart}) => setCart(cart)); +``` + +This updates the region in the cart. + +To find out what data you can update in the cart, check out the [JS Client reference](../references/js-client/classes/CartsResource.md#update) or the [API reference](/api/store/#tag/Cart/operation/PostCartsCart). + +### Associate a Logged-In Customer with the Cart + +A customer might add items to their cart, then creates an account or log in. In that case, you should ensure that the cart is associated with the logged-in customer moving forward. + +This can be done using the same update operation: + + + + +```jsx +client.carts.update(cart.id, { + customer_id +}) +.then(({cart}) => setCart(cart)); +``` + + + + +```jsx +fetch(`/store/carts/${cart.id}`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + customer_id + }) +}) +.then((response) => response.json()) +.then(({cart}) => setCart(cart)); +``` + + + + +This updates the `customer_id` associated with the cart to make sure it belongs to a specific customer. + +### Associate Guest Customers with a Cart using Email + +In case the customer does not want to use their own account, you must at least associate an email address with the cart before completing the cart and placing the order. + +This can be done using the same update operation: + + + + +```jsx +client.carts.update(cart.id, { + email: 'user@example.com' +}) +.then(({cart}) => setCart(cart)); +``` + + + + +```jsx +fetch(`/store/carts/${cart.id}`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + email: 'user@example.com' + }) +}) +.then((response) => response.json()) +.then(({cart}) => setCart(cart)); +``` + + + + +## Add Line Item to the Cart + +To create a line item of a product and add it to a cart, you can use the following code snippet: + + + + +```jsx +client.carts.lineItems.create(cart.id, { + variant_id, + quantity: 1 +}) +.then(({cart}) => setCart(cart)); +``` + + + + +```jsx +fetch(`/store/carts/${cart.id}/line-items`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + variant_id, + quantity: 1 + }) +}) +.then((response) => response.json()) +.then(({cart}) => setCart(cart)); +``` + + + + +Where `variant_id` is the variant of the product you want to add to the cart. + +:::note + +If you’re using Sales Channels, make sure that the cart and the product belong to the same sales channel. You can update the cart’s sales channel by [updating the cart](#update-a-cart). + +::: + +This adds a new line item to the cart. Line items can be accessed using `cart.items` which is an array that holds all line items in the cart. You can learn more about what properties line items have in the [API reference](/api/store/#tag/Cart/operation/PostCartsCartLineItems). + +## Update Line Item in the Cart + +To update a line item in the cart, you can use the following code snippet: + + + + +```jsx +client.carts.lineItems.update(cart.id, line_item_id, { + quantity: 3 +}) +.then(({cart}) => setCart(cart)) +``` + + + + +```jsx +fetch(`/store/carts/${cart.id}/line-items/${line_item_id}`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + quantity: 3 + }) +}) +.then((response) => response.json()) +.then(({cart}) => setCart(cart)); +``` + + + + +This updates the quantity of the line item in the cart using the item’s ID. + +## Delete a Line Item from the Cart + +To delete a line item from the cart, you can use the following code snippet: + + + + +```jsx +client.carts.lineItems.delete(cart.id, line_item_id) +.then(({cart}) => setCart(cart)) +``` + + + + +```jsx +fetch(`/store/carts/${cart.id}/line-items/${line_item_id}`, { + method: 'DELETE' +}) +.then((response) => response.json()) +.then(({cart}) => setCart(cart)); +``` + + + + +This deletes a line item from the cart using the item’s ID. + +## What’s Next 🚀 + +- Learn [how to implement the checkout flow in your storefront](../advanced/storefront/how-to-implement-checkout-flow.mdx). +- Learn more about the [JS Client and how to use it](../js-client/overview.md). diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 4c1941de5d..ea77fefcbc 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -268,10 +268,6 @@ module.exports = { } ] }, - { - type: "doc", - id: "guides/carts-in-medusa", - }, { type: "doc", id: "advanced/backend/migrations", @@ -304,6 +300,10 @@ module.exports = { type: "doc", id: "advanced/storefront/how-to-implement-checkout-flow", }, + { + type: "doc", + id: "guides/carts-in-medusa", + }, ] } ] diff --git a/www/docs/src/css/custom.css b/www/docs/src/css/custom.css index 3e4f918b06..118e1397fe 100644 --- a/www/docs/src/css/custom.css +++ b/www/docs/src/css/custom.css @@ -299,6 +299,10 @@ details summary { text-decoration: none; } +[data-theme="dark"] a:hover { + color: rgba(255, 255, 255, 0.8); +} + .DocSearch-Container { z-index: 1001 !important; } From b5b3b5431e047210ca42f34b68182238701bb6bd Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 10 Aug 2022 14:54:33 +0300 Subject: [PATCH 05/19] docs: added report issue link (#2028) --- www/docs/docusaurus.config.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/www/docs/docusaurus.config.js b/www/docs/docusaurus.config.js index 557958ade3..678dc92523 100644 --- a/www/docs/docusaurus.config.js +++ b/www/docs/docusaurus.config.js @@ -112,6 +112,11 @@ module.exports = { }, ] }, + { + href: "https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml", + position: 'right', + label: 'Report an Issue' + }, { href: "https://github.com/medusajs/medusa", className: "navbar-github-link", From 0703dd94e88be47fdc61c1caa451c050fbabbef3 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 10 Aug 2022 16:03:31 +0300 Subject: [PATCH 06/19] docs: add export options for minio (#2029) --- docs/content/add-plugins/minio.md | 68 +++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/docs/content/add-plugins/minio.md b/docs/content/add-plugins/minio.md index 14429de4d8..815e412f07 100644 --- a/docs/content/add-plugins/minio.md +++ b/docs/content/add-plugins/minio.md @@ -117,6 +117,74 @@ Run your Medusa server alongside the [Medusa Admin](../admin/quickstart.md) to t ![Image Uploaded on Admin](https://i.imgur.com/alabX2i.png) +## Additional Configuration for Exports + +Medusa v1.3.3 introduced the Export API. For example, you can now export your products from the Medusa Admin on the Products page. + +![Export button in Products page in Medusa Admin](https://i.imgur.com/uyK4id8.png) + +:::note + +Exports require using Redis to handle the event queue, and using PostgreSQL for the database. If you don’t use Redis or PostgreSQL, you can follow [this documentation to install](../tutorial/0-set-up-your-development-environment.mdx#postgresql) and then [configure them on your Medusa server](../usage/configurations.md#postgresql-configurations). + +::: + +When using MinIO, you must create a private bucket that will store these product exports. To do that, follow along the [steps mentioned earlier to create a bucket](#create-a-minio-bucket), but keep Access Policy set to private. + +Then, add the following environment variable on your Medusa server: + +```bash +MINIO_PRIVATE_BUCKET=exports +``` + +Finally, add a new option to the plugin’s options in `medusa-config.js`: + +```jsx +{ + resolve: `medusa-file-minio`, + options: { + //... + private_bucket: process.env.MINIO_PRIVATE_BUCKET + }, +}, +``` + +If you start your Medusa server now and click on Export Products on the Medusa admin, the export will run in the background. When ready, it should be available for download. + +![Export is available for download on the Medusa Admin](https://i.imgur.com/Xc61Wg1.png) + +:::tip + +If you face any errors, make sure you have the latest version of the plugin installed. + +::: + +### Use Different Secret and Access Keys + +If you only add the `private_bucket` option, the same secret and access keys that you used for the public bucket will be used to access the private bucket. + +If you want to use different keys, set the following environment variables: + +```bash +MINIO_PRIVATE_ACCESS_KEY= +MINIO_PRIVATE_SECRET_KEY= +``` + +Where `` and `` are the access key and secret access key that have access to the private MinIO bucket. + +Then, add two new options to the plugin’s options in `medusa-config.js`: + +```jsx +{ + resolve: `medusa-file-minio`, + options: { + //... + private_access_key_id: process.env.MINIO_PRIVATE_ACCESS_KEY, + private_secret_access_key: process.env.MINIO_PRIVATE_SECRET_KEY + }, +}, +``` + ## Next.js Storefront Configuration If you’re using a [Next.js](../starters/nextjs-medusa-starter.md) storefront, you need to add an additional configuration that adds the MinIO domain name into the configured images domain names. This is because all URLs of product images will be from the MinIO server. From 4a89961fd496b04005859e14f750a6a5fb9417c6 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 15 Aug 2022 12:29:02 +0300 Subject: [PATCH 07/19] docs: changed `BaseService` to `TransactionBaseService` (#2046) --- docs/content/advanced/backend/entities.md | 2 +- docs/content/advanced/backend/services/create-service.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/content/advanced/backend/entities.md b/docs/content/advanced/backend/entities.md index 95b45dea02..9a73b0590e 100644 --- a/docs/content/advanced/backend/entities.md +++ b/docs/content/advanced/backend/entities.md @@ -112,7 +112,7 @@ npm run build You can access your custom entity data in the database in services or subscribers using the repository. For example, here’s a service that lists all posts: ```tsx -import { TransactionBaseService } from "medusa-interfaces"; +import { TransactionBaseService } from '@medusajs/medusa'; class PostService extends TransactionBaseService { constructor({ postRepository, manager }) { diff --git a/docs/content/advanced/backend/services/create-service.md b/docs/content/advanced/backend/services/create-service.md index 688771d90e..e1b8c92526 100644 --- a/docs/content/advanced/backend/services/create-service.md +++ b/docs/content/advanced/backend/services/create-service.md @@ -12,7 +12,7 @@ Services in Medusa represent bundled helper methods that you want to use across For example, you can use Medusa’s `productService` to get the list of products, as well as perform other functionalities related to products. There’s also an `authService` that provides functionalities like authenticating customers and users. -Custom services reside in the `src/services` directory of your Medusa Server installation. Each service should be a class that extends the `BaseService` class from `medusa-interfaces`. +Custom services reside in the `src/services` directory of your Medusa Server installation. Each service should be a class that extends the `TransactionBaseService` class from the core Medusa package `@medusajs/medusa`. Each file you create in `src/services` should hold one service and export it. @@ -29,9 +29,9 @@ To create a service, you should create a JavaScript file in `src/services` to ho For example, if you want to create a service `helloService`, create the file `hello.js` in `src/services` with the following content: ```js -import { BaseService } from "medusa-interfaces" +import { TransactionBaseService } from '@medusajs/medusa'; -class HelloService extends BaseService { +class HelloService extends TransactionBaseService { getMessage() { return `Welcome to My Store!` } @@ -42,7 +42,7 @@ export default HelloService ## Service Constructor -As the service extends the `BaseService` class, all services in Medusa’s core, as well as all your custom services, will be available in your service’s constructor using dependency injection. +As the service extends the `TransactionBaseService` class, all services in Medusa’s core, as well as all your custom services, will be available in your service’s constructor using dependency injection. So, if you want your service to use another service, simply add it as part of your constructor’s dependencies and set it to a field inside your service’s class: From 4a416e7fa5b410a8fa45629f007dca7779be0d54 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 15 Aug 2022 15:54:48 +0300 Subject: [PATCH 08/19] docs: added entity reference (#2047) * added entity reference * chore: added github action * added link to reference --- .../workflows/generate-entity-reference.yml | 53 ++ .github/workflows/generate-reference.yml | 2 +- docs/content/advanced/backend/entities.md | 4 +- docs/content/references/entities/.nojekyll | 1 + .../references/entities/classes/Address.md | 231 +++++++ .../references/entities/classes/BatchJob.md | 249 ++++++++ .../references/entities/classes/Cart.md | 455 ++++++++++++++ .../references/entities/classes/ClaimImage.md | 131 ++++ .../references/entities/classes/ClaimItem.md | 211 +++++++ .../references/entities/classes/ClaimOrder.md | 261 ++++++++ .../references/entities/classes/ClaimTag.md | 111 ++++ .../references/entities/classes/Country.md | 91 +++ .../references/entities/classes/Currency.md | 51 ++ .../entities/classes/CustomShippingOption.md | 151 +++++ .../references/entities/classes/Customer.md | 211 +++++++ .../entities/classes/CustomerGroup.md | 131 ++++ .../references/entities/classes/Discount.md | 231 +++++++ .../entities/classes/DiscountCondition.md | 191 ++++++ .../classes/DiscountConditionCustomerGroup.md | 81 +++ .../classes/DiscountConditionProduct.md | 81 +++ .../DiscountConditionProductCollection.md | 81 +++ .../classes/DiscountConditionProductTag.md | 81 +++ .../classes/DiscountConditionProductType.md | 81 +++ .../entities/classes/DiscountRule.md | 151 +++++ .../references/entities/classes/DraftOrder.md | 187 ++++++ .../entities/classes/Fulfillment.md | 247 ++++++++ .../entities/classes/FulfillmentItem.md | 61 ++ .../entities/classes/FulfillmentProvider.md | 31 + .../references/entities/classes/GiftCard.md | 191 ++++++ .../entities/classes/GiftCardTransaction.md | 115 ++++ .../entities/classes/IdempotencyKey.md | 125 ++++ .../references/entities/classes/Image.md | 111 ++++ .../references/entities/classes/Invite.md | 151 +++++ .../references/entities/classes/LineItem.md | 417 +++++++++++++ .../entities/classes/LineItemAdjustment.md | 105 ++++ .../entities/classes/LineItemTaxLine.md | 153 +++++ .../entities/classes/MoneyAmount.md | 201 +++++++ .../references/entities/classes/Note.md | 151 +++++ .../entities/classes/Notification.md | 197 ++++++ .../references/entities/classes/Oauth.md | 85 +++ .../references/entities/classes/Order.md | 567 ++++++++++++++++++ .../references/entities/classes/Payment.md | 237 ++++++++ .../entities/classes/PaymentProvider.md | 31 + .../entities/classes/PaymentSession.md | 147 +++++ .../references/entities/classes/PriceList.md | 171 ++++++ .../references/entities/classes/Product.md | 381 ++++++++++++ .../entities/classes/ProductCollection.md | 131 ++++ .../entities/classes/ProductOption.md | 141 +++++ .../entities/classes/ProductOptionValue.md | 151 +++++ .../references/entities/classes/ProductTag.md | 111 ++++ .../entities/classes/ProductTaxRate.md | 81 +++ .../entities/classes/ProductType.md | 111 ++++ .../entities/classes/ProductTypeTaxRate.md | 81 +++ .../entities/classes/ProductVariant.md | 311 ++++++++++ .../references/entities/classes/Refund.md | 147 +++++ .../references/entities/classes/Region.md | 231 +++++++ .../references/entities/classes/Return.md | 227 +++++++ .../references/entities/classes/ReturnItem.md | 131 ++++ .../entities/classes/ReturnReason.md | 161 +++++ .../entities/classes/SalesChannel.md | 121 ++++ .../entities/classes/ShippingMethod.md | 185 ++++++ .../entities/classes/ShippingMethodTaxLine.md | 153 +++++ .../entities/classes/ShippingOption.md | 231 +++++++ .../classes/ShippingOptionRequirement.md | 85 +++ .../entities/classes/ShippingProfile.md | 141 +++++ .../entities/classes/ShippingTaxRate.md | 81 +++ .../references/entities/classes/StagedJob.md | 55 ++ .../references/entities/classes/Store.md | 177 ++++++ .../references/entities/classes/Swap.md | 291 +++++++++ .../entities/classes/TaxProvider.md | 31 + .../references/entities/classes/TaxRate.md | 197 ++++++ .../entities/classes/TrackingLink.md | 151 +++++ .../references/entities/classes/User.md | 161 +++++ .../entities/enums/AllocationType.md | 25 + .../references/entities/enums/CartType.md | 55 ++ .../entities/enums/ClaimFulfillmentStatus.md | 95 +++ .../entities/enums/ClaimPaymentStatus.md | 35 ++ .../references/entities/enums/ClaimReason.md | 45 ++ .../references/entities/enums/ClaimType.md | 25 + .../enums/DiscountConditionOperator.md | 25 + .../entities/enums/DiscountConditionType.md | 55 ++ .../entities/enums/DiscountRuleType.md | 35 ++ .../entities/enums/DraftOrderStatus.md | 25 + .../entities/enums/FulfillmentStatus.md | 95 +++ .../references/entities/enums/OrderStatus.md | 55 ++ .../entities/enums/PaymentSessionStatus.md | 55 ++ .../entities/enums/PaymentStatus.md | 75 +++ .../entities/enums/ProductStatus.md | 45 ++ .../references/entities/enums/RefundReason.md | 55 ++ .../entities/enums/RequirementType.md | 25 + .../references/entities/enums/ReturnStatus.md | 45 ++ .../entities/enums/ShippingOptionPriceType.md | 25 + .../entities/enums/ShippingProfileType.md | 35 ++ .../entities/enums/SwapFulfillmentStatus.md | 55 ++ .../entities/enums/SwapPaymentStatus.md | 95 +++ .../references/entities/enums/UserRoles.md | 35 ++ docs/content/references/entities/index.md | 103 ++++ package.json | 1 + typedoc.entities.js | 17 + www/docs/docusaurus.config.js | 5 + www/docs/sidebars.js | 8 +- 101 files changed, 12704 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/generate-entity-reference.yml create mode 100644 docs/content/references/entities/.nojekyll create mode 100644 docs/content/references/entities/classes/Address.md create mode 100644 docs/content/references/entities/classes/BatchJob.md create mode 100644 docs/content/references/entities/classes/Cart.md create mode 100644 docs/content/references/entities/classes/ClaimImage.md create mode 100644 docs/content/references/entities/classes/ClaimItem.md create mode 100644 docs/content/references/entities/classes/ClaimOrder.md create mode 100644 docs/content/references/entities/classes/ClaimTag.md create mode 100644 docs/content/references/entities/classes/Country.md create mode 100644 docs/content/references/entities/classes/Currency.md create mode 100644 docs/content/references/entities/classes/CustomShippingOption.md create mode 100644 docs/content/references/entities/classes/Customer.md create mode 100644 docs/content/references/entities/classes/CustomerGroup.md create mode 100644 docs/content/references/entities/classes/Discount.md create mode 100644 docs/content/references/entities/classes/DiscountCondition.md create mode 100644 docs/content/references/entities/classes/DiscountConditionCustomerGroup.md create mode 100644 docs/content/references/entities/classes/DiscountConditionProduct.md create mode 100644 docs/content/references/entities/classes/DiscountConditionProductCollection.md create mode 100644 docs/content/references/entities/classes/DiscountConditionProductTag.md create mode 100644 docs/content/references/entities/classes/DiscountConditionProductType.md create mode 100644 docs/content/references/entities/classes/DiscountRule.md create mode 100644 docs/content/references/entities/classes/DraftOrder.md create mode 100644 docs/content/references/entities/classes/Fulfillment.md create mode 100644 docs/content/references/entities/classes/FulfillmentItem.md create mode 100644 docs/content/references/entities/classes/FulfillmentProvider.md create mode 100644 docs/content/references/entities/classes/GiftCard.md create mode 100644 docs/content/references/entities/classes/GiftCardTransaction.md create mode 100644 docs/content/references/entities/classes/IdempotencyKey.md create mode 100644 docs/content/references/entities/classes/Image.md create mode 100644 docs/content/references/entities/classes/Invite.md create mode 100644 docs/content/references/entities/classes/LineItem.md create mode 100644 docs/content/references/entities/classes/LineItemAdjustment.md create mode 100644 docs/content/references/entities/classes/LineItemTaxLine.md create mode 100644 docs/content/references/entities/classes/MoneyAmount.md create mode 100644 docs/content/references/entities/classes/Note.md create mode 100644 docs/content/references/entities/classes/Notification.md create mode 100644 docs/content/references/entities/classes/Oauth.md create mode 100644 docs/content/references/entities/classes/Order.md create mode 100644 docs/content/references/entities/classes/Payment.md create mode 100644 docs/content/references/entities/classes/PaymentProvider.md create mode 100644 docs/content/references/entities/classes/PaymentSession.md create mode 100644 docs/content/references/entities/classes/PriceList.md create mode 100644 docs/content/references/entities/classes/Product.md create mode 100644 docs/content/references/entities/classes/ProductCollection.md create mode 100644 docs/content/references/entities/classes/ProductOption.md create mode 100644 docs/content/references/entities/classes/ProductOptionValue.md create mode 100644 docs/content/references/entities/classes/ProductTag.md create mode 100644 docs/content/references/entities/classes/ProductTaxRate.md create mode 100644 docs/content/references/entities/classes/ProductType.md create mode 100644 docs/content/references/entities/classes/ProductTypeTaxRate.md create mode 100644 docs/content/references/entities/classes/ProductVariant.md create mode 100644 docs/content/references/entities/classes/Refund.md create mode 100644 docs/content/references/entities/classes/Region.md create mode 100644 docs/content/references/entities/classes/Return.md create mode 100644 docs/content/references/entities/classes/ReturnItem.md create mode 100644 docs/content/references/entities/classes/ReturnReason.md create mode 100644 docs/content/references/entities/classes/SalesChannel.md create mode 100644 docs/content/references/entities/classes/ShippingMethod.md create mode 100644 docs/content/references/entities/classes/ShippingMethodTaxLine.md create mode 100644 docs/content/references/entities/classes/ShippingOption.md create mode 100644 docs/content/references/entities/classes/ShippingOptionRequirement.md create mode 100644 docs/content/references/entities/classes/ShippingProfile.md create mode 100644 docs/content/references/entities/classes/ShippingTaxRate.md create mode 100644 docs/content/references/entities/classes/StagedJob.md create mode 100644 docs/content/references/entities/classes/Store.md create mode 100644 docs/content/references/entities/classes/Swap.md create mode 100644 docs/content/references/entities/classes/TaxProvider.md create mode 100644 docs/content/references/entities/classes/TaxRate.md create mode 100644 docs/content/references/entities/classes/TrackingLink.md create mode 100644 docs/content/references/entities/classes/User.md create mode 100644 docs/content/references/entities/enums/AllocationType.md create mode 100644 docs/content/references/entities/enums/CartType.md create mode 100644 docs/content/references/entities/enums/ClaimFulfillmentStatus.md create mode 100644 docs/content/references/entities/enums/ClaimPaymentStatus.md create mode 100644 docs/content/references/entities/enums/ClaimReason.md create mode 100644 docs/content/references/entities/enums/ClaimType.md create mode 100644 docs/content/references/entities/enums/DiscountConditionOperator.md create mode 100644 docs/content/references/entities/enums/DiscountConditionType.md create mode 100644 docs/content/references/entities/enums/DiscountRuleType.md create mode 100644 docs/content/references/entities/enums/DraftOrderStatus.md create mode 100644 docs/content/references/entities/enums/FulfillmentStatus.md create mode 100644 docs/content/references/entities/enums/OrderStatus.md create mode 100644 docs/content/references/entities/enums/PaymentSessionStatus.md create mode 100644 docs/content/references/entities/enums/PaymentStatus.md create mode 100644 docs/content/references/entities/enums/ProductStatus.md create mode 100644 docs/content/references/entities/enums/RefundReason.md create mode 100644 docs/content/references/entities/enums/RequirementType.md create mode 100644 docs/content/references/entities/enums/ReturnStatus.md create mode 100644 docs/content/references/entities/enums/ShippingOptionPriceType.md create mode 100644 docs/content/references/entities/enums/ShippingProfileType.md create mode 100644 docs/content/references/entities/enums/SwapFulfillmentStatus.md create mode 100644 docs/content/references/entities/enums/SwapPaymentStatus.md create mode 100644 docs/content/references/entities/enums/UserRoles.md create mode 100644 docs/content/references/entities/index.md create mode 100644 typedoc.entities.js diff --git a/.github/workflows/generate-entity-reference.yml b/.github/workflows/generate-entity-reference.yml new file mode 100644 index 0000000000..9e2927865d --- /dev/null +++ b/.github/workflows/generate-entity-reference.yml @@ -0,0 +1,53 @@ +name: Generate Entity Reference +on: + push: + branches: + - "master" + paths: + - packages/medusa/src/models/** + pull_request: + types: + - closed + branches: + - "master" + paths: + - packages/medusa/src/models/** +jobs: + services: + runs-on: ubuntu-latest + steps: + - name: Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.9.1 + with: + access_token: ${{ github.token }} + + - name: Checkout + uses: actions/checkout@v2.3.5 + with: + fetch-depth: 0 + + - name: Setup Node.js environment + uses: actions/setup-node@v2.4.1 + with: + node-version: "14" + cache: "yarn" + + - name: Install dependencies + uses: ./.github/actions/cache-deps + with: + extension: reference + + - name: Build Packages + run: yarn build + + - name: Generate Entities Reference + run: yarn generate:entities + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v4 + with: + commit-message: 'chore(docs): Generated Entities Reference (automated)' + base: 'master' + title: 'chore(docs): Generated Entities Reference (automated)' + labels: 'type: chore' + add-paths: docs/content/references/entities/** diff --git a/.github/workflows/generate-reference.yml b/.github/workflows/generate-reference.yml index 5de3c78839..1d71089f9b 100644 --- a/.github/workflows/generate-reference.yml +++ b/.github/workflows/generate-reference.yml @@ -1,4 +1,4 @@ -name: Generate Reference +name: Generate Services Reference on: push: branches: diff --git a/docs/content/advanced/backend/entities.md b/docs/content/advanced/backend/entities.md index 9a73b0590e..4d7cf7382e 100644 --- a/docs/content/advanced/backend/entities.md +++ b/docs/content/advanced/backend/entities.md @@ -155,6 +155,6 @@ await postRepository.softDelete(post.id); ## What’s Next 🚀 +- Check out Medusa's entities in the [Entities' reference](../../references/entities/classes/Address.md). +- Learn about [migrations](migrations.md). - Learn more about [Services](services/create-service.md) and how to use them. -- Learn how to create an endpoint for [storefront](endpoints/add-storefront.md) and [admin](endpoints/add-admin.md). -- Learn about [migrations](migrations.md). \ No newline at end of file diff --git a/docs/content/references/entities/.nojekyll b/docs/content/references/entities/.nojekyll new file mode 100644 index 0000000000..e2ac6616ad --- /dev/null +++ b/docs/content/references/entities/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/content/references/entities/classes/Address.md b/docs/content/references/entities/classes/Address.md new file mode 100644 index 0000000000..d412ba8964 --- /dev/null +++ b/docs/content/references/entities/classes/Address.md @@ -0,0 +1,231 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Address + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Address`** + +## Constructors + +### constructor + +• **new Address**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### address\_1 + +• **address\_1**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:120](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L120) + +___ + +### address\_2 + +• **address\_2**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:123](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L123) + +___ + +### city + +• **city**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:126](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L126) + +___ + +### company + +• **company**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:111](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L111) + +___ + +### country + +• **country**: ``null`` \| [`Country`](Country.md) + +#### Defined in + +[models/address.ts:133](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L133) + +___ + +### country\_code + +• **country\_code**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:129](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L129) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### customer + +• **customer**: ``null`` \| [`Customer`](Customer.md) + +#### Defined in + +[models/address.ts:108](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L108) + +___ + +### customer\_id + +• **customer\_id**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L104) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### first\_name + +• **first\_name**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:114](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L114) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### last\_name + +• **last\_name**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:117](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L117) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/address.ts:145](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L145) + +___ + +### phone + +• **phone**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:142](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L142) + +___ + +### postal\_code + +• **postal\_code**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:139](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L139) + +___ + +### province + +• **province**: ``null`` \| `string` + +#### Defined in + +[models/address.ts:136](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L136) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/address.ts:147](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L147) diff --git a/docs/content/references/entities/classes/BatchJob.md b/docs/content/references/entities/classes/BatchJob.md new file mode 100644 index 0000000000..0d9393b291 --- /dev/null +++ b/docs/content/references/entities/classes/BatchJob.md @@ -0,0 +1,249 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: BatchJob + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`BatchJob`** + +## Constructors + +### constructor + +• **new BatchJob**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### canceled\_at + +• `Optional` **canceled\_at**: `Date` + +#### Defined in + +[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L62) + +___ + +### completed\_at + +• `Optional` **completed\_at**: `Date` + +#### Defined in + +[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L59) + +___ + +### confirmed\_at + +• `Optional` **confirmed\_at**: `Date` + +#### Defined in + +[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L56) + +___ + +### context + +• **context**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L33) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### created\_by + +• **created\_by**: ``null`` \| `string` + +#### Defined in + +[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L26) + +___ + +### created\_by\_user + +• **created\_by\_user**: [`User`](User.md) + +#### Defined in + +[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L30) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### dry\_run + +• **dry\_run**: `boolean` = `false` + +#### Defined in + +[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L47) + +___ + +### failed\_at + +• `Optional` **failed\_at**: `Date` + +#### Defined in + +[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L65) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### pre\_processed\_at + +• `Optional` **pre\_processed\_at**: `Date` + +#### Defined in + +[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L50) + +___ + +### processing\_at + +• `Optional` **processing\_at**: `Date` + +#### Defined in + +[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L53) + +___ + +### result + +• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: `BatchJobResultError`[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[] } & `Record`<`string`, `unknown`\> + +#### Defined in + +[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L36) + +___ + +### status + +• **status**: `BatchJobStatus` + +#### Defined in + +[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L67) + +___ + +### type + +• **type**: `string` + +#### Defined in + +[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L23) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L94) + +___ + +### loadStatus + +▸ **loadStatus**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L69) + +___ + +### toJSON + +▸ **toJSON**(): [`BatchJob`](BatchJob.md) + +#### Returns + +[`BatchJob`](BatchJob.md) + +#### Defined in + +[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L99) diff --git a/docs/content/references/entities/classes/Cart.md b/docs/content/references/entities/classes/Cart.md new file mode 100644 index 0000000000..b6c2d9c781 --- /dev/null +++ b/docs/content/references/entities/classes/Cart.md @@ -0,0 +1,455 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Cart + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Cart`** + +## Constructors + +### constructor + +• **new Cart**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### billing\_address + +• **billing\_address**: [`Address`](Address.md) + +#### Defined in + +[models/cart.ts:226](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L226) + +___ + +### billing\_address\_id + +• **billing\_address\_id**: `string` + +#### Defined in + +[models/cart.ts:220](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L220) + +___ + +### completed\_at + +• **completed\_at**: `Date` + +#### Defined in + +[models/cart.ts:311](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L311) + +___ + +### context + +• **context**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/cart.ts:320](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L320) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### customer + +• **customer**: [`Customer`](Customer.md) + +#### Defined in + +[models/cart.ts:285](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L285) + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +[models/cart.ts:281](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L281) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### discount\_total + +• `Optional` **discount\_total**: `number` + +#### Defined in + +[models/cart.ts:335](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L335) + +___ + +### discounts + +• **discounts**: [`Discount`](Discount.md)[] + +#### Defined in + +[models/cart.ts:263](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L263) + +___ + +### email + +• **email**: `string` + +#### Defined in + +[models/cart.ts:216](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L216) + +___ + +### gift\_card\_tax\_total + +• `Optional` **gift\_card\_tax\_total**: `number` + +#### Defined in + +[models/cart.ts:342](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L342) + +___ + +### gift\_card\_total + +• `Optional` **gift\_card\_total**: `number` + +#### Defined in + +[models/cart.ts:341](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L341) + +___ + +### gift\_cards + +• **gift\_cards**: [`GiftCard`](GiftCard.md)[] + +#### Defined in + +[models/cart.ts:277](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L277) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/cart.ts:317](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L317) + +___ + +### items + +• **items**: [`LineItem`](LineItem.md)[] + +#### Defined in + +[models/cart.ts:241](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L241) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/cart.ts:323](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L323) + +___ + +### object + +• `Readonly` **object**: ``"cart"`` + +#### Defined in + +[models/cart.ts:213](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L213) + +___ + +### payment + +• **payment**: [`Payment`](Payment.md) + +#### Defined in + +[models/cart.ts:300](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L300) + +___ + +### payment\_authorized\_at + +• **payment\_authorized\_at**: `Date` + +#### Defined in + +[models/cart.ts:314](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L314) + +___ + +### payment\_id + +• **payment\_id**: `string` + +#### Defined in + +[models/cart.ts:296](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L296) + +___ + +### payment\_session + +• **payment\_session**: ``null`` \| [`PaymentSession`](PaymentSession.md) + +#### Defined in + +[models/cart.ts:287](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L287) + +___ + +### payment\_sessions + +• **payment\_sessions**: [`PaymentSession`](PaymentSession.md)[] + +#### Defined in + +[models/cart.ts:292](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L292) + +___ + +### refundable\_amount + +• `Optional` **refundable\_amount**: `number` + +#### Defined in + +[models/cart.ts:340](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L340) + +___ + +### refunded\_total + +• `Optional` **refunded\_total**: `number` + +#### Defined in + +[models/cart.ts:337](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L337) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/cart.ts:249](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L249) + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +[models/cart.ts:245](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L245) + +___ + +### sales\_channel + +• **sales\_channel**: [`SalesChannel`](SalesChannel.md) + +#### Defined in + +[models/cart.ts:332](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L332) + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: ``null`` \| `string` + +#### Defined in + +[models/cart.ts:326](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L326) + +___ + +### shipping\_address + +• **shipping\_address**: ``null`` \| [`Address`](Address.md) + +#### Defined in + +[models/cart.ts:236](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L236) + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +[models/cart.ts:230](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L230) + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] + +#### Defined in + +[models/cart.ts:305](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L305) + +___ + +### shipping\_total + +• `Optional` **shipping\_total**: `number` + +#### Defined in + +[models/cart.ts:334](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L334) + +___ + +### subtotal + +• `Optional` **subtotal**: `number` + +#### Defined in + +[models/cart.ts:339](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L339) + +___ + +### tax\_total + +• `Optional` **tax\_total**: ``null`` \| `number` + +#### Defined in + +[models/cart.ts:336](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L336) + +___ + +### total + +• `Optional` **total**: `number` + +#### Defined in + +[models/cart.ts:338](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L338) + +___ + +### type + +• **type**: [`CartType`](../enums/CartType.md) + +#### Defined in + +[models/cart.ts:308](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L308) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### afterLoad + +▸ `Private` **afterLoad**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/cart.ts:344](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L344) + +___ + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/cart.ts:351](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L351) diff --git a/docs/content/references/entities/classes/ClaimImage.md b/docs/content/references/entities/classes/ClaimImage.md new file mode 100644 index 0000000000..cf0d79df97 --- /dev/null +++ b/docs/content/references/entities/classes/ClaimImage.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ClaimImage + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ClaimImage`** + +## Constructors + +### constructor + +• **new ClaimImage**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### claim\_item + +• **claim\_item**: [`ClaimItem`](ClaimItem.md) + +#### Defined in + +[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L23) + +___ + +### claim\_item\_id + +• **claim\_item\_id**: `string` + +#### Defined in + +[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L19) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L29) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### url + +• **url**: `string` + +#### Defined in + +[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L26) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L31) diff --git a/docs/content/references/entities/classes/ClaimItem.md b/docs/content/references/entities/classes/ClaimItem.md new file mode 100644 index 0000000000..719cc83848 --- /dev/null +++ b/docs/content/references/entities/classes/ClaimItem.md @@ -0,0 +1,211 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ClaimItem + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ClaimItem`** + +## Constructors + +### constructor + +• **new ClaimItem**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) + +#### Defined in + +[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L42) + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L38) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### images + +• **images**: [`ClaimImage`](ClaimImage.md)[] + +#### Defined in + +[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L34) + +___ + +### item + +• **item**: [`LineItem`](LineItem.md) + +#### Defined in + +[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L50) + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L46) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L84) + +___ + +### note + +• **note**: `string` + +#### Defined in + +[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L64) + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L67) + +___ + +### reason + +• **reason**: [`ClaimReason`](../enums/ClaimReason.md) + +#### Defined in + +[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L61) + +___ + +### tags + +• **tags**: [`ClaimTag`](ClaimTag.md)[] + +#### Defined in + +[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L81) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### variant + +• **variant**: [`ProductVariant`](ProductVariant.md) + +#### Defined in + +[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L58) + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L54) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L86) diff --git a/docs/content/references/entities/classes/ClaimOrder.md b/docs/content/references/entities/classes/ClaimOrder.md new file mode 100644 index 0000000000..6802121fa1 --- /dev/null +++ b/docs/content/references/entities/classes/ClaimOrder.md @@ -0,0 +1,261 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ClaimOrder + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ClaimOrder`** + +## Constructors + +### constructor + +• **new ClaimOrder**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### additional\_items + +• **additional\_items**: [`LineItem`](LineItem.md)[] + +#### Defined in + +[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L69) + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L107) + +___ + +### claim\_items + +• **claim\_items**: [`ClaimItem`](ClaimItem.md)[] + +#### Defined in + +[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L66) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Overrides + +SoftDeletableEntity.created\_at + +#### Defined in + +[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L110) + +___ + +### deleted\_at + +• **deleted\_at**: `Date` + +#### Overrides + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L116) + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.md) + +#### Defined in + +[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L63) + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](Fulfillment.md)[] + +#### Defined in + +[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L101) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L125) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L122) + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L119) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L80) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L76) + +___ + +### payment\_status + +• **payment\_status**: [`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.md) + +#### Defined in + +[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L56) + +___ + +### refund\_amount + +• **refund\_amount**: `number` + +#### Defined in + +[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L104) + +___ + +### return\_order + +• **return\_order**: [`Return`](Return.md) + +#### Defined in + +[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L83) + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](Address.md) + +#### Defined in + +[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L91) + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L87) + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] + +#### Defined in + +[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L96) + +___ + +### type + +• **type**: [`ClaimType`](../enums/ClaimType.md) + +#### Defined in + +[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L72) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Overrides + +SoftDeletableEntity.updated\_at + +#### Defined in + +[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L113) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L127) diff --git a/docs/content/references/entities/classes/ClaimTag.md b/docs/content/references/entities/classes/ClaimTag.md new file mode 100644 index 0000000000..1cfd7dd326 --- /dev/null +++ b/docs/content/references/entities/classes/ClaimTag.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ClaimTag + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ClaimTag`** + +## Constructors + +### constructor + +• **new ClaimTag**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-tag.ts#L14) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `string` + +#### Defined in + +[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-tag.ts#L11) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-tag.ts#L16) diff --git a/docs/content/references/entities/classes/Country.md b/docs/content/references/entities/classes/Country.md new file mode 100644 index 0000000000..e94d71942a --- /dev/null +++ b/docs/content/references/entities/classes/Country.md @@ -0,0 +1,91 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Country + +## Constructors + +### constructor + +• **new Country**() + +## Properties + +### display\_name + +• **display\_name**: `string` + +#### Defined in + +[models/country.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L31) + +___ + +### id + +• **id**: `number` + +#### Defined in + +[models/country.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L15) + +___ + +### iso\_2 + +• **iso\_2**: `string` + +#### Defined in + +[models/country.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L19) + +___ + +### iso\_3 + +• **iso\_3**: `string` + +#### Defined in + +[models/country.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L22) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/country.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L28) + +___ + +### num\_code + +• **num\_code**: `number` + +#### Defined in + +[models/country.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L25) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/country.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L39) + +___ + +### region\_id + +• **region\_id**: ``null`` \| `string` + +#### Defined in + +[models/country.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L35) diff --git a/docs/content/references/entities/classes/Currency.md b/docs/content/references/entities/classes/Currency.md new file mode 100644 index 0000000000..ff3bff3c02 --- /dev/null +++ b/docs/content/references/entities/classes/Currency.md @@ -0,0 +1,51 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Currency + +## Constructors + +### constructor + +• **new Currency**() + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +[models/currency.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L6) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/currency.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L15) + +___ + +### symbol + +• **symbol**: `string` + +#### Defined in + +[models/currency.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L9) + +___ + +### symbol\_native + +• **symbol\_native**: `string` + +#### Defined in + +[models/currency.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L12) diff --git a/docs/content/references/entities/classes/CustomShippingOption.md b/docs/content/references/entities/classes/CustomShippingOption.md new file mode 100644 index 0000000000..1a7ebd7a7a --- /dev/null +++ b/docs/content/references/entities/classes/CustomShippingOption.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: CustomShippingOption + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`CustomShippingOption`** + +## Constructors + +### constructor + +• **new CustomShippingOption**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L37) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L33) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L40) + +___ + +### price + +• **price**: `number` + +#### Defined in + +[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L21) + +___ + +### shipping\_option + +• **shipping\_option**: [`ShippingOption`](ShippingOption.md) + +#### Defined in + +[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L29) + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L25) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L42) diff --git a/docs/content/references/entities/classes/Customer.md b/docs/content/references/entities/classes/Customer.md new file mode 100644 index 0000000000..68d74df196 --- /dev/null +++ b/docs/content/references/entities/classes/Customer.md @@ -0,0 +1,211 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Customer + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Customer`** + +## Constructors + +### constructor + +• **new Customer**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### billing\_address + +• **billing\_address**: [`Address`](Address.md) + +#### Defined in + +[models/customer.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L38) + +___ + +### billing\_address\_id + +• **billing\_address\_id**: ``null`` \| `string` + +#### Defined in + +[models/customer.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L34) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### email + +• **email**: `string` + +#### Defined in + +[models/customer.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L24) + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +[models/customer.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L27) + +___ + +### groups + +• **groups**: [`CustomerGroup`](CustomerGroup.md)[] + +#### Defined in + +[models/customer.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L69) + +___ + +### has\_account + +• **has\_account**: `boolean` + +#### Defined in + +[models/customer.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L50) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +[models/customer.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L30) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/customer.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L72) + +___ + +### orders + +• **orders**: [`Order`](Order.md)[] + +#### Defined in + +[models/customer.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L53) + +___ + +### password\_hash + +• **password\_hash**: `string` + +#### Defined in + +[models/customer.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L44) + +___ + +### phone + +• **phone**: `string` + +#### Defined in + +[models/customer.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L47) + +___ + +### shipping\_addresses + +• **shipping\_addresses**: [`Address`](Address.md)[] + +#### Defined in + +[models/customer.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L41) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/customer.ts:74](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L74) diff --git a/docs/content/references/entities/classes/CustomerGroup.md b/docs/content/references/entities/classes/CustomerGroup.md new file mode 100644 index 0000000000..0461aa7f30 --- /dev/null +++ b/docs/content/references/entities/classes/CustomerGroup.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: CustomerGroup + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`CustomerGroup`** + +## Constructors + +### constructor + +• **new CustomerGroup**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### customers + +• **customers**: [`Customer`](Customer.md)[] + +#### Defined in + +[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L18) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L26) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L13) + +___ + +### price\_lists + +• **price\_lists**: [`PriceList`](PriceList.md)[] + +#### Defined in + +[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L23) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L28) diff --git a/docs/content/references/entities/classes/Discount.md b/docs/content/references/entities/classes/Discount.md new file mode 100644 index 0000000000..f4a3581e2b --- /dev/null +++ b/docs/content/references/entities/classes/Discount.md @@ -0,0 +1,231 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Discount + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Discount`** + +## Constructors + +### constructor + +• **new Discount**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +[models/discount.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L22) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### ends\_at + +• **ends\_at**: ``null`` \| `Date` + +#### Defined in + +[models/discount.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L52) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +[models/discount.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L36) + +___ + +### is\_dynamic + +• **is\_dynamic**: `boolean` + +#### Defined in + +[models/discount.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L25) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L78) + +___ + +### parent\_discount + +• **parent\_discount**: [`Discount`](Discount.md) + +#### Defined in + +[models/discount.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L43) + +___ + +### parent\_discount\_id + +• **parent\_discount\_id**: `string` + +#### Defined in + +[models/discount.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L39) + +___ + +### regions + +• **regions**: [`Region`](Region.md)[] + +#### Defined in + +[models/discount.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L69) + +___ + +### rule + +• **rule**: [`DiscountRule`](DiscountRule.md) + +#### Defined in + +[models/discount.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L33) + +___ + +### rule\_id + +• **rule\_id**: `string` + +#### Defined in + +[models/discount.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L29) + +___ + +### starts\_at + +• **starts\_at**: `Date` + +#### Defined in + +[models/discount.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L49) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### usage\_count + +• **usage\_count**: `number` + +#### Defined in + +[models/discount.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L75) + +___ + +### usage\_limit + +• **usage\_limit**: ``null`` \| `number` + +#### Defined in + +[models/discount.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L72) + +___ + +### valid\_duration + +• **valid\_duration**: ``null`` \| `string` + +#### Defined in + +[models/discount.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L55) + +## Methods + +### upperCaseCode + +▸ `Private` **upperCaseCode**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/discount.ts:80](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L80) diff --git a/docs/content/references/entities/classes/DiscountCondition.md b/docs/content/references/entities/classes/DiscountCondition.md new file mode 100644 index 0000000000..affb51fd66 --- /dev/null +++ b/docs/content/references/entities/classes/DiscountCondition.md @@ -0,0 +1,191 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DiscountCondition + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`DiscountCondition`** + +## Constructors + +### constructor + +• **new DiscountCondition**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### customer\_groups + +• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[] + +#### Defined in + +[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L127) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### discount\_rule + +• **discount\_rule**: [`DiscountRule`](DiscountRule.md) + +#### Defined in + +[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L57) + +___ + +### discount\_rule\_id + +• **discount\_rule\_id**: `string` + +#### Defined in + +[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L53) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L130) + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/DiscountConditionOperator.md) + +#### Defined in + +[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L49) + +___ + +### product\_collections + +• **product\_collections**: [`ProductCollection`](ProductCollection.md)[] + +#### Defined in + +[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L113) + +___ + +### product\_tags + +• **product\_tags**: [`ProductTag`](ProductTag.md)[] + +#### Defined in + +[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L99) + +___ + +### product\_types + +• **product\_types**: [`ProductType`](ProductType.md)[] + +#### Defined in + +[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L85) + +___ + +### products + +• **products**: [`Product`](Product.md)[] + +#### Defined in + +[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L71) + +___ + +### type + +• **type**: [`DiscountConditionType`](../enums/DiscountConditionType.md) + +#### Defined in + +[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L43) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L132) diff --git a/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md b/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md new file mode 100644 index 0000000000..c85fd6f727 --- /dev/null +++ b/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DiscountConditionCustomerGroup + +## Constructors + +### constructor + +• **new DiscountConditionCustomerGroup**() + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L20) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L31) + +___ + +### customer\_group + +• `Optional` **customer\_group**: [`CustomerGroup`](CustomerGroup.md) + +#### Defined in + +[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L24) + +___ + +### customer\_group\_id + +• **customer\_group\_id**: `string` + +#### Defined in + +[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L17) + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) + +#### Defined in + +[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L28) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L37) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProduct.md b/docs/content/references/entities/classes/DiscountConditionProduct.md new file mode 100644 index 0000000000..b6803a3b0f --- /dev/null +++ b/docs/content/references/entities/classes/DiscountConditionProduct.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DiscountConditionProduct + +## Constructors + +### constructor + +• **new DiscountConditionProduct**() + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L20) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L31) + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) + +#### Defined in + +[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L28) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L37) + +___ + +### product + +• `Optional` **product**: [`Product`](Product.md) + +#### Defined in + +[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L24) + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L17) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductCollection.md b/docs/content/references/entities/classes/DiscountConditionProductCollection.md new file mode 100644 index 0000000000..d38c0e4a4f --- /dev/null +++ b/docs/content/references/entities/classes/DiscountConditionProductCollection.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DiscountConditionProductCollection + +## Constructors + +### constructor + +• **new DiscountConditionProductCollection**() + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L20) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L31) + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) + +#### Defined in + +[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L28) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L37) + +___ + +### product\_collection + +• `Optional` **product\_collection**: [`ProductCollection`](ProductCollection.md) + +#### Defined in + +[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L24) + +___ + +### product\_collection\_id + +• **product\_collection\_id**: `string` + +#### Defined in + +[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L17) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductTag.md b/docs/content/references/entities/classes/DiscountConditionProductTag.md new file mode 100644 index 0000000000..fca8e5b4c3 --- /dev/null +++ b/docs/content/references/entities/classes/DiscountConditionProductTag.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DiscountConditionProductTag + +## Constructors + +### constructor + +• **new DiscountConditionProductTag**() + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L20) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L31) + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) + +#### Defined in + +[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L28) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L37) + +___ + +### product\_tag + +• `Optional` **product\_tag**: [`ProductTag`](ProductTag.md) + +#### Defined in + +[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L24) + +___ + +### product\_tag\_id + +• **product\_tag\_id**: `string` + +#### Defined in + +[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L17) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductType.md b/docs/content/references/entities/classes/DiscountConditionProductType.md new file mode 100644 index 0000000000..fe11c0cc96 --- /dev/null +++ b/docs/content/references/entities/classes/DiscountConditionProductType.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DiscountConditionProductType + +## Constructors + +### constructor + +• **new DiscountConditionProductType**() + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L20) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L31) + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) + +#### Defined in + +[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L28) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L37) + +___ + +### product\_type + +• `Optional` **product\_type**: [`ProductType`](ProductType.md) + +#### Defined in + +[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L24) + +___ + +### product\_type\_id + +• **product\_type\_id**: `string` + +#### Defined in + +[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L17) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountRule.md b/docs/content/references/entities/classes/DiscountRule.md new file mode 100644 index 0000000000..b0e093b578 --- /dev/null +++ b/docs/content/references/entities/classes/DiscountRule.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DiscountRule + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`DiscountRule`** + +## Constructors + +### constructor + +• **new DiscountRule**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### allocation + +• **allocation**: [`AllocationType`](../enums/AllocationType.md) + +#### Defined in + +[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L38) + +___ + +### conditions + +• **conditions**: [`DiscountCondition`](DiscountCondition.md)[] + +#### Defined in + +[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L41) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### description + +• **description**: `string` + +#### Defined in + +[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L22) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L44) + +___ + +### type + +• **type**: [`DiscountRuleType`](../enums/DiscountRuleType.md) + +#### Defined in + +[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L28) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `number` + +#### Defined in + +[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L31) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L46) diff --git a/docs/content/references/entities/classes/DraftOrder.md b/docs/content/references/entities/classes/DraftOrder.md new file mode 100644 index 0000000000..655025da6b --- /dev/null +++ b/docs/content/references/entities/classes/DraftOrder.md @@ -0,0 +1,187 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: DraftOrder + +## Hierarchy + +- `BaseEntity` + + ↳ **`DraftOrder`** + +## Constructors + +### constructor + +• **new DraftOrder**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L54) + +___ + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L43) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L39) + +___ + +### completed\_at + +• **completed\_at**: `Date` + +#### Defined in + +[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L57) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L35) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L66) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L63) + +___ + +### no\_notification\_order + +• **no\_notification\_order**: `boolean` + +#### Defined in + +[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L60) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L51) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L47) + +___ + +### status + +• **status**: [`DraftOrderStatus`](../enums/DraftOrderStatus.md) + +#### Defined in + +[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L30) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L68) diff --git a/docs/content/references/entities/classes/Fulfillment.md b/docs/content/references/entities/classes/Fulfillment.md new file mode 100644 index 0000000000..fd8f7aaa8d --- /dev/null +++ b/docs/content/references/entities/classes/Fulfillment.md @@ -0,0 +1,247 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Fulfillment + +## Hierarchy + +- `BaseEntity` + + ↳ **`Fulfillment`** + +## Constructors + +### constructor + +• **new Fulfillment**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L79) + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) + +#### Defined in + +[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L29) + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L25) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L73) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L85) + +___ + +### items + +• **items**: [`FulfillmentItem`](FulfillmentItem.md)[] + +#### Defined in + +[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L62) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L82) + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L48) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L45) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L41) + +___ + +### provider + +• **provider**: [`FulfillmentProvider`](FulfillmentProvider.md) + +#### Defined in + +[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L56) + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L52) + +___ + +### shipped\_at + +• **shipped\_at**: `Date` + +#### Defined in + +[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L76) + +___ + +### swap + +• **swap**: [`Swap`](Swap.md) + +#### Defined in + +[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L37) + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L33) + +___ + +### tracking\_links + +• **tracking\_links**: [`TrackingLink`](TrackingLink.md)[] + +#### Defined in + +[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L67) + +___ + +### tracking\_numbers + +• **tracking\_numbers**: `string`[] + +#### Defined in + +[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L70) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L87) diff --git a/docs/content/references/entities/classes/FulfillmentItem.md b/docs/content/references/entities/classes/FulfillmentItem.md new file mode 100644 index 0000000000..3cf6939f15 --- /dev/null +++ b/docs/content/references/entities/classes/FulfillmentItem.md @@ -0,0 +1,61 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: FulfillmentItem + +## Constructors + +### constructor + +• **new FulfillmentItem**() + +## Properties + +### fulfillment + +• **fulfillment**: [`Fulfillment`](Fulfillment.md) + +#### Defined in + +[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L16) + +___ + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L9) + +___ + +### item + +• **item**: [`LineItem`](LineItem.md) + +#### Defined in + +[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L20) + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L12) + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L23) diff --git a/docs/content/references/entities/classes/FulfillmentProvider.md b/docs/content/references/entities/classes/FulfillmentProvider.md new file mode 100644 index 0000000000..915eb744dc --- /dev/null +++ b/docs/content/references/entities/classes/FulfillmentProvider.md @@ -0,0 +1,31 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: FulfillmentProvider + +## Constructors + +### constructor + +• **new FulfillmentProvider**() + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-provider.ts#L6) + +___ + +### is\_installed + +• **is\_installed**: `boolean` + +#### Defined in + +[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-provider.ts#L9) diff --git a/docs/content/references/entities/classes/GiftCard.md b/docs/content/references/entities/classes/GiftCard.md new file mode 100644 index 0000000000..ca9ab3799b --- /dev/null +++ b/docs/content/references/entities/classes/GiftCard.md @@ -0,0 +1,191 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: GiftCard + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`GiftCard`** + +## Constructors + +### constructor + +• **new GiftCard**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### balance + +• **balance**: `number` + +#### Defined in + +[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L26) + +___ + +### code + +• **code**: `string` + +#### Defined in + +[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L20) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### ends\_at + +• **ends\_at**: `Date` + +#### Defined in + +[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L51) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L45) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L54) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L42) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L38) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L34) + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L30) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `number` + +#### Defined in + +[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L23) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L56) diff --git a/docs/content/references/entities/classes/GiftCardTransaction.md b/docs/content/references/entities/classes/GiftCardTransaction.md new file mode 100644 index 0000000000..270311cfe6 --- /dev/null +++ b/docs/content/references/entities/classes/GiftCardTransaction.md @@ -0,0 +1,115 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: GiftCardTransaction + +## Constructors + +### constructor + +• **new GiftCardTransaction**() + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L40) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L43) + +___ + +### gift\_card + +• **gift\_card**: [`GiftCard`](GiftCard.md) + +#### Defined in + +[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L29) + +___ + +### gift\_card\_id + +• **gift\_card\_id**: `string` + +#### Defined in + +[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L25) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L22) + +___ + +### is\_taxable + +• **is\_taxable**: `boolean` + +#### Defined in + +[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L46) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L37) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L33) + +___ + +### tax\_rate + +• **tax\_rate**: ``null`` \| `number` + +#### Defined in + +[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L49) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L51) diff --git a/docs/content/references/entities/classes/IdempotencyKey.md b/docs/content/references/entities/classes/IdempotencyKey.md new file mode 100644 index 0000000000..5da85448eb --- /dev/null +++ b/docs/content/references/entities/classes/IdempotencyKey.md @@ -0,0 +1,125 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: IdempotencyKey + +## Constructors + +### constructor + +• **new IdempotencyKey**() + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L23) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L16) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L20) + +___ + +### locked\_at + +• **locked\_at**: `Date` + +#### Defined in + +[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L26) + +___ + +### recovery\_point + +• **recovery\_point**: `string` + +#### Defined in + +[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L44) + +___ + +### request\_method + +• **request\_method**: `string` + +#### Defined in + +[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L29) + +___ + +### request\_params + +• **request\_params**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L32) + +___ + +### request\_path + +• **request\_path**: `string` + +#### Defined in + +[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L35) + +___ + +### response\_body + +• **response\_body**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L41) + +___ + +### response\_code + +• **response\_code**: `number` + +#### Defined in + +[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L38) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L46) diff --git a/docs/content/references/entities/classes/Image.md b/docs/content/references/entities/classes/Image.md new file mode 100644 index 0000000000..b93068fd11 --- /dev/null +++ b/docs/content/references/entities/classes/Image.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Image + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Image`** + +## Constructors + +### constructor + +• **new Image**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/image.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/image.ts#L13) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### url + +• **url**: `string` + +#### Defined in + +[models/image.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/image.ts#L10) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/image.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/image.ts#L15) diff --git a/docs/content/references/entities/classes/Invite.md b/docs/content/references/entities/classes/Invite.md new file mode 100644 index 0000000000..98466d0a04 --- /dev/null +++ b/docs/content/references/entities/classes/Invite.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Invite + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Invite`** + +## Constructors + +### constructor + +• **new Invite**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### accepted + +• **accepted**: `boolean` + +#### Defined in + +[models/invite.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L23) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### expires\_at + +• **expires\_at**: `Date` + +#### Defined in + +[models/invite.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L29) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/invite.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L32) + +___ + +### role + +• **role**: [`UserRoles`](../enums/UserRoles.md) + +#### Defined in + +[models/invite.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L20) + +___ + +### token + +• **token**: `string` + +#### Defined in + +[models/invite.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L26) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### user\_email + +• **user\_email**: `string` + +#### Defined in + +[models/invite.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L12) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/invite.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L34) diff --git a/docs/content/references/entities/classes/LineItem.md b/docs/content/references/entities/classes/LineItem.md new file mode 100644 index 0000000000..974ae4cb60 --- /dev/null +++ b/docs/content/references/entities/classes/LineItem.md @@ -0,0 +1,417 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: LineItem + +## Hierarchy + +- `BaseEntity` + + ↳ **`LineItem`** + +## Constructors + +### constructor + +• **new LineItem**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### adjustments + +• **adjustments**: [`LineItemAdjustment`](LineItemAdjustment.md)[] + +#### Defined in + +[models/line-item.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L67) + +___ + +### allow\_discounts + +• **allow\_discounts**: `boolean` + +#### Defined in + +[models/line-item.ts:88](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L88) + +___ + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/line-item.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L35) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/line-item.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L31) + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) + +#### Defined in + +[models/line-item.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L59) + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +[models/line-item.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L55) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### description + +• **description**: `string` + +#### Defined in + +[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L73) + +___ + +### discount\_total + +• `Optional` **discount\_total**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:125](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L125) + +___ + +### fulfilled\_quantity + +• **fulfilled\_quantity**: `number` + +#### Defined in + +[models/line-item.ts:108](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L108) + +___ + +### gift\_card\_total + +• `Optional` **gift\_card\_total**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:126](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L126) + +___ + +### has\_shipping + +• **has\_shipping**: `boolean` + +#### Defined in + +[models/line-item.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L91) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +[models/line-item.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L82) + +___ + +### is\_return + +• **is\_return**: `boolean` + +#### Defined in + +[models/line-item.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L79) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/line-item.ts:117](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L117) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/line-item.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L43) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/line-item.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L39) + +___ + +### original\_tax\_total + +• `Optional` **original\_tax\_total**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L124) + +___ + +### original\_total + +• `Optional` **original\_total**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:123](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L123) + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +[models/line-item.ts:105](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L105) + +___ + +### refundable + +• `Optional` **refundable**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:119](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L119) + +___ + +### returned\_quantity + +• **returned\_quantity**: `number` + +#### Defined in + +[models/line-item.ts:111](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L111) + +___ + +### shipped\_quantity + +• **shipped\_quantity**: `number` + +#### Defined in + +[models/line-item.ts:114](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L114) + +___ + +### should\_merge + +• **should\_merge**: `boolean` + +#### Defined in + +[models/line-item.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L85) + +___ + +### subtotal + +• `Optional` **subtotal**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:120](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L120) + +___ + +### swap + +• **swap**: [`Swap`](Swap.md) + +#### Defined in + +[models/line-item.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L51) + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +[models/line-item.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L47) + +___ + +### tax\_lines + +• **tax\_lines**: [`LineItemTaxLine`](LineItemTaxLine.md)[] + +#### Defined in + +[models/line-item.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L62) + +___ + +### tax\_total + +• `Optional` **tax\_total**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L121) + +___ + +### thumbnail + +• **thumbnail**: ``null`` \| `string` + +#### Defined in + +[models/line-item.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L76) + +___ + +### title + +• **title**: `string` + +#### Defined in + +[models/line-item.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L70) + +___ + +### total + +• `Optional` **total**: ``null`` \| `number` + +#### Defined in + +[models/line-item.ts:122](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L122) + +___ + +### unit\_price + +• **unit\_price**: `number` + +#### Defined in + +[models/line-item.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L94) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### variant + +• **variant**: [`ProductVariant`](ProductVariant.md) + +#### Defined in + +[models/line-item.ts:102](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L102) + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +[models/line-item.ts:98](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L98) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L128) diff --git a/docs/content/references/entities/classes/LineItemAdjustment.md b/docs/content/references/entities/classes/LineItemAdjustment.md new file mode 100644 index 0000000000..c190378c98 --- /dev/null +++ b/docs/content/references/entities/classes/LineItemAdjustment.md @@ -0,0 +1,105 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: LineItemAdjustment + +## Constructors + +### constructor + +• **new LineItemAdjustment**() + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L45) + +___ + +### description + +• **description**: `string` + +#### Defined in + +[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L34) + +___ + +### discount + +• **discount**: [`Discount`](Discount.md) + +#### Defined in + +[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L38) + +___ + +### discount\_id + +• **discount\_id**: `string` + +#### Defined in + +[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L42) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L23) + +___ + +### item + +• **item**: [`LineItem`](LineItem.md) + +#### Defined in + +[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L31) + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L27) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L48) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L50) diff --git a/docs/content/references/entities/classes/LineItemTaxLine.md b/docs/content/references/entities/classes/LineItemTaxLine.md new file mode 100644 index 0000000000..9a39da7b17 --- /dev/null +++ b/docs/content/references/entities/classes/LineItemTaxLine.md @@ -0,0 +1,153 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: LineItemTaxLine + +## Hierarchy + +- `TaxLine` + + ↳ **`LineItemTaxLine`** + +## Constructors + +### constructor + +• **new LineItemTaxLine**() + +#### Inherited from + +TaxLine.constructor + +## Properties + +### code + +• **code**: ``null`` \| `string` + +#### Inherited from + +TaxLine.code + +#### Defined in + +[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L13) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +TaxLine.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +TaxLine.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### item + +• **item**: [`LineItem`](LineItem.md) + +#### Defined in + +[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-tax-line.ts#L24) + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-tax-line.ts#L20) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TaxLine.metadata + +#### Defined in + +[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L16) + +___ + +### name + +• **name**: `string` + +#### Inherited from + +TaxLine.name + +#### Defined in + +[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L10) + +___ + +### rate + +• **rate**: `number` + +#### Inherited from + +TaxLine.rate + +#### Defined in + +[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L7) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +TaxLine.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-tax-line.ts#L26) diff --git a/docs/content/references/entities/classes/MoneyAmount.md b/docs/content/references/entities/classes/MoneyAmount.md new file mode 100644 index 0000000000..415159aa00 --- /dev/null +++ b/docs/content/references/entities/classes/MoneyAmount.md @@ -0,0 +1,201 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: MoneyAmount + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`MoneyAmount`** + +## Constructors + +### constructor + +• **new MoneyAmount**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[models/money-amount.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L27) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### currency + +• **currency**: [`Currency`](Currency.md) + +#### Defined in + +[models/money-amount.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L24) + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +[models/money-amount.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L20) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### max\_quantity + +• **max\_quantity**: ``null`` \| `number` + +#### Defined in + +[models/money-amount.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L33) + +___ + +### min\_quantity + +• **min\_quantity**: ``null`` \| `number` + +#### Defined in + +[models/money-amount.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L30) + +___ + +### price\_list + +• **price\_list**: ``null`` \| [`PriceList`](PriceList.md) + +#### Defined in + +[models/money-amount.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L43) + +___ + +### price\_list\_id + +• **price\_list\_id**: ``null`` \| `string` + +#### Defined in + +[models/money-amount.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L36) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/money-amount.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L61) + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +[models/money-amount.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L57) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### variant + +• **variant**: [`ProductVariant`](ProductVariant.md) + +#### Defined in + +[models/money-amount.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L53) + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +[models/money-amount.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L47) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `undefined` \| `void` + +#### Returns + +`undefined` \| `void` + +#### Defined in + +[models/money-amount.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L63) diff --git a/docs/content/references/entities/classes/Note.md b/docs/content/references/entities/classes/Note.md new file mode 100644 index 0000000000..f0e731837b --- /dev/null +++ b/docs/content/references/entities/classes/Note.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Note + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Note`** + +## Constructors + +### constructor + +• **new Note**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### author + +• **author**: [`User`](User.md) + +#### Defined in + +[models/note.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L33) + +___ + +### author\_id + +• **author\_id**: `string` + +#### Defined in + +[models/note.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L29) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/note.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L36) + +___ + +### resource\_id + +• **resource\_id**: `string` + +#### Defined in + +[models/note.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L26) + +___ + +### resource\_type + +• **resource\_type**: `string` + +#### Defined in + +[models/note.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L22) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `string` + +#### Defined in + +[models/note.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L18) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/note.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L38) diff --git a/docs/content/references/entities/classes/Notification.md b/docs/content/references/entities/classes/Notification.md new file mode 100644 index 0000000000..2b41504add --- /dev/null +++ b/docs/content/references/entities/classes/Notification.md @@ -0,0 +1,197 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Notification + +## Hierarchy + +- `BaseEntity` + + ↳ **`Notification`** + +## Constructors + +### constructor + +• **new Notification**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### customer + +• **customer**: [`Customer`](Customer.md) + +#### Defined in + +[models/notification.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L36) + +___ + +### customer\_id + +• **customer\_id**: ``null`` \| `string` + +#### Defined in + +[models/notification.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L32) + +___ + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/notification.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L42) + +___ + +### event\_name + +• **event\_name**: `string` + +#### Defined in + +[models/notification.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L20) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### parent\_id + +• **parent\_id**: `string` + +#### Defined in + +[models/notification.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L45) + +___ + +### parent\_notification + +• **parent\_notification**: [`Notification`](Notification.md) + +#### Defined in + +[models/notification.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L49) + +___ + +### provider + +• **provider**: `NotificationProvider` + +#### Defined in + +[models/notification.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L59) + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +[models/notification.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L55) + +___ + +### resends + +• **resends**: [`Notification`](Notification.md)[] + +#### Defined in + +[models/notification.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L52) + +___ + +### resource\_id + +• **resource\_id**: `string` + +#### Defined in + +[models/notification.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L28) + +___ + +### resource\_type + +• **resource\_type**: `string` + +#### Defined in + +[models/notification.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L24) + +___ + +### to + +• **to**: `string` + +#### Defined in + +[models/notification.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L39) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/notification.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L61) diff --git a/docs/content/references/entities/classes/Oauth.md b/docs/content/references/entities/classes/Oauth.md new file mode 100644 index 0000000000..78b0e2b719 --- /dev/null +++ b/docs/content/references/entities/classes/Oauth.md @@ -0,0 +1,85 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Oauth + +## Constructors + +### constructor + +• **new Oauth**() + +## Properties + +### application\_name + +• **application\_name**: `string` + +#### Defined in + +[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L16) + +___ + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L25) + +___ + +### display\_name + +• **display\_name**: `string` + +#### Defined in + +[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L12) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L9) + +___ + +### install\_url + +• **install\_url**: `string` + +#### Defined in + +[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L19) + +___ + +### uninstall\_url + +• **uninstall\_url**: `string` + +#### Defined in + +[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L22) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/oauth.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L27) diff --git a/docs/content/references/entities/classes/Order.md b/docs/content/references/entities/classes/Order.md new file mode 100644 index 0000000000..386cf27c73 --- /dev/null +++ b/docs/content/references/entities/classes/Order.md @@ -0,0 +1,567 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Order + +## Hierarchy + +- `BaseEntity` + + ↳ **`Order`** + +## Constructors + +### constructor + +• **new Order**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### billing\_address + +• **billing\_address**: [`Address`](Address.md) + +#### Defined in + +[models/order.ts:123](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L123) + +___ + +### billing\_address\_id + +• **billing\_address\_id**: `string` + +#### Defined in + +[models/order.ts:119](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L119) + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +[models/order.ts:220](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L220) + +___ + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/order.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L104) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/order.ts:100](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L100) + +___ + +### claims + +• **claims**: [`ClaimOrder`](ClaimOrder.md)[] + +#### Defined in + +[models/order.ts:196](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L196) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### currency + +• **currency**: [`Currency`](Currency.md) + +#### Defined in + +[models/order.ts:146](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L146) + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +[models/order.ts:142](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L142) + +___ + +### customer + +• **customer**: [`Customer`](Customer.md) + +#### Defined in + +[models/order.ts:112](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L112) + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +[models/order.ts:108](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L108) + +___ + +### discount\_total + +• **discount\_total**: `number` + +#### Defined in + +[models/order.ts:245](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L245) + +___ + +### discounts + +• **discounts**: [`Discount`](Discount.md)[] + +#### Defined in + +[models/order.ts:163](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L163) + +___ + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +[models/order.ts:96](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L96) + +___ + +### draft\_order + +• **draft\_order**: [`DraftOrder`](DraftOrder.md) + +#### Defined in + +[models/order.ts:209](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L209) + +___ + +### draft\_order\_id + +• **draft\_order\_id**: `string` + +#### Defined in + +[models/order.ts:205](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L205) + +___ + +### email + +• **email**: `string` + +#### Defined in + +[models/order.ts:115](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L115) + +___ + +### external\_id + +• **external\_id**: ``null`` \| `string` + +#### Defined in + +[models/order.ts:232](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L232) + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`FulfillmentStatus`](../enums/FulfillmentStatus.md) + +#### Defined in + +[models/order.ts:88](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L88) + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](Fulfillment.md)[] + +#### Defined in + +[models/order.ts:190](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L190) + +___ + +### gift\_card\_tax\_total + +• **gift\_card\_tax\_total**: `number` + +#### Defined in + +[models/order.ts:253](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L253) + +___ + +### gift\_card\_total + +• **gift\_card\_total**: `number` + +#### Defined in + +[models/order.ts:252](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L252) + +___ + +### gift\_card\_transactions + +• **gift\_card\_transactions**: [`GiftCardTransaction`](GiftCardTransaction.md)[] + +#### Defined in + +[models/order.ts:217](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L217) + +___ + +### gift\_cards + +• **gift\_cards**: [`GiftCard`](GiftCard.md)[] + +#### Defined in + +[models/order.ts:177](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L177) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/order.ts:229](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L229) + +___ + +### items + +• **items**: [`LineItem`](LineItem.md)[] + +#### Defined in + +[models/order.ts:214](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L214) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/order.ts:223](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L223) + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +[models/order.ts:226](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L226) + +___ + +### object + +• `Readonly` **object**: ``"order"`` + +#### Defined in + +[models/order.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L78) + +___ + +### paid\_total + +• **paid\_total**: `number` + +#### Defined in + +[models/order.ts:250](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L250) + +___ + +### payment\_status + +• **payment\_status**: [`PaymentStatus`](../enums/PaymentStatus.md) + +#### Defined in + +[models/order.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L91) + +___ + +### payments + +• **payments**: [`Payment`](Payment.md)[] + +#### Defined in + +[models/order.ts:185](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L185) + +___ + +### refundable\_amount + +• **refundable\_amount**: `number` + +#### Defined in + +[models/order.ts:251](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L251) + +___ + +### refunded\_total + +• **refunded\_total**: `number` + +#### Defined in + +[models/order.ts:247](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L247) + +___ + +### refunds + +• **refunds**: [`Refund`](Refund.md)[] + +#### Defined in + +[models/order.ts:199](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L199) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/order.ts:139](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L139) + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +[models/order.ts:135](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L135) + +___ + +### returns + +• **returns**: [`Return`](Return.md)[] + +#### Defined in + +[models/order.ts:193](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L193) + +___ + +### sales\_channel + +• **sales\_channel**: [`SalesChannel`](SalesChannel.md) + +#### Defined in + +[models/order.ts:241](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L241) + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: ``null`` \| `string` + +#### Defined in + +[models/order.ts:235](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L235) + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](Address.md) + +#### Defined in + +[models/order.ts:131](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L131) + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +[models/order.ts:127](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L127) + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] + +#### Defined in + +[models/order.ts:182](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L182) + +___ + +### shipping\_total + +• **shipping\_total**: `number` + +#### Defined in + +[models/order.ts:244](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L244) + +___ + +### status + +• **status**: [`OrderStatus`](../enums/OrderStatus.md) + +#### Defined in + +[models/order.ts:81](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L81) + +___ + +### subtotal + +• **subtotal**: `number` + +#### Defined in + +[models/order.ts:249](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L249) + +___ + +### swaps + +• **swaps**: [`Swap`](Swap.md)[] + +#### Defined in + +[models/order.ts:202](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L202) + +___ + +### tax\_rate + +• **tax\_rate**: ``null`` \| `number` + +#### Defined in + +[models/order.ts:149](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L149) + +___ + +### tax\_total + +• **tax\_total**: ``null`` \| `number` + +#### Defined in + +[models/order.ts:246](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L246) + +___ + +### total + +• **total**: `number` + +#### Defined in + +[models/order.ts:248](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L248) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[models/order.ts:255](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L255) diff --git a/docs/content/references/entities/classes/Payment.md b/docs/content/references/entities/classes/Payment.md new file mode 100644 index 0000000000..0ef1f688e4 --- /dev/null +++ b/docs/content/references/entities/classes/Payment.md @@ -0,0 +1,237 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Payment + +## Hierarchy + +- `BaseEntity` + + ↳ **`Payment`** + +## Constructors + +### constructor + +• **new Payment**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[models/payment.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L46) + +___ + +### amount\_refunded + +• **amount\_refunded**: `number` + +#### Defined in + +[models/payment.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L56) + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +[models/payment.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L69) + +___ + +### captured\_at + +• **captured\_at**: `Date` + +#### Defined in + +[models/payment.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L66) + +___ + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/payment.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L35) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/payment.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L31) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### currency + +• **currency**: [`Currency`](Currency.md) + +#### Defined in + +[models/payment.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L53) + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +[models/payment.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L49) + +___ + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/payment.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L63) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/payment.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L75) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/payment.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L72) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/payment.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L43) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/payment.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L39) + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +[models/payment.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L60) + +___ + +### swap + +• **swap**: [`Swap`](Swap.md) + +#### Defined in + +[models/payment.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L27) + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +[models/payment.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L23) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/payment.ts:77](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L77) diff --git a/docs/content/references/entities/classes/PaymentProvider.md b/docs/content/references/entities/classes/PaymentProvider.md new file mode 100644 index 0000000000..f3ac765a18 --- /dev/null +++ b/docs/content/references/entities/classes/PaymentProvider.md @@ -0,0 +1,31 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: PaymentProvider + +## Constructors + +### constructor + +• **new PaymentProvider**() + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-provider.ts#L6) + +___ + +### is\_installed + +• **is\_installed**: `boolean` + +#### Defined in + +[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-provider.ts#L9) diff --git a/docs/content/references/entities/classes/PaymentSession.md b/docs/content/references/entities/classes/PaymentSession.md new file mode 100644 index 0000000000..35af4e6d0d --- /dev/null +++ b/docs/content/references/entities/classes/PaymentSession.md @@ -0,0 +1,147 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: PaymentSession + +## Hierarchy + +- `BaseEntity` + + ↳ **`PaymentSession`** + +## Constructors + +### constructor + +• **new PaymentSession**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/payment-session.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L33) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/payment-session.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L29) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/payment-session.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L46) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/payment-session.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L49) + +___ + +### is\_selected + +• **is\_selected**: ``null`` \| `boolean` + +#### Defined in + +[models/payment-session.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L40) + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +[models/payment-session.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L37) + +___ + +### status + +• **status**: `string` + +#### Defined in + +[models/payment-session.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L43) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/payment-session.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L51) diff --git a/docs/content/references/entities/classes/PriceList.md b/docs/content/references/entities/classes/PriceList.md new file mode 100644 index 0000000000..8015405886 --- /dev/null +++ b/docs/content/references/entities/classes/PriceList.md @@ -0,0 +1,171 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: PriceList + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`PriceList`** + +## Constructors + +### constructor + +• **new PriceList**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### customer\_groups + +• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[] + +#### Defined in + +[models/price-list.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L54) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### description + +• **description**: `string` + +#### Defined in + +[models/price-list.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L23) + +___ + +### ends\_at + +• **ends\_at**: ``null`` \| `Date` + +#### Defined in + +[models/price-list.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L38) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/price-list.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L20) + +___ + +### prices + +• **prices**: [`MoneyAmount`](MoneyAmount.md)[] + +#### Defined in + +[models/price-list.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L59) + +___ + +### starts\_at + +• **starts\_at**: ``null`` \| `Date` + +#### Defined in + +[models/price-list.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L35) + +___ + +### status + +• **status**: `PriceListStatus` + +#### Defined in + +[models/price-list.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L29) + +___ + +### type + +• **type**: `PriceListType` + +#### Defined in + +[models/price-list.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L26) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `undefined` \| `void` + +#### Returns + +`undefined` \| `void` + +#### Defined in + +[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L61) diff --git a/docs/content/references/entities/classes/Product.md b/docs/content/references/entities/classes/Product.md new file mode 100644 index 0000000000..decaacc8e4 --- /dev/null +++ b/docs/content/references/entities/classes/Product.md @@ -0,0 +1,381 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Product + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Product`** + +## Constructors + +### constructor + +• **new Product**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### collection + +• **collection**: [`ProductCollection`](ProductCollection.md) + +#### Defined in + +[models/product.ts:117](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L117) + +___ + +### collection\_id + +• **collection\_id**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:113](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L113) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### description + +• **description**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L43) + +___ + +### discountable + +• **discountable**: `boolean` + +#### Defined in + +[models/product.ts:141](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L141) + +___ + +### external\_id + +• **external\_id**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:144](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L144) + +___ + +### handle + +• **handle**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L47) + +___ + +### height + +• **height**: ``null`` \| `number` + +#### Defined in + +[models/product.ts:95](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L95) + +___ + +### hs\_code + +• **hs\_code**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:101](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L101) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### images + +• **images**: [`Image`](Image.md)[] + +#### Defined in + +[models/product.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L67) + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +[models/product.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L50) + +___ + +### length + +• **length**: ``null`` \| `number` + +#### Defined in + +[models/product.ts:92](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L92) + +___ + +### material + +• **material**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:110](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L110) + +___ + +### metadata + +• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product.ts:147](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L147) + +___ + +### mid\_code + +• **mid\_code**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:107](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L107) + +___ + +### options + +• **options**: [`ProductOption`](ProductOption.md)[] + +#### Defined in + +[models/product.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L73) + +___ + +### origin\_country + +• **origin\_country**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L104) + +___ + +### profile + +• **profile**: [`ShippingProfile`](ShippingProfile.md) + +#### Defined in + +[models/product.ts:86](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L86) + +___ + +### profile\_id + +• **profile\_id**: `string` + +#### Defined in + +[models/product.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L82) + +___ + +### sales\_channels + +• **sales\_channels**: [`SalesChannel`](SalesChannel.md)[] + +#### Defined in + +[models/product.ts:163](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L163) + +___ + +### status + +• **status**: [`ProductStatus`](../enums/ProductStatus.md) + +#### Defined in + +[models/product.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L53) + +___ + +### subtitle + +• **subtitle**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L40) + +___ + +### tags + +• **tags**: [`ProductTag`](ProductTag.md)[] + +#### Defined in + +[models/product.ts:138](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L138) + +___ + +### thumbnail + +• **thumbnail**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L70) + +___ + +### title + +• **title**: `string` + +#### Defined in + +[models/product.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L37) + +___ + +### type + +• **type**: [`ProductType`](ProductType.md) + +#### Defined in + +[models/product.ts:124](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L124) + +___ + +### type\_id + +• **type\_id**: ``null`` \| `string` + +#### Defined in + +[models/product.ts:120](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L120) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### variants + +• **variants**: [`ProductVariant`](ProductVariant.md)[] + +#### Defined in + +[models/product.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L78) + +___ + +### weight + +• **weight**: ``null`` \| `number` + +#### Defined in + +[models/product.ts:89](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L89) + +___ + +### width + +• **width**: ``null`` \| `number` + +#### Defined in + +[models/product.ts:98](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L98) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/product.ts:165](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L165) diff --git a/docs/content/references/entities/classes/ProductCollection.md b/docs/content/references/entities/classes/ProductCollection.md new file mode 100644 index 0000000000..5f94dacd74 --- /dev/null +++ b/docs/content/references/entities/classes/ProductCollection.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductCollection + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ProductCollection`** + +## Constructors + +### constructor + +• **new ProductCollection**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### handle + +• **handle**: `string` + +#### Defined in + +[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L16) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L22) + +___ + +### products + +• **products**: [`Product`](Product.md)[] + +#### Defined in + +[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L19) + +___ + +### title + +• **title**: `string` + +#### Defined in + +[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L12) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### createHandleIfNotProvided + +▸ `Private` **createHandleIfNotProvided**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/product-collection.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L24) diff --git a/docs/content/references/entities/classes/ProductOption.md b/docs/content/references/entities/classes/ProductOption.md new file mode 100644 index 0000000000..1396fde3f0 --- /dev/null +++ b/docs/content/references/entities/classes/ProductOption.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductOption + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ProductOption`** + +## Constructors + +### constructor + +• **new ProductOption**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-option.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L32) + +___ + +### product + +• **product**: [`Product`](Product.md) + +#### Defined in + +[models/product-option.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L29) + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +[models/product-option.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L25) + +___ + +### title + +• **title**: `string` + +#### Defined in + +[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L19) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### values + +• **values**: [`ProductOptionValue`](ProductOptionValue.md)[] + +#### Defined in + +[models/product-option.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L22) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L34) diff --git a/docs/content/references/entities/classes/ProductOptionValue.md b/docs/content/references/entities/classes/ProductOptionValue.md new file mode 100644 index 0000000000..5b10567352 --- /dev/null +++ b/docs/content/references/entities/classes/ProductOptionValue.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductOptionValue + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ProductOptionValue`** + +## Constructors + +### constructor + +• **new ProductOptionValue**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L40) + +___ + +### option + +• **option**: [`ProductOption`](ProductOption.md) + +#### Defined in + +[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L27) + +___ + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L23) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `string` + +#### Defined in + +[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L19) + +___ + +### variant + +• **variant**: [`ProductVariant`](ProductVariant.md) + +#### Defined in + +[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L37) + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L31) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/product-option-value.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L42) diff --git a/docs/content/references/entities/classes/ProductTag.md b/docs/content/references/entities/classes/ProductTag.md new file mode 100644 index 0000000000..af7422e0ae --- /dev/null +++ b/docs/content/references/entities/classes/ProductTag.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductTag + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ProductTag`** + +## Constructors + +### constructor + +• **new ProductTag**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-tag.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tag.ts#L13) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `string` + +#### Defined in + +[models/product-tag.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tag.ts#L10) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/product-tag.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tag.ts#L15) diff --git a/docs/content/references/entities/classes/ProductTaxRate.md b/docs/content/references/entities/classes/ProductTaxRate.md new file mode 100644 index 0000000000..2446cf67bd --- /dev/null +++ b/docs/content/references/entities/classes/ProductTaxRate.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductTaxRate + +## Constructors + +### constructor + +• **new ProductTaxRate**() + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/product-tax-rate.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L32) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-tax-rate.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L38) + +___ + +### product + +• `Optional` **product**: [`Product`](Product.md) + +#### Defined in + +[models/product-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L24) + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +[models/product-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L17) + +___ + +### rate\_id + +• **rate\_id**: `string` + +#### Defined in + +[models/product-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L20) + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md) + +#### Defined in + +[models/product-tax-rate.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L29) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/product-tax-rate.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L35) diff --git a/docs/content/references/entities/classes/ProductType.md b/docs/content/references/entities/classes/ProductType.md new file mode 100644 index 0000000000..417e42ddd6 --- /dev/null +++ b/docs/content/references/entities/classes/ProductType.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductType + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ProductType`** + +## Constructors + +### constructor + +• **new ProductType**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-type.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type.ts#L13) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `string` + +#### Defined in + +[models/product-type.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type.ts#L10) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/product-type.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type.ts#L15) diff --git a/docs/content/references/entities/classes/ProductTypeTaxRate.md b/docs/content/references/entities/classes/ProductTypeTaxRate.md new file mode 100644 index 0000000000..569041ede2 --- /dev/null +++ b/docs/content/references/entities/classes/ProductTypeTaxRate.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductTypeTaxRate + +## Constructors + +### constructor + +• **new ProductTypeTaxRate**() + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/product-type-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L31) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-type-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L37) + +___ + +### product\_type + +• `Optional` **product\_type**: [`ProductType`](ProductType.md) + +#### Defined in + +[models/product-type-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L24) + +___ + +### product\_type\_id + +• **product\_type\_id**: `string` + +#### Defined in + +[models/product-type-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L17) + +___ + +### rate\_id + +• **rate\_id**: `string` + +#### Defined in + +[models/product-type-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L20) + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md) + +#### Defined in + +[models/product-type-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L28) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/product-type-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L34) diff --git a/docs/content/references/entities/classes/ProductVariant.md b/docs/content/references/entities/classes/ProductVariant.md new file mode 100644 index 0000000000..e32b06518c --- /dev/null +++ b/docs/content/references/entities/classes/ProductVariant.md @@ -0,0 +1,311 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ProductVariant + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ProductVariant`** + +## Constructors + +### constructor + +• **new ProductVariant**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### allow\_backorder + +• **allow\_backorder**: `boolean` + +#### Defined in + +[models/product-variant.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L60) + +___ + +### barcode + +• **barcode**: `string` + +#### Defined in + +[models/product-variant.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L43) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### ean + +• **ean**: `string` + +#### Defined in + +[models/product-variant.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L47) + +___ + +### height + +• **height**: `number` + +#### Defined in + +[models/product-variant.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L84) + +___ + +### hs\_code + +• **hs\_code**: `string` + +#### Defined in + +[models/product-variant.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L66) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +[models/product-variant.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L57) + +___ + +### length + +• **length**: `number` + +#### Defined in + +[models/product-variant.ts:81](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L81) + +___ + +### manage\_inventory + +• **manage\_inventory**: `boolean` + +#### Defined in + +[models/product-variant.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L63) + +___ + +### material + +• **material**: `string` + +#### Defined in + +[models/product-variant.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L75) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/product-variant.ts:95](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L95) + +___ + +### mid\_code + +• **mid\_code**: `string` + +#### Defined in + +[models/product-variant.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L72) + +___ + +### options + +• **options**: [`ProductOptionValue`](ProductOptionValue.md)[] + +#### Defined in + +[models/product-variant.ts:92](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L92) + +___ + +### origin\_country + +• **origin\_country**: `string` + +#### Defined in + +[models/product-variant.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L69) + +___ + +### prices + +• **prices**: [`MoneyAmount`](MoneyAmount.md)[] + +#### Defined in + +[models/product-variant.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L35) + +___ + +### product + +• **product**: [`Product`](Product.md) + +#### Defined in + +[models/product-variant.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L29) + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +[models/product-variant.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L25) + +___ + +### sku + +• **sku**: `string` + +#### Defined in + +[models/product-variant.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L39) + +___ + +### title + +• **title**: `string` + +#### Defined in + +[models/product-variant.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L21) + +___ + +### upc + +• **upc**: `string` + +#### Defined in + +[models/product-variant.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L51) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### variant\_rank + +• **variant\_rank**: `number` + +#### Defined in + +[models/product-variant.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L54) + +___ + +### weight + +• **weight**: `number` + +#### Defined in + +[models/product-variant.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L78) + +___ + +### width + +• **width**: `number` + +#### Defined in + +[models/product-variant.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L87) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/product-variant.ts:97](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L97) diff --git a/docs/content/references/entities/classes/Refund.md b/docs/content/references/entities/classes/Refund.md new file mode 100644 index 0000000000..df51448eba --- /dev/null +++ b/docs/content/references/entities/classes/Refund.md @@ -0,0 +1,147 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Refund + +## Hierarchy + +- `BaseEntity` + + ↳ **`Refund`** + +## Constructors + +### constructor + +• **new Refund**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[models/refund.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L34) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/refund.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L46) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/refund.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L43) + +___ + +### note + +• **note**: `string` + +#### Defined in + +[models/refund.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L37) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/refund.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L31) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/refund.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L27) + +___ + +### reason + +• **reason**: `string` + +#### Defined in + +[models/refund.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L40) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/refund.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L48) diff --git a/docs/content/references/entities/classes/Region.md b/docs/content/references/entities/classes/Region.md new file mode 100644 index 0000000000..223387ddaa --- /dev/null +++ b/docs/content/references/entities/classes/Region.md @@ -0,0 +1,231 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Region + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Region`** + +## Constructors + +### constructor + +• **new Region**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### automatic\_taxes + +• **automatic\_taxes**: `boolean` + +#### Defined in + +[models/region.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L47) + +___ + +### countries + +• **countries**: [`Country`](Country.md)[] + +#### Defined in + +[models/region.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L50) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### currency + +• **currency**: [`Currency`](Currency.md) + +#### Defined in + +[models/region.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L32) + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +[models/region.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L28) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### fulfillment\_providers + +• **fulfillment\_providers**: [`FulfillmentProvider`](FulfillmentProvider.md)[] + +#### Defined in + +[models/region.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L91) + +___ + +### gift\_cards\_taxable + +• **gift\_cards\_taxable**: `boolean` + +#### Defined in + +[models/region.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L44) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/region.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L94) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/region.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L25) + +___ + +### payment\_providers + +• **payment\_providers**: [`PaymentProvider`](PaymentProvider.md)[] + +#### Defined in + +[models/region.ts:74](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L74) + +___ + +### tax\_code + +• **tax\_code**: `string` + +#### Defined in + +[models/region.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L41) + +___ + +### tax\_provider + +• **tax\_provider**: [`TaxProvider`](TaxProvider.md) + +#### Defined in + +[models/region.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L57) + +___ + +### tax\_provider\_id + +• **tax\_provider\_id**: ``null`` \| `string` + +#### Defined in + +[models/region.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L53) + +___ + +### tax\_rate + +• **tax\_rate**: `number` + +#### Defined in + +[models/region.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L35) + +___ + +### tax\_rates + +• **tax\_rates**: ``null`` \| [`TaxRate`](TaxRate.md)[] + +#### Defined in + +[models/region.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L38) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/region.ts:96](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L96) diff --git a/docs/content/references/entities/classes/Return.md b/docs/content/references/entities/classes/Return.md new file mode 100644 index 0000000000..ed68fff221 --- /dev/null +++ b/docs/content/references/entities/classes/Return.md @@ -0,0 +1,227 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Return + +## Hierarchy + +- `BaseEntity` + + ↳ **`Return`** + +## Constructors + +### constructor + +• **new Return**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) + +#### Defined in + +[models/return.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L57) + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +[models/return.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L53) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/return.ts:88](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L88) + +___ + +### items + +• **items**: [`ReturnItem`](ReturnItem.md)[] + +#### Defined in + +[models/return.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L41) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/return.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L85) + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +[models/return.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L82) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/return.ts:65](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L65) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/return.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L61) + +___ + +### received\_at + +• **received\_at**: `Date` + +#### Defined in + +[models/return.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L79) + +___ + +### refund\_amount + +• **refund\_amount**: `number` + +#### Defined in + +[models/return.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L76) + +___ + +### shipping\_data + +• **shipping\_data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/return.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L73) + +___ + +### shipping\_method + +• **shipping\_method**: [`ShippingMethod`](ShippingMethod.md) + +#### Defined in + +[models/return.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L70) + +___ + +### status + +• **status**: [`ReturnStatus`](../enums/ReturnStatus.md) + +#### Defined in + +[models/return.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L35) + +___ + +### swap + +• **swap**: [`Swap`](Swap.md) + +#### Defined in + +[models/return.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L49) + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +[models/return.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L45) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/return.ts:90](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L90) diff --git a/docs/content/references/entities/classes/ReturnItem.md b/docs/content/references/entities/classes/ReturnItem.md new file mode 100644 index 0000000000..4b23002526 --- /dev/null +++ b/docs/content/references/entities/classes/ReturnItem.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ReturnItem + +## Constructors + +### constructor + +• **new ReturnItem**() + +## Properties + +### is\_requested + +• **is\_requested**: `boolean` + +#### Defined in + +[models/return-item.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L28) + +___ + +### item + +• **item**: [`LineItem`](LineItem.md) + +#### Defined in + +[models/return-item.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L22) + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +[models/return-item.ts:14](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L14) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/return-item.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L47) + +___ + +### note + +• **note**: `string` + +#### Defined in + +[models/return-item.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L44) + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +[models/return-item.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L25) + +___ + +### reason + +• **reason**: [`ReturnReason`](ReturnReason.md) + +#### Defined in + +[models/return-item.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L41) + +___ + +### reason\_id + +• **reason\_id**: `string` + +#### Defined in + +[models/return-item.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L37) + +___ + +### received\_quantity + +• **received\_quantity**: `number` + +#### Defined in + +[models/return-item.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L34) + +___ + +### requested\_quantity + +• **requested\_quantity**: `number` + +#### Defined in + +[models/return-item.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L31) + +___ + +### return\_id + +• **return\_id**: `string` + +#### Defined in + +[models/return-item.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L11) + +___ + +### return\_order + +• **return\_order**: [`Return`](Return.md) + +#### Defined in + +[models/return-item.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L18) diff --git a/docs/content/references/entities/classes/ReturnReason.md b/docs/content/references/entities/classes/ReturnReason.md new file mode 100644 index 0000000000..fd8572ce26 --- /dev/null +++ b/docs/content/references/entities/classes/ReturnReason.md @@ -0,0 +1,161 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ReturnReason + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ReturnReason`** + +## Constructors + +### constructor + +• **new ReturnReason**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### description + +• **description**: `string` + +#### Defined in + +[models/return-reason.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L25) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### label + +• **label**: `string` + +#### Defined in + +[models/return-reason.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L22) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/return-reason.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L42) + +___ + +### parent\_return\_reason + +• **parent\_return\_reason**: ``null`` \| [`ReturnReason`](ReturnReason.md) + +#### Defined in + +[models/return-reason.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L32) + +___ + +### parent\_return\_reason\_id + +• **parent\_return\_reason\_id**: ``null`` \| `string` + +#### Defined in + +[models/return-reason.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L28) + +___ + +### return\_reason\_children + +• **return\_reason\_children**: [`ReturnReason`](ReturnReason.md)[] + +#### Defined in + +[models/return-reason.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L39) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### value + +• **value**: `string` + +#### Defined in + +[models/return-reason.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/return-reason.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L44) diff --git a/docs/content/references/entities/classes/SalesChannel.md b/docs/content/references/entities/classes/SalesChannel.md new file mode 100644 index 0000000000..f4c007f465 --- /dev/null +++ b/docs/content/references/entities/classes/SalesChannel.md @@ -0,0 +1,121 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: SalesChannel + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`SalesChannel`** + +## Constructors + +### constructor + +• **new SalesChannel**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### description + +• **description**: ``null`` \| `string` + +#### Defined in + +[models/sales-channel.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L13) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +[models/sales-channel.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L16) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/sales-channel.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L10) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/sales-channel.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L18) diff --git a/docs/content/references/entities/classes/ShippingMethod.md b/docs/content/references/entities/classes/ShippingMethod.md new file mode 100644 index 0000000000..678317844b --- /dev/null +++ b/docs/content/references/entities/classes/ShippingMethod.md @@ -0,0 +1,185 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ShippingMethod + +## Constructors + +### constructor + +• **new ShippingMethod**() + +## Properties + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/shipping-method.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L59) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/shipping-method.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L55) + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) + +#### Defined in + +[models/shipping-method.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L51) + +___ + +### claim\_order\_id + +• **claim\_order\_id**: ``null`` \| `string` + +#### Defined in + +[models/shipping-method.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L47) + +___ + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/shipping-method.ts:90](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L90) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[models/shipping-method.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L31) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/shipping-method.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L43) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/shipping-method.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L39) + +___ + +### price + +• **price**: `number` + +#### Defined in + +[models/shipping-method.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L87) + +___ + +### return\_id + +• **return\_id**: `string` + +#### Defined in + +[models/shipping-method.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L71) + +___ + +### return\_order + +• **return\_order**: [`Return`](Return.md) + +#### Defined in + +[models/shipping-method.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L75) + +___ + +### shipping\_option + +• **shipping\_option**: [`ShippingOption`](ShippingOption.md) + +#### Defined in + +[models/shipping-method.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L79) + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +[models/shipping-method.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L35) + +___ + +### swap + +• **swap**: [`Swap`](Swap.md) + +#### Defined in + +[models/shipping-method.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L67) + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +[models/shipping-method.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L63) + +___ + +### tax\_lines + +• **tax\_lines**: [`ShippingMethodTaxLine`](ShippingMethodTaxLine.md)[] + +#### Defined in + +[models/shipping-method.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L84) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L92) diff --git a/docs/content/references/entities/classes/ShippingMethodTaxLine.md b/docs/content/references/entities/classes/ShippingMethodTaxLine.md new file mode 100644 index 0000000000..5d9fc5d136 --- /dev/null +++ b/docs/content/references/entities/classes/ShippingMethodTaxLine.md @@ -0,0 +1,153 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ShippingMethodTaxLine + +## Hierarchy + +- `TaxLine` + + ↳ **`ShippingMethodTaxLine`** + +## Constructors + +### constructor + +• **new ShippingMethodTaxLine**() + +#### Inherited from + +TaxLine.constructor + +## Properties + +### code + +• **code**: ``null`` \| `string` + +#### Inherited from + +TaxLine.code + +#### Defined in + +[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L13) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +TaxLine.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +TaxLine.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TaxLine.metadata + +#### Defined in + +[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L16) + +___ + +### name + +• **name**: `string` + +#### Inherited from + +TaxLine.name + +#### Defined in + +[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L10) + +___ + +### rate + +• **rate**: `number` + +#### Inherited from + +TaxLine.rate + +#### Defined in + +[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L7) + +___ + +### shipping\_method + +• **shipping\_method**: [`ShippingMethod`](ShippingMethod.md) + +#### Defined in + +[models/shipping-method-tax-line.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method-tax-line.ts#L24) + +___ + +### shipping\_method\_id + +• **shipping\_method\_id**: `string` + +#### Defined in + +[models/shipping-method-tax-line.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method-tax-line.ts#L20) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +TaxLine.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/shipping-method-tax-line.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method-tax-line.ts#L26) diff --git a/docs/content/references/entities/classes/ShippingOption.md b/docs/content/references/entities/classes/ShippingOption.md new file mode 100644 index 0000000000..6bf8bd0692 --- /dev/null +++ b/docs/content/references/entities/classes/ShippingOption.md @@ -0,0 +1,231 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ShippingOption + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ShippingOption`** + +## Constructors + +### constructor + +• **new ShippingOption**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### admin\_only + +• **admin\_only**: `boolean` + +#### Defined in + +[models/shipping-option.ts:65](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L65) + +___ + +### amount + +• **amount**: ``null`` \| `number` + +#### Defined in + +[models/shipping-option.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L59) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/shipping-option.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L73) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### is\_return + +• **is\_return**: `boolean` + +#### Defined in + +[models/shipping-option.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L62) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/shipping-option.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L76) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/shipping-option.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L29) + +___ + +### price\_type + +• **price\_type**: [`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.md) + +#### Defined in + +[models/shipping-option.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L56) + +___ + +### profile + +• **profile**: [`ShippingProfile`](ShippingProfile.md) + +#### Defined in + +[models/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L45) + +___ + +### profile\_id + +• **profile\_id**: `string` + +#### Defined in + +[models/shipping-option.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L41) + +___ + +### provider + +• **provider**: [`FulfillmentProvider`](FulfillmentProvider.md) + +#### Defined in + +[models/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L53) + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +[models/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L49) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L37) + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +[models/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L33) + +___ + +### requirements + +• **requirements**: [`ShippingOptionRequirement`](ShippingOptionRequirement.md)[] + +#### Defined in + +[models/shipping-option.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L70) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/shipping-option.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L78) diff --git a/docs/content/references/entities/classes/ShippingOptionRequirement.md b/docs/content/references/entities/classes/ShippingOptionRequirement.md new file mode 100644 index 0000000000..7dde2e1d7c --- /dev/null +++ b/docs/content/references/entities/classes/ShippingOptionRequirement.md @@ -0,0 +1,85 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ShippingOptionRequirement + +## Constructors + +### constructor + +• **new ShippingOptionRequirement**() + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[models/shipping-option-requirement.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L38) + +___ + +### deleted\_at + +• **deleted\_at**: `Date` + +#### Defined in + +[models/shipping-option-requirement.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L41) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[models/shipping-option-requirement.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L24) + +___ + +### shipping\_option + +• **shipping\_option**: [`ShippingOption`](ShippingOption.md) + +#### Defined in + +[models/shipping-option-requirement.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L32) + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +[models/shipping-option-requirement.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L28) + +___ + +### type + +• **type**: [`RequirementType`](../enums/RequirementType.md) + +#### Defined in + +[models/shipping-option-requirement.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L35) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/shipping-option-requirement.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L43) diff --git a/docs/content/references/entities/classes/ShippingProfile.md b/docs/content/references/entities/classes/ShippingProfile.md new file mode 100644 index 0000000000..f751703e86 --- /dev/null +++ b/docs/content/references/entities/classes/ShippingProfile.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ShippingProfile + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`ShippingProfile`** + +## Constructors + +### constructor + +• **new ShippingProfile**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/shipping-profile.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L30) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L18) + +___ + +### products + +• **products**: [`Product`](Product.md)[] + +#### Defined in + +[models/shipping-profile.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L24) + +___ + +### shipping\_options + +• **shipping\_options**: [`ShippingOption`](ShippingOption.md)[] + +#### Defined in + +[models/shipping-profile.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L27) + +___ + +### type + +• **type**: [`ShippingProfileType`](../enums/ShippingProfileType.md) + +#### Defined in + +[models/shipping-profile.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L21) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/shipping-profile.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L32) diff --git a/docs/content/references/entities/classes/ShippingTaxRate.md b/docs/content/references/entities/classes/ShippingTaxRate.md new file mode 100644 index 0000000000..6dfa2db729 --- /dev/null +++ b/docs/content/references/entities/classes/ShippingTaxRate.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: ShippingTaxRate + +## Constructors + +### constructor + +• **new ShippingTaxRate**() + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +[models/shipping-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L31) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/shipping-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L37) + +___ + +### rate\_id + +• **rate\_id**: `string` + +#### Defined in + +[models/shipping-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L20) + +___ + +### shipping\_option + +• `Optional` **shipping\_option**: [`ShippingOption`](ShippingOption.md) + +#### Defined in + +[models/shipping-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L24) + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +[models/shipping-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L17) + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md) + +#### Defined in + +[models/shipping-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L28) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +[models/shipping-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L34) diff --git a/docs/content/references/entities/classes/StagedJob.md b/docs/content/references/entities/classes/StagedJob.md new file mode 100644 index 0000000000..c68fa4df02 --- /dev/null +++ b/docs/content/references/entities/classes/StagedJob.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: StagedJob + +## Constructors + +### constructor + +• **new StagedJob**() + +## Properties + +### data + +• **data**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/staged-job.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L15) + +___ + +### event\_name + +• **event\_name**: `string` + +#### Defined in + +[models/staged-job.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L12) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[models/staged-job.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L9) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/staged-job.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L17) diff --git a/docs/content/references/entities/classes/Store.md b/docs/content/references/entities/classes/Store.md new file mode 100644 index 0000000000..af133e307e --- /dev/null +++ b/docs/content/references/entities/classes/Store.md @@ -0,0 +1,177 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Store + +## Hierarchy + +- `BaseEntity` + + ↳ **`Store`** + +## Constructors + +### constructor + +• **new Store**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### currencies + +• **currencies**: [`Currency`](Currency.md)[] + +#### Defined in + +[models/store.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L46) + +___ + +### default\_currency + +• **default\_currency**: [`Currency`](Currency.md) + +#### Defined in + +[models/store.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L32) + +___ + +### default\_currency\_code + +• **default\_currency\_code**: `string` + +#### Defined in + +[models/store.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L28) + +___ + +### default\_sales\_channel + +• **default\_sales\_channel**: [`SalesChannel`](SalesChannel.md) + +#### Defined in + +[models/store.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L67) + +___ + +### default\_sales\_channel\_id + +• **default\_sales\_channel\_id**: `string` + +#### Defined in + +[models/store.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L61) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### invite\_link\_template + +• **invite\_link\_template**: `string` + +#### Defined in + +[models/store.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L55) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/store.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L58) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/store.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L25) + +___ + +### payment\_link\_template + +• **payment\_link\_template**: `string` + +#### Defined in + +[models/store.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L52) + +___ + +### swap\_link\_template + +• **swap\_link\_template**: `string` + +#### Defined in + +[models/store.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L49) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/store.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L69) diff --git a/docs/content/references/entities/classes/Swap.md b/docs/content/references/entities/classes/Swap.md new file mode 100644 index 0000000000..2ac7de7b80 --- /dev/null +++ b/docs/content/references/entities/classes/Swap.md @@ -0,0 +1,291 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: Swap + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`Swap`** + +## Constructors + +### constructor + +• **new Swap**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### additional\_items + +• **additional\_items**: [`LineItem`](LineItem.md)[] + +#### Defined in + +[models/swap.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L61) + +___ + +### allow\_backorder + +• **allow\_backorder**: `boolean` + +#### Defined in + +[models/swap.ts:106](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L106) + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +[models/swap.ts:100](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L100) + +___ + +### cart + +• **cart**: [`Cart`](Cart.md) + +#### Defined in + +[models/swap.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L94) + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +[models/swap.ts:90](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L90) + +___ + +### confirmed\_at + +• **confirmed\_at**: `Date` + +#### Defined in + +[models/swap.ts:97](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L97) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### difference\_due + +• **difference\_due**: `number` + +#### Defined in + +[models/swap.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L75) + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.md) + +#### Defined in + +[models/swap.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L47) + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](Fulfillment.md)[] + +#### Defined in + +[models/swap.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L69) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/swap.ts:109](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L109) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/swap.ts:112](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L112) + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +[models/swap.ts:103](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L103) + +___ + +### order + +• **order**: [`Order`](Order.md) + +#### Defined in + +[models/swap.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L58) + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +[models/swap.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L54) + +___ + +### payment + +• **payment**: [`Payment`](Payment.md) + +#### Defined in + +[models/swap.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L72) + +___ + +### payment\_status + +• **payment\_status**: [`SwapPaymentStatus`](../enums/SwapPaymentStatus.md) + +#### Defined in + +[models/swap.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L50) + +___ + +### return\_order + +• **return\_order**: [`Return`](Return.md) + +#### Defined in + +[models/swap.ts:64](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L64) + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](Address.md) + +#### Defined in + +[models/swap.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L82) + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +[models/swap.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L78) + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] + +#### Defined in + +[models/swap.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L87) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/swap.ts:114](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L114) diff --git a/docs/content/references/entities/classes/TaxProvider.md b/docs/content/references/entities/classes/TaxProvider.md new file mode 100644 index 0000000000..667e633a8b --- /dev/null +++ b/docs/content/references/entities/classes/TaxProvider.md @@ -0,0 +1,31 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: TaxProvider + +## Constructors + +### constructor + +• **new TaxProvider**() + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[models/tax-provider.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-provider.ts#L6) + +___ + +### is\_installed + +• **is\_installed**: `boolean` + +#### Defined in + +[models/tax-provider.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-provider.ts#L9) diff --git a/docs/content/references/entities/classes/TaxRate.md b/docs/content/references/entities/classes/TaxRate.md new file mode 100644 index 0000000000..5160adfc98 --- /dev/null +++ b/docs/content/references/entities/classes/TaxRate.md @@ -0,0 +1,197 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: TaxRate + +## Hierarchy + +- `BaseEntity` + + ↳ **`TaxRate`** + +## Constructors + +### constructor + +• **new TaxRate**() + +#### Inherited from + +BaseEntity.constructor + +## Properties + +### code + +• **code**: ``null`` \| `string` + +#### Defined in + +[models/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L25) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +BaseEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +BaseEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/tax-rate.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L38) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[models/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L28) + +___ + +### product\_count + +• `Optional` **product\_count**: `number` + +#### Defined in + +[models/tax-rate.ts:83](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L83) + +___ + +### product\_type\_count + +• `Optional` **product\_type\_count**: `number` + +#### Defined in + +[models/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L84) + +___ + +### product\_types + +• **product\_types**: [`ProductType`](ProductType.md)[] + +#### Defined in + +[models/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L66) + +___ + +### products + +• **products**: [`Product`](Product.md)[] + +#### Defined in + +[models/tax-rate.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L52) + +___ + +### rate + +• **rate**: ``null`` \| `number` + +#### Defined in + +[models/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L22) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/tax-rate.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L35) + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +[models/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L31) + +___ + +### shipping\_option\_count + +• `Optional` **shipping\_option\_count**: `number` + +#### Defined in + +[models/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L85) + +___ + +### shipping\_options + +• **shipping\_options**: [`ShippingOption`](ShippingOption.md)[] + +#### Defined in + +[models/tax-rate.ts:80](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L80) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +BaseEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/tax-rate.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L87) diff --git a/docs/content/references/entities/classes/TrackingLink.md b/docs/content/references/entities/classes/TrackingLink.md new file mode 100644 index 0000000000..366a5038ec --- /dev/null +++ b/docs/content/references/entities/classes/TrackingLink.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: TrackingLink + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`TrackingLink`** + +## Constructors + +### constructor + +• **new TrackingLink**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### fulfillment + +• **fulfillment**: [`Fulfillment`](Fulfillment.md) + +#### Defined in + +[models/tracking-link.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L21) + +___ + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +[models/tracking-link.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L17) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +[models/tracking-link.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L24) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/tracking-link.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L27) + +___ + +### tracking\_number + +• **tracking\_number**: `string` + +#### Defined in + +[models/tracking-link.ts:14](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L14) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +___ + +### url + +• **url**: `string` + +#### Defined in + +[models/tracking-link.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L11) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/tracking-link.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L29) diff --git a/docs/content/references/entities/classes/User.md b/docs/content/references/entities/classes/User.md new file mode 100644 index 0000000000..836adfcce5 --- /dev/null +++ b/docs/content/references/entities/classes/User.md @@ -0,0 +1,161 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: User + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`User`** + +## Constructors + +### constructor + +• **new User**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### api\_token + +• **api\_token**: `string` + +#### Defined in + +[models/user.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L37) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### email + +• **email**: `string` + +#### Defined in + +[models/user.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L25) + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +[models/user.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L28) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +[models/user.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L31) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/user.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L40) + +___ + +### password\_hash + +• **password\_hash**: `string` + +#### Defined in + +[models/user.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L34) + +___ + +### role + +• **role**: [`UserRoles`](../enums/UserRoles.md) + +#### Defined in + +[models/user.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L21) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/user.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L42) diff --git a/docs/content/references/entities/enums/AllocationType.md b/docs/content/references/entities/enums/AllocationType.md new file mode 100644 index 0000000000..c96b0fc22a --- /dev/null +++ b/docs/content/references/entities/enums/AllocationType.md @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: AllocationType + +## Enumeration Members + +### ITEM + +• **ITEM** = ``"item"`` + +#### Defined in + +[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L16) + +___ + +### TOTAL + +• **TOTAL** = ``"total"`` + +#### Defined in + +[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L15) diff --git a/docs/content/references/entities/enums/CartType.md b/docs/content/references/entities/enums/CartType.md new file mode 100644 index 0000000000..1ec47af4a1 --- /dev/null +++ b/docs/content/references/entities/enums/CartType.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: CartType + +## Enumeration Members + +### CLAIM + +• **CLAIM** = ``"claim"`` + +#### Defined in + +[models/cart.ts:208](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L208) + +___ + +### DEFAULT + +• **DEFAULT** = ``"default"`` + +#### Defined in + +[models/cart.ts:204](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L204) + +___ + +### DRAFT\_ORDER + +• **DRAFT\_ORDER** = ``"draft_order"`` + +#### Defined in + +[models/cart.ts:206](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L206) + +___ + +### PAYMENT\_LINK + +• **PAYMENT\_LINK** = ``"payment_link"`` + +#### Defined in + +[models/cart.ts:207](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L207) + +___ + +### SWAP + +• **SWAP** = ``"swap"`` + +#### Defined in + +[models/cart.ts:205](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L205) diff --git a/docs/content/references/entities/enums/ClaimFulfillmentStatus.md b/docs/content/references/entities/enums/ClaimFulfillmentStatus.md new file mode 100644 index 0000000000..15b4be6e0b --- /dev/null +++ b/docs/content/references/entities/enums/ClaimFulfillmentStatus.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ClaimFulfillmentStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L45) + +___ + +### FULFILLED + +• **FULFILLED** = ``"fulfilled"`` + +#### Defined in + +[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L40) + +___ + +### NOT\_FULFILLED + +• **NOT\_FULFILLED** = ``"not_fulfilled"`` + +#### Defined in + +[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L38) + +___ + +### PARTIALLY\_FULFILLED + +• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` + +#### Defined in + +[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L39) + +___ + +### PARTIALLY\_RETURNED + +• **PARTIALLY\_RETURNED** = ``"partially_returned"`` + +#### Defined in + +[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L43) + +___ + +### PARTIALLY\_SHIPPED + +• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + +#### Defined in + +[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L41) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L46) + +___ + +### RETURNED + +• **RETURNED** = ``"returned"`` + +#### Defined in + +[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L44) + +___ + +### SHIPPED + +• **SHIPPED** = ``"shipped"`` + +#### Defined in + +[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L42) diff --git a/docs/content/references/entities/enums/ClaimPaymentStatus.md b/docs/content/references/entities/enums/ClaimPaymentStatus.md new file mode 100644 index 0000000000..a876a6262d --- /dev/null +++ b/docs/content/references/entities/enums/ClaimPaymentStatus.md @@ -0,0 +1,35 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ClaimPaymentStatus + +## Enumeration Members + +### NA + +• **NA** = ``"na"`` + +#### Defined in + +[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L32) + +___ + +### NOT\_REFUNDED + +• **NOT\_REFUNDED** = ``"not_refunded"`` + +#### Defined in + +[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L33) + +___ + +### REFUNDED + +• **REFUNDED** = ``"refunded"`` + +#### Defined in + +[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L34) diff --git a/docs/content/references/entities/enums/ClaimReason.md b/docs/content/references/entities/enums/ClaimReason.md new file mode 100644 index 0000000000..8a48fe1d82 --- /dev/null +++ b/docs/content/references/entities/enums/ClaimReason.md @@ -0,0 +1,45 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ClaimReason + +## Enumeration Members + +### MISSING\_ITEM + +• **MISSING\_ITEM** = ``"missing_item"`` + +#### Defined in + +[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L23) + +___ + +### OTHER + +• **OTHER** = ``"other"`` + +#### Defined in + +[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L26) + +___ + +### PRODUCTION\_FAILURE + +• **PRODUCTION\_FAILURE** = ``"production_failure"`` + +#### Defined in + +[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L25) + +___ + +### WRONG\_ITEM + +• **WRONG\_ITEM** = ``"wrong_item"`` + +#### Defined in + +[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L24) diff --git a/docs/content/references/entities/enums/ClaimType.md b/docs/content/references/entities/enums/ClaimType.md new file mode 100644 index 0000000000..e1c7bf91d9 --- /dev/null +++ b/docs/content/references/entities/enums/ClaimType.md @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ClaimType + +## Enumeration Members + +### REFUND + +• **REFUND** = ``"refund"`` + +#### Defined in + +[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L27) + +___ + +### REPLACE + +• **REPLACE** = ``"replace"`` + +#### Defined in + +[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L28) diff --git a/docs/content/references/entities/enums/DiscountConditionOperator.md b/docs/content/references/entities/enums/DiscountConditionOperator.md new file mode 100644 index 0000000000..d8fe97f0f0 --- /dev/null +++ b/docs/content/references/entities/enums/DiscountConditionOperator.md @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: DiscountConditionOperator + +## Enumeration Members + +### IN + +• **IN** = ``"in"`` + +#### Defined in + +[models/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L32) + +___ + +### NOT\_IN + +• **NOT\_IN** = ``"not_in"`` + +#### Defined in + +[models/discount-condition.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L33) diff --git a/docs/content/references/entities/enums/DiscountConditionType.md b/docs/content/references/entities/enums/DiscountConditionType.md new file mode 100644 index 0000000000..e44cfbf492 --- /dev/null +++ b/docs/content/references/entities/enums/DiscountConditionType.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: DiscountConditionType + +## Enumeration Members + +### CUSTOMER\_GROUPS + +• **CUSTOMER\_GROUPS** = ``"customer_groups"`` + +#### Defined in + +[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L28) + +___ + +### PRODUCTS + +• **PRODUCTS** = ``"products"`` + +#### Defined in + +[models/discount-condition.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L24) + +___ + +### PRODUCT\_COLLECTIONS + +• **PRODUCT\_COLLECTIONS** = ``"product_collections"`` + +#### Defined in + +[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L26) + +___ + +### PRODUCT\_TAGS + +• **PRODUCT\_TAGS** = ``"product_tags"`` + +#### Defined in + +[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L27) + +___ + +### PRODUCT\_TYPES + +• **PRODUCT\_TYPES** = ``"product_types"`` + +#### Defined in + +[models/discount-condition.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L25) diff --git a/docs/content/references/entities/enums/DiscountRuleType.md b/docs/content/references/entities/enums/DiscountRuleType.md new file mode 100644 index 0000000000..8875aac6ae --- /dev/null +++ b/docs/content/references/entities/enums/DiscountRuleType.md @@ -0,0 +1,35 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: DiscountRuleType + +## Enumeration Members + +### FIXED + +• **FIXED** = ``"fixed"`` + +#### Defined in + +[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L9) + +___ + +### FREE\_SHIPPING + +• **FREE\_SHIPPING** = ``"free_shipping"`` + +#### Defined in + +[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L11) + +___ + +### PERCENTAGE + +• **PERCENTAGE** = ``"percentage"`` + +#### Defined in + +[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L10) diff --git a/docs/content/references/entities/enums/DraftOrderStatus.md b/docs/content/references/entities/enums/DraftOrderStatus.md new file mode 100644 index 0000000000..587e0ba155 --- /dev/null +++ b/docs/content/references/entities/enums/DraftOrderStatus.md @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: DraftOrderStatus + +## Enumeration Members + +### COMPLETED + +• **COMPLETED** = ``"completed"`` + +#### Defined in + +[models/draft-order.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L24) + +___ + +### OPEN + +• **OPEN** = ``"open"`` + +#### Defined in + +[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L23) diff --git a/docs/content/references/entities/enums/FulfillmentStatus.md b/docs/content/references/entities/enums/FulfillmentStatus.md new file mode 100644 index 0000000000..76cd29b8da --- /dev/null +++ b/docs/content/references/entities/enums/FulfillmentStatus.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: FulfillmentStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/order.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L62) + +___ + +### FULFILLED + +• **FULFILLED** = ``"fulfilled"`` + +#### Defined in + +[models/order.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L57) + +___ + +### NOT\_FULFILLED + +• **NOT\_FULFILLED** = ``"not_fulfilled"`` + +#### Defined in + +[models/order.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L55) + +___ + +### PARTIALLY\_FULFILLED + +• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` + +#### Defined in + +[models/order.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L56) + +___ + +### PARTIALLY\_RETURNED + +• **PARTIALLY\_RETURNED** = ``"partially_returned"`` + +#### Defined in + +[models/order.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L60) + +___ + +### PARTIALLY\_SHIPPED + +• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + +#### Defined in + +[models/order.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L58) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/order.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L63) + +___ + +### RETURNED + +• **RETURNED** = ``"returned"`` + +#### Defined in + +[models/order.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L61) + +___ + +### SHIPPED + +• **SHIPPED** = ``"shipped"`` + +#### Defined in + +[models/order.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L59) diff --git a/docs/content/references/entities/enums/OrderStatus.md b/docs/content/references/entities/enums/OrderStatus.md new file mode 100644 index 0000000000..b246ba11da --- /dev/null +++ b/docs/content/references/entities/enums/OrderStatus.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: OrderStatus + +## Enumeration Members + +### ARCHIVED + +• **ARCHIVED** = ``"archived"`` + +#### Defined in + +[models/order.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L49) + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/order.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L50) + +___ + +### COMPLETED + +• **COMPLETED** = ``"completed"`` + +#### Defined in + +[models/order.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L48) + +___ + +### PENDING + +• **PENDING** = ``"pending"`` + +#### Defined in + +[models/order.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L47) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/order.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L51) diff --git a/docs/content/references/entities/enums/PaymentSessionStatus.md b/docs/content/references/entities/enums/PaymentSessionStatus.md new file mode 100644 index 0000000000..c8fc982bd4 --- /dev/null +++ b/docs/content/references/entities/enums/PaymentSessionStatus.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: PaymentSessionStatus + +## Enumeration Members + +### AUTHORIZED + +• **AUTHORIZED** = ``"authorized"`` + +#### Defined in + +[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L17) + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L21) + +___ + +### ERROR + +• **ERROR** = ``"error"`` + +#### Defined in + +[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L20) + +___ + +### PENDING + +• **PENDING** = ``"pending"`` + +#### Defined in + +[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L18) + +___ + +### REQUIRES\_MORE + +• **REQUIRES\_MORE** = ``"requires_more"`` + +#### Defined in + +[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L19) diff --git a/docs/content/references/entities/enums/PaymentStatus.md b/docs/content/references/entities/enums/PaymentStatus.md new file mode 100644 index 0000000000..327869e015 --- /dev/null +++ b/docs/content/references/entities/enums/PaymentStatus.md @@ -0,0 +1,75 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: PaymentStatus + +## Enumeration Members + +### AWAITING + +• **AWAITING** = ``"awaiting"`` + +#### Defined in + +[models/order.ts:68](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L68) + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/order.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L72) + +___ + +### CAPTURED + +• **CAPTURED** = ``"captured"`` + +#### Defined in + +[models/order.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L69) + +___ + +### NOT\_PAID + +• **NOT\_PAID** = ``"not_paid"`` + +#### Defined in + +[models/order.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L67) + +___ + +### PARTIALLY\_REFUNDED + +• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` + +#### Defined in + +[models/order.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L70) + +___ + +### REFUNDED + +• **REFUNDED** = ``"refunded"`` + +#### Defined in + +[models/order.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L71) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/order.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L73) diff --git a/docs/content/references/entities/enums/ProductStatus.md b/docs/content/references/entities/enums/ProductStatus.md new file mode 100644 index 0000000000..6f87419706 --- /dev/null +++ b/docs/content/references/entities/enums/ProductStatus.md @@ -0,0 +1,45 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ProductStatus + +## Enumeration Members + +### DRAFT + +• **DRAFT** = ``"draft"`` + +#### Defined in + +[models/product.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L28) + +___ + +### PROPOSED + +• **PROPOSED** = ``"proposed"`` + +#### Defined in + +[models/product.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L29) + +___ + +### PUBLISHED + +• **PUBLISHED** = ``"published"`` + +#### Defined in + +[models/product.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L30) + +___ + +### REJECTED + +• **REJECTED** = ``"rejected"`` + +#### Defined in + +[models/product.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L31) diff --git a/docs/content/references/entities/enums/RefundReason.md b/docs/content/references/entities/enums/RefundReason.md new file mode 100644 index 0000000000..618a71ae68 --- /dev/null +++ b/docs/content/references/entities/enums/RefundReason.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: RefundReason + +## Enumeration Members + +### CLAIM + +• **CLAIM** = ``"claim"`` + +#### Defined in + +[models/refund.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L19) + +___ + +### DISCOUNT + +• **DISCOUNT** = ``"discount"`` + +#### Defined in + +[models/refund.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L16) + +___ + +### OTHER + +• **OTHER** = ``"other"`` + +#### Defined in + +[models/refund.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L20) + +___ + +### RETURN + +• **RETURN** = ``"return"`` + +#### Defined in + +[models/refund.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L17) + +___ + +### SWAP + +• **SWAP** = ``"swap"`` + +#### Defined in + +[models/refund.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L18) diff --git a/docs/content/references/entities/enums/RequirementType.md b/docs/content/references/entities/enums/RequirementType.md new file mode 100644 index 0000000000..5caafb5c3d --- /dev/null +++ b/docs/content/references/entities/enums/RequirementType.md @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: RequirementType + +## Enumeration Members + +### MAX\_SUBTOTAL + +• **MAX\_SUBTOTAL** = ``"max_subtotal"`` + +#### Defined in + +[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L18) + +___ + +### MIN\_SUBTOTAL + +• **MIN\_SUBTOTAL** = ``"min_subtotal"`` + +#### Defined in + +[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L17) diff --git a/docs/content/references/entities/enums/ReturnStatus.md b/docs/content/references/entities/enums/ReturnStatus.md new file mode 100644 index 0000000000..23ae76c4b0 --- /dev/null +++ b/docs/content/references/entities/enums/ReturnStatus.md @@ -0,0 +1,45 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ReturnStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/return.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L25) + +___ + +### RECEIVED + +• **RECEIVED** = ``"received"`` + +#### Defined in + +[models/return.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L23) + +___ + +### REQUESTED + +• **REQUESTED** = ``"requested"`` + +#### Defined in + +[models/return.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L22) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/return.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L24) diff --git a/docs/content/references/entities/enums/ShippingOptionPriceType.md b/docs/content/references/entities/enums/ShippingOptionPriceType.md new file mode 100644 index 0000000000..63fc20b106 --- /dev/null +++ b/docs/content/references/entities/enums/ShippingOptionPriceType.md @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ShippingOptionPriceType + +## Enumeration Members + +### CALCULATED + +• **CALCULATED** = ``"calculated"`` + +#### Defined in + +[models/shipping-option.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L22) + +___ + +### FLAT\_RATE + +• **FLAT\_RATE** = ``"flat_rate"`` + +#### Defined in + +[models/shipping-option.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L21) diff --git a/docs/content/references/entities/enums/ShippingProfileType.md b/docs/content/references/entities/enums/ShippingProfileType.md new file mode 100644 index 0000000000..5d201a7dad --- /dev/null +++ b/docs/content/references/entities/enums/ShippingProfileType.md @@ -0,0 +1,35 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: ShippingProfileType + +## Enumeration Members + +### CUSTOM + +• **CUSTOM** = ``"custom"`` + +#### Defined in + +[models/shipping-profile.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L12) + +___ + +### DEFAULT + +• **DEFAULT** = ``"default"`` + +#### Defined in + +[models/shipping-profile.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L10) + +___ + +### GIFT\_CARD + +• **GIFT\_CARD** = ``"gift_card"`` + +#### Defined in + +[models/shipping-profile.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L11) diff --git a/docs/content/references/entities/enums/SwapFulfillmentStatus.md b/docs/content/references/entities/enums/SwapFulfillmentStatus.md new file mode 100644 index 0000000000..76df627714 --- /dev/null +++ b/docs/content/references/entities/enums/SwapFulfillmentStatus.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: SwapFulfillmentStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/swap.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L28) + +___ + +### FULFILLED + +• **FULFILLED** = ``"fulfilled"`` + +#### Defined in + +[models/swap.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L26) + +___ + +### NOT\_FULFILLED + +• **NOT\_FULFILLED** = ``"not_fulfilled"`` + +#### Defined in + +[models/swap.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L25) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/swap.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L29) + +___ + +### SHIPPED + +• **SHIPPED** = ``"shipped"`` + +#### Defined in + +[models/swap.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L27) diff --git a/docs/content/references/entities/enums/SwapPaymentStatus.md b/docs/content/references/entities/enums/SwapPaymentStatus.md new file mode 100644 index 0000000000..b5b9a9ea2f --- /dev/null +++ b/docs/content/references/entities/enums/SwapPaymentStatus.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: SwapPaymentStatus + +## Enumeration Members + +### AWAITING + +• **AWAITING** = ``"awaiting"`` + +#### Defined in + +[models/swap.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L34) + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/swap.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L37) + +___ + +### CAPTURED + +• **CAPTURED** = ``"captured"`` + +#### Defined in + +[models/swap.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L35) + +___ + +### CONFIRMED + +• **CONFIRMED** = ``"confirmed"`` + +#### Defined in + +[models/swap.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L36) + +___ + +### DIFFERENCE\_REFUNDED + +• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"`` + +#### Defined in + +[models/swap.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L38) + +___ + +### NOT\_PAID + +• **NOT\_PAID** = ``"not_paid"`` + +#### Defined in + +[models/swap.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L33) + +___ + +### PARTIALLY\_REFUNDED + +• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` + +#### Defined in + +[models/swap.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L39) + +___ + +### REFUNDED + +• **REFUNDED** = ``"refunded"`` + +#### Defined in + +[models/swap.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L40) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/swap.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L41) diff --git a/docs/content/references/entities/enums/UserRoles.md b/docs/content/references/entities/enums/UserRoles.md new file mode 100644 index 0000000000..f889e37eaa --- /dev/null +++ b/docs/content/references/entities/enums/UserRoles.md @@ -0,0 +1,35 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: UserRoles + +## Enumeration Members + +### ADMIN + +• **ADMIN** = ``"admin"`` + +#### Defined in + +[models/user.ts:8](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L8) + +___ + +### DEVELOPER + +• **DEVELOPER** = ``"developer"`` + +#### Defined in + +[models/user.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L10) + +___ + +### MEMBER + +• **MEMBER** = ``"member"`` + +#### Defined in + +[models/user.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L9) diff --git a/docs/content/references/entities/index.md b/docs/content/references/entities/index.md new file mode 100644 index 0000000000..20e64ea0d1 --- /dev/null +++ b/docs/content/references/entities/index.md @@ -0,0 +1,103 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Entities Reference + +## Enumerations + +- [AllocationType](enums/AllocationType.md) +- [CartType](enums/CartType.md) +- [ClaimFulfillmentStatus](enums/ClaimFulfillmentStatus.md) +- [ClaimPaymentStatus](enums/ClaimPaymentStatus.md) +- [ClaimReason](enums/ClaimReason.md) +- [ClaimType](enums/ClaimType.md) +- [DiscountConditionOperator](enums/DiscountConditionOperator.md) +- [DiscountConditionType](enums/DiscountConditionType.md) +- [DiscountRuleType](enums/DiscountRuleType.md) +- [DraftOrderStatus](enums/DraftOrderStatus.md) +- [FulfillmentStatus](enums/FulfillmentStatus.md) +- [OrderStatus](enums/OrderStatus.md) +- [PaymentSessionStatus](enums/PaymentSessionStatus.md) +- [PaymentStatus](enums/PaymentStatus.md) +- [ProductStatus](enums/ProductStatus.md) +- [RefundReason](enums/RefundReason.md) +- [RequirementType](enums/RequirementType.md) +- [ReturnStatus](enums/ReturnStatus.md) +- [ShippingOptionPriceType](enums/ShippingOptionPriceType.md) +- [ShippingProfileType](enums/ShippingProfileType.md) +- [SwapFulfillmentStatus](enums/SwapFulfillmentStatus.md) +- [SwapPaymentStatus](enums/SwapPaymentStatus.md) +- [UserRoles](enums/UserRoles.md) + +## Classes + +- [Address](classes/Address.md) +- [BatchJob](classes/BatchJob.md) +- [Cart](classes/Cart.md) +- [ClaimImage](classes/ClaimImage.md) +- [ClaimItem](classes/ClaimItem.md) +- [ClaimOrder](classes/ClaimOrder.md) +- [ClaimTag](classes/ClaimTag.md) +- [Country](classes/Country.md) +- [Currency](classes/Currency.md) +- [CustomShippingOption](classes/CustomShippingOption.md) +- [Customer](classes/Customer.md) +- [CustomerGroup](classes/CustomerGroup.md) +- [Discount](classes/Discount.md) +- [DiscountCondition](classes/DiscountCondition.md) +- [DiscountConditionCustomerGroup](classes/DiscountConditionCustomerGroup.md) +- [DiscountConditionProduct](classes/DiscountConditionProduct.md) +- [DiscountConditionProductCollection](classes/DiscountConditionProductCollection.md) +- [DiscountConditionProductTag](classes/DiscountConditionProductTag.md) +- [DiscountConditionProductType](classes/DiscountConditionProductType.md) +- [DiscountRule](classes/DiscountRule.md) +- [DraftOrder](classes/DraftOrder.md) +- [Fulfillment](classes/Fulfillment.md) +- [FulfillmentItem](classes/FulfillmentItem.md) +- [FulfillmentProvider](classes/FulfillmentProvider.md) +- [GiftCard](classes/GiftCard.md) +- [GiftCardTransaction](classes/GiftCardTransaction.md) +- [IdempotencyKey](classes/IdempotencyKey.md) +- [Image](classes/Image.md) +- [Invite](classes/Invite.md) +- [LineItem](classes/LineItem.md) +- [LineItemAdjustment](classes/LineItemAdjustment.md) +- [LineItemTaxLine](classes/LineItemTaxLine.md) +- [MoneyAmount](classes/MoneyAmount.md) +- [Note](classes/Note.md) +- [Notification](classes/Notification.md) +- [Oauth](classes/Oauth.md) +- [Order](classes/Order.md) +- [Payment](classes/Payment.md) +- [PaymentProvider](classes/PaymentProvider.md) +- [PaymentSession](classes/PaymentSession.md) +- [PriceList](classes/PriceList.md) +- [Product](classes/Product.md) +- [ProductCollection](classes/ProductCollection.md) +- [ProductOption](classes/ProductOption.md) +- [ProductOptionValue](classes/ProductOptionValue.md) +- [ProductTag](classes/ProductTag.md) +- [ProductTaxRate](classes/ProductTaxRate.md) +- [ProductType](classes/ProductType.md) +- [ProductTypeTaxRate](classes/ProductTypeTaxRate.md) +- [ProductVariant](classes/ProductVariant.md) +- [Refund](classes/Refund.md) +- [Region](classes/Region.md) +- [Return](classes/Return.md) +- [ReturnItem](classes/ReturnItem.md) +- [ReturnReason](classes/ReturnReason.md) +- [SalesChannel](classes/SalesChannel.md) +- [ShippingMethod](classes/ShippingMethod.md) +- [ShippingMethodTaxLine](classes/ShippingMethodTaxLine.md) +- [ShippingOption](classes/ShippingOption.md) +- [ShippingOptionRequirement](classes/ShippingOptionRequirement.md) +- [ShippingProfile](classes/ShippingProfile.md) +- [ShippingTaxRate](classes/ShippingTaxRate.md) +- [StagedJob](classes/StagedJob.md) +- [Store](classes/Store.md) +- [Swap](classes/Swap.md) +- [TaxProvider](classes/TaxProvider.md) +- [TaxRate](classes/TaxRate.md) +- [TrackingLink](classes/TrackingLink.md) +- [User](classes/User.md) diff --git a/package.json b/package.json index 2574de68f7..e5b08d1445 100644 --- a/package.json +++ b/package.json @@ -71,6 +71,7 @@ "openapi:generate": "node ./scripts/build-openapi.js", "generate:services": "typedoc --options typedoc.services.js", "generate:js-client": "typedoc --options typedoc.js-client.js", + "generate:entities": "typedoc --options typedoc.entities.js", "release:snapshot": "changeset publish --no-git-tags --snapshot --tag snapshot" }, "dependencies": { diff --git a/typedoc.entities.js b/typedoc.entities.js new file mode 100644 index 0000000000..bec60ab2f8 --- /dev/null +++ b/typedoc.entities.js @@ -0,0 +1,17 @@ +const globalTypedocOptions = require("./typedoc") + +module.exports = { + ...globalTypedocOptions, + entryPoints: ["packages/medusa/src/models/index.ts"], + out: ["docs/content/references/entities"], + tsconfig: "packages/medusa/tsconfig.json", + name: "Entities Reference", + indexTitle: "Entities Reference", + entryDocument: "index.md", + hideInPageTOC: true, + hideBreadcrumbs: true, + plugin: [...globalTypedocOptions.plugin, "typedoc-frontmatter-plugin"], + frontmatterData: { + displayed_sidebar: "entitiesSidebar", + }, +} diff --git a/www/docs/docusaurus.config.js b/www/docs/docusaurus.config.js index 678dc92523..cd7889e104 100644 --- a/www/docs/docusaurus.config.js +++ b/www/docs/docusaurus.config.js @@ -96,6 +96,11 @@ module.exports = { to: "cli/reference", label: "CLI Reference", }, + { + type: "docSidebar", + sidebarId: "entitiesSidebar", + label: "Entities Reference", + }, { to: "advanced/backend/subscribers/events-list", label: "Events Reference", diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index ea77fefcbc..2903eb728c 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -751,5 +751,11 @@ module.exports = { }, ] } - ] + ], + entitiesSidebar: [ + { + type: 'autogenerated', + dirName: 'references/entities/classes', // generate sidebar from the docs folder (or versioned_docs/) + }, + ], } From a743752d4f5354e5c2d3e78edc7290ba7668547e Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 16 Aug 2022 11:54:42 +0300 Subject: [PATCH 09/19] docs: added search track event (#2051) * added search track event * handle all search inputs events --- www/docs/src/theme/SearchBar/index.js | 34 ++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/www/docs/src/theme/SearchBar/index.js b/www/docs/src/theme/SearchBar/index.js index 381d9012c0..4d3a68954e 100644 --- a/www/docs/src/theme/SearchBar/index.js +++ b/www/docs/src/theme/SearchBar/index.js @@ -1,7 +1,39 @@ -import React from 'react'; +import React, { useEffect } from 'react'; + import SearchBar from '@theme-original/SearchBar'; +import useIsBrowser from '@docusaurus/useIsBrowser'; +import {useLocation} from '@docusaurus/router'; export default function SearchBarWrapper(props) { + + const isBrowser = useIsBrowser(); + const location = useLocation(); + + useEffect(() => { + if (isBrowser) { + + function trackSearch(e) { + if (!e.target.classList.contains('DocSearch-Input') && !(e.target.tagName.toLowerCase() === "input" && e.target.getAttribute('type') === 'search')) { + return; + } + + const query = e.target.value; + if (query.length >= 3) { + //send event to segment + window.analytics.track('search', { + query + }); + } + } + + document.body.addEventListener('keyup', trackSearch); + + return () => { + document.body.removeEventListener('keyup', trackSearch); + } + } + }, [isBrowser, location.pathname]); + return ( <> From a551bd46642e0a828ae1ccd718006a3390f5b331 Mon Sep 17 00:00:00 2001 From: Himanshu Singh Date: Mon, 22 Aug 2022 13:16:55 +0530 Subject: [PATCH 10/19] docs: update homepage.md (#2063) Change the broken url in the Overview Page --- docs/content/homepage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/homepage.md b/docs/content/homepage.md index be74edfe54..cd79110e51 100644 --- a/docs/content/homepage.md +++ b/docs/content/homepage.md @@ -56,7 +56,7 @@ The final step is to set up a storefront to sell your products. Medusa provides 2 starter storefronts, one built with [Next.js](./starters/nextjs-medusa-starter.md) and one with [Gatsby](./starters/gatsby-medusa-starter.md), that you can use to quickly set up your store and start selling. -Alternatively, you can build your own storefront with any frontend framework of your choice just by connecting to your server with the [Storefront REST APIs](https://docs.medusajs.com/api/store/collection). +Alternatively, you can build your own storefront with any frontend framework of your choice just by connecting to your server with the [Storefront REST APIs](https://docs.medusajs.com/api/store/). ## What’s Next 🚀 From 7d6f33baf1c176c18dc08302284962c331240bb7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 22 Aug 2022 10:51:17 +0300 Subject: [PATCH 11/19] chore(docs): Generated Entities Reference (automated) (#2060) --- .../references/entities/classes/Address.md | 38 +++---- .../references/entities/classes/BatchJob.md | 40 +++---- .../references/entities/classes/Cart.md | 82 +++++++------- .../references/entities/classes/ClaimImage.md | 18 +-- .../references/entities/classes/ClaimItem.md | 34 +++--- .../references/entities/classes/ClaimOrder.md | 44 ++++---- .../references/entities/classes/ClaimTag.md | 14 +-- .../references/entities/classes/Country.md | 16 +-- .../references/entities/classes/Currency.md | 8 +- .../entities/classes/CustomShippingOption.md | 22 ++-- .../references/entities/classes/Customer.md | 34 +++--- .../entities/classes/CustomerGroup.md | 18 +-- .../references/entities/classes/Discount.md | 38 +++---- .../entities/classes/DiscountCondition.md | 30 ++--- .../classes/DiscountConditionCustomerGroup.md | 14 +-- .../classes/DiscountConditionProduct.md | 14 +-- .../DiscountConditionProductCollection.md | 14 +-- .../classes/DiscountConditionProductTag.md | 14 +-- .../classes/DiscountConditionProductType.md | 14 +-- .../entities/classes/DiscountRule.md | 22 ++-- .../references/entities/classes/DraftOrder.md | 30 ++--- .../entities/classes/Fulfillment.md | 42 +++---- .../entities/classes/FulfillmentItem.md | 10 +- .../entities/classes/FulfillmentProvider.md | 4 +- .../references/entities/classes/GiftCard.md | 30 ++--- .../entities/classes/GiftCardTransaction.md | 20 ++-- .../entities/classes/IdempotencyKey.md | 22 ++-- .../references/entities/classes/Image.md | 14 +-- .../references/entities/classes/Invite.md | 22 ++-- .../references/entities/classes/LineItem.md | 76 ++++++------- .../entities/classes/LineItemAdjustment.md | 18 +-- .../entities/classes/LineItemTaxLine.md | 20 ++-- .../entities/classes/MoneyAmount.md | 32 +++--- .../references/entities/classes/Note.md | 22 ++-- .../entities/classes/Notification.md | 32 +++--- .../references/entities/classes/Oauth.md | 14 +-- .../references/entities/classes/Order.md | 106 +++++++++--------- .../references/entities/classes/Payment.md | 44 ++++---- .../entities/classes/PaymentProvider.md | 4 +- .../entities/classes/PaymentSession.md | 22 ++-- .../references/entities/classes/PriceList.md | 26 ++--- .../references/entities/classes/Product.md | 68 +++++------ .../entities/classes/ProductCollection.md | 18 +-- .../entities/classes/ProductOption.md | 20 ++-- .../entities/classes/ProductOptionValue.md | 22 ++-- .../references/entities/classes/ProductTag.md | 14 +-- .../entities/classes/ProductTaxRate.md | 14 +-- .../entities/classes/ProductType.md | 14 +-- .../entities/classes/ProductTypeTaxRate.md | 14 +-- .../entities/classes/ProductVariant.md | 54 ++++----- .../references/entities/classes/Refund.md | 22 ++-- .../references/entities/classes/Region.md | 38 +++---- .../references/entities/classes/Return.md | 38 +++---- .../references/entities/classes/ReturnItem.md | 24 ++-- .../entities/classes/ReturnReason.md | 24 ++-- .../entities/classes/SalesChannel.md | 16 +-- .../entities/classes/ShippingMethod.md | 34 +++--- .../entities/classes/ShippingMethodTaxLine.md | 20 ++-- .../entities/classes/ShippingOption.md | 38 +++---- .../classes/ShippingOptionRequirement.md | 14 +-- .../entities/classes/ShippingProfile.md | 20 ++-- .../entities/classes/ShippingTaxRate.md | 14 +-- .../references/entities/classes/StagedJob.md | 8 +- .../references/entities/classes/Store.md | 28 ++--- .../references/entities/classes/Swap.md | 50 ++++----- .../entities/classes/TaxProvider.md | 4 +- .../references/entities/classes/TaxRate.md | 32 +++--- .../entities/classes/TrackingLink.md | 22 ++-- .../references/entities/classes/User.md | 24 ++-- .../entities/enums/AllocationType.md | 4 +- .../references/entities/enums/CartType.md | 10 +- .../entities/enums/ClaimFulfillmentStatus.md | 18 +-- .../entities/enums/ClaimPaymentStatus.md | 6 +- .../references/entities/enums/ClaimReason.md | 8 +- .../references/entities/enums/ClaimType.md | 4 +- .../enums/DiscountConditionOperator.md | 4 +- .../entities/enums/DiscountConditionType.md | 10 +- .../entities/enums/DiscountRuleType.md | 6 +- .../entities/enums/DraftOrderStatus.md | 4 +- .../entities/enums/FulfillmentStatus.md | 18 +-- .../references/entities/enums/OrderStatus.md | 10 +- .../entities/enums/PaymentSessionStatus.md | 10 +- .../entities/enums/PaymentStatus.md | 14 +-- .../entities/enums/ProductStatus.md | 8 +- .../references/entities/enums/RefundReason.md | 10 +- .../entities/enums/RequirementType.md | 4 +- .../references/entities/enums/ReturnStatus.md | 8 +- .../entities/enums/ShippingOptionPriceType.md | 4 +- .../entities/enums/ShippingProfileType.md | 6 +- .../entities/enums/SwapFulfillmentStatus.md | 10 +- .../entities/enums/SwapPaymentStatus.md | 18 +-- .../references/entities/enums/UserRoles.md | 6 +- 92 files changed, 1023 insertions(+), 1023 deletions(-) diff --git a/docs/content/references/entities/classes/Address.md b/docs/content/references/entities/classes/Address.md index d412ba8964..82b7eb59b5 100644 --- a/docs/content/references/entities/classes/Address.md +++ b/docs/content/references/entities/classes/Address.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/address.ts:120](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L120) +[models/address.ts:120](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L120) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/address.ts:123](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L123) +[models/address.ts:123](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L123) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/address.ts:126](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L126) +[models/address.ts:126](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L126) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/address.ts:111](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L111) +[models/address.ts:111](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L111) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/address.ts:133](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L133) +[models/address.ts:133](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L133) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/address.ts:129](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L129) +[models/address.ts:129](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L129) ___ @@ -92,7 +92,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/address.ts:108](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L108) +[models/address.ts:108](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L108) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/address.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L104) +[models/address.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L104) ___ @@ -126,7 +126,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/address.ts:114](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L114) +[models/address.ts:114](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L114) ___ @@ -150,7 +150,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/address.ts:117](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L117) +[models/address.ts:117](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L117) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/address.ts:145](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L145) +[models/address.ts:145](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L145) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/address.ts:142](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L142) +[models/address.ts:142](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L142) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/address.ts:139](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L139) +[models/address.ts:139](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L139) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/address.ts:136](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L136) +[models/address.ts:136](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L136) ___ @@ -214,7 +214,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -228,4 +228,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/address.ts:147](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/address.ts#L147) +[models/address.ts:147](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L147) diff --git a/docs/content/references/entities/classes/BatchJob.md b/docs/content/references/entities/classes/BatchJob.md index 0d9393b291..b47a9454eb 100644 --- a/docs/content/references/entities/classes/BatchJob.md +++ b/docs/content/references/entities/classes/BatchJob.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L62) +[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L62) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L59) +[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L59) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L56) +[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L56) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L33) +[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L33) ___ @@ -72,7 +72,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L26) +[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L26) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L30) +[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L30) ___ @@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L47) +[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L47) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L65) +[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L65) ___ @@ -140,7 +140,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L50) +[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L50) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L53) +[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L53) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L36) +[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L36) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L67) +[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L67) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L23) +[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L23) ___ @@ -204,7 +204,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -218,7 +218,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L94) +[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L94) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L69) +[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L69) ___ @@ -246,4 +246,4 @@ ___ #### Defined in -[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/batch-job.ts#L99) +[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L99) diff --git a/docs/content/references/entities/classes/Cart.md b/docs/content/references/entities/classes/Cart.md index b6c2d9c781..69eded2b05 100644 --- a/docs/content/references/entities/classes/Cart.md +++ b/docs/content/references/entities/classes/Cart.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/cart.ts:226](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L226) +[models/cart.ts:226](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L226) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/cart.ts:220](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L220) +[models/cart.ts:220](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L220) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/cart.ts:311](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L311) +[models/cart.ts:311](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L311) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/cart.ts:320](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L320) +[models/cart.ts:320](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L320) ___ @@ -72,7 +72,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/cart.ts:285](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L285) +[models/cart.ts:285](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L285) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[models/cart.ts:281](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L281) +[models/cart.ts:281](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L281) ___ @@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/cart.ts:335](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L335) +[models/cart.ts:335](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L335) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/cart.ts:263](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L263) +[models/cart.ts:263](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L263) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/cart.ts:216](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L216) +[models/cart.ts:216](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L216) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/cart.ts:342](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L342) +[models/cart.ts:342](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L342) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/cart.ts:341](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L341) +[models/cart.ts:341](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L341) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/cart.ts:277](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L277) +[models/cart.ts:277](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L277) ___ @@ -180,7 +180,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/cart.ts:317](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L317) +[models/cart.ts:317](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L317) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/cart.ts:241](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L241) +[models/cart.ts:241](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L241) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/cart.ts:323](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L323) +[models/cart.ts:323](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L323) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/cart.ts:213](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L213) +[models/cart.ts:213](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L213) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/cart.ts:300](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L300) +[models/cart.ts:300](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L300) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[models/cart.ts:314](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L314) +[models/cart.ts:314](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L314) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[models/cart.ts:296](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L296) +[models/cart.ts:296](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L296) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[models/cart.ts:287](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L287) +[models/cart.ts:287](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L287) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[models/cart.ts:292](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L292) +[models/cart.ts:292](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L292) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[models/cart.ts:340](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L340) +[models/cart.ts:340](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L340) ___ @@ -290,7 +290,7 @@ ___ #### Defined in -[models/cart.ts:337](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L337) +[models/cart.ts:337](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L337) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[models/cart.ts:249](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L249) +[models/cart.ts:249](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L249) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -[models/cart.ts:245](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L245) +[models/cart.ts:245](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L245) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[models/cart.ts:332](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L332) +[models/cart.ts:332](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L332) ___ @@ -330,7 +330,7 @@ ___ #### Defined in -[models/cart.ts:326](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L326) +[models/cart.ts:326](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L326) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[models/cart.ts:236](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L236) +[models/cart.ts:236](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L236) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -[models/cart.ts:230](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L230) +[models/cart.ts:230](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L230) ___ @@ -360,7 +360,7 @@ ___ #### Defined in -[models/cart.ts:305](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L305) +[models/cart.ts:305](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L305) ___ @@ -370,7 +370,7 @@ ___ #### Defined in -[models/cart.ts:334](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L334) +[models/cart.ts:334](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L334) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[models/cart.ts:339](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L339) +[models/cart.ts:339](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L339) ___ @@ -390,7 +390,7 @@ ___ #### Defined in -[models/cart.ts:336](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L336) +[models/cart.ts:336](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L336) ___ @@ -400,7 +400,7 @@ ___ #### Defined in -[models/cart.ts:338](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L338) +[models/cart.ts:338](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L338) ___ @@ -410,7 +410,7 @@ ___ #### Defined in -[models/cart.ts:308](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L308) +[models/cart.ts:308](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L308) ___ @@ -424,7 +424,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -438,7 +438,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/cart.ts:344](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L344) +[models/cart.ts:344](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L344) ___ @@ -452,4 +452,4 @@ ___ #### Defined in -[models/cart.ts:351](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L351) +[models/cart.ts:351](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L351) diff --git a/docs/content/references/entities/classes/ClaimImage.md b/docs/content/references/entities/classes/ClaimImage.md index cf0d79df97..5be26caa05 100644 --- a/docs/content/references/entities/classes/ClaimImage.md +++ b/docs/content/references/entities/classes/ClaimImage.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L23) +[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L23) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L19) +[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L19) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L29) +[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L29) ___ @@ -104,7 +104,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L26) +[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L26) ## Methods @@ -128,4 +128,4 @@ ___ #### Defined in -[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-image.ts#L31) +[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L31) diff --git a/docs/content/references/entities/classes/ClaimItem.md b/docs/content/references/entities/classes/ClaimItem.md index 719cc83848..d97b110299 100644 --- a/docs/content/references/entities/classes/ClaimItem.md +++ b/docs/content/references/entities/classes/ClaimItem.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L42) +[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L42) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L38) +[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L38) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L34) +[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L34) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L50) +[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L50) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L46) +[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L46) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L84) +[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L84) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L64) +[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L64) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L67) +[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L67) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L61) +[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L61) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L81) +[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L81) ___ @@ -174,7 +174,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L58) +[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L58) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L54) +[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L54) ## Methods @@ -208,4 +208,4 @@ ___ #### Defined in -[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L86) +[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L86) diff --git a/docs/content/references/entities/classes/ClaimOrder.md b/docs/content/references/entities/classes/ClaimOrder.md index 6802121fa1..8d31d66641 100644 --- a/docs/content/references/entities/classes/ClaimOrder.md +++ b/docs/content/references/entities/classes/ClaimOrder.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L69) +[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L69) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L107) +[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L107) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L66) +[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L66) ___ @@ -62,7 +62,7 @@ SoftDeletableEntity.created\_at #### Defined in -[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L110) +[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L110) ___ @@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L116) +[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L116) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L63) +[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L63) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L101) +[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L101) ___ @@ -110,7 +110,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L125) +[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L125) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L122) +[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L122) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L119) +[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L119) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L80) +[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L80) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L76) +[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L76) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L56) +[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L56) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L104) +[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L104) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L83) +[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L83) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L91) +[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L91) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L87) +[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L87) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L96) +[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L96) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L72) +[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L72) ___ @@ -244,7 +244,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L113) +[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L113) ## Methods @@ -258,4 +258,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L127) +[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L127) diff --git a/docs/content/references/entities/classes/ClaimTag.md b/docs/content/references/entities/classes/ClaimTag.md index 1cfd7dd326..fd1fa58753 100644 --- a/docs/content/references/entities/classes/ClaimTag.md +++ b/docs/content/references/entities/classes/ClaimTag.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-tag.ts#L14) +[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-tag.ts#L14) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-tag.ts#L11) +[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-tag.ts#L11) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-tag.ts#L16) +[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-tag.ts#L16) diff --git a/docs/content/references/entities/classes/Country.md b/docs/content/references/entities/classes/Country.md index e94d71942a..ed067997e5 100644 --- a/docs/content/references/entities/classes/Country.md +++ b/docs/content/references/entities/classes/Country.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/country.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L31) +[models/country.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L31) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/country.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L15) +[models/country.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L15) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/country.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L19) +[models/country.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L19) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/country.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L22) +[models/country.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L22) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/country.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L28) +[models/country.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L28) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/country.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L25) +[models/country.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L25) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/country.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L39) +[models/country.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L39) ___ @@ -88,4 +88,4 @@ ___ #### Defined in -[models/country.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/country.ts#L35) +[models/country.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L35) diff --git a/docs/content/references/entities/classes/Currency.md b/docs/content/references/entities/classes/Currency.md index ff3bff3c02..8bd6c1ae68 100644 --- a/docs/content/references/entities/classes/Currency.md +++ b/docs/content/references/entities/classes/Currency.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/currency.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L6) +[models/currency.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L6) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/currency.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L15) +[models/currency.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L15) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/currency.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L9) +[models/currency.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L9) ___ @@ -48,4 +48,4 @@ ___ #### Defined in -[models/currency.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/currency.ts#L12) +[models/currency.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L12) diff --git a/docs/content/references/entities/classes/CustomShippingOption.md b/docs/content/references/entities/classes/CustomShippingOption.md index 1a7ebd7a7a..1fc4e4d3d5 100644 --- a/docs/content/references/entities/classes/CustomShippingOption.md +++ b/docs/content/references/entities/classes/CustomShippingOption.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L37) +[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L37) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L33) +[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L33) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L40) +[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L40) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L21) +[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L21) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L29) +[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L29) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L25) +[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L25) ___ @@ -134,7 +134,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -148,4 +148,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L42) +[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L42) diff --git a/docs/content/references/entities/classes/Customer.md b/docs/content/references/entities/classes/Customer.md index 68d74df196..eac3024db0 100644 --- a/docs/content/references/entities/classes/Customer.md +++ b/docs/content/references/entities/classes/Customer.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/customer.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L38) +[models/customer.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L38) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/customer.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L34) +[models/customer.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L34) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/customer.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L24) +[models/customer.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L24) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/customer.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L27) +[models/customer.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L27) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/customer.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L69) +[models/customer.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L69) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/customer.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L50) +[models/customer.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L50) ___ @@ -120,7 +120,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/customer.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L30) +[models/customer.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L30) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/customer.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L72) +[models/customer.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L72) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/customer.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L53) +[models/customer.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L53) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/customer.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L44) +[models/customer.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L44) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/customer.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L47) +[models/customer.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L47) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/customer.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L41) +[models/customer.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L41) ___ @@ -194,7 +194,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -208,4 +208,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/customer.ts:74](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer.ts#L74) +[models/customer.ts:74](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L74) diff --git a/docs/content/references/entities/classes/CustomerGroup.md b/docs/content/references/entities/classes/CustomerGroup.md index 0461aa7f30..6fa1cbe888 100644 --- a/docs/content/references/entities/classes/CustomerGroup.md +++ b/docs/content/references/entities/classes/CustomerGroup.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L18) +[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L18) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L26) +[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L26) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L13) +[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L23) +[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L23) ___ @@ -114,7 +114,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -128,4 +128,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/customer-group.ts#L28) +[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L28) diff --git a/docs/content/references/entities/classes/Discount.md b/docs/content/references/entities/classes/Discount.md index f4a3581e2b..d4251b818c 100644 --- a/docs/content/references/entities/classes/Discount.md +++ b/docs/content/references/entities/classes/Discount.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/discount.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L22) +[models/discount.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L22) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/discount.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L52) +[models/discount.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L52) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/discount.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L36) +[models/discount.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L36) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/discount.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L25) +[models/discount.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L25) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/discount.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L78) +[models/discount.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L78) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/discount.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L43) +[models/discount.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L43) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/discount.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L39) +[models/discount.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L39) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/discount.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L69) +[models/discount.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L69) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/discount.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L33) +[models/discount.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L33) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/discount.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L29) +[models/discount.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L29) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/discount.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L49) +[models/discount.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L49) ___ @@ -184,7 +184,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[models/discount.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L75) +[models/discount.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L75) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[models/discount.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L72) +[models/discount.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L72) ___ @@ -214,7 +214,7 @@ ___ #### Defined in -[models/discount.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L55) +[models/discount.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L55) ## Methods @@ -228,4 +228,4 @@ ___ #### Defined in -[models/discount.ts:80](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount.ts#L80) +[models/discount.ts:80](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L80) diff --git a/docs/content/references/entities/classes/DiscountCondition.md b/docs/content/references/entities/classes/DiscountCondition.md index affb51fd66..dbf6ce7336 100644 --- a/docs/content/references/entities/classes/DiscountCondition.md +++ b/docs/content/references/entities/classes/DiscountCondition.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L127) +[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L127) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L57) +[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L57) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L53) +[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L53) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L130) +[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L130) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L49) +[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L49) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L113) +[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L113) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L99) +[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L99) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L85) +[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L85) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L71) +[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L71) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L43) +[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L43) ___ @@ -174,7 +174,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -188,4 +188,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L132) +[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L132) diff --git a/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md b/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md index c85fd6f727..2118a24c66 100644 --- a/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md +++ b/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L20) +[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L31) +[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L24) +[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L17) +[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L17) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L28) +[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L28) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L37) +[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L37) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-customer-group.ts#L34) +[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProduct.md b/docs/content/references/entities/classes/DiscountConditionProduct.md index b6803a3b0f..d1723a54e2 100644 --- a/docs/content/references/entities/classes/DiscountConditionProduct.md +++ b/docs/content/references/entities/classes/DiscountConditionProduct.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L20) +[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L31) +[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L28) +[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L37) +[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L24) +[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L17) +[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product.ts#L34) +[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductCollection.md b/docs/content/references/entities/classes/DiscountConditionProductCollection.md index d38c0e4a4f..25b5a5aeb7 100644 --- a/docs/content/references/entities/classes/DiscountConditionProductCollection.md +++ b/docs/content/references/entities/classes/DiscountConditionProductCollection.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L20) +[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L31) +[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L28) +[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L37) +[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L24) +[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L17) +[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-collection.ts#L34) +[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductTag.md b/docs/content/references/entities/classes/DiscountConditionProductTag.md index fca8e5b4c3..f013673802 100644 --- a/docs/content/references/entities/classes/DiscountConditionProductTag.md +++ b/docs/content/references/entities/classes/DiscountConditionProductTag.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L20) +[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L31) +[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L28) +[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L37) +[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L24) +[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L17) +[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-tag.ts#L34) +[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductType.md b/docs/content/references/entities/classes/DiscountConditionProductType.md index fe11c0cc96..a3746129d0 100644 --- a/docs/content/references/entities/classes/DiscountConditionProductType.md +++ b/docs/content/references/entities/classes/DiscountConditionProductType.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L20) +[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L31) +[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L28) +[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L37) +[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L24) +[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L17) +[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition-product-type.ts#L34) +[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountRule.md b/docs/content/references/entities/classes/DiscountRule.md index b0e093b578..bd90ebc2d2 100644 --- a/docs/content/references/entities/classes/DiscountRule.md +++ b/docs/content/references/entities/classes/DiscountRule.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L38) +[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L38) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L41) +[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L41) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L22) +[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L22) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L44) +[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L44) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L28) +[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L28) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L31) +[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L31) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L46) +[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L46) diff --git a/docs/content/references/entities/classes/DraftOrder.md b/docs/content/references/entities/classes/DraftOrder.md index 655025da6b..077add8810 100644 --- a/docs/content/references/entities/classes/DraftOrder.md +++ b/docs/content/references/entities/classes/DraftOrder.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L54) +[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L54) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L43) +[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L43) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L39) +[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L39) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L57) +[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L57) ___ @@ -72,7 +72,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L35) +[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L35) ___ @@ -96,7 +96,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L66) +[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L66) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L63) +[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L63) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L60) +[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L60) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L51) +[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L51) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L47) +[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L47) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L30) +[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L30) ___ @@ -170,7 +170,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -184,4 +184,4 @@ BaseEntity.updated\_at #### Defined in -[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L68) +[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L68) diff --git a/docs/content/references/entities/classes/Fulfillment.md b/docs/content/references/entities/classes/Fulfillment.md index fd8f7aaa8d..2ba855f784 100644 --- a/docs/content/references/entities/classes/Fulfillment.md +++ b/docs/content/references/entities/classes/Fulfillment.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L79) +[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L79) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L29) +[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L29) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L25) +[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L25) ___ @@ -62,7 +62,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L73) +[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L73) ___ @@ -86,7 +86,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L85) +[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L85) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L62) +[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L62) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L82) +[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L82) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L48) +[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L48) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L45) +[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L45) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L41) +[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L41) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L56) +[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L56) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L52) +[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L52) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L76) +[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L76) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L37) +[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L37) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L33) +[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L33) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L67) +[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L67) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L70) +[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L70) ___ @@ -230,7 +230,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -244,4 +244,4 @@ BaseEntity.updated\_at #### Defined in -[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment.ts#L87) +[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L87) diff --git a/docs/content/references/entities/classes/FulfillmentItem.md b/docs/content/references/entities/classes/FulfillmentItem.md index 3cf6939f15..1a55513459 100644 --- a/docs/content/references/entities/classes/FulfillmentItem.md +++ b/docs/content/references/entities/classes/FulfillmentItem.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L16) +[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L16) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L9) +[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L9) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L20) +[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L20) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L12) +[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L12) ___ @@ -58,4 +58,4 @@ ___ #### Defined in -[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-item.ts#L23) +[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L23) diff --git a/docs/content/references/entities/classes/FulfillmentProvider.md b/docs/content/references/entities/classes/FulfillmentProvider.md index 915eb744dc..0a4f7499a1 100644 --- a/docs/content/references/entities/classes/FulfillmentProvider.md +++ b/docs/content/references/entities/classes/FulfillmentProvider.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-provider.ts#L6) +[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-provider.ts#L6) ___ @@ -28,4 +28,4 @@ ___ #### Defined in -[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/fulfillment-provider.ts#L9) +[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-provider.ts#L9) diff --git a/docs/content/references/entities/classes/GiftCard.md b/docs/content/references/entities/classes/GiftCard.md index ca9ab3799b..4546490711 100644 --- a/docs/content/references/entities/classes/GiftCard.md +++ b/docs/content/references/entities/classes/GiftCard.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L26) +[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L26) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L20) +[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L20) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L51) +[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L51) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L45) +[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L45) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L54) +[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L54) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L42) +[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L42) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L38) +[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L38) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L34) +[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L34) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L30) +[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L30) ___ @@ -164,7 +164,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L23) +[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L23) ## Methods @@ -188,4 +188,4 @@ ___ #### Defined in -[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card.ts#L56) +[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L56) diff --git a/docs/content/references/entities/classes/GiftCardTransaction.md b/docs/content/references/entities/classes/GiftCardTransaction.md index 270311cfe6..ffe3236620 100644 --- a/docs/content/references/entities/classes/GiftCardTransaction.md +++ b/docs/content/references/entities/classes/GiftCardTransaction.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L40) +[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L40) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L43) +[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L43) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L29) +[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L29) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L25) +[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L25) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L22) +[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L22) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L46) +[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L46) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L37) +[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L37) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L33) +[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L33) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L49) +[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L49) ## Methods @@ -112,4 +112,4 @@ ___ #### Defined in -[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/gift-card-transaction.ts#L51) +[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L51) diff --git a/docs/content/references/entities/classes/IdempotencyKey.md b/docs/content/references/entities/classes/IdempotencyKey.md index 5da85448eb..b7c504b5d6 100644 --- a/docs/content/references/entities/classes/IdempotencyKey.md +++ b/docs/content/references/entities/classes/IdempotencyKey.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L23) +[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L23) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L16) +[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L16) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L20) +[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L20) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L26) +[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L26) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L44) +[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L29) +[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L29) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L32) +[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L32) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L35) +[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L35) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L41) +[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L41) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L38) +[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L38) ## Methods @@ -122,4 +122,4 @@ ___ #### Defined in -[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/idempotency-key.ts#L46) +[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L46) diff --git a/docs/content/references/entities/classes/Image.md b/docs/content/references/entities/classes/Image.md index b93068fd11..25dd001ceb 100644 --- a/docs/content/references/entities/classes/Image.md +++ b/docs/content/references/entities/classes/Image.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/image.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/image.ts#L13) +[models/image.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/image.ts#L13) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/image.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/image.ts#L10) +[models/image.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/image.ts#L10) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/image.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/image.ts#L15) +[models/image.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/image.ts#L15) diff --git a/docs/content/references/entities/classes/Invite.md b/docs/content/references/entities/classes/Invite.md index 98466d0a04..efb30ba94b 100644 --- a/docs/content/references/entities/classes/Invite.md +++ b/docs/content/references/entities/classes/Invite.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/invite.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L23) +[models/invite.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L23) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/invite.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L29) +[models/invite.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L29) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/invite.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L32) +[models/invite.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L32) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/invite.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L20) +[models/invite.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L20) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/invite.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L26) +[models/invite.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L26) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/invite.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L12) +[models/invite.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L12) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/invite.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/invite.ts#L34) +[models/invite.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L34) diff --git a/docs/content/references/entities/classes/LineItem.md b/docs/content/references/entities/classes/LineItem.md index 974ae4cb60..8c8e48fcc8 100644 --- a/docs/content/references/entities/classes/LineItem.md +++ b/docs/content/references/entities/classes/LineItem.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/line-item.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L67) +[models/line-item.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L67) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/line-item.ts:88](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L88) +[models/line-item.ts:88](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L88) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/line-item.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L35) +[models/line-item.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L35) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/line-item.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L31) +[models/line-item.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L31) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/line-item.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L59) +[models/line-item.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L59) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/line-item.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L55) +[models/line-item.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L55) ___ @@ -92,7 +92,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L73) +[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L73) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/line-item.ts:125](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L125) +[models/line-item.ts:125](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L125) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/line-item.ts:108](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L108) +[models/line-item.ts:108](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L108) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[models/line-item.ts:126](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L126) +[models/line-item.ts:126](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L126) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[models/line-item.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L91) +[models/line-item.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L91) ___ @@ -156,7 +156,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/line-item.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L82) +[models/line-item.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L82) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/line-item.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L79) +[models/line-item.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L79) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/line-item.ts:117](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L117) +[models/line-item.ts:117](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L117) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/line-item.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L43) +[models/line-item.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L43) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[models/line-item.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L39) +[models/line-item.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L39) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L124) +[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L124) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[models/line-item.ts:123](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L123) +[models/line-item.ts:123](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L123) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[models/line-item.ts:105](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L105) +[models/line-item.ts:105](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L105) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[models/line-item.ts:119](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L119) +[models/line-item.ts:119](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L119) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[models/line-item.ts:111](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L111) +[models/line-item.ts:111](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L111) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -[models/line-item.ts:114](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L114) +[models/line-item.ts:114](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L114) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[models/line-item.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L85) +[models/line-item.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L85) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[models/line-item.ts:120](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L120) +[models/line-item.ts:120](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L120) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -[models/line-item.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L51) +[models/line-item.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L51) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[models/line-item.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L47) +[models/line-item.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L47) ___ @@ -316,7 +316,7 @@ ___ #### Defined in -[models/line-item.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L62) +[models/line-item.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L62) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L121) +[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L121) ___ @@ -336,7 +336,7 @@ ___ #### Defined in -[models/line-item.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L76) +[models/line-item.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L76) ___ @@ -346,7 +346,7 @@ ___ #### Defined in -[models/line-item.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L70) +[models/line-item.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L70) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[models/line-item.ts:122](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L122) +[models/line-item.ts:122](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L122) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[models/line-item.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L94) +[models/line-item.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L94) ___ @@ -380,7 +380,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -390,7 +390,7 @@ ___ #### Defined in -[models/line-item.ts:102](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L102) +[models/line-item.ts:102](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L102) ___ @@ -400,7 +400,7 @@ ___ #### Defined in -[models/line-item.ts:98](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L98) +[models/line-item.ts:98](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L98) ## Methods @@ -414,4 +414,4 @@ ___ #### Defined in -[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item.ts#L128) +[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L128) diff --git a/docs/content/references/entities/classes/LineItemAdjustment.md b/docs/content/references/entities/classes/LineItemAdjustment.md index c190378c98..af41b326f2 100644 --- a/docs/content/references/entities/classes/LineItemAdjustment.md +++ b/docs/content/references/entities/classes/LineItemAdjustment.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L45) +[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L45) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L34) +[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L34) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L38) +[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L38) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L42) +[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L42) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L23) +[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L23) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L31) +[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L31) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L27) +[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L27) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L48) +[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L48) ## Methods @@ -102,4 +102,4 @@ ___ #### Defined in -[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-adjustment.ts#L50) +[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L50) diff --git a/docs/content/references/entities/classes/LineItemTaxLine.md b/docs/content/references/entities/classes/LineItemTaxLine.md index 9a39da7b17..d3dd6b60d2 100644 --- a/docs/content/references/entities/classes/LineItemTaxLine.md +++ b/docs/content/references/entities/classes/LineItemTaxLine.md @@ -32,7 +32,7 @@ TaxLine.code #### Defined in -[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L13) +[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L13) ___ @@ -46,7 +46,7 @@ TaxLine.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -60,7 +60,7 @@ TaxLine.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-tax-line.ts#L24) +[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-tax-line.ts#L24) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-tax-line.ts#L20) +[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-tax-line.ts#L20) ___ @@ -94,7 +94,7 @@ TaxLine.metadata #### Defined in -[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L16) +[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L16) ___ @@ -108,7 +108,7 @@ TaxLine.name #### Defined in -[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L10) +[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L10) ___ @@ -122,7 +122,7 @@ TaxLine.rate #### Defined in -[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L7) +[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L7) ___ @@ -136,7 +136,7 @@ TaxLine.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -150,4 +150,4 @@ TaxLine.updated\_at #### Defined in -[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/line-item-tax-line.ts#L26) +[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-tax-line.ts#L26) diff --git a/docs/content/references/entities/classes/MoneyAmount.md b/docs/content/references/entities/classes/MoneyAmount.md index 415159aa00..c6fb9fa162 100644 --- a/docs/content/references/entities/classes/MoneyAmount.md +++ b/docs/content/references/entities/classes/MoneyAmount.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/money-amount.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L27) +[models/money-amount.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L27) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/money-amount.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L24) +[models/money-amount.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L24) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/money-amount.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L20) +[models/money-amount.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L20) ___ @@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/money-amount.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L33) +[models/money-amount.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L33) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/money-amount.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L30) +[models/money-amount.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L30) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/money-amount.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L43) +[models/money-amount.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L43) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/money-amount.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L36) +[models/money-amount.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L36) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/money-amount.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L61) +[models/money-amount.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L61) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/money-amount.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L57) +[models/money-amount.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L57) ___ @@ -164,7 +164,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[models/money-amount.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L53) +[models/money-amount.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L53) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[models/money-amount.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L47) +[models/money-amount.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L47) ## Methods @@ -198,4 +198,4 @@ ___ #### Defined in -[models/money-amount.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/money-amount.ts#L63) +[models/money-amount.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L63) diff --git a/docs/content/references/entities/classes/Note.md b/docs/content/references/entities/classes/Note.md index f0e731837b..a0f804f78f 100644 --- a/docs/content/references/entities/classes/Note.md +++ b/docs/content/references/entities/classes/Note.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/note.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L33) +[models/note.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L33) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/note.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L29) +[models/note.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L29) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/note.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L36) +[models/note.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L36) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/note.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L26) +[models/note.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L26) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/note.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L22) +[models/note.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L22) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/note.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L18) +[models/note.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L18) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/note.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/note.ts#L38) +[models/note.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L38) diff --git a/docs/content/references/entities/classes/Notification.md b/docs/content/references/entities/classes/Notification.md index 2b41504add..5125e1ac3b 100644 --- a/docs/content/references/entities/classes/Notification.md +++ b/docs/content/references/entities/classes/Notification.md @@ -32,7 +32,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/notification.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L36) +[models/notification.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L36) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/notification.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L32) +[models/notification.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L32) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/notification.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L42) +[models/notification.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L42) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/notification.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L20) +[models/notification.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L20) ___ @@ -86,7 +86,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/notification.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L45) +[models/notification.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L45) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/notification.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L49) +[models/notification.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L49) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/notification.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L59) +[models/notification.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L59) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/notification.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L55) +[models/notification.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L55) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/notification.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L52) +[models/notification.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L52) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/notification.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L28) +[models/notification.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L28) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/notification.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L24) +[models/notification.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L24) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/notification.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L39) +[models/notification.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L39) ___ @@ -180,7 +180,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -194,4 +194,4 @@ BaseEntity.updated\_at #### Defined in -[models/notification.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/notification.ts#L61) +[models/notification.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L61) diff --git a/docs/content/references/entities/classes/Oauth.md b/docs/content/references/entities/classes/Oauth.md index 78b0e2b719..a4299eb8b9 100644 --- a/docs/content/references/entities/classes/Oauth.md +++ b/docs/content/references/entities/classes/Oauth.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L16) +[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L16) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L25) +[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L25) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L12) +[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L12) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L9) +[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L9) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L19) +[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L19) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L22) +[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L22) ## Methods @@ -82,4 +82,4 @@ ___ #### Defined in -[models/oauth.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/oauth.ts#L27) +[models/oauth.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L27) diff --git a/docs/content/references/entities/classes/Order.md b/docs/content/references/entities/classes/Order.md index 386cf27c73..faa11fd3e1 100644 --- a/docs/content/references/entities/classes/Order.md +++ b/docs/content/references/entities/classes/Order.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/order.ts:123](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L123) +[models/order.ts:123](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L123) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/order.ts:119](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L119) +[models/order.ts:119](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L119) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/order.ts:220](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L220) +[models/order.ts:220](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L220) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/order.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L104) +[models/order.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L104) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/order.ts:100](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L100) +[models/order.ts:100](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L100) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/order.ts:196](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L196) +[models/order.ts:196](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L196) ___ @@ -92,7 +92,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/order.ts:146](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L146) +[models/order.ts:146](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L146) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/order.ts:142](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L142) +[models/order.ts:142](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L142) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/order.ts:112](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L112) +[models/order.ts:112](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L112) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[models/order.ts:108](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L108) +[models/order.ts:108](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L108) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[models/order.ts:245](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L245) +[models/order.ts:245](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L245) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[models/order.ts:163](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L163) +[models/order.ts:163](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L163) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[models/order.ts:96](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L96) +[models/order.ts:96](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L96) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[models/order.ts:209](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L209) +[models/order.ts:209](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L209) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[models/order.ts:205](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L205) +[models/order.ts:205](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L205) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[models/order.ts:115](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L115) +[models/order.ts:115](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L115) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[models/order.ts:232](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L232) +[models/order.ts:232](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L232) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[models/order.ts:88](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L88) +[models/order.ts:88](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L88) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[models/order.ts:190](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L190) +[models/order.ts:190](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L190) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[models/order.ts:253](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L253) +[models/order.ts:253](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L253) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[models/order.ts:252](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L252) +[models/order.ts:252](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L252) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[models/order.ts:217](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L217) +[models/order.ts:217](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L217) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[models/order.ts:177](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L177) +[models/order.ts:177](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L177) ___ @@ -276,7 +276,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[models/order.ts:229](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L229) +[models/order.ts:229](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L229) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -[models/order.ts:214](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L214) +[models/order.ts:214](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L214) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[models/order.ts:223](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L223) +[models/order.ts:223](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L223) ___ @@ -316,7 +316,7 @@ ___ #### Defined in -[models/order.ts:226](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L226) +[models/order.ts:226](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L226) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[models/order.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L78) +[models/order.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L78) ___ @@ -336,7 +336,7 @@ ___ #### Defined in -[models/order.ts:250](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L250) +[models/order.ts:250](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L250) ___ @@ -346,7 +346,7 @@ ___ #### Defined in -[models/order.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L91) +[models/order.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L91) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[models/order.ts:185](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L185) +[models/order.ts:185](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L185) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[models/order.ts:251](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L251) +[models/order.ts:251](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L251) ___ @@ -376,7 +376,7 @@ ___ #### Defined in -[models/order.ts:247](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L247) +[models/order.ts:247](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L247) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[models/order.ts:199](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L199) +[models/order.ts:199](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L199) ___ @@ -396,7 +396,7 @@ ___ #### Defined in -[models/order.ts:139](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L139) +[models/order.ts:139](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L139) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[models/order.ts:135](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L135) +[models/order.ts:135](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L135) ___ @@ -416,7 +416,7 @@ ___ #### Defined in -[models/order.ts:193](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L193) +[models/order.ts:193](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L193) ___ @@ -426,7 +426,7 @@ ___ #### Defined in -[models/order.ts:241](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L241) +[models/order.ts:241](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L241) ___ @@ -436,7 +436,7 @@ ___ #### Defined in -[models/order.ts:235](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L235) +[models/order.ts:235](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L235) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[models/order.ts:131](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L131) +[models/order.ts:131](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L131) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[models/order.ts:127](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L127) +[models/order.ts:127](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L127) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[models/order.ts:182](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L182) +[models/order.ts:182](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L182) ___ @@ -476,7 +476,7 @@ ___ #### Defined in -[models/order.ts:244](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L244) +[models/order.ts:244](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L244) ___ @@ -486,7 +486,7 @@ ___ #### Defined in -[models/order.ts:81](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L81) +[models/order.ts:81](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L81) ___ @@ -496,7 +496,7 @@ ___ #### Defined in -[models/order.ts:249](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L249) +[models/order.ts:249](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L249) ___ @@ -506,7 +506,7 @@ ___ #### Defined in -[models/order.ts:202](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L202) +[models/order.ts:202](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L202) ___ @@ -516,7 +516,7 @@ ___ #### Defined in -[models/order.ts:149](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L149) +[models/order.ts:149](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L149) ___ @@ -526,7 +526,7 @@ ___ #### Defined in -[models/order.ts:246](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L246) +[models/order.ts:246](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L246) ___ @@ -536,7 +536,7 @@ ___ #### Defined in -[models/order.ts:248](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L248) +[models/order.ts:248](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L248) ___ @@ -550,7 +550,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -564,4 +564,4 @@ BaseEntity.updated\_at #### Defined in -[models/order.ts:255](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L255) +[models/order.ts:255](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L255) diff --git a/docs/content/references/entities/classes/Payment.md b/docs/content/references/entities/classes/Payment.md index 0ef1f688e4..00a052e8b5 100644 --- a/docs/content/references/entities/classes/Payment.md +++ b/docs/content/references/entities/classes/Payment.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/payment.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L46) +[models/payment.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L46) ___ @@ -38,27 +38,27 @@ ___ #### Defined in -[models/payment.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L56) +[models/payment.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L56) ___ ### canceled\_at -• **canceled\_at**: `Date` +• **canceled\_at**: `string` \| `Date` #### Defined in -[models/payment.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L69) +[models/payment.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L69) ___ ### captured\_at -• **captured\_at**: `Date` +• **captured\_at**: `string` \| `Date` #### Defined in -[models/payment.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L66) +[models/payment.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L66) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/payment.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L35) +[models/payment.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L35) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/payment.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L31) +[models/payment.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L31) ___ @@ -92,7 +92,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/payment.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L53) +[models/payment.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L53) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/payment.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L49) +[models/payment.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L49) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/payment.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L63) +[models/payment.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L63) ___ @@ -136,7 +136,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/payment.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L75) +[models/payment.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L75) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/payment.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L72) +[models/payment.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L72) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/payment.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L43) +[models/payment.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L43) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/payment.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L39) +[models/payment.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L39) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/payment.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L60) +[models/payment.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L60) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/payment.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L27) +[models/payment.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L27) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[models/payment.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L23) +[models/payment.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L23) ___ @@ -220,7 +220,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -234,4 +234,4 @@ BaseEntity.updated\_at #### Defined in -[models/payment.ts:77](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment.ts#L77) +[models/payment.ts:77](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L77) diff --git a/docs/content/references/entities/classes/PaymentProvider.md b/docs/content/references/entities/classes/PaymentProvider.md index f3ac765a18..915b82b83f 100644 --- a/docs/content/references/entities/classes/PaymentProvider.md +++ b/docs/content/references/entities/classes/PaymentProvider.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-provider.ts#L6) +[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-provider.ts#L6) ___ @@ -28,4 +28,4 @@ ___ #### Defined in -[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-provider.ts#L9) +[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-provider.ts#L9) diff --git a/docs/content/references/entities/classes/PaymentSession.md b/docs/content/references/entities/classes/PaymentSession.md index 35af4e6d0d..03961f2f7f 100644 --- a/docs/content/references/entities/classes/PaymentSession.md +++ b/docs/content/references/entities/classes/PaymentSession.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/payment-session.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L33) +[models/payment-session.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L34) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/payment-session.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L29) +[models/payment-session.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L30) ___ @@ -52,7 +52,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/payment-session.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L46) +[models/payment-session.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L47) ___ @@ -76,7 +76,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/payment-session.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L49) +[models/payment-session.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L50) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/payment-session.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L40) +[models/payment-session.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L41) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/payment-session.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L37) +[models/payment-session.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L38) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/payment-session.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L43) +[models/payment-session.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L44) ___ @@ -130,7 +130,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -144,4 +144,4 @@ BaseEntity.updated\_at #### Defined in -[models/payment-session.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L51) +[models/payment-session.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L52) diff --git a/docs/content/references/entities/classes/PriceList.md b/docs/content/references/entities/classes/PriceList.md index 8015405886..0c4aef33d4 100644 --- a/docs/content/references/entities/classes/PriceList.md +++ b/docs/content/references/entities/classes/PriceList.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/price-list.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L54) +[models/price-list.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L54) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/price-list.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L23) +[models/price-list.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L23) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/price-list.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L38) +[models/price-list.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L38) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/price-list.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L20) +[models/price-list.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L20) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/price-list.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L59) +[models/price-list.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L59) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/price-list.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L35) +[models/price-list.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L35) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/price-list.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L29) +[models/price-list.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L29) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/price-list.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L26) +[models/price-list.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L26) ___ @@ -154,7 +154,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -168,4 +168,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/price-list.ts#L61) +[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L61) diff --git a/docs/content/references/entities/classes/Product.md b/docs/content/references/entities/classes/Product.md index decaacc8e4..ab06697b34 100644 --- a/docs/content/references/entities/classes/Product.md +++ b/docs/content/references/entities/classes/Product.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/product.ts:117](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L117) +[models/product.ts:117](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L117) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product.ts:113](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L113) +[models/product.ts:113](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L113) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/product.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L43) +[models/product.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L43) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/product.ts:141](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L141) +[models/product.ts:141](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L141) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/product.ts:144](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L144) +[models/product.ts:144](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L144) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/product.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L47) +[models/product.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L47) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/product.ts:95](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L95) +[models/product.ts:95](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L95) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/product.ts:101](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L101) +[models/product.ts:101](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L101) ___ @@ -140,7 +140,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/product.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L67) +[models/product.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L67) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/product.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L50) +[models/product.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L50) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/product.ts:92](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L92) +[models/product.ts:92](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L92) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/product.ts:110](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L110) +[models/product.ts:110](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L110) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/product.ts:147](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L147) +[models/product.ts:147](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L147) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/product.ts:107](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L107) +[models/product.ts:107](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L107) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/product.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L73) +[models/product.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L73) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/product.ts:104](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L104) +[models/product.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L104) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/product.ts:86](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L86) +[models/product.ts:86](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L86) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[models/product.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L82) +[models/product.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L82) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[models/product.ts:163](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L163) +[models/product.ts:163](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L163) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[models/product.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L53) +[models/product.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L53) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[models/product.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L40) +[models/product.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L40) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[models/product.ts:138](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L138) +[models/product.ts:138](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L138) ___ @@ -290,7 +290,7 @@ ___ #### Defined in -[models/product.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L70) +[models/product.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L70) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[models/product.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L37) +[models/product.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L37) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -[models/product.ts:124](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L124) +[models/product.ts:124](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L124) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[models/product.ts:120](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L120) +[models/product.ts:120](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L120) ___ @@ -334,7 +334,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[models/product.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L78) +[models/product.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L78) ___ @@ -354,7 +354,7 @@ ___ #### Defined in -[models/product.ts:89](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L89) +[models/product.ts:89](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L89) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -[models/product.ts:98](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L98) +[models/product.ts:98](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L98) ## Methods @@ -378,4 +378,4 @@ ___ #### Defined in -[models/product.ts:165](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L165) +[models/product.ts:165](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L165) diff --git a/docs/content/references/entities/classes/ProductCollection.md b/docs/content/references/entities/classes/ProductCollection.md index 5f94dacd74..2fa95cc15e 100644 --- a/docs/content/references/entities/classes/ProductCollection.md +++ b/docs/content/references/entities/classes/ProductCollection.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L16) +[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L16) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L22) +[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L22) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L19) +[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L19) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L12) +[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L12) ___ @@ -114,7 +114,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -128,4 +128,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/product-collection.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-collection.ts#L24) +[models/product-collection.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L24) diff --git a/docs/content/references/entities/classes/ProductOption.md b/docs/content/references/entities/classes/ProductOption.md index 1396fde3f0..0bdbb1731c 100644 --- a/docs/content/references/entities/classes/ProductOption.md +++ b/docs/content/references/entities/classes/ProductOption.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-option.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L32) +[models/product-option.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L32) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/product-option.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L29) +[models/product-option.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L29) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/product-option.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L25) +[models/product-option.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L25) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L19) +[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L19) ___ @@ -114,7 +114,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[models/product-option.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L22) +[models/product-option.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L22) ## Methods @@ -138,4 +138,4 @@ ___ #### Defined in -[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option.ts#L34) +[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L34) diff --git a/docs/content/references/entities/classes/ProductOptionValue.md b/docs/content/references/entities/classes/ProductOptionValue.md index 5b10567352..3e3b5bfefe 100644 --- a/docs/content/references/entities/classes/ProductOptionValue.md +++ b/docs/content/references/entities/classes/ProductOptionValue.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L40) +[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L40) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L27) +[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L27) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L23) +[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L23) ___ @@ -104,7 +104,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L19) +[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L19) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L37) +[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L37) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L31) +[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L31) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/product-option-value.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-option-value.ts#L42) +[models/product-option-value.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L42) diff --git a/docs/content/references/entities/classes/ProductTag.md b/docs/content/references/entities/classes/ProductTag.md index af7422e0ae..6ec8b2b2dc 100644 --- a/docs/content/references/entities/classes/ProductTag.md +++ b/docs/content/references/entities/classes/ProductTag.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-tag.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tag.ts#L13) +[models/product-tag.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tag.ts#L13) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/product-tag.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tag.ts#L10) +[models/product-tag.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tag.ts#L10) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/product-tag.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tag.ts#L15) +[models/product-tag.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tag.ts#L15) diff --git a/docs/content/references/entities/classes/ProductTaxRate.md b/docs/content/references/entities/classes/ProductTaxRate.md index 2446cf67bd..e00f6b9313 100644 --- a/docs/content/references/entities/classes/ProductTaxRate.md +++ b/docs/content/references/entities/classes/ProductTaxRate.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/product-tax-rate.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L32) +[models/product-tax-rate.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L32) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L38) +[models/product-tax-rate.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L38) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L24) +[models/product-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L17) +[models/product-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L17) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L20) +[models/product-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L20) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L29) +[models/product-tax-rate.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L29) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/product-tax-rate.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-tax-rate.ts#L35) +[models/product-tax-rate.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L35) diff --git a/docs/content/references/entities/classes/ProductType.md b/docs/content/references/entities/classes/ProductType.md index 417e42ddd6..54d37852b1 100644 --- a/docs/content/references/entities/classes/ProductType.md +++ b/docs/content/references/entities/classes/ProductType.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-type.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type.ts#L13) +[models/product-type.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type.ts#L13) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/product-type.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type.ts#L10) +[models/product-type.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type.ts#L10) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/product-type.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type.ts#L15) +[models/product-type.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type.ts#L15) diff --git a/docs/content/references/entities/classes/ProductTypeTaxRate.md b/docs/content/references/entities/classes/ProductTypeTaxRate.md index 569041ede2..b2b07c6ab1 100644 --- a/docs/content/references/entities/classes/ProductTypeTaxRate.md +++ b/docs/content/references/entities/classes/ProductTypeTaxRate.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/product-type-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L31) +[models/product-type-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L31) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L37) +[models/product-type-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L37) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L24) +[models/product-type-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L17) +[models/product-type-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L17) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L20) +[models/product-type-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L20) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L28) +[models/product-type-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L28) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-type-tax-rate.ts#L34) +[models/product-type-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L34) diff --git a/docs/content/references/entities/classes/ProductVariant.md b/docs/content/references/entities/classes/ProductVariant.md index e32b06518c..76fad46dd3 100644 --- a/docs/content/references/entities/classes/ProductVariant.md +++ b/docs/content/references/entities/classes/ProductVariant.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/product-variant.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L60) +[models/product-variant.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L60) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product-variant.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L43) +[models/product-variant.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L43) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/product-variant.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L47) +[models/product-variant.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L47) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/product-variant.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L84) +[models/product-variant.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L84) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/product-variant.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L66) +[models/product-variant.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L66) ___ @@ -110,7 +110,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/product-variant.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L57) +[models/product-variant.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L57) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/product-variant.ts:81](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L81) +[models/product-variant.ts:81](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L81) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/product-variant.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L63) +[models/product-variant.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L63) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/product-variant.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L75) +[models/product-variant.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L75) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/product-variant.ts:95](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L95) +[models/product-variant.ts:95](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L95) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/product-variant.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L72) +[models/product-variant.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L72) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/product-variant.ts:92](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L92) +[models/product-variant.ts:92](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L92) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/product-variant.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L69) +[models/product-variant.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L69) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/product-variant.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L35) +[models/product-variant.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L35) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/product-variant.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L29) +[models/product-variant.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L29) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/product-variant.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L25) +[models/product-variant.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L25) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/product-variant.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L39) +[models/product-variant.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L39) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[models/product-variant.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L21) +[models/product-variant.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L21) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[models/product-variant.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L51) +[models/product-variant.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L51) ___ @@ -264,7 +264,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[models/product-variant.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L54) +[models/product-variant.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L54) ___ @@ -284,7 +284,7 @@ ___ #### Defined in -[models/product-variant.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L78) +[models/product-variant.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L78) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[models/product-variant.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L87) +[models/product-variant.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L87) ## Methods @@ -308,4 +308,4 @@ ___ #### Defined in -[models/product-variant.ts:97](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product-variant.ts#L97) +[models/product-variant.ts:97](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L97) diff --git a/docs/content/references/entities/classes/Refund.md b/docs/content/references/entities/classes/Refund.md index df51448eba..84f671aa88 100644 --- a/docs/content/references/entities/classes/Refund.md +++ b/docs/content/references/entities/classes/Refund.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/refund.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L34) +[models/refund.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L34) ___ @@ -42,7 +42,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/refund.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L46) +[models/refund.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L46) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/refund.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L43) +[models/refund.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L43) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/refund.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L37) +[models/refund.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L37) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/refund.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L31) +[models/refund.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L31) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/refund.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L27) +[models/refund.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L27) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/refund.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L40) +[models/refund.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L40) ___ @@ -130,7 +130,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -144,4 +144,4 @@ BaseEntity.updated\_at #### Defined in -[models/refund.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L48) +[models/refund.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L48) diff --git a/docs/content/references/entities/classes/Region.md b/docs/content/references/entities/classes/Region.md index 223387ddaa..5303171e97 100644 --- a/docs/content/references/entities/classes/Region.md +++ b/docs/content/references/entities/classes/Region.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/region.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L47) +[models/region.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L47) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/region.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L50) +[models/region.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L50) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/region.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L32) +[models/region.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L32) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/region.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L28) +[models/region.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L28) ___ @@ -86,7 +86,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/region.ts:91](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L91) +[models/region.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L91) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/region.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L44) +[models/region.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L44) ___ @@ -120,7 +120,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/region.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L94) +[models/region.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L94) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/region.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L25) +[models/region.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L25) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/region.ts:74](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L74) +[models/region.ts:74](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L74) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/region.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L41) +[models/region.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L41) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/region.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L57) +[models/region.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L57) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/region.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L53) +[models/region.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L53) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/region.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L35) +[models/region.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L35) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/region.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L38) +[models/region.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L38) ___ @@ -214,7 +214,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -228,4 +228,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/region.ts:96](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/region.ts#L96) +[models/region.ts:96](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L96) diff --git a/docs/content/references/entities/classes/Return.md b/docs/content/references/entities/classes/Return.md index ed68fff221..86f716d74c 100644 --- a/docs/content/references/entities/classes/Return.md +++ b/docs/content/references/entities/classes/Return.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/return.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L57) +[models/return.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L57) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/return.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L53) +[models/return.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L53) ___ @@ -52,7 +52,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/return.ts:88](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L88) +[models/return.ts:88](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L88) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/return.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L41) +[models/return.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L41) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/return.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L85) +[models/return.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L85) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/return.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L82) +[models/return.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L82) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/return.ts:65](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L65) +[models/return.ts:65](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L65) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/return.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L61) +[models/return.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L61) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/return.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L79) +[models/return.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L79) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/return.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L76) +[models/return.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L76) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/return.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L73) +[models/return.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L73) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/return.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L70) +[models/return.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L70) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/return.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L35) +[models/return.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L35) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/return.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L49) +[models/return.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L49) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/return.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L45) +[models/return.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L45) ___ @@ -210,7 +210,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -224,4 +224,4 @@ BaseEntity.updated\_at #### Defined in -[models/return.ts:90](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L90) +[models/return.ts:90](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L90) diff --git a/docs/content/references/entities/classes/ReturnItem.md b/docs/content/references/entities/classes/ReturnItem.md index 4b23002526..66824bc1ec 100644 --- a/docs/content/references/entities/classes/ReturnItem.md +++ b/docs/content/references/entities/classes/ReturnItem.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/return-item.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L28) +[models/return-item.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L28) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/return-item.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L22) +[models/return-item.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L22) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/return-item.ts:14](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L14) +[models/return-item.ts:14](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L14) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/return-item.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L47) +[models/return-item.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L47) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/return-item.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L44) +[models/return-item.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/return-item.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L25) +[models/return-item.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L25) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/return-item.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L41) +[models/return-item.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L41) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/return-item.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L37) +[models/return-item.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L37) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/return-item.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L34) +[models/return-item.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L34) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[models/return-item.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L31) +[models/return-item.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L31) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[models/return-item.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L11) +[models/return-item.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L11) ___ @@ -128,4 +128,4 @@ ___ #### Defined in -[models/return-item.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-item.ts#L18) +[models/return-item.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L18) diff --git a/docs/content/references/entities/classes/ReturnReason.md b/docs/content/references/entities/classes/ReturnReason.md index fd8572ce26..b8519dd9d6 100644 --- a/docs/content/references/entities/classes/ReturnReason.md +++ b/docs/content/references/entities/classes/ReturnReason.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/return-reason.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L25) +[models/return-reason.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L25) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/return-reason.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L22) +[models/return-reason.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L22) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/return-reason.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L42) +[models/return-reason.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L42) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/return-reason.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L32) +[models/return-reason.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L32) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/return-reason.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L28) +[models/return-reason.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L28) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/return-reason.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L39) +[models/return-reason.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L39) ___ @@ -134,7 +134,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[models/return-reason.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L19) +[models/return-reason.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L19) ## Methods @@ -158,4 +158,4 @@ ___ #### Defined in -[models/return-reason.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return-reason.ts#L44) +[models/return-reason.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L44) diff --git a/docs/content/references/entities/classes/SalesChannel.md b/docs/content/references/entities/classes/SalesChannel.md index f4c007f465..ee3d2acd23 100644 --- a/docs/content/references/entities/classes/SalesChannel.md +++ b/docs/content/references/entities/classes/SalesChannel.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/sales-channel.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L13) +[models/sales-channel.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L13) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/sales-channel.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L16) +[models/sales-channel.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/sales-channel.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L10) +[models/sales-channel.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L10) ___ @@ -104,7 +104,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -118,4 +118,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/sales-channel.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/sales-channel.ts#L18) +[models/sales-channel.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L18) diff --git a/docs/content/references/entities/classes/ShippingMethod.md b/docs/content/references/entities/classes/ShippingMethod.md index 678317844b..ba73d896ba 100644 --- a/docs/content/references/entities/classes/ShippingMethod.md +++ b/docs/content/references/entities/classes/ShippingMethod.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-method.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L59) +[models/shipping-method.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L59) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/shipping-method.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L55) +[models/shipping-method.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L55) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-method.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L51) +[models/shipping-method.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L51) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/shipping-method.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L47) +[models/shipping-method.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L47) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/shipping-method.ts:90](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L90) +[models/shipping-method.ts:90](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L90) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/shipping-method.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L31) +[models/shipping-method.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L31) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/shipping-method.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L43) +[models/shipping-method.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/shipping-method.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L39) +[models/shipping-method.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L39) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/shipping-method.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L87) +[models/shipping-method.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L87) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[models/shipping-method.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L71) +[models/shipping-method.ts:71](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L71) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[models/shipping-method.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L75) +[models/shipping-method.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L75) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[models/shipping-method.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L79) +[models/shipping-method.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L79) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[models/shipping-method.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L35) +[models/shipping-method.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L35) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[models/shipping-method.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L67) +[models/shipping-method.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L67) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[models/shipping-method.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L63) +[models/shipping-method.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L63) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[models/shipping-method.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L84) +[models/shipping-method.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L84) ## Methods @@ -182,4 +182,4 @@ ___ #### Defined in -[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L92) +[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L92) diff --git a/docs/content/references/entities/classes/ShippingMethodTaxLine.md b/docs/content/references/entities/classes/ShippingMethodTaxLine.md index 5d9fc5d136..6740e2f705 100644 --- a/docs/content/references/entities/classes/ShippingMethodTaxLine.md +++ b/docs/content/references/entities/classes/ShippingMethodTaxLine.md @@ -32,7 +32,7 @@ TaxLine.code #### Defined in -[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L13) +[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L13) ___ @@ -46,7 +46,7 @@ TaxLine.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -60,7 +60,7 @@ TaxLine.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -74,7 +74,7 @@ TaxLine.metadata #### Defined in -[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L16) +[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L16) ___ @@ -88,7 +88,7 @@ TaxLine.name #### Defined in -[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L10) +[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L10) ___ @@ -102,7 +102,7 @@ TaxLine.rate #### Defined in -[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-line.ts#L7) +[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L7) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/shipping-method-tax-line.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method-tax-line.ts#L24) +[models/shipping-method-tax-line.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method-tax-line.ts#L24) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/shipping-method-tax-line.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method-tax-line.ts#L20) +[models/shipping-method-tax-line.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method-tax-line.ts#L20) ___ @@ -136,7 +136,7 @@ TaxLine.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -150,4 +150,4 @@ TaxLine.updated\_at #### Defined in -[models/shipping-method-tax-line.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method-tax-line.ts#L26) +[models/shipping-method-tax-line.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method-tax-line.ts#L26) diff --git a/docs/content/references/entities/classes/ShippingOption.md b/docs/content/references/entities/classes/ShippingOption.md index 6bf8bd0692..0261d22ec9 100644 --- a/docs/content/references/entities/classes/ShippingOption.md +++ b/docs/content/references/entities/classes/ShippingOption.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/shipping-option.ts:65](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L65) +[models/shipping-option.ts:65](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L65) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-option.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L59) +[models/shipping-option.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L59) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/shipping-option.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L73) +[models/shipping-option.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L73) ___ @@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/shipping-option.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L62) +[models/shipping-option.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L62) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/shipping-option.ts:76](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L76) +[models/shipping-option.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L76) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/shipping-option.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L29) +[models/shipping-option.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L29) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/shipping-option.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L56) +[models/shipping-option.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L56) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L45) +[models/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L45) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/shipping-option.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L41) +[models/shipping-option.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L41) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L53) +[models/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L53) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L49) +[models/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L49) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L37) +[models/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L37) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L33) +[models/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L33) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/shipping-option.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L70) +[models/shipping-option.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L70) ___ @@ -214,7 +214,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -228,4 +228,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/shipping-option.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L78) +[models/shipping-option.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L78) diff --git a/docs/content/references/entities/classes/ShippingOptionRequirement.md b/docs/content/references/entities/classes/ShippingOptionRequirement.md index 7dde2e1d7c..8c4ae3828c 100644 --- a/docs/content/references/entities/classes/ShippingOptionRequirement.md +++ b/docs/content/references/entities/classes/ShippingOptionRequirement.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-option-requirement.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L38) +[models/shipping-option-requirement.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L38) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L41) +[models/shipping-option-requirement.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L41) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L24) +[models/shipping-option-requirement.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L32) +[models/shipping-option-requirement.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L32) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L28) +[models/shipping-option-requirement.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L28) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L35) +[models/shipping-option-requirement.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L35) ## Methods @@ -82,4 +82,4 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L43) +[models/shipping-option-requirement.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L43) diff --git a/docs/content/references/entities/classes/ShippingProfile.md b/docs/content/references/entities/classes/ShippingProfile.md index f751703e86..3fbbf809cd 100644 --- a/docs/content/references/entities/classes/ShippingProfile.md +++ b/docs/content/references/entities/classes/ShippingProfile.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/shipping-profile.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L30) +[models/shipping-profile.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L30) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L18) +[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L18) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/shipping-profile.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L24) +[models/shipping-profile.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L24) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/shipping-profile.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L27) +[models/shipping-profile.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L27) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/shipping-profile.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L21) +[models/shipping-profile.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L21) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -138,4 +138,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/shipping-profile.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L32) +[models/shipping-profile.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L32) diff --git a/docs/content/references/entities/classes/ShippingTaxRate.md b/docs/content/references/entities/classes/ShippingTaxRate.md index 6dfa2db729..023335dc14 100644 --- a/docs/content/references/entities/classes/ShippingTaxRate.md +++ b/docs/content/references/entities/classes/ShippingTaxRate.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L31) +[models/shipping-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L31) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L37) +[models/shipping-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L37) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L20) +[models/shipping-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L20) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L24) +[models/shipping-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L24) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L17) +[models/shipping-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L17) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L28) +[models/shipping-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L28) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-tax-rate.ts#L34) +[models/shipping-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L34) diff --git a/docs/content/references/entities/classes/StagedJob.md b/docs/content/references/entities/classes/StagedJob.md index c68fa4df02..da94130ec0 100644 --- a/docs/content/references/entities/classes/StagedJob.md +++ b/docs/content/references/entities/classes/StagedJob.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/staged-job.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L15) +[models/staged-job.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L15) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/staged-job.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L12) +[models/staged-job.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L12) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/staged-job.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L9) +[models/staged-job.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L9) ## Methods @@ -52,4 +52,4 @@ ___ #### Defined in -[models/staged-job.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/staged-job.ts#L17) +[models/staged-job.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L17) diff --git a/docs/content/references/entities/classes/Store.md b/docs/content/references/entities/classes/Store.md index af133e307e..5f37942908 100644 --- a/docs/content/references/entities/classes/Store.md +++ b/docs/content/references/entities/classes/Store.md @@ -32,7 +32,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/store.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L46) +[models/store.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L46) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/store.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L32) +[models/store.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L32) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/store.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L28) +[models/store.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L28) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/store.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L67) +[models/store.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L67) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/store.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L61) +[models/store.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L61) ___ @@ -96,7 +96,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/store.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L55) +[models/store.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L55) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/store.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L58) +[models/store.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L58) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/store.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L25) +[models/store.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L25) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/store.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L52) +[models/store.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L52) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/store.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L49) +[models/store.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L49) ___ @@ -160,7 +160,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -174,4 +174,4 @@ BaseEntity.updated\_at #### Defined in -[models/store.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/store.ts#L69) +[models/store.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L69) diff --git a/docs/content/references/entities/classes/Swap.md b/docs/content/references/entities/classes/Swap.md index 2ac7de7b80..96d7073799 100644 --- a/docs/content/references/entities/classes/Swap.md +++ b/docs/content/references/entities/classes/Swap.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/swap.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L61) +[models/swap.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L61) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/swap.ts:106](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L106) +[models/swap.ts:106](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L106) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/swap.ts:100](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L100) +[models/swap.ts:100](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L100) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/swap.ts:94](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L94) +[models/swap.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L94) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/swap.ts:90](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L90) +[models/swap.ts:90](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L90) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/swap.ts:97](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L97) +[models/swap.ts:97](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L97) ___ @@ -92,7 +92,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/swap.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L75) +[models/swap.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L75) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/swap.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L47) +[models/swap.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L47) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/swap.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L69) +[models/swap.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L69) ___ @@ -150,7 +150,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/swap.ts:109](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L109) +[models/swap.ts:109](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L109) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/swap.ts:112](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L112) +[models/swap.ts:112](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L112) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/swap.ts:103](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L103) +[models/swap.ts:103](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L103) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/swap.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L58) +[models/swap.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L58) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/swap.ts:54](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L54) +[models/swap.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L54) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/swap.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L72) +[models/swap.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L72) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/swap.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L50) +[models/swap.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L50) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/swap.ts:64](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L64) +[models/swap.ts:64](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L64) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[models/swap.ts:82](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L82) +[models/swap.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L82) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[models/swap.ts:78](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L78) +[models/swap.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L78) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[models/swap.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L87) +[models/swap.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L87) ___ @@ -274,7 +274,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -288,4 +288,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/swap.ts:114](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L114) +[models/swap.ts:114](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L114) diff --git a/docs/content/references/entities/classes/TaxProvider.md b/docs/content/references/entities/classes/TaxProvider.md index 667e633a8b..5358f2cf69 100644 --- a/docs/content/references/entities/classes/TaxProvider.md +++ b/docs/content/references/entities/classes/TaxProvider.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/tax-provider.ts:6](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-provider.ts#L6) +[models/tax-provider.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-provider.ts#L6) ___ @@ -28,4 +28,4 @@ ___ #### Defined in -[models/tax-provider.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-provider.ts#L9) +[models/tax-provider.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-provider.ts#L9) diff --git a/docs/content/references/entities/classes/TaxRate.md b/docs/content/references/entities/classes/TaxRate.md index 5160adfc98..ea2e0ce0dc 100644 --- a/docs/content/references/entities/classes/TaxRate.md +++ b/docs/content/references/entities/classes/TaxRate.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L25) +[models/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L25) ___ @@ -42,7 +42,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/tax-rate.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L38) +[models/tax-rate.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L38) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L28) +[models/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L28) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/tax-rate.ts:83](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L83) +[models/tax-rate.ts:83](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L83) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L84) +[models/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L84) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L66) +[models/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L66) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/tax-rate.ts:52](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L52) +[models/tax-rate.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L52) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L22) +[models/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L22) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/tax-rate.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L35) +[models/tax-rate.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L35) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L31) +[models/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L31) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L85) +[models/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L85) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/tax-rate.ts:80](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L80) +[models/tax-rate.ts:80](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L80) ___ @@ -180,7 +180,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -194,4 +194,4 @@ BaseEntity.updated\_at #### Defined in -[models/tax-rate.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tax-rate.ts#L87) +[models/tax-rate.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L87) diff --git a/docs/content/references/entities/classes/TrackingLink.md b/docs/content/references/entities/classes/TrackingLink.md index 366a5038ec..a516d77c2c 100644 --- a/docs/content/references/entities/classes/TrackingLink.md +++ b/docs/content/references/entities/classes/TrackingLink.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/tracking-link.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L21) +[models/tracking-link.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L21) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/tracking-link.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L17) +[models/tracking-link.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L17) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/tracking-link.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L24) +[models/tracking-link.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L24) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/tracking-link.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L27) +[models/tracking-link.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L27) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/tracking-link.ts:14](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L14) +[models/tracking-link.ts:14](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L14) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/tracking-link.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L11) +[models/tracking-link.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L11) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/tracking-link.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/tracking-link.ts#L29) +[models/tracking-link.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L29) diff --git a/docs/content/references/entities/classes/User.md b/docs/content/references/entities/classes/User.md index 836adfcce5..b6b8208971 100644 --- a/docs/content/references/entities/classes/User.md +++ b/docs/content/references/entities/classes/User.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/user.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L37) +[models/user.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L37) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/user.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L25) +[models/user.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L25) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/user.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L28) +[models/user.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L28) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/user.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L31) +[models/user.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L31) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/user.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L40) +[models/user.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L40) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/user.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L34) +[models/user.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L34) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/user.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L21) +[models/user.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L21) ___ @@ -144,7 +144,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -158,4 +158,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/user.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L42) +[models/user.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L42) diff --git a/docs/content/references/entities/enums/AllocationType.md b/docs/content/references/entities/enums/AllocationType.md index c96b0fc22a..e7de8c2f93 100644 --- a/docs/content/references/entities/enums/AllocationType.md +++ b/docs/content/references/entities/enums/AllocationType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L16) +[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L16) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L15) +[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L15) diff --git a/docs/content/references/entities/enums/CartType.md b/docs/content/references/entities/enums/CartType.md index 1ec47af4a1..92d7e6d2ad 100644 --- a/docs/content/references/entities/enums/CartType.md +++ b/docs/content/references/entities/enums/CartType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/cart.ts:208](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L208) +[models/cart.ts:208](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L208) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/cart.ts:204](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L204) +[models/cart.ts:204](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L204) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/cart.ts:206](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L206) +[models/cart.ts:206](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L206) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/cart.ts:207](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L207) +[models/cart.ts:207](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L207) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/cart.ts:205](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L205) +[models/cart.ts:205](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L205) diff --git a/docs/content/references/entities/enums/ClaimFulfillmentStatus.md b/docs/content/references/entities/enums/ClaimFulfillmentStatus.md index 15b4be6e0b..6f769f6127 100644 --- a/docs/content/references/entities/enums/ClaimFulfillmentStatus.md +++ b/docs/content/references/entities/enums/ClaimFulfillmentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L45) +[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L45) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L40) +[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L40) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L38) +[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L38) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L39) +[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L39) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L43) +[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L43) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L41) +[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L41) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L46) +[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L46) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L44) +[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L44) ___ @@ -92,4 +92,4 @@ ___ #### Defined in -[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L42) +[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L42) diff --git a/docs/content/references/entities/enums/ClaimPaymentStatus.md b/docs/content/references/entities/enums/ClaimPaymentStatus.md index a876a6262d..5b7fb681b2 100644 --- a/docs/content/references/entities/enums/ClaimPaymentStatus.md +++ b/docs/content/references/entities/enums/ClaimPaymentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L32) +[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L32) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L33) +[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L33) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L34) +[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L34) diff --git a/docs/content/references/entities/enums/ClaimReason.md b/docs/content/references/entities/enums/ClaimReason.md index 8a48fe1d82..c3d6680ffb 100644 --- a/docs/content/references/entities/enums/ClaimReason.md +++ b/docs/content/references/entities/enums/ClaimReason.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L23) +[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L23) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L26) +[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L26) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L25) +[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L25) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L24) +[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L24) diff --git a/docs/content/references/entities/enums/ClaimType.md b/docs/content/references/entities/enums/ClaimType.md index e1c7bf91d9..03576105ee 100644 --- a/docs/content/references/entities/enums/ClaimType.md +++ b/docs/content/references/entities/enums/ClaimType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L27) +[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L27) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L28) +[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L28) diff --git a/docs/content/references/entities/enums/DiscountConditionOperator.md b/docs/content/references/entities/enums/DiscountConditionOperator.md index d8fe97f0f0..1644986c3b 100644 --- a/docs/content/references/entities/enums/DiscountConditionOperator.md +++ b/docs/content/references/entities/enums/DiscountConditionOperator.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L32) +[models/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L32) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/discount-condition.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L33) +[models/discount-condition.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L33) diff --git a/docs/content/references/entities/enums/DiscountConditionType.md b/docs/content/references/entities/enums/DiscountConditionType.md index e44cfbf492..06832d8c3b 100644 --- a/docs/content/references/entities/enums/DiscountConditionType.md +++ b/docs/content/references/entities/enums/DiscountConditionType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L28) +[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L28) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/discount-condition.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L24) +[models/discount-condition.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L24) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L26) +[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L26) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L27) +[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L27) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/discount-condition.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L25) +[models/discount-condition.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L25) diff --git a/docs/content/references/entities/enums/DiscountRuleType.md b/docs/content/references/entities/enums/DiscountRuleType.md index 8875aac6ae..546230542c 100644 --- a/docs/content/references/entities/enums/DiscountRuleType.md +++ b/docs/content/references/entities/enums/DiscountRuleType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L9) +[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L9) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L11) +[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L11) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L10) +[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L10) diff --git a/docs/content/references/entities/enums/DraftOrderStatus.md b/docs/content/references/entities/enums/DraftOrderStatus.md index 587e0ba155..5d50215b33 100644 --- a/docs/content/references/entities/enums/DraftOrderStatus.md +++ b/docs/content/references/entities/enums/DraftOrderStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/draft-order.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L24) +[models/draft-order.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L24) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L23) +[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L23) diff --git a/docs/content/references/entities/enums/FulfillmentStatus.md b/docs/content/references/entities/enums/FulfillmentStatus.md index 76cd29b8da..83041391cb 100644 --- a/docs/content/references/entities/enums/FulfillmentStatus.md +++ b/docs/content/references/entities/enums/FulfillmentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/order.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L62) +[models/order.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L62) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/order.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L57) +[models/order.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L57) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/order.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L55) +[models/order.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L55) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/order.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L56) +[models/order.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L56) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/order.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L60) +[models/order.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L60) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/order.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L58) +[models/order.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L58) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/order.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L63) +[models/order.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L63) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/order.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L61) +[models/order.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L61) ___ @@ -92,4 +92,4 @@ ___ #### Defined in -[models/order.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L59) +[models/order.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L59) diff --git a/docs/content/references/entities/enums/OrderStatus.md b/docs/content/references/entities/enums/OrderStatus.md index b246ba11da..3d3ebccf97 100644 --- a/docs/content/references/entities/enums/OrderStatus.md +++ b/docs/content/references/entities/enums/OrderStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/order.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L49) +[models/order.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L49) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/order.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L50) +[models/order.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L50) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/order.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L48) +[models/order.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L48) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/order.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L47) +[models/order.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L47) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/order.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L51) +[models/order.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L51) diff --git a/docs/content/references/entities/enums/PaymentSessionStatus.md b/docs/content/references/entities/enums/PaymentSessionStatus.md index c8fc982bd4..b581d3ba4a 100644 --- a/docs/content/references/entities/enums/PaymentSessionStatus.md +++ b/docs/content/references/entities/enums/PaymentSessionStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L17) +[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L17) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L21) +[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L21) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L20) +[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L20) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L18) +[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L18) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L19) +[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L19) diff --git a/docs/content/references/entities/enums/PaymentStatus.md b/docs/content/references/entities/enums/PaymentStatus.md index 327869e015..546b4b0099 100644 --- a/docs/content/references/entities/enums/PaymentStatus.md +++ b/docs/content/references/entities/enums/PaymentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/order.ts:68](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L68) +[models/order.ts:68](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L68) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/order.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L72) +[models/order.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L72) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/order.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L69) +[models/order.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L69) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/order.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L67) +[models/order.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L67) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/order.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L70) +[models/order.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L70) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/order.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L71) +[models/order.ts:71](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L71) ___ @@ -72,4 +72,4 @@ ___ #### Defined in -[models/order.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L73) +[models/order.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L73) diff --git a/docs/content/references/entities/enums/ProductStatus.md b/docs/content/references/entities/enums/ProductStatus.md index 6f87419706..bad6477f01 100644 --- a/docs/content/references/entities/enums/ProductStatus.md +++ b/docs/content/references/entities/enums/ProductStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/product.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L28) +[models/product.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L28) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/product.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L29) +[models/product.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L29) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/product.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L30) +[models/product.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L30) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[models/product.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L31) +[models/product.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L31) diff --git a/docs/content/references/entities/enums/RefundReason.md b/docs/content/references/entities/enums/RefundReason.md index 618a71ae68..e7c5ae5c7f 100644 --- a/docs/content/references/entities/enums/RefundReason.md +++ b/docs/content/references/entities/enums/RefundReason.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/refund.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L19) +[models/refund.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L19) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/refund.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L16) +[models/refund.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L16) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/refund.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L20) +[models/refund.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L20) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/refund.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L17) +[models/refund.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L17) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/refund.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L18) +[models/refund.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L18) diff --git a/docs/content/references/entities/enums/RequirementType.md b/docs/content/references/entities/enums/RequirementType.md index 5caafb5c3d..c5fd019d6a 100644 --- a/docs/content/references/entities/enums/RequirementType.md +++ b/docs/content/references/entities/enums/RequirementType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L18) +[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L18) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L17) +[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L17) diff --git a/docs/content/references/entities/enums/ReturnStatus.md b/docs/content/references/entities/enums/ReturnStatus.md index 23ae76c4b0..8783043a68 100644 --- a/docs/content/references/entities/enums/ReturnStatus.md +++ b/docs/content/references/entities/enums/ReturnStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/return.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L25) +[models/return.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L25) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/return.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L23) +[models/return.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L23) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/return.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L22) +[models/return.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L22) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[models/return.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L24) +[models/return.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L24) diff --git a/docs/content/references/entities/enums/ShippingOptionPriceType.md b/docs/content/references/entities/enums/ShippingOptionPriceType.md index 63fc20b106..9adc8904d4 100644 --- a/docs/content/references/entities/enums/ShippingOptionPriceType.md +++ b/docs/content/references/entities/enums/ShippingOptionPriceType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-option.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L22) +[models/shipping-option.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L22) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/shipping-option.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L21) +[models/shipping-option.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L21) diff --git a/docs/content/references/entities/enums/ShippingProfileType.md b/docs/content/references/entities/enums/ShippingProfileType.md index 5d201a7dad..e3892347cc 100644 --- a/docs/content/references/entities/enums/ShippingProfileType.md +++ b/docs/content/references/entities/enums/ShippingProfileType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-profile.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L12) +[models/shipping-profile.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L12) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/shipping-profile.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L10) +[models/shipping-profile.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L10) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/shipping-profile.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L11) +[models/shipping-profile.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L11) diff --git a/docs/content/references/entities/enums/SwapFulfillmentStatus.md b/docs/content/references/entities/enums/SwapFulfillmentStatus.md index 76df627714..cba1b1d79a 100644 --- a/docs/content/references/entities/enums/SwapFulfillmentStatus.md +++ b/docs/content/references/entities/enums/SwapFulfillmentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/swap.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L28) +[models/swap.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L28) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/swap.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L26) +[models/swap.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L26) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/swap.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L25) +[models/swap.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L25) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/swap.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L29) +[models/swap.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L29) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/swap.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L27) +[models/swap.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L27) diff --git a/docs/content/references/entities/enums/SwapPaymentStatus.md b/docs/content/references/entities/enums/SwapPaymentStatus.md index b5b9a9ea2f..2fe9dad0a3 100644 --- a/docs/content/references/entities/enums/SwapPaymentStatus.md +++ b/docs/content/references/entities/enums/SwapPaymentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/swap.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L34) +[models/swap.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L34) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/swap.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L37) +[models/swap.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L37) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/swap.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L35) +[models/swap.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L35) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/swap.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L36) +[models/swap.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L36) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/swap.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L38) +[models/swap.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L38) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/swap.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L33) +[models/swap.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L33) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/swap.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L39) +[models/swap.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L39) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/swap.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L40) +[models/swap.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L40) ___ @@ -92,4 +92,4 @@ ___ #### Defined in -[models/swap.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L41) +[models/swap.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L41) diff --git a/docs/content/references/entities/enums/UserRoles.md b/docs/content/references/entities/enums/UserRoles.md index f889e37eaa..248a5f79c3 100644 --- a/docs/content/references/entities/enums/UserRoles.md +++ b/docs/content/references/entities/enums/UserRoles.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/user.ts:8](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L8) +[models/user.ts:8](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L8) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/user.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L10) +[models/user.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L10) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/user.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L9) +[models/user.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L9) From 47677668191b16b9ae50ecf6541d26561c57fa35 Mon Sep 17 00:00:00 2001 From: Danijel Predojevic Date: Mon, 22 Aug 2022 10:41:03 +0200 Subject: [PATCH 12/19] docs: update admin and storefront API URLs (#2072) Co-authored-by: Danijel Predojevic --- docs/content/introduction.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/introduction.md b/docs/content/introduction.md index aaccbe82b6..672314dd82 100644 --- a/docs/content/introduction.md +++ b/docs/content/introduction.md @@ -20,8 +20,8 @@ The admin dashboard is accessible by store operators. Store operators can use th Medusa provides a beautiful [admin dashboard](https://demo.medusajs.com) that you can use right off the bat. Our admin dashboard provides a lot of functionalities to manage your store including Order management, Product management, User management, and more. -You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin/auth). +You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin). ### Storefront -Your customers use the Storefront to view products and make orders. Medusa provides 2 storefronts, one built with [Next.js](https://docs.medusajs.com/starters/nextjs-medusa-starter) and one with [Gatsby](https://docs.medusajs.com/starters/gatsby-medusa-starter). You are also free to create your own storefront using the [Storefront REST APIs](https://docs.medusajs.com/api/store/auth). +Your customers use the Storefront to view products and make orders. Medusa provides 2 storefronts, one built with [Next.js](https://docs.medusajs.com/starters/nextjs-medusa-starter) and one with [Gatsby](https://docs.medusajs.com/starters/gatsby-medusa-starter). You are also free to create your own storefront using the [Storefront REST APIs](https://docs.medusajs.com/api/store/). From b78171b80cbeae4fb87ee3604cb40520ed397925 Mon Sep 17 00:00:00 2001 From: Danijel Predojevic Date: Mon, 22 Aug 2022 13:35:58 +0200 Subject: [PATCH 13/19] docs: update api urls (#2074) * Update homepage.md * Update add-fulfillment-provider.md * Update gatsby-medusa-starter.md * Update how-to-create-notification-provider.md * Update how-to-create-payment-provider.md * Update how-to-implement-checkout-flow.mdx * Update nextjs-medusa-starter.md * Update paypal.md * Update quick-start.md * Update stripe.md * Update docs/content/advanced/backend/shipping/add-fulfillment-provider.md Co-authored-by: Shahed Nasser * Update docs/content/quickstart/quick-start.md Co-authored-by: Shahed Nasser * Update docs/content/advanced/backend/shipping/add-fulfillment-provider.md Co-authored-by: Shahed Nasser Co-authored-by: Danijel Predojevic Co-authored-by: Shahed Nasser --- docs/content/add-plugins/paypal.md | 12 +++++------ docs/content/add-plugins/stripe.md | 6 +++--- .../how-to-create-notification-provider.md | 10 +++++----- .../payment/how-to-create-payment-provider.md | 18 ++++++++--------- .../shipping/add-fulfillment-provider.md | 14 ++++++------- .../how-to-implement-checkout-flow.mdx | 20 +++++++++---------- docs/content/homepage.md | 2 +- docs/content/quickstart/quick-start.md | 2 +- .../content/starters/gatsby-medusa-starter.md | 2 +- .../content/starters/nextjs-medusa-starter.md | 2 +- 10 files changed, 44 insertions(+), 44 deletions(-) diff --git a/docs/content/add-plugins/paypal.md b/docs/content/add-plugins/paypal.md index dc5d5a7cf4..45a56da32d 100644 --- a/docs/content/add-plugins/paypal.md +++ b/docs/content/add-plugins/paypal.md @@ -20,7 +20,7 @@ Webhooks are used in scenarios where the customer might leave the page during th Additionally, you need a Medusa server installed and set up. If not, you can follow our [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to get started. -You also need [Medusa Admin](../admin/quickstart.md) installed to enable PayPal as a payment provider. You can alternatively use our [REST APIs](https://docs.medusajs.com/api/admin/auth). +You also need [Medusa Admin](../admin/quickstart.md) installed to enable PayPal as a payment provider. You can alternatively use our [REST APIs](https://docs.medusajs.com/api/admin). ## Medusa Server @@ -256,8 +256,8 @@ Here’s briefly what this code snippet does: 1. This component renders a PayPal button to initialize the payment using PayPal. You use the components from the PayPal React components library to render the button and you pass the `PayPalScriptProvider` component the Client ID. 2. When the button is clicked, the `handlePayment` function is executed. In this method, you initialize the payment authorization using `actions.order.authorize()`. It takes the customer to another page to log in with PayPal and authorize the payment. 3. After the payment is authorized successfully on PayPal’s portal, the fulfillment function passed to `actions.order.authorize().then` will be executed which calls the `completeOrder` function. -4. In `completeOrder`, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/cart/select-a-payment-session). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) data with the authorization data received from PayPal. -5. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/cart/complete-a-cart). If that is done successfully, you navigate to the `/order-confirmed` page. +4. In `completeOrder`, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) data with the authorization data received from PayPal. +5. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete). If that is done successfully, you navigate to the `/order-confirmed` page. The last step is to add this component as the component to render when PayPal is available as a payment provider. @@ -385,8 +385,8 @@ Here’s briefly what this code snippet does: 3. This component renders a PayPal button to initialize the payment using PayPal. You use the components from the PayPal React components library to render the button and you pass the `PayPalScriptProvider` component the Client ID. Make sure to replace `` with the environment variable you added. 4. When the button is clicked, the `handlePayment` function is executed. In this method, you initialize the payment authorization using `actions.order.authorize()`. It takes the customer to another page to log in with PayPal and authorize the payment. 5. After the payment is authorized successfully on PayPal’s portal, the fulfillment function passed to `actions.order.authorize().then` will be executed. -6. In the fulfillment function, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/cart/select-a-payment-session). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) data with the authorization data received from PayPal. -7. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/cart/complete-a-cart). If that is done successfully, you just show a success alert. You can change this based on the behavior you want in your storefront. +6. In the fulfillment function, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) data with the authorization data received from PayPal. +7. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete). If that is done successfully, you just show a success alert. You can change this based on the behavior you want in your storefront. You can then import this component where you want to show it in your storefront. @@ -406,4 +406,4 @@ Refunding or Capturing payments is reflected in your PayPal dashboard as well. ## What's Next 🚀 -- Check out [more plugins](https://github.com/medusajs/medusa/tree/master/packages) you can add to your store. \ No newline at end of file +- Check out [more plugins](https://github.com/medusajs/medusa/tree/master/packages) you can add to your store. diff --git a/docs/content/add-plugins/stripe.md b/docs/content/add-plugins/stripe.md index 7b36044266..50054ebbcf 100644 --- a/docs/content/add-plugins/stripe.md +++ b/docs/content/add-plugins/stripe.md @@ -171,10 +171,10 @@ This section will go over how to add Stripe into a React-based framework. The in The integration with stripe must have the following workflow: -1. During checkout when the user reaches the payment section, you should [create payment sessions](https://docs.medusajs.com/api/store/cart/initialize-payment-sessions). This will initialize the `payment_sessions` array in the `cart` object received. The `payment_sessions` is an array of available payment providers. -2. If Stripe is available as a payment provider, you should select Stripe as [the payment session](https://docs.medusajs.com/api/store/cart/select-a-payment-session) for the current cart. This will initialize the `payment_session` object in the `cart` object to include data related to Stripe and the current payment session. This includes the payment intent and client secret. +1. During checkout when the user reaches the payment section, you should [create payment sessions](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessions). This will initialize the `payment_sessions` array in the `cart` object received. The `payment_sessions` is an array of available payment providers. +2. If Stripe is available as a payment provider, you should select Stripe as [the payment session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession) for the current cart. This will initialize the `payment_session` object in the `cart` object to include data related to Stripe and the current payment session. This includes the payment intent and client secret. 3. After the user enters their card details and submits the form, confirm the payment with Stripe. -4. If the payment is confirmed successfully, [complete the order](https://docs.medusajs.com/api/store/cart/complete-a-cart) in Medusa. Otherwise show an error. +4. If the payment is confirmed successfully, [complete the order](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete) in Medusa. Otherwise show an error. #### Install Dependencies diff --git a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md index bc5dcd7786..7f34b835ca 100644 --- a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md +++ b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md @@ -154,7 +154,7 @@ The `to` and `data` properties are used in the `NotificationService` in Medusa ### resendNotification -Using the [Resend Notification endpoint](https://docs.medusajs.com/api/admin/notification/resend-notification), an admin user can resend a Notification to the customer. The [`NotificationService`](../../../references/services/classes/NotificationService.md) in Medusa’s core then executes the `resendNotification` method in your Notification Provider. +Using the [Resend Notification endpoint](https://docs.medusajs.com/api/admin/#tag/Notification/operation/PostNotificationsNotificationResend), an admin user can resend a Notification to the customer. The [`NotificationService`](../../../references/services/classes/NotificationService.md) in Medusa’s core then executes the `resendNotification` method in your Notification Provider. This method receives 3 parameters: @@ -236,7 +236,7 @@ Then, start by running your Medusa server: npm run start ``` -Then, place an order either using the [REST APIs](https://docs.medusajs.com/api/store/auth) or using the storefront. +Then, place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the storefront. :::tip @@ -248,17 +248,17 @@ After placing an order, you can see in your console the message “Notification ## Test Resending Notifications with your Notification Provider -To test resending a notification, first, retrieve the ID of the notification you just sent using the [List Notifications admin endpoint](https://docs.medusajs.com/api/admin/notification/list-notifications). You can pass as a body parameter the `to` or `event_name` parameters to filter out the notification you just sent. +To test resending a notification, first, retrieve the ID of the notification you just sent using the [List Notifications admin endpoint](https://docs.medusajs.com/api/admin/#tag/Notification/operation/GetNotifications). You can pass as a body parameter the `to` or `event_name` parameters to filter out the notification you just sent. :::tip -You must be authenticated as an admin user before sending this request. You can use the [Authenticate a User](https://docs.medusajs.com/api/admin/auth/) endpoint to get authenticated. +You must be authenticated as an admin user before sending this request. You can use the [Authenticate a User](https://docs.medusajs.com/api/admin) endpoint to get authenticated. ::: ![List Notifications Request](https://i.imgur.com/iF1rZX1.png) -Then, send a request to the [Resend Notification](https://docs.medusajs.com/api/admin/notification/resend-notification) endpoint using the ID retrieved from the previous request. You can pass the `to` parameter in the body to change the receiver of the notification. You should see the message “Notification Resent” in your console and if you implemented your own logic for resending the notification it will be resent. +Then, send a request to the [Resend Notification](https://docs.medusajs.com/api/admin/#tag/Notification/operation/PostNotificationsNotificationResend) endpoint using the ID retrieved from the previous request. You can pass the `to` parameter in the body to change the receiver of the notification. You should see the message “Notification Resent” in your console and if you implemented your own logic for resending the notification it will be resent. ![Resend Notifications Request](https://i.imgur.com/0zFfPed.png) diff --git a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md index e867ffe91c..77947f8a09 100644 --- a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md +++ b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md @@ -24,7 +24,7 @@ The Payment Provider service is also required to implement the following methods 2. `retrievePayment`: Used to retrieve payment data from the third-party provider, if there’s any. 3. `getStatus`: Used to get the status of a Payment or Payment Session. 4. `updatePayment`: Used to update the Payment Session whenever the cart and its related data are updated. -5. `updatePaymentData`: Used to update the `data` field of Payment Sessions. Specifically called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) endpoint. +5. `updatePaymentData`: Used to update the `data` field of Payment Sessions. Specifically called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) endpoint. 6. `deletePayment`: Used to perform any action necessary before a Payment Session is deleted. 7. `authorizePayment`: Used to authorize the payment amount of the cart before the order or swap is created. 8. `getPaymentData`: Used to retrieve the data that should be stored in the `data` field of a new Payment instance after the payment amount has been authorized. @@ -72,7 +72,7 @@ As mentioned in the overview, Payment Providers should have a static `identifie The `PaymentProvider` entity has 2 properties: `identifier` and `is_installed`. The value of the `identifier` property in the class will be used when the Payment Provider is created in the database. -The value of this property will also be used to reference the Payment Provider throughout the Medusa server. For example, the identifier is used when a [Payment Session in a cart is selected on checkout](https://docs.medusajs.com/api/store/cart/select-a-payment-session). +The value of this property will also be used to reference the Payment Provider throughout the Medusa server. For example, the identifier is used when a [Payment Session in a cart is selected on checkout](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession). ### constructor @@ -90,7 +90,7 @@ constructor({}, options) { ### createPayment -This method is called during checkout when [Payment Sessions are initialized](https://docs.medusajs.com/api/store/cart/initialize-payment-sessions) to present payment options to the customer. It is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to initialize a Payment Intent for the customer. +This method is called during checkout when [Payment Sessions are initialized](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessions) to present payment options to the customer. It is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to initialize a Payment Intent for the customer. The method receives the cart as an object for its first parameter. It holds all the necessary information you need to know about the cart and the customer that owns this cart. @@ -155,7 +155,7 @@ This code block assumes the status is stored in the `data` field as demonstrated ### updatePayment -This method is used to perform any necessary updates on the payment. This method is called whenever the cart or any of its related data is updated. For example, when a [line item is added to the cart](https://docs.medusajs.com/api/store/cart/add-a-line-item) or when a [shipping method is selected](https://docs.medusajs.com/api/store/cart/add-a-shipping-method). +This method is used to perform any necessary updates on the payment. This method is called whenever the cart or any of its related data is updated. For example, when a [line item is added to the cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartLineItems) or when a [shipping method is selected](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod). :::tip @@ -179,7 +179,7 @@ async updatePayment(sessionData, cart) { ### updatePaymentData -This method is used to update the `data` field of a Payment Session. Particularly, it is called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) endpoint. This endpoint receives a `data` object in the body of the request that should be used to update the existing `data` field of the Payment Session. +This method is used to update the `data` field of a Payment Session. Particularly, it is called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) endpoint. This endpoint receives a `data` object in the body of the request that should be used to update the existing `data` field of the Payment Session. This method accepts the current `data` field of the Payment Session as the first parameter, and the new `data` field sent in the body request as the second parameter. @@ -199,8 +199,8 @@ async updatePaymentData(sessionData, updatedData) { This method is used to perform any actions necessary before a Payment Session is deleted. The Payment Session is deleted in one of the following cases: -1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store/cart/delete-a-payment-session). -2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store/cart/refresh-a-payment-session). The Payment Session is deleted so that a newer one is initialized instead. +1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/DeleteCartsCartPaymentSessionsSession). +2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionsSession). The Payment Session is deleted so that a newer one is initialized instead. 3. When the Payment Provider is no longer available. This generally happens when the store operator removes it from the available Payment Provider in the admin. 4. When the region of the store is changed based on the cart information and the Payment Provider is not available in the new region. @@ -218,7 +218,7 @@ async deletePayment(paymentSession) { ### authorizePayment -This method is used to authorize payment using the Payment Session for an order. This is called when the [cart is completed](https://docs.medusajs.com/api/store/cart/complete-a-cart) and before the order is created. +This method is used to authorize payment using the Payment Session for an order. This is called when the [cart is completed](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete) and before the order is created. This method is also used for authorizing payments of a swap of an order. @@ -347,7 +347,7 @@ async cancelPayment(payment) { This method can be added to your Payment Provider service if your third-party provider supports saving the customer’s payment methods. Please note that in Medusa there is no way to save payment methods. -This method is called when a request is sent to [Retrieve Saved Payment Methods](https://docs.medusajs.com/api/store/customer/retrieve-saved-payment-methods). +This method is called when a request is sent to [Retrieve Saved Payment Methods](https://docs.medusajs.com/api/store/#tag/Customer/operation/GetCustomersCustomerPaymentMethods). This method accepts the customer as an object for its first parameter. diff --git a/docs/content/advanced/backend/shipping/add-fulfillment-provider.md b/docs/content/advanced/backend/shipping/add-fulfillment-provider.md index 08af0cebbf..d1ee828ffd 100644 --- a/docs/content/advanced/backend/shipping/add-fulfillment-provider.md +++ b/docs/content/advanced/backend/shipping/add-fulfillment-provider.md @@ -47,7 +47,7 @@ As mentioned in the overview, fulfillment providers should have a static `identi The `FulfillmentProvider` entity has 2 properties: `identifier` and `is_installed`. The `identifier` property in the class will be used when the fulfillment provider is created in the database. -The value of this property will also be used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin/region/add-fulfillment-provider) to a region. +The value of this property will also be used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin/#tag/Region/operation/PostRegionsRegionFulfillmentProviders) to a region. ```jsx import { FulfillmentService } from "medusa-interfaces" @@ -102,7 +102,7 @@ For that reason, the fulfillment option does not have any required structure and ### validateOption -Once the admin creates the shipping option, the data will be validated first using this method in the underlying fulfillment provider of that shipping option. This method is called when a `POST` request is sent to `[/admin/shipping-options](https://docs.medusajs.com/api/admin/shipping-option/create-shipping-option)`. +Once the admin creates the shipping option, the data will be validated first using this method in the underlying fulfillment provider of that shipping option. This method is called when a `POST` request is sent to [`/admin/shipping-options`](https://docs.medusajs.com/api/admin/#tag/Shipping-Option/operation/PostShippingOptions). This method accepts the `data` object that is sent in the body of the request. You can use this data to validate the shipping option before it is saved. @@ -122,7 +122,7 @@ If your fulfillment provider does not need to run any validation, you can simply When the customer chooses a shipping option on checkout, the shipping option and its data are validated before the shipping method is created. -`validateFulfillmentOption` is called when a `POST` request is sent to `[/carts/:id/shipping-methods](https://docs.medusajs.com/api/store/cart/add-a-shipping-method)`. +`validateFulfillmentOption` is called when a `POST` request is sent to [`/carts/:id/shipping-methods`](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod). This method accepts 3 parameters: @@ -196,7 +196,7 @@ If this method returns `true`, that means that the price should be calculated dy If the method returns `false`, an error is thrown as it means the selected shipping option can only be chosen if the price type is set to `flat_rate`. -This method receives as a parameter the `data` object sent with the request that [creates the shipping option.](https://docs.medusajs.com/api/admin/shipping-option/create-shipping-option) You can use this data to determine whether the shipping option should be calculated or not. This is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options. +This method receives as a parameter the `data` object sent with the request that [creates the shipping option.](https://docs.medusajs.com/api/admin/#tag/Shipping-Option/operation/PostShippingOptions) You can use this data to determine whether the shipping option should be calculated or not. This is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options. For example: @@ -213,7 +213,7 @@ This method is called on checkout when the shipping method is being created if t This method receives 3 parameters: 1. The `data` parameter of the selected shipping option. -2. The `data` parameter sent with [the request](https://docs.medusajs.com/api/store/cart/add-a-shipping-method). +2. The `data` parameter sent with [the request](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod). 3. The customer’s cart data. If your fulfillment provider does not provide any dynamically calculated rates you can keep the function empty: @@ -236,7 +236,7 @@ calculatePrice (optionData, data, cart) { Fulfillment providers can also be used to return products. A shipping option can be used for returns if the `is_return` property is `true` or if an admin creates a Return Shipping Option from the settings. -This method is called when the admin [creates a return request](https://docs.medusajs.com/api/admin/order/request-a-return) for an order or when the customer [creates a return of their order](https://docs.medusajs.com/api/store/return/create-return). +This method is called when the admin [creates a return request](https://docs.medusajs.com/api/admin/#tag/Order/operation/PostOrdersOrderReturns) for an order or when the customer [creates a return of their order](https://docs.medusajs.com/api/store/#tag/Return/operation/PostReturns). It gives you access to the return being created in case you need to perform any additional actions with the third-party provider. @@ -269,4 +269,4 @@ cancelFulfillment(fulfillment) { ## What’s Next 🚀 - Check out the [Webshipper plugin](https://github.com/medusajs/medusa/tree/cab5821f55cfa448c575a20250c918b7fc6835c9/packages/medusa-fulfillment-webshipper) for an example of a fulfillment provider that interacts with a third-party providers. -- Check out the [manual fulfillment plugin](https://github.com/medusajs/medusa/tree/cab5821f55cfa448c575a20250c918b7fc6835c9/packages/medusa-payment-manual) for a basic implementation of a fulfillment provider. \ No newline at end of file +- Check out the [manual fulfillment plugin](https://github.com/medusajs/medusa/tree/cab5821f55cfa448c575a20250c918b7fc6835c9/packages/medusa-payment-manual) for a basic implementation of a fulfillment provider. diff --git a/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx b/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx index 5c05cac164..416a600875 100644 --- a/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx +++ b/docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx @@ -16,7 +16,7 @@ It’s recommended to go through the [Shipping Architecture Overview](../backend ## Prerequisites -This document assumes you’ve already taken care of the add-to-cart flow. So, you should have a [cart created](https://docs.medusajs.com/api/store/cart/create-a-cart) for the customer with at least [one product in it](https://docs.medusajs.com/api/store/cart/add-a-line-item). +This document assumes you’ve already taken care of the add-to-cart flow. So, you should have a [cart created](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCart) for the customer with at least [one product in it](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartLineItems). You can learn how to implement the cart flow using [this documentation](../../guides/carts-in-medusa.mdx). @@ -34,7 +34,7 @@ In this step, the customer generally enters their shipping info, then chooses th ### Add Shipping Address -After the customer enters their shipping address information, you must send a `POST` request to the [Update a Cart](https://docs.medusajs.com/api/store/cart/update-a-cart) API endpoint passing it the new shipping address: +After the customer enters their shipping address information, you must send a `POST` request to the [Update a Cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCart) API endpoint passing it the new shipping address: @@ -94,7 +94,7 @@ You can have access to the updated cart in `response.cart`, which now has the sh ### List Shipping Options -After updating the cart with the customer’s address, the list of available [shipping options](../backend/shipping/overview.md#shipping-option) for that cart might change. So, you should retrieve the updated list of options by sending a `GET` request to the [Retrieve Shipping Options for Cart API](https://docs.medusajs.com/api/store/shipping-option/retrieve-shipping-options-for-cart) endpoint: +After updating the cart with the customer’s address, the list of available [shipping options](../backend/shipping/overview.md#shipping-option) for that cart might change. So, you should retrieve the updated list of options by sending a `GET` request to the [Retrieve Shipping Options for Cart API](https://docs.medusajs.com/api/store/#tag/Shipping-Option/operation/GetShippingOptionsCartId) endpoint: @@ -120,13 +120,13 @@ fetch(`/store/shipping-options/${cart.id}`) -You can access all shipping options available with their info in `response.shipping_options` which is an array of [shipping options](https://docs.medusajs.com/api/store/shipping-option). Typically you would display those options to the customer to choose from. +You can access all shipping options available with their info in `response.shipping_options` which is an array of [shipping options](https://docs.medusajs.com/api/store/#tag/Shipping-Option/operation/GetShippingOptions). Typically you would display those options to the customer to choose from. ### Choose Shipping Option -Once the customer chooses one of the available shipping options, send a `POST` request to the [Add a Shipping Method](https://docs.medusajs.com/api/store/cart/add-a-shipping-method) API endpoint. This will create a [shipping method](../backend/shipping/overview.md#shipping-method) based on the shipping option chosen and will associate it with the customer’s cart: +Once the customer chooses one of the available shipping options, send a `POST` request to the [Add a Shipping Method](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod) API endpoint. This will create a [shipping method](../backend/shipping/overview.md#shipping-method) based on the shipping option chosen and will associate it with the customer’s cart: - + ```jsx @@ -168,7 +168,7 @@ In this step, the customer generally chooses a payment method to complete their When the page opens and before the payment providers are displayed to the customer to choose from, you must initialize the [payment sessions](./../backend/payment/overview.md#payment-session) for the current cart. Each payment provider will have a payment session associated with it. These payment sessions will be used later when the customer chooses the payment provider they want to complete their purchase with. -To initialize the payment sessions, send a `POST` request to the [Initialize Payment Sessions](https://docs.medusajs.com/api/store/cart/initialize-payment-sessions) API endpoint: +To initialize the payment sessions, send a `POST` request to the [Initialize Payment Sessions](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessions) API endpoint: @@ -199,7 +199,7 @@ You can then access the initialized payment sessions under the `payment_sessions ### Select Payment Session -When the customer chooses the payment provider they want to complete purchase with, you should select the payment session associated with that payment provider. To do that, send a `POST` request to the [Select a Payment Session](https://docs.medusajs.com/api/store/cart/select-a-payment-session) API endpoint: +When the customer chooses the payment provider they want to complete purchase with, you should select the payment session associated with that payment provider. To do that, send a `POST` request to the [Select a Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession) API endpoint: @@ -245,7 +245,7 @@ If you have one payment provider or if only one payment provider is available fo This step is optional and is only necessary for some payment providers. As mentioned in the [Payment Architecture](../backend/payment/overview.md#overview) documentation, the `PaymentSession` model has a `data` attribute that holds any data required for the Payment Provider to perform payment operations such as capturing payment. -If you need to update that data at any point before the purchase is made, send a request to [Update a Payment Session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) API endpoint passing it the updated data object: +If you need to update that data at any point before the purchase is made, send a request to [Update a Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) API endpoint passing it the updated data object: @@ -293,7 +293,7 @@ You can have access to the updated data in the payment session in `response.cart The last step is to place the order by completing the cart. When you complete the cart, your Medusa server will try to authorize the payment first, then place the order if the authorization is successful. So, you should perform any necessary action with your payment provider first to make sure the authorization is successful when you send the request to complete the cart. -To complete a cart, send a `POST` request to the [Complete a Cart](https://docs.medusajs.com/api/store/cart/complete-a-cart) API endpoint: +To complete a cart, send a `POST` request to the [Complete a Cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete) API endpoint: diff --git a/docs/content/homepage.md b/docs/content/homepage.md index cd79110e51..cc8442554b 100644 --- a/docs/content/homepage.md +++ b/docs/content/homepage.md @@ -56,7 +56,7 @@ The final step is to set up a storefront to sell your products. Medusa provides 2 starter storefronts, one built with [Next.js](./starters/nextjs-medusa-starter.md) and one with [Gatsby](./starters/gatsby-medusa-starter.md), that you can use to quickly set up your store and start selling. -Alternatively, you can build your own storefront with any frontend framework of your choice just by connecting to your server with the [Storefront REST APIs](https://docs.medusajs.com/api/store/). +Alternatively, you can build your own storefront with any frontend framework of your choice just by connecting to your server with the [Storefront REST APIs](https://docs.medusajs.com/api/store). ## What’s Next 🚀 diff --git a/docs/content/quickstart/quick-start.md b/docs/content/quickstart/quick-start.md index 9bf0ede1ea..c9ce689630 100644 --- a/docs/content/quickstart/quick-start.md +++ b/docs/content/quickstart/quick-start.md @@ -81,5 +81,5 @@ You can learn more about configuring your server and loading environment variabl - Install our [Next.js](../starters/nextjs-medusa-starter) or [Gatsby](../starters/gatsby-medusa-starter) storefronts to set up your ecommerce storefront quickly. - Install the [Medusa Admin](../admin/quickstart.md) to supercharge your ecommerce experience with easy access to configurations and features. -- Check out the [API reference](https://docs.medusajs.com/api) to learn more about available endpoints available on your Medusa server. +- Check out the [API reference](https://docs.medusajs.com/api/store) to learn more about available endpoints available on your Medusa server. - Install [plugins](https://github.com/medusajs/medusa/tree/master/packages) for features like Payment, CMS, Notifications, among other features. diff --git a/docs/content/starters/gatsby-medusa-starter.md b/docs/content/starters/gatsby-medusa-starter.md index 0d7178e026..394bcd2ce8 100644 --- a/docs/content/starters/gatsby-medusa-starter.md +++ b/docs/content/starters/gatsby-medusa-starter.md @@ -108,6 +108,6 @@ The Gatsby storefront comes with a lot of features out of the box including: ## What’s Next 🚀 -- Check the [Storefront API reference](https://docs.medusajs.com/api/store/auth) for a full list of REST APIs to use on your storefront. +- Check the [Storefront API reference](https://docs.medusajs.com/api/store) for a full list of REST APIs to use on your storefront. - Learn how to [deploy the Gatsby storefront on Netlify](../deployments/storefront/deploying-gatsby-on-netlify.md). - Learn how to add [Stripe as a payment provider](../add-plugins/stripe.md#gatsby-storefront). diff --git a/docs/content/starters/nextjs-medusa-starter.md b/docs/content/starters/nextjs-medusa-starter.md index 167993895c..d572e9cad6 100644 --- a/docs/content/starters/nextjs-medusa-starter.md +++ b/docs/content/starters/nextjs-medusa-starter.md @@ -213,5 +213,5 @@ You can learn more about development with Next.js through [their documentation]( ## What’s Next 🚀 -- Check the [Storefront API reference](https://docs.medusajs.com/api/store/auth) for a full list of REST APIs to use on your storefront. +- Check the [Storefront API reference](https://docs.medusajs.com/api/store) for a full list of REST APIs to use on your storefront. - Learn [how to install Medusa Admin](../admin/quickstart.md). From 08d2942ddfc67c127f257e58c952082c28c14930 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 22 Aug 2022 17:51:25 +0300 Subject: [PATCH 14/19] docs: added introduction to user guide (#2075) * docs: added introduction to user guide * remove link in header * added UI icons * small changes --- docs/content/user-guide/index.mdx | 71 +++++++++++++++++++++++++ www/docs/sidebars.js | 7 +++ www/docs/src/components/UiIcon/index.js | 11 ++++ www/docs/src/css/custom.css | 17 ++++++ 4 files changed, 106 insertions(+) create mode 100644 docs/content/user-guide/index.mdx create mode 100644 www/docs/src/components/UiIcon/index.js diff --git a/docs/content/user-guide/index.mdx b/docs/content/user-guide/index.mdx new file mode 100644 index 0000000000..c5d4e036bd --- /dev/null +++ b/docs/content/user-guide/index.mdx @@ -0,0 +1,71 @@ +import UiIcon from '@site/src/components/UiIcon'; + +# Welcome to Medusa’s User Guide + +This user guide is intended to help users learn how they can use the Medusa admin to perform different operational and ecommerce tasks. + +:::tip + +If you don’t have a Medusa admin yet, you can check [our live demo](https://demo.medusajs.com/)! + +::: + +![Medusa Admin Overview](https://i.imgur.com/RdrJznk.png) + +## Accessing the Medusa Admin + +To access the admin panel of your ecommerce store, you must have a URL to the deployed website. + +Once you open the URL, you’ll be asked to log in. + +![Log In Page](https://i.imgur.com/4U2Saed.png) + +You must use your user’s email and password to log in. If you’re unsure what your email and password are, please contact the technical personnel that deployed your Medusa server and admin. + +## Tour of Medusa Admin + +After you log into your Medusa admin, you can see a sidebar menu, a search bar at the top, some icons at the top right, and in the middle the content of the page you’re currently on. + +### Sidebar Menu + +The sidebar menu includes the main navigation of your Medusa admin. You can use it to navigate between different pages, such as Products or Orders pages. + +You can also see your team members in the sidebar menu. These are the users that can access the Medusa Admin. + +![Sidebar Menu](https://i.imgur.com/54y2omy.png) + +### Search Bar + +You’ll find at the top of the page a search bar. You can use this search bar to search orders, products, customers, and more information available in your Medusa Admin. + +:::info Handy Shortcut + +You can open the search window using the shortcuts: + +Windows and Linux: CTRL + K + +Mac OS: ⌘ + K + +::: + +![Search Window](https://i.imgur.com/kIeoiW3.png) + +You can either select a resolve with your mouse, or use the up and down arrows on your keyboard to navigate between the results, then choosing a result by hitting the Enter key. + +### Check Notifications + +At the top right you’ll find a bell icon . Clicking this icon opens a side window to view any notifications you might have. You can use this to view notifications such as completed product exports. + +![Notifications Window](https://i.imgur.com/bmDQ4Cj.png) + +### Quick Actions + +At the top right, you’ll find an avatar icon. By clicking this icon, you’ll see a dropdown. You can use this dropdown to quickly access settings or sign out. + +![Quick Actions Dropdown](https://i.imgur.com/Og7F5oz.png) + +### Need Help? + +At the top right, you’ll find a question mark icon . When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. Our team usually responds in a few hours on business days. + +![Get Help Form](https://i.imgur.com/8Fpa0gr.png) \ No newline at end of file diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 2903eb728c..52ca550b4a 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -488,6 +488,13 @@ module.exports = { label: "Contribution Guidelines", }, ], + userGuideSidebar: [ + { + type: "doc", + id: "user-guide/index", + label: "Introduction" + } + ], servicesSidebar: [ { type: 'autogenerated', diff --git a/www/docs/src/components/UiIcon/index.js b/www/docs/src/components/UiIcon/index.js new file mode 100644 index 0000000000..1f6daebc93 --- /dev/null +++ b/www/docs/src/components/UiIcon/index.js @@ -0,0 +1,11 @@ +import React from 'react'; +import {useColorMode} from '@docusaurus/theme-common'; + +export default function UiIcon ({ lightIcon, darkIcon = '' }) { + const {colorMode} = useColorMode(); + const icon = colorMode === 'dark' && darkIcon ? darkIcon : lightIcon; + + return ( + + ) +} \ No newline at end of file diff --git a/www/docs/src/css/custom.css b/www/docs/src/css/custom.css index 118e1397fe..7980436b53 100644 --- a/www/docs/src/css/custom.css +++ b/www/docs/src/css/custom.css @@ -330,4 +330,21 @@ html[data-theme="dark"] .redocusaurus .expanded + tr > td > div { .redocusaurus a { color: var(--ifm-link-color) !important; +} + +/* User Guide Styling */ +html[data-theme="dark"] kbd { + --ifm-color-emphasis-0: var(--ifm-color-gray-200); +} + +kbd { + --ifm-color-emphasis-800: var(--ifm-color-gray-800); + + font: 100% var(--ifm-font-family-monospace) !important; +} + +.ui-icon { + vertical-align: sub; + width: 20px; + height: 20px; } \ No newline at end of file From 7b6148c1ddd7e8d7ca8423aece01251bae4346e7 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 22 Aug 2022 18:40:33 +0300 Subject: [PATCH 15/19] docs: added orders overview user guide (#2076) --- docs/content/user-guide/index.mdx | 4 +- docs/content/user-guide/orders/index.mdx | 119 +++++++++++++++++++++++ www/docs/sidebars.js | 14 ++- www/docs/src/components/UiIcon/index.js | 4 +- 4 files changed, 136 insertions(+), 5 deletions(-) create mode 100644 docs/content/user-guide/orders/index.mdx diff --git a/docs/content/user-guide/index.mdx b/docs/content/user-guide/index.mdx index c5d4e036bd..fc85952374 100644 --- a/docs/content/user-guide/index.mdx +++ b/docs/content/user-guide/index.mdx @@ -54,7 +54,7 @@ You can either select a resolve with your mouse, or use the up and down arrows o ### Check Notifications -At the top right you’ll find a bell icon . Clicking this icon opens a side window to view any notifications you might have. You can use this to view notifications such as completed product exports. +At the top right you’ll find a icon. Clicking this icon opens a side window to view any notifications you might have. You can use this to view notifications such as completed product exports. ![Notifications Window](https://i.imgur.com/bmDQ4Cj.png) @@ -66,6 +66,6 @@ At the top right, you’ll find an avatar icon. By clicking this icon, you’ll ### Need Help? -At the top right, you’ll find a question mark icon . When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. Our team usually responds in a few hours on business days. +At the top right, you’ll find a icon. When you click on this icon, a form will pop up. You can use this form to send the Medusa team a message asking for help. Our team usually responds in a few hours on business days. ![Get Help Form](https://i.imgur.com/8Fpa0gr.png) \ No newline at end of file diff --git a/docs/content/user-guide/orders/index.mdx b/docs/content/user-guide/orders/index.mdx new file mode 100644 index 0000000000..532143a0f4 --- /dev/null +++ b/docs/content/user-guide/orders/index.mdx @@ -0,0 +1,119 @@ +import UiIcon from '@site/src/components/UiIcon'; + +# Orders Overview + +In this document, you’ll get an overview of the orders listing page and all the things you can do with it. + +## View List of Orders + +You can view the list of available orders in your ecommerce store by clicking on Orders from the sidebar menu. + +![Orders List](https://i.imgur.com/dRBQpZW.png) + +In the list, you can see order details such as the ID, date, customer, fulfillment and payment status, total, and the country of the shipping address. + +:::tip + +If there are more than 15 orders, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## View List of Draft Orders + +You can view the list of draft orders on the Orders page by clicking on the grey Drafts headline next to the Orders headline. + +![Draft Orders List](https://i.imgur.com/jvNVbbI.png) + +In the list, you can see order details such as ID, the ID of the order the draft order belongs to, the date, the customer, and the status of the draft order. + +:::tip + +If there are more than 15 orders, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## Filter Orders + +You can use filters to retrieve only orders matching specific criteria. + +### Quick Filters + +On the Orders list page, you’ll find quick filters such as “Complete” and “Incomplete” at the top of the list. These filters show the complete and incomplete orders respectively. + +You can click on one of these filters to quickly filter the orders based on whether they’re complete or not. + +![Activated quick filter](https://i.imgur.com/FPW8tCY.png) + +### Advanced Filters + +You can use advanced filters to furthermore limit the orders shown based on specific criteria. For example, you can filter orders to only show pending orders created in a specific region. + +To use advanced filters: + +- Click on the icon next to Filters. This will toggle a dropdown with categories for different fields. +- You can click on a field name to expand it and choose a filter for that field. + +![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/7N1OELc.png) + +Once you’re done, you can click on the Apply button at the top of the dropdown. This will retrieve the orders based on the filters you’ve selected. + +### Save Advanced Filters as Quick Filters + +If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “European Orders”. + +To save an advanced filter: + +- Choose your filters from the dropdown. +- Choose a name for the filters in the input at the end of the dropdown. +- Click the Save button. + +![Give the filters a name and click Save](https://i.imgur.com/HhLVYkh.png) + +Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the orders list. + +![Saved Filter shows as a quick filter](https://i.imgur.com/1ep3hVy.png) + +To apply a saved quick filter, just click on it. + +### Delete Saved Quick Filters + +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. + +### Clear Filters + +To clear all applied filters: + +- Click on the + icon next to Filters. +- Click on the Clear button. + +![Click clear button in the advanced filters dropdown](https://i.imgur.com/1ra8L7o.png) + +:::info + +Clearing filters does not delete saved quick filters. You can still apply them by clicking on them. + +::: + +## Search Orders + +You can search for orders by clicking the icon at the top right of the order list. When you search orders, you are searching by the first name supplied in the shipping address, the email associated with the order, and the order ID. + +![Search orders by name](https://i.imgur.com/Z09rbmQ.png) + +## Search Draft Orders + +You can search for draft orders by clicking the icon at the top right of the draft order list. When you search draft orders, you are searching by the email associated with the draft order and the draft order’s ID. + +![Search draft orders by email](https://i.imgur.com/el0Y9WS.png) + +## What More Can you Do With Orders? + +The Orders pages in the Medusa Admin include many functionalities including: + +- Manage and View Order’s Details +- Manage Order’s Payment +- Manage Order’s Fulfillment +- Create a Draft Order +- Manage Order Returns +- Manage Order Claims +- Manage Order Exchanges and Swaps \ No newline at end of file diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 52ca550b4a..148b3031aa 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -493,7 +493,19 @@ module.exports = { type: "doc", id: "user-guide/index", label: "Introduction" - } + }, + { + type: "category", + collapsed: false, + label: "Orders", + items: [ + { + type: "doc", + id: "user-guide/orders/index", + label: "Introduction" + } + ] + }, ], servicesSidebar: [ { diff --git a/www/docs/src/components/UiIcon/index.js b/www/docs/src/components/UiIcon/index.js index 1f6daebc93..8704c8b95a 100644 --- a/www/docs/src/components/UiIcon/index.js +++ b/www/docs/src/components/UiIcon/index.js @@ -1,11 +1,11 @@ import React from 'react'; import {useColorMode} from '@docusaurus/theme-common'; -export default function UiIcon ({ lightIcon, darkIcon = '' }) { +export default function UiIcon ({ lightIcon, darkIcon = '', alt = '' }) { const {colorMode} = useColorMode(); const icon = colorMode === 'dark' && darkIcon ? darkIcon : lightIcon; return ( - + {alt} ) } \ No newline at end of file From b87b83c7d3428de18b2c77d109344b01866ea0db Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 23 Aug 2022 16:37:02 +0300 Subject: [PATCH 16/19] docs: added "Products Overview" user guide (#2082) * docs: added products overview * docs: small changes to orders overview --- docs/content/user-guide/orders/index.mdx | 10 +- docs/content/user-guide/products/index.mdx | 166 +++++++++++++++++++++ www/docs/sidebars.js | 14 +- 3 files changed, 184 insertions(+), 6 deletions(-) create mode 100644 docs/content/user-guide/products/index.mdx diff --git a/docs/content/user-guide/orders/index.mdx b/docs/content/user-guide/orders/index.mdx index 532143a0f4..2b605b16ad 100644 --- a/docs/content/user-guide/orders/index.mdx +++ b/docs/content/user-guide/orders/index.mdx @@ -40,7 +40,7 @@ You can use filters to retrieve only orders matching specific criteria. On the Orders list page, you’ll find quick filters such as “Complete” and “Incomplete” at the top of the list. These filters show the complete and incomplete orders respectively. -You can click on one of these filters to quickly filter the orders based on whether they’re complete or not. +You can click on one of these filters to quickly filter the orders. ![Activated quick filter](https://i.imgur.com/FPW8tCY.png) @@ -52,17 +52,19 @@ To use advanced filters: - Click on the icon next to Filters. This will toggle a dropdown with categories for different fields. - You can click on a field name to expand it and choose a filter for that field. +- Click on the Apply button at the top of the dropdown. + +This will retrieve the orders based on the filters you’ve selected. ![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/7N1OELc.png) -Once you’re done, you can click on the Apply button at the top of the dropdown. This will retrieve the orders based on the filters you’ve selected. - ### Save Advanced Filters as Quick Filters If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “European Orders”. To save an advanced filter: +- Click on the icon next to Filters. - Choose your filters from the dropdown. - Choose a name for the filters in the input at the end of the dropdown. - Click the Save button. @@ -98,7 +100,7 @@ Clearing filters does not delete saved quick filters. You can still apply them b You can search for orders by clicking the icon at the top right of the order list. When you search orders, you are searching by the first name supplied in the shipping address, the email associated with the order, and the order ID. -![Search orders by name](https://i.imgur.com/Z09rbmQ.png) +![Search orders by customer name](https://i.imgur.com/Z09rbmQ.png) ## Search Draft Orders diff --git a/docs/content/user-guide/products/index.mdx b/docs/content/user-guide/products/index.mdx new file mode 100644 index 0000000000..d1e5760355 --- /dev/null +++ b/docs/content/user-guide/products/index.mdx @@ -0,0 +1,166 @@ +import UiIcon from '@site/src/components/UiIcon'; + +# Products Overview + +In this document, you’ll get an overview of the product listing page and all the things you can do with it. + +## View List of Products + +You can view the list of available products in your ecommerce store by clicking on Products from the sidebar menu. + +![Products List](https://i.imgur.com/xvRZQwK.png) + +In the list, you can see product details such as the name, collection, inventory, and status of the product. + +:::tip + +If there are more than 15 products, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## Change Product View + +### List View + +To view products in a list view, which is the default view, click on the icon at the top right of the product list. + +### Grid View + +To view products in a grid view, click on the icon at the top right of the product list. + +![Grid View of Products List](https://i.imgur.com/GkTcjsO.png) + +## View List of Collections + +Collections are used to split products based on their type or function. For example, if you sell furniture and clothing, you can have two collections: Furniture and Clothing. + +You can view the list of collections on the Products page by clicking on the grey Collections headline next to the Products headline. + +![Collections List](https://i.imgur.com/RMRIGAW.png) + +In the list, you can see collection details such as the title, handle, and the number of products in the collection. + +:::tip + +If there are more than 15 collections, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## Filter Products + +You can use filters to retrieve only products matching specific criteria. + +### Quick Filters + +On the Products list page, you can find quick filters such as “Unpublished” at the top of the list. The “Unpublished” filter shows only draft products in the list. + +You can click on these filters to quickly filter the products. + +![Activated quick filter](https://i.imgur.com/VCob6F5.png) + +### Advanced Filters + +You can use advanced filters to furthermore limit the products shown based on specific criteria. For example, you can filter products to only show draft products created in a specific collection. + +To use advanced filters: + +- Click on the icon next to Filters. This will toggle a dropdown with categories for different fields. +- You can click on a field name to expand it and choose a filter for that field. +- Click on the Apply button at the top of the dropdown. + +This will retrieve the products based on the filters you’ve selected. + +![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/WPlTtTA.png) + +### Save Advanced Filters as Quick Filters + +If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “Draft Clothing”. + +To save an advanced filter: + +- Click on the icon next to Filters. +- Choose your filters from the dropdown. +- Choose a name for the filters in the input at the end of the dropdown. +- Click the Save button. + +![Give the filters a name and click Save](https://i.imgur.com/OJ4G1ex.png) + +Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the orders list. + +![Saved Filter shows as a quick filter](https://i.imgur.com/BE9RftP.png) + +To apply a saved quick filter, just click on it. + +### Delete Saved Quick Filters + +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. + +### Clear Filters + +To clear all applied filters: + +- Click on the icon next to Filters. +- Click on the Clear button. + +![Click clear button in the advanced filters dropdown](https://i.imgur.com/MgESrMv.png) + +:::info + +Clearing filters does not delete saved quick filters. You can still apply them by clicking on them. + +::: + +## Search Products + +You can search for products by clicking the icon at the top right of the products list. When you search products, you search by product title, description, variant title, variant SKU, and collection title. + +![Search products by name](https://i.imgur.com/ch6dLZA.png) + +## Search Collections + +You can search for collections by clicking the icon at the top right of the collections list. When you search collections, you search by collection title and handle. + +![Search collections by title](https://i.imgur.com/KMJDIDJ.png) + +## Export Products + +To export products: + +- Go to the Products page. +- Click on Export Products at the top right. +- Click Export in the window that opens. +- Click on the icon at the top right of the page. +- You should see your new export loading. +- Once the export is ready, click on the Download button. + +:::note + +If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used. + +::: + +![Click on the download button in the activity panel](https://i.imgur.com/EVhZExV.png) + +### Cancel a Product Export + +You can only cancel an unfinished product export. + +To cancel a product export: + +- Click on the icon at the top right of the page. +- Find the export you want to cancel. +- Click on the cancel button. + +![Click on the cancel button in the activity panel](https://i.imgur.com/O2IgDQz.png) + +### Delete a Product Export + +You can only delete a finished product export. + +To delete a product export: + +- Click on the icon at the top right of the page. +- Find the export you want to delete. +- Click on the Delete button. + +![Click on the delete button in the activity panel](https://i.imgur.com/KWZ195h.png) \ No newline at end of file diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 148b3031aa..e778a73afd 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -501,8 +501,18 @@ module.exports = { items: [ { type: "doc", - id: "user-guide/orders/index", - label: "Introduction" + id: "user-guide/orders/index" + } + ] + }, + { + type: "category", + collapsed: false, + label: "Products", + items: [ + { + type: "doc", + id: "user-guide/products/index" } ] }, From 136a98ea0728d4b9f9c86999341f171a1368545d Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 23 Aug 2022 17:22:57 +0300 Subject: [PATCH 17/19] docs: added "Customers Overview" documentation (#2083) --- docs/content/user-guide/customers/index.mdx | 54 +++++++++++++++++++++ docs/content/user-guide/orders/index.mdx | 2 +- docs/content/user-guide/products/index.mdx | 9 +++- www/docs/sidebars.js | 11 +++++ www/docs/src/components/UiIcon/index.js | 9 ++-- 5 files changed, 79 insertions(+), 6 deletions(-) create mode 100644 docs/content/user-guide/customers/index.mdx diff --git a/docs/content/user-guide/customers/index.mdx b/docs/content/user-guide/customers/index.mdx new file mode 100644 index 0000000000..ac7a7c220d --- /dev/null +++ b/docs/content/user-guide/customers/index.mdx @@ -0,0 +1,54 @@ +import UiIcon from '@site/src/components/UiIcon'; + +# Customers Overview + +In this document, you’ll get an overview of the customer listing page and all the things you can do with it. + +## View List of Customers + +You can view the list of available orders in your ecommerce store by clicking on Customers from the sidebar menu. + +![Customers List](https://i.imgur.com/VXclXqd.png) + +In the list, you can see customer details such as the customer’s name, email address, and the number of orders. + +:::tip + +If there are more than 15 customers, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## View List of Customer Groups + +Customer groups allow you to put together a set of customers for business purposes. For example, you can create a VIP customer group for customers that you want to give special discounts. + +You can view the list of customer groups on the Customer Groups page by clicking on the grey Groups headline next to the Customers headline. + +![Customer Groups List](https://i.imgur.com/z1nEvhX.png) + +In the list, you can see group details such as the group’s title and the number of customers in the group. + +:::tip + +If there are more than 15 customer groups, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## Search Customers + +You can search for customers by clicking the icon at the top right of the customer list. When you search for customers, you search by their first name, last name, and email. + +![Search customers by name](https://i.imgur.com/c0IFMej.png) + +## Search Customer Groups + +You can search for customer groups by clicking the icon at the top right of the group list. When you search groups, you search by the customer group’s title. + +![Search customer groups by title](https://i.imgur.com/aksN5eW.png) + +## What More Can you Do with Customers? + +The Customers pages in the Medusa Admin include many functionalities including: + +- Manage and View a Customer’s Details +- Manage and View a Customer Group \ No newline at end of file diff --git a/docs/content/user-guide/orders/index.mdx b/docs/content/user-guide/orders/index.mdx index 2b605b16ad..a43f635acb 100644 --- a/docs/content/user-guide/orders/index.mdx +++ b/docs/content/user-guide/orders/index.mdx @@ -108,7 +108,7 @@ You can search for draft orders by clicking the + ) } \ No newline at end of file From 687a6badeb6b54f9d688b3ea67f418adc6d5ff5d Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 23 Aug 2022 18:06:23 +0300 Subject: [PATCH 18/19] docs: Added "Discounts Overview" to User Guide (#2084) * small fixes to customers * small fixes to products * docs: added "Discounts Overview" page --- docs/content/user-guide/customers/index.mdx | 2 +- docs/content/user-guide/discounts/index.mdx | 88 +++++++++++++++++++++ docs/content/user-guide/products/index.mdx | 2 +- www/docs/sidebars.js | 11 +++ 4 files changed, 101 insertions(+), 2 deletions(-) create mode 100644 docs/content/user-guide/discounts/index.mdx diff --git a/docs/content/user-guide/customers/index.mdx b/docs/content/user-guide/customers/index.mdx index ac7a7c220d..94ab3c40a4 100644 --- a/docs/content/user-guide/customers/index.mdx +++ b/docs/content/user-guide/customers/index.mdx @@ -6,7 +6,7 @@ In this document, you’ll get an overview of the customer listing page and all ## View List of Customers -You can view the list of available orders in your ecommerce store by clicking on Customers from the sidebar menu. +You can view the list of available customers in your ecommerce store by clicking on Customers from the sidebar menu. ![Customers List](https://i.imgur.com/VXclXqd.png) diff --git a/docs/content/user-guide/discounts/index.mdx b/docs/content/user-guide/discounts/index.mdx new file mode 100644 index 0000000000..56b3a37561 --- /dev/null +++ b/docs/content/user-guide/discounts/index.mdx @@ -0,0 +1,88 @@ +import UiIcon from '@site/src/components/UiIcon'; + +# Discounts Overview + +In this document, you’ll get an overview of the customer listing page and all the things you can do with it. + +## View List of Discounts + +You can view the list of available discounts in your ecommerce store by clicking on Discounts from the sidebar menu. + +![Discounts List](https://i.imgur.com/buJGt36.png) + +In the list, you can see discount details such as the code, description, amount, and status. + +:::tip + +If there are more than 15 discounts, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## Filter Discounts + +You can use filters to retrieve only discounts matching specific criteria. + +## Advanced Filters + +You can use advanced filters to limit the discounts shown based on specific criteria. For example, you can filter discounts to only show dynamic discounts. + +To use advanced filters: + +- Click on the icon next to Filters. This will toggle a dropdown with categories for different fields. +- You can click on a field name to expand it and choose a filter for that field. +- Click on the Apply button at the top of the dropdown. + +This will retrieve the discount based on the filters you’ve selected. + +![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/LWPMXG5.png) + +## Save Advanced Filters as Quick Filters + +If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “Normal Discounts”. + +To save an advanced filter: + +- Click on the icon next to Filters. +- Choose your filters from the dropdown. +- Choose a name for the filters in the input at the end of the dropdown. +- Click the Save button. + +![Give the filters a name and click Save](https://i.imgur.com/HjVMQG4.png) + +Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the products list. + +![Saved Filter shows as a quick filter](https://i.imgur.com/Kycxtny.png) + +To apply a saved quick filter, just click on it. + +### Delete Saved Quick Filters + +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. + +### Clear Filters + +To clear all applied filters: + +- Click on the icon next to Filters. +- Click on the Clear button. + +![Click clear button in the advanced filters dropdown](https://i.imgur.com/98ms0U2.png) + +:::info + +Clearing filters does not delete saved quick filters. You can still apply them by clicking on them. + +::: + +## Search Discounts + +You can search for discounts by clicking the icon at the top right of the discounts list. When you search for discounts, you search by discount codes. + +![Search discounts by code](https://i.imgur.com/zab2oqp.png) + +## What More Can you Do with Discounts? + +The Discounts pages in the Medusa Admin include many functionalities including: + +- Create a Discount +- Edit a Discount diff --git a/docs/content/user-guide/products/index.mdx b/docs/content/user-guide/products/index.mdx index a7a896ef83..456e9bba1b 100644 --- a/docs/content/user-guide/products/index.mdx +++ b/docs/content/user-guide/products/index.mdx @@ -85,7 +85,7 @@ To save an advanced filter: ![Give the filters a name and click Save](https://i.imgur.com/OJ4G1ex.png) -Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the orders list. +Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the products list. ![Saved Filter shows as a quick filter](https://i.imgur.com/BE9RftP.png) diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 51bef3722d..ce56e24396 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -527,6 +527,17 @@ module.exports = { } ] }, + { + type: "category", + collapsed: false, + label: "Discounts", + items: [ + { + type: "doc", + id: "user-guide/discounts/index" + } + ] + }, ], servicesSidebar: [ { From 690ca9e89a209360680ccd4a7208e7a2c437aff9 Mon Sep 17 00:00:00 2001 From: "Carlos R. L. Rodrigues" <37986729+carlos-r-l-rodrigues@users.noreply.github.com> Date: Wed, 24 Aug 2022 07:29:53 -0300 Subject: [PATCH 19/19] chore(integration-tests): Normalize DB config + use single process (#2077) --- .github/workflows/action.yml | 4 ++-- integration-tests/{.env.template => .env.test} | 1 + .../api/__tests__/admin/discount.js | 1 - .../__tests__/line-item-adjustments/index.js | 4 ---- integration-tests/api/jest.config.js | 1 + integration-tests/api/medusa-config.js | 9 +++++---- integration-tests/helpers/use-db.js | 18 ++++++++---------- integration-tests/helpers/use-template-db.js | 11 +++++++---- integration-tests/jest.config.js | 1 + integration-tests/plugins/jest.config.js | 1 + integration-tests/plugins/medusa-config.js | 13 +++++++------ integration-tests/plugins/package.json | 2 +- integration-tests/setup-env.js | 8 ++++++++ integration-tests/setup.js | 16 ++++++---------- package.json | 8 ++++---- 15 files changed, 52 insertions(+), 46 deletions(-) rename integration-tests/{.env.template => .env.test} (78%) create mode 100644 integration-tests/setup-env.js diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml index ed2eeeac6f..0e1423b25c 100644 --- a/.github/workflows/action.yml +++ b/.github/workflows/action.yml @@ -143,7 +143,7 @@ jobs: working-directory: integration-tests/api - name: Run integration tests - run: yarn test --maxWorkers=50% + run: yarn test --runInBand working-directory: integration-tests/api env: DB_PASSWORD: postgres @@ -215,6 +215,6 @@ jobs: working-directory: integration-tests/plugins - name: Run plugin integration tests - run: yarn test:integration:plugins --maxWorkers=50% --silent=false + run: yarn test:integration:plugins --silent=false env: DB_PASSWORD: postgres diff --git a/integration-tests/.env.template b/integration-tests/.env.test similarity index 78% rename from integration-tests/.env.template rename to integration-tests/.env.test index b8fc5610ab..ef7d4eb129 100644 --- a/integration-tests/.env.template +++ b/integration-tests/.env.test @@ -1,3 +1,4 @@ # Default postgres credentials +DB_HOST=localhost DB_USERNAME=postgres DB_PASSWORD='' \ No newline at end of file diff --git a/integration-tests/api/__tests__/admin/discount.js b/integration-tests/api/__tests__/admin/discount.js index 5a56698f7d..7b3982bc1c 100644 --- a/integration-tests/api/__tests__/admin/discount.js +++ b/integration-tests/api/__tests__/admin/discount.js @@ -2233,7 +2233,6 @@ describe("/admin/discounts", () => { }) const cond = discountCondition.data.discount_condition - console.log(cond.products) expect(discountCondition.status).toEqual(200) expect(cond).toMatchSnapshot({ diff --git a/integration-tests/api/__tests__/line-item-adjustments/index.js b/integration-tests/api/__tests__/line-item-adjustments/index.js index 31ccf99527..5a9d4cc601 100644 --- a/integration-tests/api/__tests__/line-item-adjustments/index.js +++ b/integration-tests/api/__tests__/line-item-adjustments/index.js @@ -101,10 +101,6 @@ describe("Line Item Adjustments", () => { await doAfterEach() }) - afterEach(async () => { - await doAfterEach() - }) - describe("Given an existing line item, a discount, and a line item adjustment for both", () => { describe("When creating an adjustment for another line item w. same discount", () => { test("Then should create an adjustment", async () => { diff --git a/integration-tests/api/jest.config.js b/integration-tests/api/jest.config.js index f91a72a144..862113b1b4 100644 --- a/integration-tests/api/jest.config.js +++ b/integration-tests/api/jest.config.js @@ -17,6 +17,7 @@ module.exports = { ], transformIgnorePatterns: [`/dist`], transform: { "^.+\\.[jt]s$": `../../jest-transformer.js` }, + setupFiles: ["../setup-env.js"], setupFilesAfterEnv: ["../setup.js"], globalSetup: "../globalSetup.js", globalTeardown: "../globalTeardown.js", diff --git a/integration-tests/api/medusa-config.js b/integration-tests/api/medusa-config.js index 5d076946b6..ef42b43153 100644 --- a/integration-tests/api/medusa-config.js +++ b/integration-tests/api/medusa-config.js @@ -1,12 +1,13 @@ -const DB_USERNAME = process.env.DB_USERNAME || "postgres" -const DB_PASSWORD = process.env.DB_PASSWORD || "" -const workerId = parseInt(process.env.JEST_WORKER_ID || "1") +const DB_HOST = process.env.DB_HOST +const DB_USERNAME = process.env.DB_USERNAME +const DB_PASSWORD = process.env.DB_PASSWORD +const DB_NAME = process.env.DB_TEMP_NAME module.exports = { plugins: [], projectConfig: { redis_url: process.env.REDIS_URL, - database_url: `postgres://${DB_USERNAME}:${DB_PASSWORD}@localhost/medusa-integration-${workerId}`, + database_url: `postgres://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}/${DB_NAME}`, database_type: "postgres", jwt_secret: "test", cookie_secret: "test", diff --git a/integration-tests/helpers/use-db.js b/integration-tests/helpers/use-db.js index 36b301c33b..fb8c10f661 100644 --- a/integration-tests/helpers/use-db.js +++ b/integration-tests/helpers/use-db.js @@ -1,18 +1,19 @@ const path = require("path") -require("dotenv").config({ path: path.join(__dirname, "../.env") }) const { dropDatabase } = require("pg-god") const { createConnection } = require("typeorm") const dbFactory = require("./use-template-db") -const workerId = parseInt(process.env.JEST_WORKER_ID || "1") -const DB_USERNAME = process.env.DB_USERNAME || "postgres" -const DB_PASSWORD = process.env.DB_PASSWORD || "" -const DB_URL = `postgres://${DB_USERNAME}:${DB_PASSWORD}@localhost/medusa-integration-${workerId}` +const DB_HOST = process.env.DB_HOST +const DB_USERNAME = process.env.DB_USERNAME +const DB_PASSWORD = process.env.DB_PASSWORD +const DB_NAME = process.env.DB_TEMP_NAME +const DB_URL = `postgres://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}/${DB_NAME}` const pgGodCredentials = { user: DB_USERNAME, password: DB_PASSWORD, + host: DB_HOST, } const keepTables = [ @@ -69,8 +70,7 @@ const DbTestUtil = { shutdown: async function () { await this.db_.close() - const databaseName = `medusa-integration-${workerId}` - return await dropDatabase({ databaseName }, pgGodCredentials) + return await dropDatabase({ DB_NAME }, pgGodCredentials) }, } @@ -117,9 +117,7 @@ module.exports = { instance.setDb(dbConnection) return dbConnection } else { - const databaseName = `medusa-integration-${workerId}` - - await dbFactory.createFromTemplate(databaseName) + await dbFactory.createFromTemplate(DB_NAME) // get migraitons with enabled featureflags const migrationDir = path.resolve( diff --git a/integration-tests/helpers/use-template-db.js b/integration-tests/helpers/use-template-db.js index 484acda457..5af2fe9797 100644 --- a/integration-tests/helpers/use-template-db.js +++ b/integration-tests/helpers/use-template-db.js @@ -1,16 +1,19 @@ const path = require("path") -require("dotenv").config({ path: path.join(__dirname, "../.env") }) + +require("dotenv").config({ path: path.join(__dirname, "../.env.test") }) const { createDatabase, dropDatabase } = require("pg-god") const { createConnection, getConnection } = require("typeorm") -const DB_USERNAME = process.env.DB_USERNAME || "postgres" -const DB_PASSWORD = process.env.DB_PASSWORD || "" -const DB_URL = `postgres://${DB_USERNAME}:${DB_PASSWORD}@localhost` +const DB_HOST = process.env.DB_HOST +const DB_USERNAME = process.env.DB_USERNAME +const DB_PASSWORD = process.env.DB_PASSWORD +const DB_URL = `postgres://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}` const pgGodCredentials = { user: DB_USERNAME, password: DB_PASSWORD, + host: DB_HOST, } class DatabaseFactory { diff --git a/integration-tests/jest.config.js b/integration-tests/jest.config.js index 9c43ae0e76..f9e2ed225d 100644 --- a/integration-tests/jest.config.js +++ b/integration-tests/jest.config.js @@ -25,5 +25,6 @@ module.exports = { `.cache`, ], transform: { "^.+\\.[jt]s$": `/jest-transformer.js` }, + setupFiles: ["/integration-tests/setup-env.js"], setupFilesAfterEnv: ["/integration-tests/setup.js"], } diff --git a/integration-tests/plugins/jest.config.js b/integration-tests/plugins/jest.config.js index 4350251337..298282f809 100644 --- a/integration-tests/plugins/jest.config.js +++ b/integration-tests/plugins/jest.config.js @@ -15,6 +15,7 @@ module.exports = { ], transformIgnorePatterns: [`/dist`], transform: { "^.+\\.[jt]s$": `../../jest-transformer.js` }, + setupFiles: ["../setup-env.js"], setupFilesAfterEnv: ["../setup.js"], globalSetup: "../globalSetup.js", globalTeardown: "../globalTeardown.js", diff --git a/integration-tests/plugins/medusa-config.js b/integration-tests/plugins/medusa-config.js index 91896bce98..2b16170fa9 100644 --- a/integration-tests/plugins/medusa-config.js +++ b/integration-tests/plugins/medusa-config.js @@ -1,6 +1,7 @@ -const DB_USERNAME = process.env.DB_USERNAME || "postgres" -const DB_PASSWORD = process.env.DB_PASSWORD || "" -const workerId = parseInt(process.env.JEST_WORKER_ID || "1") +const DB_HOST = process.env.DB_HOST +const DB_USERNAME = process.env.DB_USERNAME +const DB_PASSWORD = process.env.DB_PASSWORD +const DB_NAME = process.env.DB_TEMP_NAME module.exports = { plugins: [ @@ -22,9 +23,9 @@ module.exports = { ], projectConfig: { // redis_url: REDIS_URL, - database_url: `postgres://${DB_USERNAME}:${DB_PASSWORD}@localhost/medusa-integration-${workerId}`, + database_url: `postgres://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}/${DB_NAME}`, database_type: "postgres", - jwt_secret: 'test', - cookie_secret: 'test' + jwt_secret: "test", + cookie_secret: "test", }, } diff --git a/integration-tests/plugins/package.json b/integration-tests/plugins/package.json index d0869a4edb..21bf58868b 100644 --- a/integration-tests/plugins/package.json +++ b/integration-tests/plugins/package.json @@ -4,7 +4,7 @@ "main": "index.js", "license": "MIT", "scripts": { - "test": "jest --maxWorkers=50% --silent=false", + "test": "jest --runInBand --silent=false", "build": "babel src -d dist --extensions \".ts,.js\"" }, "dependencies": { diff --git a/integration-tests/setup-env.js b/integration-tests/setup-env.js new file mode 100644 index 0000000000..da786853dd --- /dev/null +++ b/integration-tests/setup-env.js @@ -0,0 +1,8 @@ +const path = require("path") + +require("dotenv").config({ path: path.join(__dirname, ".env.test") }) + +if (typeof process.env.DB_TEMP_NAME === "undefined") { + const tempName = parseInt(process.env.JEST_WORKER_ID || "1") + process.env.DB_TEMP_NAME = `medusa-integration-${tempName}` +} diff --git a/integration-tests/setup.js b/integration-tests/setup.js index 54a3d0eb44..484988cd45 100644 --- a/integration-tests/setup.js +++ b/integration-tests/setup.js @@ -1,20 +1,16 @@ -const path = require("path") const { dropDatabase } = require("pg-god") -require("dotenv").config({ path: path.join(__dirname, ".env") }) - -const DB_USERNAME = process.env.DB_USERNAME || "postgres" -const DB_PASSWORD = process.env.DB_PASSWORD || "" +const DB_HOST = process.env.DB_HOST +const DB_USERNAME = process.env.DB_USERNAME +const DB_PASSWORD = process.env.DB_PASSWORD +const DB_NAME = process.env.DB_TEMP_NAME const pgGodCredentials = { user: DB_USERNAME, password: DB_PASSWORD, + host: DB_HOST, } afterAll(async () => { - const workerId = parseInt(process.env.JEST_WORKER_ID || "1") - await dropDatabase( - { databaseName: `medusa-integration-${workerId}` }, - pgGodCredentials - ) + await dropDatabase({ databaseName: DB_NAME }, pgGodCredentials) }) diff --git a/package.json b/package.json index e5b08d1445..df3a6070fe 100644 --- a/package.json +++ b/package.json @@ -64,10 +64,10 @@ "jest": "jest", "test": "turbo run test", "prettier": "prettier", - "test:integration": "jest --config=integration-tests/jest.config.js", - "test:integration:api": "jest --config=integration-tests/jest.config.js --projects=integration-tests/api", - "test:integration:plugins": "jest --config=integration-tests/jest.config.js --projects=integration-tests/plugins", - "test:fixtures": "jest --config=docs-util/jest.config.js --runInBand", + "test:integration": "NODE_ENV=test jest --runInBand --config=integration-tests/jest.config.js", + "test:integration:api": "NODE_ENV=test jest --runInBand --config=integration-tests/jest.config.js --projects=integration-tests/api", + "test:integration:plugins": "NODE_ENV=test jest --runInBand --config=integration-tests/jest.config.js --projects=integration-tests/plugins", + "test:fixtures": "NODE_ENV=test jest --config=docs-util/jest.config.js --runInBand", "openapi:generate": "node ./scripts/build-openapi.js", "generate:services": "typedoc --options typedoc.services.js", "generate:js-client": "typedoc --options typedoc.js-client.js",