@wix/auto_sdk_get-paid_receipts 1.0.0

package/build/cjs/src/receipts-v1-receipt-receipts.universal.d.ts

@@ -0,0 +1,1072 @@
+/**
+ * A Receipt is a document acknowledging that a person has received money or property in payment following a sale or
+ * other transfer of goods or provision of a service.
+ * Read more about Receipts
+ * in this [article](https://support.wix.com/en/article/wix-receipts-adding-and-setting-up-your-receipts).
+ */
+export interface Receipt {
+    /**
+     * Receipt Id.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Receipt is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the Receipt.
+     *
+     * Ignored when creating a Receipt.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Receipt was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Receipt was last updated.
+     * Receipt updates are only related to number allocation, document generation but not related to the receipt financial
+     * document information changes.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Receipt numbering.
+     * @readonly
+     */
+    numbering?: Numbering;
+    /**
+     * Regional properties pertaining to the receipt.
+     * The defaults are taken from the site properties if regional properties are not populated.
+     */
+    regionalProperties?: RegionalProperties;
+    /** Currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */
+    currency?: string;
+    /** Source reference text. */
+    sourceReference?: SourceReference;
+    /**
+     * Business details.
+     * The defaults are taken from the site properties if business details are not populated.
+     */
+    businessDetails?: BusinessDetails;
+    /** Customer for which this receipt was issued. */
+    customer?: Customer;
+    /** Line items. */
+    lineItems?: LineItem[];
+    /** Shipping info. */
+    shippingInfo?: ShippingInfo;
+    /** Additional fees. */
+    additionalFees?: AdditionalFee[];
+    /** Discounts. */
+    discounts?: Discount[];
+    /** Payment. */
+    payment?: Payment;
+    /** Summaries of totals including tax, shipping, additional fees and discounts. */
+    totals?: Totals;
+    /** Tax and taxable amounts breakdowns. */
+    taxBreakdown?: Tax[];
+    /**
+     * Receipt Preset Id.
+     * Fallbacks to the default Receipt Preset Id if not present.
+     */
+    presetId?: string | null;
+    /** Custom fields. */
+    customFields?: CustomFields;
+    /**
+     * Receipt document file.
+     * @readonly
+     */
+    document?: Document;
+    /** Data Extensions. */
+    extendedFields?: ExtendedFields;
+}
+export interface Numbering {
+    /** Receipt number. */
+    number?: number | null;
+    /** Receipt prefix. */
+    prefix?: string | null;
+    /** Receipt suffix. */
+    suffix?: string | null;
+    /**
+     * Receipt display number. E.g. `[prefix][number][suffix]`
+     * @readonly
+     */
+    displayNumber?: string;
+}
+export interface RegionalProperties {
+    /** The locale determines the format of numbers, dates and times. */
+    locale?: Locale;
+    /** The time zone determines the offset of dates and times. */
+    timeZone?: string | null;
+}
+export interface Locale {
+    /**
+     * Locale language code, 2 letters [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1).
+     * Examples: en, de, ja.
+     */
+    languageCode?: string;
+    /**
+     * Locale country code, 2 letters ISO-3166-1.
+     * Examples: US, DE, JP.
+     */
+    country?: string | null;
+}
+export interface SourceReference extends SourceReferenceOrderOneOf {
+    /** Regular payments order. */
+    wixPaymentOrder?: WixPayment;
+    /** Wix eCommerce order. */
+    wixEcomOrder?: WixEcom;
+    /** App Id of the vertical/third-party application that generated the receipt. */
+    appId?: string;
+    /**
+     * External reference Id.
+     * Example: orderId, eventId.
+     */
+    externalReferenceId?: string;
+    /** Specifies the type of order. */
+    receiptOrderType?: ReceiptOrderType;
+}
+/** @oneof */
+export interface SourceReferenceOrderOneOf {
+    /** Regular payments order. */
+    wixPaymentOrder?: WixPayment;
+    /** Wix eCommerce order. */
+    wixEcomOrder?: WixEcom;
+}
+export declare enum ReceiptOrderType {
+    UNKNOWN_ORDER_TYPE = "UNKNOWN_ORDER_TYPE",
+    WIX_PAYMENT = "WIX_PAYMENT",
+    WIX_ECOM = "WIX_ECOM"
+}
+export interface WixPayment {
+    /** Payment order Id. */
+    orderId?: string;
+    /** Payment transaction Id. */
+    transactionId?: string;
+}
+export interface WixEcom {
+    /** Wix eCommerce order Id. */
+    orderId?: string;
+    /** Payment transaction Id. */
+    transactionId?: string;
+}
+export interface BusinessDetails {
+    /** Business name. */
+    name?: string | null;
+    /** Business email. */
+    email?: string | null;
+    /** Business phone. */
+    phone?: string | null;
+    /** Business address. */
+    address?: Address;
+    /** Business logo. */
+    logo?: string;
+}
+/** Physical address */
+export interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+export interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+export interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+export interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+export declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+/** Subdivision Concordance values */
+export interface StandardDetails {
+    /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */
+    iso31662?: string | null;
+}
+export interface Customer {
+    /** Contact Id. */
+    contactId?: string | null;
+    /** Customer's contact details. */
+    contactDetails?: FullAddressContactDetails;
+    /** Customer's billing address. */
+    billingAddress?: Address;
+    /** Customer's shipping address. */
+    shippingAddress?: Address;
+}
+/** Full contact details for an address */
+export interface FullAddressContactDetails {
+    /** Contact's first name. */
+    firstName?: string | null;
+    /** Contact's last name. */
+    lastName?: string | null;
+    /** Contact's phone number. */
+    phone?: string | null;
+    /** Contact's company name. */
+    company?: string | null;
+    /** Email associated with the address. */
+    email?: string | null;
+    /** Tax info. Currently usable only in Brazil. */
+    vatId?: VatId;
+}
+export interface VatId {
+    /** Customer's tax ID. */
+    _id?: string;
+    /**
+     * Tax type.
+     *
+     * Supported values:
+     * + `CPF`: for individual tax payers
+     * + `CNPJ`: for corporations
+     */
+    type?: VatType;
+}
+/** tax info types */
+export declare enum VatType {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** CPF - for individual tax payers. */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+export interface LineItem {
+    /** Line item Id. */
+    _id?: string | null;
+    /** Line item name. */
+    name?: string | null;
+    /** Line item description. */
+    description?: string | null;
+    /** Line item quantity. */
+    quantity?: string | null;
+    /** Line item unit price amount after discounts. */
+    price?: string | null;
+    /** Line item unit price amount before discounts. */
+    priceBeforeDiscounts?: string | null;
+    /** Line item tax breakdown. */
+    taxBreakdown?: LineItemTax[];
+    /** Line item totals. */
+    totals?: LineItemTotals;
+}
+export interface LineItemTax {
+    /** Tax name. */
+    taxName?: string;
+    /**
+     * Tax rate percentage.
+     * Example: 0.1000 signifies 10% tax and 2.1000 signifies 210% tax.
+     */
+    taxRate?: string;
+    /** Taxable amount of the line item price. */
+    taxableAmount?: string;
+    /** Amount of tax calculated for this line item. */
+    taxAmount?: string;
+}
+export interface LineItemTotals {
+    /** Line item total discount. */
+    totalDiscount?: string | null;
+    /** Line item total price after discounts and before taxes. */
+    totalPriceBeforeTax?: string | null;
+    /** Line item total applied tax. */
+    totalTax?: string | null;
+    /** Line item total after taxes and discounts. */
+    totalPriceAfterTax?: string | null;
+}
+export interface ShippingInfo {
+    /** Shipping title. */
+    title?: string;
+    /** Shipping amount after discounts (when relevant), and before tax. */
+    priceBeforeTax?: string;
+    /** Shipping price after all discounts (if any exist), and after tax. */
+    priceAfterTax?: string;
+    /** Shipping tax breakdown. */
+    taxBreakdown?: ShippingTax[];
+}
+export interface ShippingTax {
+    /** Tax name. */
+    name?: string;
+    /**
+     * Tax rate percentage.
+     * Example: 0.1000 signifies 10% tax and 2.1000 signifies 210% tax.
+     */
+    rate?: string;
+    /** Tax amount. */
+    amount?: string;
+}
+export interface AdditionalFee {
+    /** Additional fee's name. */
+    name?: string;
+    /** Additional fee's price before taxes. */
+    priceBeforeTax?: string;
+    /**
+     * Additional fee's amount after taxes.
+     * Should be the same as price before taxes if no taxes apply to this fee.
+     */
+    priceAfterTax?: string;
+    /** Additional fee's tax breakdown. */
+    taxBreakdown?: AdditionalFeeTax[];
+}
+export interface AdditionalFeeTax {
+    /** Tax name. */
+    name?: string;
+    /**
+     * Tax rate.
+     * Example: 0.1000 signifies 10% tax and 2.1000 signifies 210% tax.
+     */
+    rate?: string;
+    /** Tax amount. */
+    amount?: string;
+}
+export interface Discount {
+    /** Discount name. */
+    name?: string;
+    /** Discount amount. */
+    amount?: string;
+}
+export interface Payment {
+    /** Payment method. */
+    paymentMethod?: string;
+    /** Payment details. */
+    paymentMethodDetails?: string | null;
+    /** Payment amount. */
+    amount?: string;
+    /** Payment transaction date. */
+    transactionDate?: Date | null;
+}
+export interface Totals {
+    /** Subtotal of all line items, before discounts and before taxes. */
+    subtotal?: string | null;
+    /** Shipping price, before discounts and tax. */
+    shipping?: string | null;
+    /** Discount amount. */
+    discount?: string | null;
+    /** Additional fee amount, before discounts and tax. */
+    additionalFees?: string | null;
+    /** Tax amount. */
+    tax?: string | null;
+    /** Total amount. After all the calculations: subtotal - discounts + taxes + shipping + additional_fees. */
+    total?: string | null;
+}
+export interface Tax {
+    /** Tax name. */
+    name?: string;
+    /** Tax rate percentage, as a positive decimal numeral. For example, "0.13". */
+    rate?: string;
+    /** Tax amount. */
+    taxAmount?: string;
+    /** Taxable amount this tax applies to. */
+    taxableAmount?: string;
+}
+export interface CustomFields {
+    /**
+     * Header custom fields.
+     * Order will be persisted in the receipt document.
+     */
+    headerCustomFields?: CustomField[];
+    /**
+     * Business custom fields.
+     * Order will be persisted in the receipt document.
+     */
+    businessCustomFields?: CustomField[];
+    /**
+     * Customer custom fields.
+     * Order will be persisted in the receipt document.
+     */
+    customerCustomFields?: CustomField[];
+    /**
+     * Footer custom fields.
+     * Order will be persisted in the receipt document.
+     */
+    footerCustomFields?: FooterCustomField[];
+}
+export interface CustomField {
+    /** Title. */
+    title?: string | null;
+    /** Value. */
+    value?: string;
+}
+export interface FooterCustomField {
+    /** Title. */
+    title?: string;
+    /** Value. */
+    value?: string | null;
+}
+export interface Document {
+    /** Document status. */
+    status?: DocumentStatus;
+    /** Document download URL. */
+    downloadUrl?: string | null;
+}
+export declare enum DocumentStatus {
+    UNKNOWN_DOCUMENT_STATUS = "UNKNOWN_DOCUMENT_STATUS",
+    PROCESSING = "PROCESSING",
+    AVAILABLE = "AVAILABLE",
+    FAILED = "FAILED"
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface ReceiptDocumentProcess {
+    /** Receipt Id. */
+    receiptId?: string;
+    /** Media Document Id. */
+    documentId?: string;
+}
+export interface ReceiptNumberingProcess {
+    /** Receipt Id. */
+    receiptId?: string;
+}
+export interface ReceiptDocumentHandled extends ReceiptDocumentHandledResultOneOf {
+    /** Populated only if receipt document handling has succeeded. */
+    succeeded?: Succeeded;
+    /** Populated only if receipt document handling has failed. */
+    failed?: Failed;
+}
+/** @oneof */
+export interface ReceiptDocumentHandledResultOneOf {
+    /** Populated only if receipt document handling has succeeded. */
+    succeeded?: Succeeded;
+    /** Populated only if receipt document handling has failed. */
+    failed?: Failed;
+}
+export interface Succeeded {
+    /** Receipt Id. */
+    receiptId?: string;
+    /** Media file Id. */
+    mediaFileId?: string;
+    /** Download URL. */
+    downloadUrl?: string;
+}
+export interface Failed {
+    /** Receipt Id. */
+    receiptId?: string;
+}
+export interface GenerateReceiptDocument {
+    /** Receipt Id. */
+    receiptId?: string;
+    /** Shows how request for document generation was made. */
+    requestOrigin?: RequestOrigin;
+}
+export declare enum RequestOrigin {
+    INITIAL = "INITIAL",
+    MANUAL = "MANUAL"
+}
+export interface Sent {
+    /** Receipt that was sent. */
+    receipt?: Receipt;
+    /** Receipt was sent in automatic or manual flow. */
+    automatic?: boolean;
+}
+export interface CreateReceiptRequest {
+    /** Receipt to be created. */
+    receipt: Receipt;
+}
+export interface CreateReceiptResponse {
+    /** The created Receipt. */
+    receipt?: Receipt;
+}
+export interface GetReceiptRequest {
+    /** Id of the Receipt to retrieve. */
+    receiptId: string;
+}
+export interface GetReceiptResponse {
+    /** The requested Receipt. */
+    receipt?: Receipt;
+}
+export interface QueryReceiptsRequest {
+    /** [WQL](https://dev.wix.com/api/rest/getting-started/api-query-language) expression. */
+    query?: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryReceiptsResponse {
+    /** List of Receipts. */
+    receipts?: Receipt[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface RegenerateReceiptDocumentRequest {
+    /** Receipt id. */
+    receiptId: string;
+}
+export interface RegenerateReceiptDocumentResponse {
+}
+export interface SendReceiptEmailRequest {
+    /** Id of the receipt to send to recipients. */
+    receiptId: string;
+    /** Contact Id to send the email to. */
+    contactId?: string | null;
+}
+export interface SendReceiptEmailResponse {
+}
+export interface GetLatestReceiptNumberRequest {
+    /** Receipt prefix. */
+    prefix?: string | null;
+}
+export interface GetLatestReceiptNumberResponse {
+    /** Receipt number. */
+    number?: number | null;
+}
+export interface UpdateExtendedFieldsRequest {
+    /** ID of the entity to update. */
+    _id: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+export interface UpdateExtendedFieldsResponse {
+    /** Updated Receipt. */
+    receipt?: Receipt;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface NumberingNonNullableFields {
+    displayNumber: string;
+}
+interface LocaleNonNullableFields {
+    languageCode: string;
+}
+interface RegionalPropertiesNonNullableFields {
+    locale?: LocaleNonNullableFields;
+}
+interface WixPaymentNonNullableFields {
+    orderId: string;
+    transactionId: string;
+}
+interface WixEcomNonNullableFields {
+    orderId: string;
+    transactionId: string;
+}
+interface SourceReferenceNonNullableFields {
+    wixPaymentOrder?: WixPaymentNonNullableFields;
+    wixEcomOrder?: WixEcomNonNullableFields;
+    appId: string;
+    externalReferenceId: string;
+    receiptOrderType: ReceiptOrderType;
+}
+interface StreetAddressNonNullableFields {
+    number: string;
+    name: string;
+    apt: string;
+}
+interface SubdivisionNonNullableFields {
+    name: string;
+}
+interface AddressNonNullableFields {
+    streetAddress?: StreetAddressNonNullableFields;
+    subdivisions: SubdivisionNonNullableFields[];
+}
+interface BusinessDetailsNonNullableFields {
+    address?: AddressNonNullableFields;
+    logo: string;
+}
+interface VatIdNonNullableFields {
+    _id: string;
+    type: VatType;
+}
+interface FullAddressContactDetailsNonNullableFields {
+    vatId?: VatIdNonNullableFields;
+}
+interface CustomerNonNullableFields {
+    contactDetails?: FullAddressContactDetailsNonNullableFields;
+    billingAddress?: AddressNonNullableFields;
+    shippingAddress?: AddressNonNullableFields;
+}
+interface LineItemTaxNonNullableFields {
+    taxName: string;
+    taxRate: string;
+    taxableAmount: string;
+    taxAmount: string;
+}
+interface LineItemNonNullableFields {
+    taxBreakdown: LineItemTaxNonNullableFields[];
+}
+interface ShippingTaxNonNullableFields {
+    name: string;
+    rate: string;
+    amount: string;
+}
+interface ShippingInfoNonNullableFields {
+    title: string;
+    priceBeforeTax: string;
+    priceAfterTax: string;
+    taxBreakdown: ShippingTaxNonNullableFields[];
+}
+interface AdditionalFeeTaxNonNullableFields {
+    name: string;
+    rate: string;
+    amount: string;
+}
+interface AdditionalFeeNonNullableFields {
+    name: string;
+    priceBeforeTax: string;
+    priceAfterTax: string;
+    taxBreakdown: AdditionalFeeTaxNonNullableFields[];
+}
+interface DiscountNonNullableFields {
+    name: string;
+    amount: string;
+}
+interface PaymentNonNullableFields {
+    paymentMethod: string;
+    amount: string;
+}
+interface TaxNonNullableFields {
+    name: string;
+    rate: string;
+    taxAmount: string;
+    taxableAmount: string;
+}
+interface CustomFieldNonNullableFields {
+    value: string;
+}
+interface FooterCustomFieldNonNullableFields {
+    title: string;
+}
+interface CustomFieldsNonNullableFields {
+    headerCustomFields: CustomFieldNonNullableFields[];
+    businessCustomFields: CustomFieldNonNullableFields[];
+    customerCustomFields: CustomFieldNonNullableFields[];
+    footerCustomFields: FooterCustomFieldNonNullableFields[];
+}
+interface DocumentNonNullableFields {
+    status: DocumentStatus;
+}
+export interface ReceiptNonNullableFields {
+    numbering?: NumberingNonNullableFields;
+    regionalProperties?: RegionalPropertiesNonNullableFields;
+    currency: string;
+    sourceReference?: SourceReferenceNonNullableFields;
+    businessDetails?: BusinessDetailsNonNullableFields;
+    customer?: CustomerNonNullableFields;
+    lineItems: LineItemNonNullableFields[];
+    shippingInfo?: ShippingInfoNonNullableFields;
+    additionalFees: AdditionalFeeNonNullableFields[];
+    discounts: DiscountNonNullableFields[];
+    payment?: PaymentNonNullableFields;
+    taxBreakdown: TaxNonNullableFields[];
+    customFields?: CustomFieldsNonNullableFields;
+    document?: DocumentNonNullableFields;
+}
+export interface CreateReceiptResponseNonNullableFields {
+    receipt?: ReceiptNonNullableFields;
+}
+export interface GetReceiptResponseNonNullableFields {
+    receipt?: ReceiptNonNullableFields;
+}
+export interface QueryReceiptsResponseNonNullableFields {
+    receipts: ReceiptNonNullableFields[];
+}
+export interface UpdateExtendedFieldsResponseNonNullableFields {
+    receipt?: ReceiptNonNullableFields;
+}
+/**
+ * Creates a Receipt.
+ *
+ * The request body must include: currency, source reference, line items, payment, totals.
+ * Receipt number will not be assigned on the create response. Number will be assigned eventually but before the
+ * document file is created.
+ * @param receipt - Receipt to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField receipt
+ * @requiredField receipt.currency
+ * @requiredField receipt.lineItems
+ * @requiredField receipt.lineItems._id
+ * @requiredField receipt.lineItems.price
+ * @requiredField receipt.lineItems.quantity
+ * @requiredField receipt.lineItems.totals
+ * @requiredField receipt.lineItems.totals.totalPriceBeforeTax
+ * @requiredField receipt.payment
+ * @requiredField receipt.payment.amount
+ * @requiredField receipt.payment.paymentMethod
+ * @requiredField receipt.payment.transactionDate
+ * @requiredField receipt.sourceReference
+ * @requiredField receipt.sourceReference.appId
+ * @requiredField receipt.sourceReference.externalReferenceId
+ * @requiredField receipt.sourceReference.receiptOrderType
+ * @requiredField receipt.sourceReference.wixEcomOrder.transactionId
+ * @requiredField receipt.sourceReference.wixPaymentOrder.transactionId
+ * @requiredField receipt.totals
+ * @requiredField receipt.totals.subtotal
+ * @requiredField receipt.totals.total
+ * @permissionId RECEIPTS.RECEIPT_CREATE
+ * @returns The created Receipt.
+ * @fqn wix.receipts.v1.Receipts.CreateReceipt
+ */
+export declare function createReceipt(receipt: Receipt): Promise<Receipt & ReceiptNonNullableFields>;
+/**
+ * Retrieves a Receipt.
+ * @param receiptId - Id of the Receipt to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField receiptId
+ * @permissionId RECEIPTS.RECEIPT_READ
+ * @returns The requested Receipt.
+ * @fqn wix.receipts.v1.Receipts.GetReceipt
+ */
+export declare function getReceipt(receiptId: string): Promise<Receipt & ReceiptNonNullableFields>;
+/**
+ * Retrieves a list of up to 100 Receipts, given the provided [paging, filtering, and sorting][1].
+ *
+ * Define queries using WQL - Wix Query Language. To learn how to query Receipts, see [API Query Language][2].
+ *
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RECEIPTS.RECEIPT_READ
+ * @fqn wix.receipts.v1.Receipts.QueryReceipts
+ */
+export declare function queryReceipts(): ReceiptsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface ReceiptsQueryResult extends QueryCursorResult {
+    items: Receipt[];
+    query: ReceiptsQueryBuilder;
+    next: () => Promise<ReceiptsQueryResult>;
+    prev: () => Promise<ReceiptsQueryResult>;
+}
+export interface ReceiptsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate' | 'numbering.number', value: any) => ReceiptsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate' | 'numbering.number', value: any) => ReceiptsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate' | 'numbering.number', value: any) => ReceiptsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate' | 'numbering.number', value: any) => ReceiptsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: string) => ReceiptsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any[]) => ReceiptsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: any) => ReceiptsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId', value: boolean) => ReceiptsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId'>) => ReceiptsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'numbering.number' | 'numbering.prefix' | 'numbering.suffix' | 'sourceReference.appId' | 'sourceReference.externalReferenceId'>) => ReceiptsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ReceiptsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ReceiptsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ReceiptsQueryResult>;
+}
+/**
+ * Retries generating document if its status is FAILED.
+ * @param receiptId - Receipt id.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField receiptId
+ * @permissionId RECEIPTS.RECEIPT_UPDATE
+ * @fqn wix.receipts.v1.Receipts.RegenerateReceiptDocument
+ */
+export declare function regenerateReceiptDocument(receiptId: string): Promise<void>;
+/**
+ * Sends email with Receipt.
+ * @param receiptId - Id of the receipt to send to recipients.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField receiptId
+ * @permissionId RECEIPTS.RECEIPT_SEND
+ * @fqn wix.receipts.v1.Receipts.SendReceiptEmail
+ */
+export declare function sendReceiptEmail(receiptId: string, options?: SendReceiptEmailOptions): Promise<void>;
+export interface SendReceiptEmailOptions {
+    /** Contact Id to send the email to. */
+    contactId?: string | null;
+}
+/**
+ * Returns latest number for a given prefix.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RECEIPTS.RECEIPT_READ
+ * @fqn wix.receipts.v1.Receipts.GetLatestReceiptNumber
+ */
+export declare function getLatestReceiptNumber(options?: GetLatestReceiptNumberOptions): Promise<GetLatestReceiptNumberResponse>;
+export interface GetLatestReceiptNumberOptions {
+    /** Receipt prefix. */
+    prefix?: string | null;
+}
+/**
+ * Updates extended fields of a Receipt without incrementing revision.
+ * @param _id - ID of the entity to update.
+ * @param namespace - Identifier for the app whose extended fields are being updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField namespace
+ * @requiredField options
+ * @requiredField options.namespaceData
+ * @permissionId RECEIPTS.RECEIPT_UPDATE
+ * @fqn wix.receipts.v1.Receipts.UpdateExtendedFields
+ */
+export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
+export interface UpdateExtendedFieldsOptions {
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+export {};