import { GetOrdersSettingsRequest as GetOrdersSettingsRequest$1, GetOrdersSettingsResponse as GetOrdersSettingsResponse$1, UpdateOrdersSettingsRequest as UpdateOrdersSettingsRequest$1, UpdateOrdersSettingsResponse as UpdateOrdersSettingsResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** Site-level settings that control order behavior, such as when inventory is decremented and whether invoices are automatically generated. */ interface OrdersSettings { /** * Defines when to update the store inventory. * Default: `ON_ORDER_PLACED` */ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals; /** * Whether to automatically create invoices for every new order paid online. *
* Default: `false` *
* **Note**: The issued invoice for an order is not a tax invoice and doesn't reflect refunds. You are responsible for ensuring that invoices you issue conform to any relevant legal requirements. */ createInvoice?: boolean | null; /** * Date and time the orders settings were created. * @readonly */ createdDate?: Date | null; /** * Date and time the orders settings were updated. * @readonly */ updatedDate?: Date | null; } declare enum InventoryUpdateTrigger { /** Stock quantities will update only after the payment is approved. */ ON_ORDER_PAID = "ON_ORDER_PAID", /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */ ON_ORDER_PLACED = "ON_ORDER_PLACED" } /** @enumType */ type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED'; interface GetOrdersSettingsRequest { } interface GetOrdersSettingsResponse { /** Orders settings. */ ordersSettings?: OrdersSettings; } interface UpdateOrdersSettingsRequest { /** Orders settings to update. */ ordersSettings: OrdersSettings; } interface UpdateOrdersSettingsResponse { /** The updated orders settings. */ ordersSettings?: OrdersSettings; } interface DeleteOrdersSettingsRequest { } interface DeleteOrdersSettingsResponse { } interface ListOrdersSettingsRequest { } interface ListOrdersSettingsResponse { /** List of retrieved orders settings. */ ordersSettings?: OrdersSettings[]; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function getOrdersSettings(): __PublicMethodMetaInfo<'GET', {}, GetOrdersSettingsRequest$1, GetOrdersSettingsRequest, GetOrdersSettingsResponse$1, GetOrdersSettingsResponse>; declare function updateOrdersSettings(): __PublicMethodMetaInfo<'PATCH', {}, UpdateOrdersSettingsRequest$1, UpdateOrdersSettingsRequest, UpdateOrdersSettingsResponse$1, UpdateOrdersSettingsResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type DeleteOrdersSettingsRequest as DeleteOrdersSettingsRequestOriginal, type DeleteOrdersSettingsResponse as DeleteOrdersSettingsResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GetOrdersSettingsRequest as GetOrdersSettingsRequestOriginal, type GetOrdersSettingsResponse as GetOrdersSettingsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, InventoryUpdateTrigger as InventoryUpdateTriggerOriginal, type InventoryUpdateTriggerWithLiterals as InventoryUpdateTriggerWithLiteralsOriginal, type ListOrdersSettingsRequest as ListOrdersSettingsRequestOriginal, type ListOrdersSettingsResponse as ListOrdersSettingsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type OrdersSettings as OrdersSettingsOriginal, type RestoreInfo as RestoreInfoOriginal, type UpdateOrdersSettingsRequest as UpdateOrdersSettingsRequestOriginal, type UpdateOrdersSettingsResponse as UpdateOrdersSettingsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, getOrdersSettings, updateOrdersSettings };