@vendure/docs 0.0.0-202601161541

package/docs/reference/typescript-api/entities/promotion.md

@@ -0,0 +1,190 @@
+---
+title: "Promotion"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Promotion
+
+<GenerationInfo sourceFile="packages/core/src/entity/promotion/promotion.entity.ts" sourceLine="61" packageName="@vendure/core" />
+
+A Promotion is used to define a set of conditions under which promotions actions (typically discounts)
+will be applied to an Order.
+
+Each assigned <a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a> is checked against the Order, and if they all return `true`,
+then each assign <a href='/reference/typescript-api/promotions/promotion-action#promotionitemaction'>PromotionItemAction</a> / <a href='/reference/typescript-api/promotions/promotion-action#promotionlineaction'>PromotionLineAction</a> / <a href='/reference/typescript-api/promotions/promotion-action#promotionorderaction'>PromotionOrderAction</a> / <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingaction'>PromotionShippingAction</a> is applied to the Order.
+
+```ts title="Signature"
+class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable, HasCustomFields, Translatable {
+    type = AdjustmentType.PROMOTION;
+    constructor(input?: DeepPartial<Promotion> & {
+            promotionConditions?: Array<PromotionCondition<any>>;
+            promotionActions?: Array<PromotionAction<any>>;
+        })
+    @Column({ type: Date, nullable: true })
+    deletedAt: Date | null;
+    @Column({ type: Date, nullable: true })
+    startsAt: Date | null;
+    @Column({ type: Date, nullable: true })
+    endsAt: Date | null;
+    @Column({ nullable: true })
+    couponCode: string;
+    @Column({ nullable: true })
+    perCustomerUsageLimit: number;
+    @Column({ nullable: true })
+    usageLimit: number;
+    name: LocaleString;
+    description: LocaleString;
+    @OneToMany(type => PromotionTranslation, translation => translation.base, { eager: true })
+    translations: Array<Translation<Promotion>>;
+    @Column() enabled: boolean;
+    @ManyToMany(type => Channel, channel => channel.promotions)
+    @JoinTable()
+    channels: Channel[];
+    @ManyToMany(type => Order, order => order.promotions)
+    orders: Order[];
+    @Column(type => CustomPromotionFields)
+    customFields: CustomPromotionFields;
+    @Column('simple-json') conditions: ConfigurableOperation[];
+    @Column('simple-json') actions: ConfigurableOperation[];
+    @Column() priorityScore: number;
+    apply(ctx: RequestContext, args: ApplyOrderActionArgs | ApplyOrderItemActionArgs | ApplyShippingActionArgs, state?: PromotionState) => Promise<Adjustment | undefined>;
+    test(ctx: RequestContext, order: Order) => Promise<PromotionTestResult>;
+    activate(ctx: RequestContext, order: Order) => ;
+    deactivate(ctx: RequestContext, order: Order) => ;
+}
+```
+* Extends: <code>AdjustmentSource</code>
+
+
+* Implements: <code><a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a></code>, <code><a href='/reference/typescript-api/entities/interfaces#softdeletable'>SoftDeletable</a></code>, <code>HasCustomFields</code>, <code><a href='/reference/typescript-api/entities/interfaces#translatable'>Translatable</a></code>
+
+
+
+<div className="members-wrapper">
+
+### type
+
+<MemberInfo kind="property" type={``}   />
+
+
+### constructor
+
+<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>&#62; &#38; {             promotionConditions?: Array&#60;<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>&#60;any&#62;&#62;;             promotionActions?: Array&#60;<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>&#60;any&#62;&#62;;         }) => Promotion`}   />
+
+
+### deletedAt
+
+<MemberInfo kind="property" type={`Date | null`}   />
+
+
+### startsAt
+
+<MemberInfo kind="property" type={`Date | null`}   />
+
+
+### endsAt
+
+<MemberInfo kind="property" type={`Date | null`}   />
+
+
+### couponCode
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### perCustomerUsageLimit
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### usageLimit
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### name
+
+<MemberInfo kind="property" type={`LocaleString`}   />
+
+
+### description
+
+<MemberInfo kind="property" type={`LocaleString`}   />
+
+
+### translations
+
+<MemberInfo kind="property" type={`Array&#60;Translation&#60;<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>&#62;&#62;`}   />
+
+
+### enabled
+
+<MemberInfo kind="property" type={`boolean`}   />
+
+
+### channels
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]`}   />
+
+
+### orders
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/order#order'>Order</a>[]`}   />
+
+
+### customFields
+
+<MemberInfo kind="property" type={`CustomPromotionFields`}   />
+
+
+### conditions
+
+<MemberInfo kind="property" type={`ConfigurableOperation[]`}   />
+
+
+### actions
+
+<MemberInfo kind="property" type={`ConfigurableOperation[]`}   />
+
+
+### priorityScore
+
+<MemberInfo kind="property" type={`number`}   />
+
+The PriorityScore is used to determine the sequence in which multiple promotions are tested
+on a given order. A higher number moves the Promotion towards the end of the sequence.
+
+The score is derived from the sum of the priorityValues of the PromotionConditions and
+PromotionActions comprising this Promotion.
+
+An example illustrating the need for a priority is this:
+
+
+Consider 2 Promotions, 1) buy 1 get one free and 2) 10% off when order total is over $50.
+If Promotion 2 is evaluated prior to Promotion 1, then it can trigger the 10% discount even
+if the subsequent application of Promotion 1 brings the order total down to way below $50.
+### apply
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, args: ApplyOrderActionArgs | ApplyOrderItemActionArgs | ApplyShippingActionArgs, state?: PromotionState) => Promise&#60;Adjustment | undefined&#62;`}   />
+
+
+### test
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;PromotionTestResult&#62;`}   />
+
+
+### activate
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `}   />
+
+
+### deactivate
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/entities/province.md

@@ -0,0 +1,39 @@
+---
+title: "Province"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Province
+
+<GenerationInfo sourceFile="packages/core/src/entity/region/province.entity.ts" sourceLine="13" packageName="@vendure/core" />
+
+A Province represents an administrative subdivision of a <a href='/reference/typescript-api/entities/country#country'>Country</a>. For example, in the
+United States, the country would be "United States" and the province would be "California".
+
+```ts title="Signature"
+class Province extends Region {
+    constructor(input?: DeepPartial<Province>)
+    readonly type: RegionType = 'province';
+}
+```
+* Extends: <code><a href='/reference/typescript-api/entities/region#region'>Region</a></code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/province#province'>Province</a>&#62;) => Province`}   />
+
+
+### type
+
+<MemberInfo kind="property" type={`RegionType`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/entities/refund.md

@@ -0,0 +1,120 @@
+---
+title: "Refund"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Refund
+
+<GenerationInfo sourceFile="packages/core/src/entity/refund/refund.entity.ts" sourceLine="19" packageName="@vendure/core" />
+
+A refund the belongs to an order
+
+```ts title="Signature"
+class Refund extends VendureEntity implements HasCustomFields {
+    constructor(input?: DeepPartial<Refund>)
+    @Money() items: number;
+    @Money() shipping: number;
+    @Money() adjustment: number;
+    @Money() total: number;
+    @Column() method: string;
+    @Column({ nullable: true }) reason: string;
+    @Column('varchar') state: RefundState;
+    @Column({ nullable: true }) transactionId: string;
+    @OneToMany(type => RefundLine, line => line.refund)
+    @JoinTable()
+    lines: RefundLine[];
+    @Index()
+    @ManyToOne(type => Payment, payment => payment.refunds)
+    @JoinColumn()
+    payment: Payment;
+    @EntityId()
+    paymentId: ID;
+    @Column('simple-json') metadata: PaymentMetadata;
+    @Column(type => CustomRefundFields)
+    customFields: CustomRefundFields;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a></code>
+
+
+* Implements: <code>HasCustomFields</code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>&#62;) => Refund`}   />
+
+
+### items
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### shipping
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### adjustment
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### total
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### method
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### reason
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### state
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>`}   />
+
+
+### transactionId
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### lines
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/order-line-reference#refundline'>RefundLine</a>[]`}   />
+
+
+### payment
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/payment#payment'>Payment</a>`}   />
+
+
+### paymentId
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
+
+
+### metadata
+
+<MemberInfo kind="property" type={`PaymentMetadata`}   />
+
+
+### customFields
+
+<MemberInfo kind="property" type={`CustomRefundFields`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/entities/region.md

@@ -0,0 +1,87 @@
+---
+title: "Region"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Region
+
+<GenerationInfo sourceFile="packages/core/src/entity/region/region.entity.ts" sourceLine="22" packageName="@vendure/core" />
+
+A Region represents a geographical administrative unit, such as a Country, Province, State, Prefecture etc.
+This is an abstract class which is extended by the <a href='/reference/typescript-api/entities/country#country'>Country</a> and <a href='/reference/typescript-api/entities/province#province'>Province</a> entities.
+Regions can be grouped into <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>s which are in turn used to determine applicable shipping and taxes for an <a href='/reference/typescript-api/entities/order#order'>Order</a>.
+
+```ts title="Signature"
+class Region extends VendureEntity implements Translatable, HasCustomFields {
+    @Column() code: string;
+    @Column({ nullable: false, type: 'varchar' })
+    readonly type: RegionType;
+    name: LocaleString;
+    @Index()
+    @ManyToOne(type => Region, { nullable: true, onDelete: 'SET NULL' })
+    parent?: Region;
+    @EntityId({ nullable: true })
+    parentId?: ID;
+    @Column() enabled: boolean;
+    @OneToMany(type => RegionTranslation, translation => translation.base, { eager: true })
+    translations: Array<Translation<Region>>;
+    @Column(type => CustomRegionFields)
+    customFields: CustomRegionFields;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a></code>
+
+
+* Implements: <code><a href='/reference/typescript-api/entities/interfaces#translatable'>Translatable</a></code>, <code>HasCustomFields</code>
+
+
+
+<div className="members-wrapper">
+
+### code
+
+<MemberInfo kind="property" type={`string`}   />
+
+A code representing the region. The code format will depend on the type of region. For
+example, a Country code will be a 2-letter ISO code, whereas a Province code could use
+a format relevant to the type of province, e.g. a US state code like "CA".
+### type
+
+<MemberInfo kind="property" type={`RegionType`}   />
+
+
+### name
+
+<MemberInfo kind="property" type={`LocaleString`}   />
+
+
+### parent
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/region#region'>Region</a>`}   />
+
+
+### parentId
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
+
+
+### enabled
+
+<MemberInfo kind="property" type={`boolean`}   />
+
+
+### translations
+
+<MemberInfo kind="property" type={`Array&#60;Translation&#60;<a href='/reference/typescript-api/entities/region#region'>Region</a>&#62;&#62;`}   />
+
+
+### customFields
+
+<MemberInfo kind="property" type={`CustomRegionFields`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/entities/role.md

@@ -0,0 +1,62 @@
+---
+title: "Role"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Role
+
+<GenerationInfo sourceFile="packages/core/src/entity/role/role.entity.ts" sourceLine="16" packageName="@vendure/core" />
+
+A Role represents a collection of permissions which determine the authorization
+level of a <a href='/reference/typescript-api/entities/user#user'>User</a> on a given set of <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>s.
+
+```ts title="Signature"
+class Role extends VendureEntity implements ChannelAware {
+    constructor(input?: DeepPartial<Role>)
+    @Column() code: string;
+    @Column() description: string;
+    @Column('simple-array') permissions: Permission[];
+    @ManyToMany(type => Channel, channel => channel.roles)
+    @JoinTable()
+    channels: Channel[];
+}
+```
+* Extends: <code><a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a></code>
+
+
+* Implements: <code><a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a></code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;) => Role`}   />
+
+
+### code
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### description
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### permissions
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>[]`}   />
+
+
+### channels
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/entities/seller.md

@@ -0,0 +1,63 @@
+---
+title: "Seller"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Seller
+
+<GenerationInfo sourceFile="packages/core/src/entity/seller/seller.entity.ts" sourceLine="17" packageName="@vendure/core" />
+
+A Seller represents the person or organization who is selling the goods on a given <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>.
+By default, a single-channel Vendure installation will have a single default Seller.
+
+```ts title="Signature"
+class Seller extends VendureEntity implements SoftDeletable, HasCustomFields {
+    constructor(input?: DeepPartial<Seller>)
+    @Column({ type: Date, nullable: true })
+    deletedAt: Date | null;
+    @Column() name: string;
+    @Column(type => CustomSellerFields)
+    customFields: CustomSellerFields;
+    @OneToMany(type => Channel, channel => channel.seller)
+    channels: Channel[];
+}
+```
+* Extends: <code><a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a></code>
+
+
+* Implements: <code><a href='/reference/typescript-api/entities/interfaces#softdeletable'>SoftDeletable</a></code>, <code>HasCustomFields</code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>&#62;) => Seller`}   />
+
+
+### deletedAt
+
+<MemberInfo kind="property" type={`Date | null`}   />
+
+
+### name
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### customFields
+
+<MemberInfo kind="property" type={`CustomSellerFields`}   />
+
+
+### channels
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/entities/session.md

@@ -0,0 +1,87 @@
+---
+title: "Session"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Session
+
+<GenerationInfo sourceFile="packages/core/src/entity/session/session.entity.ts" sourceLine="18" packageName="@vendure/core" />
+
+A Session is created when a user makes a request to restricted API operations. A Session can be an <a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a>
+in the case of un-authenticated users, otherwise it is an <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>.
+
+```ts title="Signature"
+class Session extends VendureEntity implements HasCustomFields {
+    @Index({ unique: true })
+    @Column()
+    token: string;
+    @Column() expires: Date;
+    @Column() invalidated: boolean;
+    @EntityId({ nullable: true })
+    activeOrderId?: ID;
+    @Index()
+    @ManyToOne(type => Order)
+    activeOrder: Order | null;
+    @EntityId({ nullable: true })
+    activeChannelId?: ID;
+    @Index()
+    @ManyToOne(type => Channel)
+    activeChannel: Channel | null;
+    @Column(type => CustomSessionFields)
+    customFields: CustomSessionFields;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a></code>
+
+
+* Implements: <code>HasCustomFields</code>
+
+
+
+<div className="members-wrapper">
+
+### token
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### expires
+
+<MemberInfo kind="property" type={`Date`}   />
+
+
+### invalidated
+
+<MemberInfo kind="property" type={`boolean`}   />
+
+
+### activeOrderId
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
+
+
+### activeOrder
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/order#order'>Order</a> | null`}   />
+
+
+### activeChannelId
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
+
+
+### activeChannel
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | null`}   />
+
+
+### customFields
+
+<MemberInfo kind="property" type={`CustomSessionFields`}   />
+
+
+
+
+</div>