docs: added idempotency key documentation (#4039)
This commit is contained in:
@@ -129,7 +129,7 @@
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* context:
|
||||
* description: "The context of the cart which can include info like IP or user agent."
|
||||
|
||||
@@ -262,6 +262,6 @@ export class ClaimOrder extends SoftDeletableEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
*/
|
||||
|
||||
@@ -151,7 +151,7 @@ export class DraftOrder extends BaseEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* created_at:
|
||||
* description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -199,7 +199,7 @@ export class Fulfillment extends BaseEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* created_at:
|
||||
* description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -74,7 +74,7 @@ export class IdempotencyKey {
|
||||
* description: The unique randomly generated key used to determine the state of a process.
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* created_at:
|
||||
* description: Date which the idempotency key was locked.
|
||||
|
||||
@@ -487,7 +487,7 @@ export class Order extends BaseEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* external_id:
|
||||
* description: The ID of an external order.
|
||||
|
||||
@@ -132,7 +132,7 @@ export class PaymentSession extends BaseEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* amount:
|
||||
* description: The amount that the Payment Session has been authorized for.
|
||||
|
||||
@@ -181,7 +181,7 @@ export class Payment extends BaseEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* created_at:
|
||||
* description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -124,7 +124,7 @@ export class Refund extends BaseEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* created_at:
|
||||
* description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -191,7 +191,7 @@ export class Return extends BaseEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* received_at:
|
||||
* description: The date with timezone at which the return was received.
|
||||
|
||||
@@ -248,7 +248,7 @@ export class Swap extends SoftDeletableEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* created_at:
|
||||
* description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -74,7 +74,7 @@ export class TrackingLink extends SoftDeletableEntity {
|
||||
* nullable: true
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
* url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
||||
* description: Learn more how to use the idempotency key.
|
||||
* created_at:
|
||||
* description: The date with timezone at which the resource was created.
|
||||
|
||||
Reference in New Issue
Block a user