DocumentationTypesInterfaces

Config

amerta


amerta / payload-types / Config

Interface: Config

Defined in: payload-types.ts:95

Properties

auth

auth: { customers: CustomerAuthOperations; users: UserAuthOperations; }

Defined in: payload-types.ts:96

customers

customers: CustomerAuthOperations

users

users: UserAuthOperations


blocks

blocks: { }

Defined in: payload-types.ts:100


collections

collections: { cart: Cart; cart-rules: CartRule; categories: Category; collections: Collection; country: Country; coupons: Coupon; currency: Currency; customer-groups: CustomerGroup; customer-tags: CustomerTag; customers: Customer; email-templates: EmailTemplate; form-submissions: FormSubmission; forms: Form; media: Media; menu: Menu; orders: Order; pages: Page; payload-jobs: PayloadJob; payload-kv: PayloadKv; payload-locked-documents: PayloadLockedDocument; payload-migrations: PayloadMigration; payload-preferences: PayloadPreference; payment-method: PaymentMethod; payments: Payment; posts: Post; product-brands: ProductBrand; product-media: ProductMedia; product-options: ProductOption; product-reviews: ProductReview; product-tags: ProductTag; products: Product; redirects: Redirect; sales-channel: SalesChannel; shipping: Shipping; store: Store; tags: Tag; tax-rate: TaxRate; translations: Translation; users: User; wishlist: Wishlist; }

Defined in: payload-types.ts:101

cart

cart: Cart

cart-rules

cart-rules: CartRule

categories

categories: Category

collections

collections: Collection

country

country: Country

coupons

coupons: Coupon

currency

currency: Currency

customer-groups

customer-groups: CustomerGroup

customer-tags

customer-tags: CustomerTag

customers

customers: Customer

email-templates

email-templates: EmailTemplate

form-submissions

form-submissions: FormSubmission

forms

forms: Form

media

media: Media

menu

menu: Menu

orders

orders: Order

pages

pages: Page

payload-jobs

payload-jobs: PayloadJob

payload-kv

payload-kv: PayloadKv

payload-locked-documents

payload-locked-documents: PayloadLockedDocument

payload-migrations

payload-migrations: PayloadMigration

payload-preferences

payload-preferences: PayloadPreference

payment-method

payment-method: PaymentMethod

payments

payments: Payment

posts

posts: Post

product-brands

product-brands: ProductBrand

product-media

product-media: ProductMedia

product-options

product-options: ProductOption

product-reviews

product-reviews: ProductReview

product-tags

product-tags: ProductTag

products

products: Product

redirects

redirects: Redirect

sales-channel

sales-channel: SalesChannel

shipping

shipping: Shipping

store

store: Store

tags

tags: Tag

tax-rate

tax-rate: TaxRate

translations

translations: Translation

users

users: User

wishlist

wishlist: Wishlist


collectionsJoins

collectionsJoins: { }

Defined in: payload-types.ts:143


collectionsSelect

collectionsSelect: { cart: CartSelect<false> | CartSelect<true>; cart-rules: CartRulesSelect<false> | CartRulesSelect<true>; categories: CategoriesSelect<false> | CategoriesSelect<true>; collections: CollectionsSelect<false> | CollectionsSelect<true>; country: CountrySelect<false> | CountrySelect<true>; coupons: CouponsSelect<false> | CouponsSelect<true>; currency: CurrencySelect<false> | CurrencySelect<true>; customer-groups: CustomerGroupsSelect<false> | CustomerGroupsSelect<true>; customer-tags: CustomerTagsSelect<false> | CustomerTagsSelect<true>; customers: CustomersSelect<false> | CustomersSelect<true>; email-templates: EmailTemplatesSelect<false> | EmailTemplatesSelect<true>; form-submissions: FormSubmissionsSelect<false> | FormSubmissionsSelect<true>; forms: FormsSelect<false> | FormsSelect<true>; media: MediaSelect<false> | MediaSelect<true>; menu: MenuSelect<false> | MenuSelect<true>; orders: OrdersSelect<false> | OrdersSelect<true>; pages: PagesSelect<false> | PagesSelect<true>; payload-jobs: PayloadJobsSelect<false> | PayloadJobsSelect<true>; payload-kv: PayloadKvSelect<false> | PayloadKvSelect<true>; payload-locked-documents: PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>; payload-migrations: PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>; payload-preferences: PayloadPreferencesSelect<false> | PayloadPreferencesSelect<true>; payment-method: PaymentMethodSelect<false> | PaymentMethodSelect<true>; payments: PaymentsSelect<false> | PaymentsSelect<true>; posts: PostsSelect<false> | PostsSelect<true>; product-brands: ProductBrandsSelect<false> | ProductBrandsSelect<true>; product-media: ProductMediaSelect<false> | ProductMediaSelect<true>; product-options: ProductOptionsSelect<false> | ProductOptionsSelect<true>; product-reviews: ProductReviewsSelect<false> | ProductReviewsSelect<true>; product-tags: ProductTagsSelect<false> | ProductTagsSelect<true>; products: ProductsSelect<false> | ProductsSelect<true>; redirects: RedirectsSelect<false> | RedirectsSelect<true>; sales-channel: SalesChannelSelect<false> | SalesChannelSelect<true>; shipping: ShippingSelect<false> | ShippingSelect<true>; store: StoreSelect<false> | StoreSelect<true>; tags: TagsSelect<false> | TagsSelect<true>; tax-rate: TaxRateSelect<false> | TaxRateSelect<true>; translations: TranslationsSelect<false> | TranslationsSelect<true>; users: UsersSelect<false> | UsersSelect<true>; wishlist: WishlistSelect<false> | WishlistSelect<true>; }

Defined in: payload-types.ts:144

cart

cart: CartSelect<false> | CartSelect<true>

cart-rules

cart-rules: CartRulesSelect<false> | CartRulesSelect<true>

categories

categories: CategoriesSelect<false> | CategoriesSelect<true>

collections

collections: CollectionsSelect<false> | CollectionsSelect<true>

country

country: CountrySelect<false> | CountrySelect<true>

coupons

coupons: CouponsSelect<false> | CouponsSelect<true>

currency

currency: CurrencySelect<false> | CurrencySelect<true>

customer-groups

customer-groups: CustomerGroupsSelect<false> | CustomerGroupsSelect<true>

customer-tags

customer-tags: CustomerTagsSelect<false> | CustomerTagsSelect<true>

customers

customers: CustomersSelect<false> | CustomersSelect<true>

email-templates

email-templates: EmailTemplatesSelect<false> | EmailTemplatesSelect<true>

form-submissions

form-submissions: FormSubmissionsSelect<false> | FormSubmissionsSelect<true>

forms

forms: FormsSelect<false> | FormsSelect<true>

media

media: MediaSelect<false> | MediaSelect<true>

menu

menu: MenuSelect<false> | MenuSelect<true>

orders

orders: OrdersSelect<false> | OrdersSelect<true>

pages

pages: PagesSelect<false> | PagesSelect<true>

payload-jobs

payload-jobs: PayloadJobsSelect<false> | PayloadJobsSelect<true>

payload-kv

payload-kv: PayloadKvSelect<false> | PayloadKvSelect<true>

payload-locked-documents

payload-locked-documents: PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>

payload-migrations

payload-migrations: PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>

payload-preferences

payload-preferences: PayloadPreferencesSelect<false> | PayloadPreferencesSelect<true>

payment-method

payment-method: PaymentMethodSelect<false> | PaymentMethodSelect<true>

payments

payments: PaymentsSelect<false> | PaymentsSelect<true>

posts

posts: PostsSelect<false> | PostsSelect<true>

product-brands

product-brands: ProductBrandsSelect<false> | ProductBrandsSelect<true>

product-media

product-media: ProductMediaSelect<false> | ProductMediaSelect<true>

product-options

product-options: ProductOptionsSelect<false> | ProductOptionsSelect<true>

product-reviews

product-reviews: ProductReviewsSelect<false> | ProductReviewsSelect<true>

product-tags

product-tags: ProductTagsSelect<false> | ProductTagsSelect<true>

products

products: ProductsSelect<false> | ProductsSelect<true>

redirects

redirects: RedirectsSelect<false> | RedirectsSelect<true>

sales-channel

sales-channel: SalesChannelSelect<false> | SalesChannelSelect<true>

shipping

shipping: ShippingSelect<false> | ShippingSelect<true>

store

store: StoreSelect<false> | StoreSelect<true>

tags

tags: TagsSelect<false> | TagsSelect<true>

tax-rate

tax-rate: TaxRateSelect<false> | TaxRateSelect<true>

translations

translations: TranslationsSelect<false> | TranslationsSelect<true>

users

users: UsersSelect<false> | UsersSelect<true>

wishlist

wishlist: WishlistSelect<false> | WishlistSelect<true>


db

db: { defaultIDType: string; }

Defined in: payload-types.ts:186

defaultIDType

defaultIDType: string


fallbackLocale

fallbackLocale: false | "en" | "es" | "zh" | "ja" | "ko" | "fr" | "de" | "it" | "pt" | "nl" | "ru" | "pl" | "tr" | "cs" | "el" | "ar" | "hi" | "id" | "th" | "vi" | "ms" | "sv" | "da" | "no" | "fi" | "false" | "none" | "null" | ("en" | "es" | "zh" | "ja" | "ko" | "fr" | "de" | "it" | "pt" | "nl" | "ru" | "pl" | "tr" | "cs" | "el" | "ar" | "hi" | "id" | "th" | "vi" | "ms" | "sv" | "da" | "no" | "fi")[] | null

Defined in: payload-types.ts:189


globals

globals: { ecommerce-settings: EcommerceSettings; footer: Footer; header: Header; settings: Settings; }

Defined in: payload-types.ts:247

ecommerce-settings

ecommerce-settings: EcommerceSettings

footer

footer: Footer

header

header: Header

settings

settings: Settings


globalsSelect

globalsSelect: { ecommerce-settings: EcommerceSettingsSelect<false> | EcommerceSettingsSelect<true>; footer: FooterSelect<false> | FooterSelect<true>; header: HeaderSelect<false> | HeaderSelect<true>; settings: SettingsSelect<false> | SettingsSelect<true>; }

Defined in: payload-types.ts:253

ecommerce-settings

ecommerce-settings: EcommerceSettingsSelect<false> | EcommerceSettingsSelect<true>

footer

footer: FooterSelect<false> | FooterSelect<true>

header

header: HeaderSelect<false> | HeaderSelect<true>

settings

settings: SettingsSelect<false> | SettingsSelect<true>


jobs

jobs: { tasks: { inline: { input: unknown; output: unknown; }; schedulePublish: TaskSchedulePublish; }; workflows: unknown; }

Defined in: payload-types.ts:292

tasks

tasks: { inline: { input: unknown; output: unknown; }; schedulePublish: TaskSchedulePublish; }

tasks.inline

inline: { input: unknown; output: unknown; }

tasks.inline.input

input: unknown

tasks.inline.output

output: unknown

tasks.schedulePublish

schedulePublish: TaskSchedulePublish

workflows

workflows: unknown


locale

locale: "en" | "es" | "zh" | "ja" | "ko" | "fr" | "de" | "it" | "pt" | "nl" | "ru" | "pl" | "tr" | "cs" | "el" | "ar" | "hi" | "id" | "th" | "vi" | "ms" | "sv" | "da" | "no" | "fi"

Defined in: payload-types.ts:259


user

user: Customer & { collection: "customers"; } | User & { collection: "users"; }

Defined in: payload-types.ts:285