@medusajs/medusa 1.3.5 → 1.3.6-next.0

package/dist/models/oauth.d.ts

@@ -7,3 +7,38 @@ export declare class Oauth {
     data: Record<string, unknown>;
     private beforeInsert;
 }
+/**
+ * @schema OAuth
+ * title: "OAuth"
+ * description: "Represent an OAuth app"
+ * x-resourceId: OAuth
+ * required:
+ *   - id
+ *   - display_name
+ *   - application_name
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The app's ID
+ *     example: example_app
+ *   display_name:
+ *     type: string
+ *     description: The app's display name
+ *     example: Example app
+ *   application_name:
+ *     type: string
+ *     description: The app's name
+ *     example: example
+ *   install_url:
+ *     type: string
+ *     description: The URL to install the app
+ *     format: uri
+ *   uninstall_url:
+ *     type: string
+ *     description: The URL to uninstall the app
+ *     format: uri
+ *   data:
+ *     type: object
+ *     description: Any data necessary to the app.
+ *     example: {}
+ */

package/dist/models/oauth.js

@@ -56,4 +56,39 @@ var Oauth = /** @class */ (function () {
     return Oauth;
 }());
 exports.Oauth = Oauth;
+/**
+ * @schema OAuth
+ * title: "OAuth"
+ * description: "Represent an OAuth app"
+ * x-resourceId: OAuth
+ * required:
+ *   - id
+ *   - display_name
+ *   - application_name
+ * properties:
+ *   id:
+ *     type: string
+ *     description: The app's ID
+ *     example: example_app
+ *   display_name:
+ *     type: string
+ *     description: The app's display name
+ *     example: Example app
+ *   application_name:
+ *     type: string
+ *     description: The app's name
+ *     example: example
+ *   install_url:
+ *     type: string
+ *     description: The URL to install the app
+ *     format: uri
+ *   uninstall_url:
+ *     type: string
+ *     description: The URL to uninstall the app
+ *     format: uri
+ *   data:
+ *     type: object
+ *     description: Any data necessary to the app.
+ *     example: {}
+ */
 //# sourceMappingURL=oauth.js.map

package/dist/models/oauth.js.map

@@ -1 +1 @@
-{"version":3,"file":"oauth.js","sourceRoot":"","sources":["../../src/models/oauth.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAA4E;AAC5E,4DAAwD;AACxD,kEAA8D;AAG9D;IAAA;IAwBA,CAAC;IAHS,4BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC;IArBD;QADC,IAAA,uBAAa,GAAE;;qCACN;IAGV;QADC,IAAA,gBAAM,GAAE;;+CACW;IAIpB;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;mDACe;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACR;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACN;IAGrB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCACpB;IAG7B;QADC,IAAA,sBAAY,GAAE;;;;6CAGd;IAvBU,KAAK;QADjB,IAAA,gBAAM,GAAE;OACI,KAAK,CAwBjB;IAAD,YAAC;CAAA,AAxBD,IAwBC;AAxBY,sBAAK"}
+{"version":3,"file":"oauth.js","sourceRoot":"","sources":["../../src/models/oauth.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAA4E;AAE5E,4DAAwD;AACxD,kEAA8D;AAG9D;IAAA;IAwBA,CAAC;IAHS,4BAAY,GAApB;QACE,IAAI,CAAC,EAAE,GAAG,IAAA,qCAAgB,EAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC;IArBD;QADC,IAAA,uBAAa,GAAE;;qCACN;IAGV;QADC,IAAA,gBAAM,GAAE;;+CACW;IAIpB;QAFC,IAAA,eAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACvB,IAAA,gBAAM,GAAE;;mDACe;IAGxB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACR;IAGnB;QADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACN;IAGrB;QADC,IAAA,+BAAa,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uCACpB;IAG7B;QADC,IAAA,sBAAY,GAAE;;;;6CAGd;IAvBU,KAAK;QADjB,IAAA,gBAAM,GAAE;OACI,KAAK,CAwBjB;IAAD,YAAC;CAAA,AAxBD,IAwBC;AAxBY,sBAAK;AA0BlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG"}

package/dist/models/order.d.ts

@@ -1,5 +1,5 @@
-import { BaseEntity } from "../interfaces/models/base-entity";
 import { Address } from "./address";
+import { BaseEntity } from "../interfaces/models/base-entity";
 import { Cart } from "./cart";
 import { ClaimOrder } from "./claim-order";
 import { Currency } from "./currency";
@@ -14,9 +14,9 @@ import { Payment } from "./payment";
 import { Refund } from "./refund";
 import { Region } from "./region";
 import { Return } from "./return";
+import { SalesChannel } from "./sales-channel";
 import { ShippingMethod } from "./shipping-method";
 import { Swap } from "./swap";
-import { SalesChannel } from "./sales-channel";
 export declare enum OrderStatus {
     PENDING = "pending",
     COMPLETED = "completed",
@@ -101,19 +101,29 @@ export declare class Order extends BaseEntity {
  * title: "Order"
  * description: "Represents an order"
  * x-resourceId: order
+ * required:
+ *   - customer_id
+ *   - email
+ *   - region_id
+ *   - currency_code
  * properties:
  *   id:
  *     type: string
+ *     description: The order's ID
+ *     example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  *   status:
  *     type: string
+ *     description: The order's status
  *     enum:
  *       - pending
  *       - completed
  *       - archived
  *       - canceled
  *       - requires_action
+ *     default: pending
  *   fulfillment_status:
  *     type: string
+ *     description: The order's fulfillment status
  *     enum:
  *       - not_fulfilled
  *       - partially_fulfilled
@@ -124,8 +134,10 @@ export declare class Order extends BaseEntity {
  *       - returned
  *       - canceled
  *       - requires_action
+ *     default: not_fulfilled
  *   payment_status:
  *     type: string
+ *     description: The order's payment status
  *     enum:
  *       - not_paid
  *       - awaiting
@@ -134,116 +146,195 @@ export declare class Order extends BaseEntity {
  *       - refuneded
  *       - canceled
  *       - requires_action
+ *     default: not_paid
  *   display_id:
  *     type: integer
+ *     description: The order's display ID
+ *     example: 2
  *   cart_id:
  *     type: string
- *   currency_code:
+ *     description: The ID of the cart associated with the order
+ *     example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+ *   cart:
+ *     description: A cart object. Available if the relation `cart` is expanded.
+ *     type: object
+ *   customer_id:
  *     type: string
- *   tax_rate:
- *     type: number
- *   discounts:
- *     type: array
- *     items:
- *       $ref: "#/components/schemas/discount"
+ *     description: The ID of the customer associated with the order
+ *     example: cus_01G2SG30J8C85S4A5CHM2S1NS2
+ *   customer:
+ *     description: A customer object. Available if the relation `customer` is expanded.
+ *     type: object
  *   email:
+ *     description: The email associated with the order
  *     type: string
+ *     format: email
  *   billing_address_id:
  *     type: string
+ *     description: The ID of the billing address associated with the order
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   billing_address:
- *     anyOf:
- *       - $ref: "#/components/schemas/address"
+ *     description: Available if the relation `billing_address` is expanded.
+ *     $ref: "#/components/schemas/address"
  *   shipping_address_id:
  *     type: string
+ *     description: The ID of the shipping address associated with the order
+ *     example: addr_01G8ZH853YPY9B94857DY91YGW
  *   shipping_address:
- *     anyOf:
- *       - $ref: "#/components/schemas/address"
- *   items:
- *     type: array
- *     items:
- *       $ref: "#/components/schemas/line_item"
+ *     description: Available if the relation `shipping_address` is expanded.
+ *     $ref: "#/components/schemas/address"
  *   region_id:
  *     type: string
+ *     description: The region's ID
+ *     example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  *   region:
- *     anyOf:
- *       - $ref: "#/components/schemas/region"
- *   gift_cards:
- *     type: array
- *     items:
- *       $ref: "#/components/schemas/gift_card"
- *   customer_id:
+ *     description: A region object. Available if the relation `region` is expanded.
+ *     type: object
+ *   currency_code:
+ *     description: "The 3 character currency code that is used in the order"
  *     type: string
- *   customer:
- *     anyOf:
- *       - $ref: "#/components/schemas/customer"
- *   payment_session:
- *     anyOf:
- *       - $ref: "#/components/schemas/payment_session"
- *   payment_sessions:
+ *     example: usd
+ *     externalDocs:
+ *       url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+ *       description: See a list of codes.
+ *   currency:
+ *     description: Available if the relation `currency` is expanded.
+ *     $ref: "#/components/schemas/currency"
+ *   tax_rate:
+ *     description: The order's tax rate
+ *     type: number
+ *     example: 0
+ *   discounts:
  *     type: array
+ *     description: The discounts used in the order. Available if the relation `discounts` is expanded.
  *     items:
- *       $ref: "#/components/schemas/payment_session"
- *   payments:
+ *       type: object
+ *       description: A discount object.
+ *   gift_cards:
  *     type: array
+ *     description: The gift cards used in the order. Available if the relation `gift_cards` is expanded.
  *     items:
- *       $ref: "#/components/schemas/payment"
+ *       type: object
+ *       description: A gift card object.
  *   shipping_methods:
  *     type: array
+ *     description: The shipping methods used in the order. Available if the relation `shipping_methods` is expanded.
  *     items:
  *       $ref: "#/components/schemas/shipping_method"
+ *   payments:
+ *     type: array
+ *     description: The payments used in the order. Available if the relation `payments` is expanded.
+ *     items:
+ *       $ref: "#/components/schemas/payment"
  *   fulfillments:
  *     type: array
+ *     description: The fulfillments used in the order. Available if the relation `fulfillments` is expanded.
  *     items:
  *       $ref: "#/components/schemas/fulfillment"
  *   returns:
  *     type: array
+ *     description: The returns associated with the order. Available if the relation `returns` is expanded.
  *     items:
- *       $ref: "#/components/schemas/return"
+ *       type: object
+ *       description: A return object.
  *   claims:
  *     type: array
+ *     description: The claims associated with the order. Available if the relation `claims` is expanded.
  *     items:
- *       $ref: "#/components/schemas/claim_order"
+ *       type: object
+ *       description: A claim order object.
  *   refunds:
  *     type: array
+ *     description: The refunds associated with the order. Available if the relation `refunds` is expanded.
  *     items:
- *       $ref: "#/components/schemas/refund"
+ *       type: object
+ *       description: A refund object.
  *   swaps:
  *     type: array
+ *     description: The swaps associated with the order. Available if the relation `swaps` is expanded.
  *     items:
- *       $ref: "#/components/schemas/refund"
+ *       type: object
+ *       description: A swap object.
+ *   draft_order_id:
+ *     type: string
+ *     description: The ID of the draft order this order is associated with.
+ *     example: null
+ *   draft_order:
+ *     description: A draft order object. Available if the relation `draft_order` is expanded.
+ *     type: object
+ *   items:
+ *     type: array
+ *     description: The line items that belong to the order. Available if the relation `items` is expanded.
+ *     items:
+ *       $ref: "#/components/schemas/line_item"
  *   gift_card_transactions:
  *     type: array
+ *     description: The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded.
  *     items:
  *       $ref: "#/components/schemas/gift_card_transaction"
  *   canceled_at:
  *     type: string
+ *     description: The date the order was canceled on.
  *     format: date-time
- *   created_at:
+ *   no_notification:
+ *     description: "Flag for describing whether or not notifications related to this should be send."
+ *     type: boolean
+ *     example: false
+ *   idempotency_key:
  *     type: string
- *     format: date-time
- *   update_at:
+ *     description: Randomly generated key used to continue the processing of the order in case of failure.
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+ *       description: Learn more how to use the idempotency key.
+ *   external_id:
+ *     description: The ID of an external order.
  *     type: string
- *     format: date-time
- *   deleted_at:
+ *     example: null
+ *   sales_channel_id:
  *     type: string
- *     format: date-time
- *   metadata:
+ *     description: The ID of the sales channel this order is associated with.
+ *     example: null
+ *   sales_channel:
+ *     description: A sales channel object. Available if the relation `sales_channel` is expanded.
  *     type: object
  *   shipping_total:
  *     type: integer
+ *     description: The total of shipping
+ *     example: 1000
  *   discount_total:
  *     type: integer
+ *     description: The total of discount
+ *     example: 800
  *   tax_total:
  *     type: integer
+ *     description: The total of tax
+ *     example: 0
+ *   refunded_total:
+ *     type: integer
+ *     description: The total amount refunded if the order is returned.
+ *     example: 0
+ *   total:
+ *     type: integer
+ *     description: The total amount of the order
+ *     example: 8200
  *   subtotal:
  *     type: integer
+ *     description: The subtotal of the order
+ *     example: 8000
+ *   paid_total:
+ *     type: integer
+ *     description: The total amount paid
+ *     example: 8000
  *   refundable_amount:
  *     type: integer
+ *     description: The amount that can be refunded
+ *     example: 8200
  *   gift_card_total:
  *     type: integer
- *   paid_total:
+ *     description: The total of gift cards
+ *     example: 0
+ *   gift_card_tax_total:
  *     type: integer
- *   no_notification:
- *     description: "Flag for describing whether or not notifications related to this should be send."
- *     type: boolean
+ *     description: The total of gift cards with taxes
+ *     example: 0
  */