import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types'; /** * A tax region uses a location to define a specific tax treatment. * A location is defined by `country` and `subdivision`. The tax region also * dictates whether or not tax is included in the displayed price. */ interface TaxRegion { /** * Tax region ID. * @format GUID * @readonly */ _id?: string | null; /** * 2-letter country code in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. * @format COUNTRY * @minLength 2 */ country?: string; /** * Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. * @maxLength 50 */ subdivision?: string; /** * The tax calculator ID to use to calculate tax for this region. * * Call List Tax Calculators to retrieve a list of available calculators for a site. * @format GUID */ appId?: string; /** Whether tax is included in the price. */ taxIncludedInPrice?: boolean; /** * Revision number, which increments by 1 each time the tax region is updated. * To prevent conflicting changes, the current revision must be passed when updating the tax region. * * Ignored when creating a tax region. * @readonly */ revision?: string | null; /** * Date and time the tax region was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the tax region was last updated. * @readonly */ _updatedDate?: Date | null; } interface CreateTaxRegionRequest { /** Tax region to create. */ taxRegion: TaxRegion; } interface CreateTaxRegionResponse { /** Created tax region. */ taxRegion?: TaxRegion; } interface ConflictErrorDetails { /** * Conflict details. * @maxLength 1000 */ reasonForConflict?: string; } interface BulkCreateTaxRegionRequest { /** * Tax regions to create. * @minSize 1 * @maxSize 100 */ taxRegions?: TaxRegion[]; /** * Whether to return the full tax region objects in the response. * * Default: `true` */ returnEntity?: boolean; } interface BulkCreateTaxRegionResponse { /** * Tax regions created by bulk action. * @minSize 1 * @maxSize 100 */ results?: BulkCreateTaxRegionResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkCreateTaxRegionResult { /** Item metadata. */ itemMetadata?: ItemMetadata; /** * Tax region. * * This field is returned if the operation was successful and * `returnEntity` is set to `true`. */ item?: TaxRegion; } interface ItemMetadata { /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */ _id?: string | null; /** Index of the item within the request array. Allows for correlation between request and response items. */ originalIndex?: number; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface GetTaxRegionRequest { /** * ID of the tax region to retrieve. * @format GUID */ taxRegionId: string; } interface GetTaxRegionResponse { /** Retrieved tax region. */ taxRegion?: TaxRegion; } interface UpdateTaxRegionRequest { /** Tax region info to update. */ taxRegion: TaxRegion; } interface UpdateTaxRegionResponse { /** Updated tax region. */ taxRegion?: TaxRegion; } interface DeleteTaxRegionRequest { /** * ID of the tax region to delete. * @format GUID */ taxRegionId: string; } interface DeleteTaxRegionResponse { } interface QueryTaxRegionsRequest { /** Query options. */ query?: CursorQuery; } interface CursorQuery extends CursorQueryPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters). */ filter?: Record | null; /** * Sort object. * * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting). * @maxSize 5 */ sort?: Sorting[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: CursorPaging; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface CursorPaging { /** * Maximum number of items to return in the results. * @max 100 */ 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. * @maxLength 16000 */ cursor?: string | null; } interface QueryTaxRegionsResponse { /** Retrieved tax regions. */ taxRegions?: TaxRegion[]; /** Paging metadata. */ pagingMetadata?: CursorPagingMetadata; } interface CursorPagingMetadata { /** Number of items returned in current page. */ 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; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface CreateOrGetTaxRegionWithoutValidationRequest { /** Tax region to create. */ taxRegion?: TaxRegion; } interface CreateOrGetTaxRegionWithoutValidationResponse { /** Created tax region. */ taxRegion?: TaxRegion; } interface DeleteTaxRegionWithoutDomainEventsRequest { /** * ID of the tax region to delete. * @format GUID */ taxRegionId?: string; } interface DeleteTaxRegionWithoutDomainEventsResponse { } interface BulkRestoreTaxRegionsRequest { /** * Tax region IDs to restore. * @format GUID * @minSize 1 * @maxSize 200 */ taxRegionIds?: string[]; } interface BulkRestoreTaxRegionsResponse { /** * Restored tax regions result * @minSize 1 * @maxSize 200 */ results?: BulkRestoreTaxRegionsResult[]; } interface BulkRestoreTaxRegionsResult { itemMetadata?: ItemMetadata; } 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 { entity?: string; } 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. */ currentEntity?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntity?: string | null; } interface ActionEvent { body?: 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; } 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 AccountDetails { /** * ID of the account. * @format GUID */ accountId?: string | null; /** * ID of the parent account. * @format GUID */ parentAccountId?: string | null; /** * ID of the site, if applicable. * @format GUID */ siteId?: string | null; } /** @docsIgnore */ type CreateTaxRegionApplicationErrors = { code?: 'ALREADY_EXISTS'; description?: string; data?: ConflictErrorDetails; } | { code?: 'CALCULATOR_ID_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'CALCULATOR_IS_NOT_SUPPORTED_FOR_THIS_TAX_REGION'; description?: string; data?: Record; } | { code?: 'INVALID_SUBDIVISION_FORMAT'; description?: string; data?: Record; } | { code?: 'SUBDIVISIONS_NOT_SUPPORTED_FOR_COUNTRY'; description?: string; data?: Record; }; /** @docsIgnore */ type UpdateTaxRegionApplicationErrors = { code?: 'CALCULATOR_ID_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'CALCULATOR_IS_NOT_SUPPORTED_FOR_THIS_TAX_REGION'; description?: string; data?: Record; } | { code?: 'INVALID_SUBDIVISION_FORMAT'; description?: string; data?: Record; } | { code?: 'SUBDIVISIONS_NOT_SUPPORTED_FOR_COUNTRY'; description?: string; data?: Record; }; interface BaseEventMetadata { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; } interface EventMetadata extends BaseEventMetadata { /** 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; } interface TaxRegionCreatedEnvelope { entity: TaxRegion; metadata: EventMetadata; } /** @permissionScope Manage Stores - all permissions * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES * @permissionScope Manage Stores * @permissionScopeId SCOPE.STORES.MANAGE-STORES * @permissionScope Manage Bookings * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS * @permissionScope Manage Restaurants - all permissions * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES * @permissionScope Manage Bookings - all permissions * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS * @permissionScope Manage eCommerce - all permissions * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS * @permissionId BILLING.TAX_REGION_READ * @webhook * @eventType wix.billing.v1.tax_region_created * @serviceIdentifier wix.billing.v1.TaxRegionsService * @slug created * @documentationMaturity preview */ declare function onTaxRegionCreated(handler: (event: TaxRegionCreatedEnvelope) => void | Promise): void; interface TaxRegionDeletedEnvelope { metadata: EventMetadata; } /** * Triggered when a tax region is deleted. * @permissionScope Manage Stores - all permissions * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES * @permissionScope Manage Stores * @permissionScopeId SCOPE.STORES.MANAGE-STORES * @permissionScope Manage Bookings * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS * @permissionScope Manage Restaurants - all permissions * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES * @permissionScope Manage Bookings - all permissions * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS * @permissionScope Manage eCommerce - all permissions * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS * @permissionId BILLING.TAX_REGION_READ * @webhook * @eventType wix.billing.v1.tax_region_deleted * @serviceIdentifier wix.billing.v1.TaxRegionsService * @slug deleted * @documentationMaturity preview */ declare function onTaxRegionDeleted(handler: (event: TaxRegionDeletedEnvelope) => void | Promise): void; interface TaxRegionUpdatedEnvelope { entity: TaxRegion; metadata: EventMetadata; } /** * Triggered when a tax region is updated. * @permissionScope Manage Stores - all permissions * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES * @permissionScope Manage Stores * @permissionScopeId SCOPE.STORES.MANAGE-STORES * @permissionScope Manage Bookings * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS * @permissionScope Manage Restaurants - all permissions * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES * @permissionScope Manage Bookings - all permissions * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS * @permissionScope Manage eCommerce - all permissions * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM * @permissionScope Manage Orders * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS * @permissionId BILLING.TAX_REGION_READ * @webhook * @eventType wix.billing.v1.tax_region_updated * @serviceIdentifier wix.billing.v1.TaxRegionsService * @slug updated * @documentationMaturity preview */ declare function onTaxRegionUpdated(handler: (event: TaxRegionUpdatedEnvelope) => void | Promise): void; /** * Creates a tax region. * * Tax regions require a tax calculator `appId`. Call List Tax Calculators to retrieve a list of available calculators for a site. * * Wix uses tax regions to calculate tax. * * @param taxRegion - Tax region to create. * @public * @documentationMaturity preview * @requiredField taxRegion * @requiredField taxRegion.appId * @requiredField taxRegion.country * @permissionId BILLING.TAX_REGION_CREATE * @applicableIdentity APP * @returns Created tax region. * @fqn wix.billing.v1.TaxRegionsService.CreateTaxRegion */ declare function createTaxRegion(taxRegion: NonNullablePaths): Promise & { __applicationErrorsType?: CreateTaxRegionApplicationErrors; }>; /** * Retrieves a tax region. * @param taxRegionId - ID of the tax region to retrieve. * @public * @documentationMaturity preview * @requiredField taxRegionId * @permissionId BILLING.TAX_REGION_READ * @applicableIdentity APP * @returns Retrieved tax region. * @fqn wix.billing.v1.TaxRegionsService.GetTaxRegion */ declare function getTaxRegion(taxRegionId: string): Promise>; /** * Updates a tax region. * * Each time the tax region is updated, `revision` increments by 1. * The current `revision` must be passed when updating the tax region. * This ensures you're working with the latest tax region and prevents * unintended overwrites. * @param _id - Tax region ID. * @public * @documentationMaturity preview * @requiredField _id * @requiredField taxRegion * @requiredField taxRegion.revision * @param taxRegion - Tax region info. * @permissionId BILLING.TAX_REGION_UPDATE * @applicableIdentity APP * @returns Updated tax region. * @fqn wix.billing.v1.TaxRegionsService.UpdateTaxRegion */ declare function updateTaxRegion(_id: string, taxRegion: NonNullablePaths): Promise & { __applicationErrorsType?: UpdateTaxRegionApplicationErrors; }>; interface UpdateTaxRegion { /** * Tax region ID. * @format GUID * @readonly */ _id?: string | null; /** * 2-letter country code in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. * @format COUNTRY * @minLength 2 */ country?: string; /** * Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. * @maxLength 50 */ subdivision?: string; /** * The tax calculator ID to use to calculate tax for this region. * * Call List Tax Calculators to retrieve a list of available calculators for a site. * @format GUID */ appId?: string; /** Whether tax is included in the price. */ taxIncludedInPrice?: boolean; /** * Revision number, which increments by 1 each time the tax region is updated. * To prevent conflicting changes, the current revision must be passed when updating the tax region. * * Ignored when creating a tax region. * @readonly */ revision?: string | null; /** * Date and time the tax region was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the tax region was last updated. * @readonly */ _updatedDate?: Date | null; } /** * Deletes a tax region. * * When a tax region is deleted, tax is not calculated and zero tax will be returned for addresses in this region. * @param taxRegionId - ID of the tax region to delete. * @public * @documentationMaturity preview * @requiredField taxRegionId * @permissionId BILLING.TAX_REGION_DELETE * @applicableIdentity APP * @fqn wix.billing.v1.TaxRegionsService.DeleteTaxRegion */ declare function deleteTaxRegion(taxRegionId: string): Promise; /** * Creates a query to retrieve a list of tax regions. * * The `queryTaxRegions()` function builds a query to retrieve a list of tax regions and returns a `TaxRegionsQueryBuilder` object. * * The returned object contains the query definition, which is typically used to run the query using the `find()` function. * * You can refine the query by chaining `TaxRegionsQueryBuilder` functions onto the query. `TaxRegionsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTaxRegions()` returns. * * `queryTaxRegions()` runs with the following `TaxRegionsQueryBuilder` default that you can override: * + `ascending("_id")` * * The functions that are chained to `queryTaxRegions()` are applied in the order they are called. For example, if you apply `ascending("country")` and then `ascending("subdivision")`, the results are sorted first by the `"country"`, and then, if there are multiple results with the same `"country"`, the items are sorted by `"subdivision"`. * * The following `TaxRegionsQueryBuilder` functions are supported for the `queryTaxRegions()` function. For a full description of the tax region object, see the object returned for the `items` property in `TaxRegionsQueryResult`. * @public * @documentationMaturity preview * @permissionId BILLING.TAX_REGION_READ * @applicableIdentity APP * @fqn wix.billing.v1.TaxRegionsService.QueryTaxRegions */ declare function queryTaxRegions(): TaxRegionsQueryBuilder; interface QueryCursorResult { cursors: Cursors; hasNext: () => boolean; hasPrev: () => boolean; length: number; pageSize: number; } interface TaxRegionsQueryResult extends QueryCursorResult { items: TaxRegion[]; query: TaxRegionsQueryBuilder; next: () => Promise; prev: () => Promise; } interface TaxRegionsQueryBuilder { /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ eq: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any) => TaxRegionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ ne: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any) => TaxRegionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ ge: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any) => TaxRegionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ gt: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any) => TaxRegionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ le: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any) => TaxRegionsQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ lt: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any) => TaxRegionsQueryBuilder; /** @param propertyName - Property whose value is compared with `string`. * @param string - String to compare against. Case-insensitive. * @documentationMaturity preview */ startsWith: (propertyName: '_id' | 'country' | 'subdivision' | 'appId', value: string) => TaxRegionsQueryBuilder; /** @param propertyName - Property whose value is compared with `values`. * @param values - List of values to compare against. * @documentationMaturity preview */ hasSome: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any[]) => TaxRegionsQueryBuilder; /** @documentationMaturity preview */ in: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: any) => TaxRegionsQueryBuilder; /** @documentationMaturity preview */ exists: (propertyName: '_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate', value: boolean) => TaxRegionsQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. * @documentationMaturity preview */ ascending: (...propertyNames: Array<'_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate'>) => TaxRegionsQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. * @documentationMaturity preview */ descending: (...propertyNames: Array<'_id' | 'country' | 'subdivision' | 'appId' | '_createdDate' | '_updatedDate'>) => TaxRegionsQueryBuilder; /** @param limit - Number of items to return, which is also the `pageSize` of the results object. * @documentationMaturity preview */ limit: (limit: number) => TaxRegionsQueryBuilder; /** @param cursor - A pointer to specific record * @documentationMaturity preview */ skipTo: (cursor: string) => TaxRegionsQueryBuilder; /** @documentationMaturity preview */ find: () => Promise; } /** * @hidden * @fqn wix.billing.v1.TaxRegionsService.QueryTaxRegions * @requiredField query */ declare function typedQueryTaxRegions(query: TaxRegionQuery): Promise>; interface TaxRegionQuerySpec extends QuerySpec { paging: 'cursor'; wql: [ { fields: [ '_createdDate', '_id', '_updatedDate', 'appId', 'country', 'subdivision' ]; operators: '*'; sort: 'BOTH'; } ]; } type CommonQueryWithEntityContext = Query; type TaxRegionQuery = { /** Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: { /** Maximum number of items to return in the results. @max: 100 */ limit?: NonNullable['limit'] | 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. @maxLength: 16000 */ cursor?: NonNullable['cursor'] | null; }; /** Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters). */ filter?: CommonQueryWithEntityContext['filter'] | null; /** Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting). @maxSize: 5 */ sort?: { /** Name of the field to sort by. @maxLength: 512 */ fieldName?: NonNullable[number]['fieldName']; /** Sort order. */ order?: NonNullable[number]['order']; }[]; }; export { type AccountDetails, type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateTaxRegionRequest, type BulkCreateTaxRegionResponse, type BulkCreateTaxRegionResult, type BulkRestoreTaxRegionsRequest, type BulkRestoreTaxRegionsResponse, type BulkRestoreTaxRegionsResult, type CommonQueryWithEntityContext, type ConflictErrorDetails, type CreateOrGetTaxRegionWithoutValidationRequest, type CreateOrGetTaxRegionWithoutValidationResponse, type CreateTaxRegionApplicationErrors, type CreateTaxRegionRequest, type CreateTaxRegionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteTaxRegionRequest, type DeleteTaxRegionResponse, type DeleteTaxRegionWithoutDomainEventsRequest, type DeleteTaxRegionWithoutDomainEventsResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetTaxRegionRequest, type GetTaxRegionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type QueryTaxRegionsRequest, type QueryTaxRegionsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type TaxRegion, type TaxRegionCreatedEnvelope, type TaxRegionDeletedEnvelope, type TaxRegionQuery, type TaxRegionQuerySpec, type TaxRegionUpdatedEnvelope, type TaxRegionsQueryBuilder, type TaxRegionsQueryResult, type UpdateTaxRegion, type UpdateTaxRegionApplicationErrors, type UpdateTaxRegionRequest, type UpdateTaxRegionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createTaxRegion, deleteTaxRegion, getTaxRegion, onTaxRegionCreated, onTaxRegionDeleted, onTaxRegionUpdated, queryTaxRegions, typedQueryTaxRegions, updateTaxRegion };