@wix/auto_sdk_get-paid_billable-items 1.0.0

package/build/es/src/billable-items-v1-billable-item-billable-items.universal.d.ts

@@ -0,0 +1,1301 @@
+/**
+ * A BillableItem represents a billable product or service that can be added to invoices.
+ * You can create, manage, and organize these items to streamline your billing process.
+ * BillableItems include details like name, description, price, and tax information.
+ */
+export interface BillableItem {
+    /**
+     * BillableItem ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the BillableItem is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the BillableItem.
+     *
+     * Ignored when creating a BillableItem.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the BillableItem was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the BillableItem was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * The name or title of the billable item. Used to identify the item on an invoice and display to customers.
+     * Must be between 1-100 characters. This is a required field when creating a new BillableItem.
+     * Example: "Premium Consultation", "Website Design Package", "Monthly Maintenance Service"
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string;
+    /**
+     * Detailed description of the billable item. Provides additional information about the product or service.
+     * Optional field with maximum 600 characters. Can include formatting details, specifications, or terms.
+     * Example: "One hour consultation session with a senior expert including follow-up email"
+     * @minLength 1
+     * @maxLength 600
+     */
+    description?: string | null;
+    /**
+     * Price of the billable item in decimal format with up to 4 decimal places.
+     * Represents the base cost before taxes are applied. This is a required field when creating a new BillableItem.
+     * Must be greater than 0 and less than or equal to 1,000,000,000,000,000.
+     * Examples: "99.99", "149.50", "1200.00", "0.5000" (for 50 cents)
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
+     */
+    price?: string;
+    /**
+     * Reference to a tax group that defines the tax rules applicable to this billable item.
+     * Use the Tax Groups API to retrieve available tax groups for the business.
+     * The tax group determines how taxes are calculated when this item is added to an invoice.
+     * If not specified, the default tax rules for the business will apply.
+     * Example: "b52a5d5c-f8f5-4e6c-a856-66578913921a"
+     * See: https://dev.wix.com/api/rest/wix-billing/tax-groups/introduction
+     * @format GUID
+     */
+    taxGroupId?: string | null;
+    /**
+     * The billable item image. Optional visual representation of the product or service.
+     * Image must be uploaded to Wix Media Manager before referencing here.
+     * Contains image ID, URL, dimensions, and alt text for accessibility.
+     * To upload an image, use the Media Manager API or dashboard before creating/updating the BillableItem.
+     * Example: { "id": "media/12345", "url": "https://static.wixstatic.com/media/12345.jpg", "height": 600, "width": 800, "altText": "Premium Consultation Service" }
+     */
+    image?: string;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+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>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+export interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+export interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+export interface CreateBillableItemRequest {
+    /** BillableItem to be created. */
+    billableItem: BillableItem;
+}
+export interface CreateBillableItemResponse {
+    /** The created BillableItem. */
+    billableItem?: BillableItem;
+}
+export interface GetBillableItemRequest {
+    /**
+     * ID of the BillableItem to retrieve.
+     * @format GUID
+     */
+    billableItemId: string;
+}
+export interface GetBillableItemResponse {
+    /** The requested BillableItem. */
+    billableItem?: BillableItem;
+}
+export interface UpdateBillableItemRequest {
+    /** BillableItem to be updated, may be partial. */
+    billableItem: BillableItem;
+}
+export interface UpdateBillableItemResponse {
+    /** Updated BillableItem. */
+    billableItem?: BillableItem;
+}
+export interface DeleteBillableItemRequest {
+    /**
+     * Id of the BillableItem to delete.
+     * @format GUID
+     */
+    billableItemId: string;
+}
+export interface DeleteBillableItemResponse {
+}
+export interface QueryBillableItemsRequest {
+    /** WQL 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"}]`
+     * @maxSize 5
+     */
+    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.
+     * @maxLength 512
+     */
+    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.
+     * @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;
+}
+export interface QueryBillableItemsResponse {
+    /** List of BillableItems. */
+    billableItems?: BillableItem[];
+    /** 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.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+export interface BulkCreateBillableItemsRequest {
+    /**
+     * List of BillableItems to be created
+     * @minSize 1
+     * @maxSize 100
+     */
+    billableItems: BillableItem[];
+    /** set to `true` if you wish to receive back the created BillableItems in the response */
+    returnEntity?: boolean;
+}
+export interface BulkCreateBillableItemsResponse {
+    /**
+     * List of the bulk create operation results including the BillableItems and metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkBillableItemResult[];
+    /** Metadata regarding the bulk create operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    _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;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkBillableItemResult {
+    /** Metadata regarding the specific single create operation */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: BillableItem;
+}
+export 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;
+}
+export interface BulkUpdateBillableItemsRequest {
+    /**
+     * List of BillableItems to be updated.
+     * @minSize 1
+     * @maxSize 100
+     */
+    billableItems: MaskedBillableItem[];
+    /** set to `true` if you wish to receive back the updated BillableItems in the response */
+    returnEntity?: boolean;
+}
+export interface MaskedBillableItem {
+    /** BillableItem to be updated, may be partial */
+    billableItem?: BillableItem;
+}
+export interface BulkUpdateBillableItemsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateBillableItemsResponseBulkBillableItemResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateBillableItemsResponseBulkBillableItemResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to true in the request */
+    item?: BillableItem;
+}
+export interface BulkDeleteBillableItemsRequest {
+    /**
+     * BillableItem ids to be deleted
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    billableItemIds: string[];
+}
+export interface BulkDeleteBillableItemsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkDeleteBillableItemsResponseBulkBillableItemResult[];
+    /** Metadata regarding the bulk delete operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteBillableItemsResponseBulkBillableItemResult {
+    /** Metadata regarding the specific single delete operation */
+    itemMetadata?: ItemMetadata;
+}
+export interface BulkUpdateBillableItemTagsRequest {
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    billableItemIds: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateBillableItemTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateBillableItemTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateBillableItemTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+export interface BulkUpdateBillableItemTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateBillableItemTagsByFilterResponse {
+    /**
+     * Job ID
+     * @format GUID
+     */
+    jobId?: string;
+}
+export interface SearchBillableItemsRequest {
+    /** Search options. */
+    search: CursorSearch;
+}
+export interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor pointing to page of results.
+     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     */
+    cursorPaging?: CursorPaging;
+    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * @maxSize 10
+     */
+    sort?: Sorting[];
+    /**
+     * Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
+     * @maxSize 10
+     */
+    aggregations?: Aggregation[];
+    /** Free text to match in searchable fields */
+    search?: SearchDetails;
+    /**
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
+     * @maxLength 50
+     */
+    timeZone?: string | null;
+}
+/** @oneof */
+export interface CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor pointing to page of results.
+     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     */
+    cursorPaging?: CursorPaging;
+}
+export interface Aggregation extends AggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Range aggregation */
+    range?: RangeAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
+    dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation */
+    nested?: NestedAggregation;
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
+    type?: AggregationType;
+    /**
+     * Field to aggregate by, use dot notation to specify json path
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface AggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Range aggregation */
+    range?: RangeAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
+    dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation */
+    nested?: NestedAggregation;
+}
+export interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if to is not given */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if from is not given */
+    to?: number | null;
+}
+export declare enum SortType {
+    /** Should sort by number of matches */
+    COUNT = "COUNT",
+    /** Should sort by value of the field alphabetically */
+    VALUE = "VALUE"
+}
+export declare enum SortDirection {
+    /** Should sort in descending order */
+    DESC = "DESC",
+    /** Should sort in ascending order */
+    ASC = "ASC"
+}
+export declare enum MissingValues {
+    /** Should missing values be excluded from the aggregation results */
+    EXCLUDE = "EXCLUDE",
+    /** Should missing values be included in the aggregation results */
+    INCLUDE = "INCLUDE"
+}
+export interface IncludeMissingValuesOptions {
+    /**
+     * Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
+     * @maxLength 20
+     */
+    addToBucket?: string;
+}
+export declare enum ScalarType {
+    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
+    /** Count of distinct values */
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value */
+    MIN = "MIN",
+    /** Maximum value */
+    MAX = "MAX"
+}
+export interface ValueAggregation extends ValueAggregationOptionsOneOf {
+    /** Options for including missing values */
+    includeOptions?: IncludeMissingValuesOptions;
+    /** Should sort by number of matches or value of the field */
+    sortType?: SortType;
+    /** Should sort in ascending or descending order */
+    sortDirection?: SortDirection;
+    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    limit?: number | null;
+    /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
+    missingValues?: MissingValues;
+}
+/** @oneof */
+export interface ValueAggregationOptionsOneOf {
+    /** Options for including missing values */
+    includeOptions?: IncludeMissingValuesOptions;
+}
+export declare enum NestedAggregationType {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
+    VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM"
+}
+export interface RangeAggregation {
+    /**
+     * List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
+     * @maxSize 50
+     */
+    buckets?: RangeBucket[];
+}
+export interface ScalarAggregation {
+    /** Define the operator for the scalar aggregation */
+    type?: ScalarType;
+}
+export interface DateHistogramAggregation {
+    /** Interval for date histogram aggregation */
+    interval?: Interval;
+}
+export declare enum Interval {
+    UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
+    /** Yearly interval */
+    YEAR = "YEAR",
+    /** Monthly interval */
+    MONTH = "MONTH",
+    /** Weekly interval */
+    WEEK = "WEEK",
+    /** Daily interval */
+    DAY = "DAY",
+    /** Hourly interval */
+    HOUR = "HOUR",
+    /** Minute interval */
+    MINUTE = "MINUTE",
+    /** Second interval */
+    SECOND = "SECOND"
+}
+export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Range aggregation */
+    range?: RangeAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
+    dateHistogram?: DateHistogramAggregation;
+    /**
+     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
+    type?: NestedAggregationType;
+    /**
+     * Field to aggregate by, use dont notation to specify json path
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface NestedAggregationItemKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Range aggregation */
+    range?: RangeAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
+    dateHistogram?: DateHistogramAggregation;
+}
+export declare enum AggregationType {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
+    VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Multi-level aggregation, where each next aggregation is nested within previous one */
+    NESTED = "NESTED"
+}
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
+export interface NestedAggregation {
+    /**
+     * Flattened list of aggregations, where each next aggregation is nested within previous one
+     * @minSize 2
+     * @maxSize 3
+     */
+    nestedAggregations?: NestedAggregationItem[];
+}
+export interface SearchDetails {
+    /** Defines how separate search terms in `expression` are combined */
+    mode?: Mode;
+    /**
+     * Search term or expression
+     * @maxLength 100
+     */
+    expression?: string | null;
+    /**
+     * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fields?: string[];
+    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    fuzzy?: boolean;
+}
+export declare enum Mode {
+    /** Any of the search terms must be present */
+    OR = "OR",
+    /** All search terms must be present */
+    AND = "AND"
+}
+export interface SearchBillableItemsResponse {
+    /** Retrieved payment link payments. */
+    billableItems?: BillableItem[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadataV2;
+    /** Response aggregation data. */
+    aggregationData?: AggregationData;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface AggregationData {
+    /**
+     * key = aggregation name (as derived from search request)
+     * @maxSize 10000
+     */
+    results?: AggregationResults[];
+}
+export interface ValueAggregationResult {
+    /**
+     * Value of the field
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of entities with this value */
+    count?: number;
+}
+export interface RangeAggregationResult {
+    /** Inclusive lower bound of the range */
+    from?: number | null;
+    /** Exclusive upper bound of the range */
+    to?: number | null;
+    /** Count of entities in this range */
+    count?: number;
+}
+export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** Value aggregation results */
+    values?: ValueResults;
+    /** Range aggregation results */
+    ranges?: RangeResults;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult;
+    /**
+     * User-defined name of aggregation, matches the one provided in request
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that matches result */
+    type?: AggregationType;
+    /**
+     * Field to aggregate by, matches the one provided in request
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface NestedAggregationResultsResultOneOf {
+    /** Value aggregation results */
+    values?: ValueResults;
+    /** Range aggregation results */
+    ranges?: RangeResults;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult;
+}
+export interface ValueResults {
+    /**
+     * List of value aggregations
+     * @maxSize 250
+     */
+    results?: ValueAggregationResult[];
+}
+export interface RangeResults {
+    /**
+     * List of ranges returned in same order as requested
+     * @maxSize 50
+     */
+    results?: RangeAggregationResult[];
+}
+export interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation */
+    type?: ScalarType;
+    /** Value of the scalar aggregation */
+    value?: number;
+}
+export interface NestedValueAggregationResult {
+    /**
+     * Value of the field
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Nested aggregations */
+    nestedResults?: NestedAggregationResults;
+}
+export interface ValueResult {
+    /**
+     * Value of the field
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Count of entities with this value */
+    count?: number | null;
+}
+export interface RangeResult {
+    /** Inclusive lower bound of the range */
+    from?: number | null;
+    /** Exclusive upper bound of the range */
+    to?: number | null;
+    /** Count of entities in this range */
+    count?: number | null;
+}
+export interface ScalarResult {
+    /** Value of the scalar aggregation */
+    value?: number;
+}
+export interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result */
+    value?: ValueResult;
+    /** Range aggregation result */
+    range?: RangeResult;
+    /** Scalar aggregation result */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result */
+    dateHistogram?: ValueResult;
+}
+/** @oneof */
+export interface NestedResultValueResultOneOf {
+    /** Value aggregation result */
+    value?: ValueResult;
+    /** Range aggregation result */
+    range?: RangeResult;
+    /** Scalar aggregation result */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result */
+    dateHistogram?: ValueResult;
+}
+export interface Results {
+    /** List of nested aggregations */
+    results?: Record<string, NestedResultValue>;
+}
+export interface DateHistogramResult {
+    /**
+     * Date in ISO 8601 format
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of documents in the bucket */
+    count?: number;
+}
+export interface GroupByValueResults {
+    /**
+     * List of value aggregations
+     * @maxSize 1000
+     */
+    results?: NestedValueAggregationResult[];
+}
+export interface DateHistogramResults {
+    /**
+     * List of date histogram aggregations
+     * @maxSize 200
+     */
+    results?: DateHistogramResult[];
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form
+ * aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+export interface NestedResults {
+    /**
+     * List of nested aggregations
+     * @maxSize 1000
+     */
+    results?: Results[];
+}
+export interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results */
+    values?: ValueResults;
+    /** Range aggregation results */
+    ranges?: RangeResults;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results */
+    nested?: NestedResults;
+    /**
+     * User-defined name of aggregation as derived from search request
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request */
+    type?: AggregationType;
+    /**
+     * Field to aggregate by as derived from search request
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface AggregationResultsResultOneOf {
+    /** Value aggregation results */
+    values?: ValueResults;
+    /** Range aggregation results */
+    ranges?: RangeResults;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results */
+    nested?: NestedResults;
+}
+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 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;
+}
+export 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?: WebhookIdentityType;
+}
+/** @oneof */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface TagListNonNullableFields {
+    tagIds: string[];
+}
+interface TagsNonNullableFields {
+    privateTags?: TagListNonNullableFields;
+    tags?: TagListNonNullableFields;
+}
+export interface BillableItemNonNullableFields {
+    name: string;
+    price: string;
+    image: string;
+    tags?: TagsNonNullableFields;
+}
+export interface CreateBillableItemResponseNonNullableFields {
+    billableItem?: BillableItemNonNullableFields;
+}
+export interface GetBillableItemResponseNonNullableFields {
+    billableItem?: BillableItemNonNullableFields;
+}
+export interface UpdateBillableItemResponseNonNullableFields {
+    billableItem?: BillableItemNonNullableFields;
+}
+export interface QueryBillableItemsResponseNonNullableFields {
+    billableItems: BillableItemNonNullableFields[];
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkBillableItemResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: BillableItemNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateBillableItemsResponseNonNullableFields {
+    results: BulkBillableItemResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkUpdateBillableItemsResponseBulkBillableItemResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: BillableItemNonNullableFields;
+}
+export interface BulkUpdateBillableItemsResponseNonNullableFields {
+    results: BulkUpdateBillableItemsResponseBulkBillableItemResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkDeleteBillableItemsResponseBulkBillableItemResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+export interface BulkDeleteBillableItemsResponseNonNullableFields {
+    results: BulkDeleteBillableItemsResponseBulkBillableItemResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkUpdateBillableItemTagsResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+export interface BulkUpdateBillableItemTagsResponseNonNullableFields {
+    results: BulkUpdateBillableItemTagsResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkUpdateBillableItemTagsByFilterResponseNonNullableFields {
+    jobId: string;
+}
+interface ValueAggregationResultNonNullableFields {
+    value: string;
+    count: number;
+}
+interface ValueResultsNonNullableFields {
+    results: ValueAggregationResultNonNullableFields[];
+}
+interface RangeAggregationResultNonNullableFields {
+    count: number;
+}
+interface RangeResultsNonNullableFields {
+    results: RangeAggregationResultNonNullableFields[];
+}
+interface AggregationResultsScalarResultNonNullableFields {
+    type: ScalarType;
+    value: number;
+}
+interface NestedAggregationResultsNonNullableFields {
+    values?: ValueResultsNonNullableFields;
+    ranges?: RangeResultsNonNullableFields;
+    scalar?: AggregationResultsScalarResultNonNullableFields;
+    name: string;
+    type: AggregationType;
+    fieldPath: string;
+}
+interface NestedValueAggregationResultNonNullableFields {
+    value: string;
+    nestedResults?: NestedAggregationResultsNonNullableFields;
+}
+interface GroupByValueResultsNonNullableFields {
+    results: NestedValueAggregationResultNonNullableFields[];
+}
+interface DateHistogramResultNonNullableFields {
+    value: string;
+    count: number;
+}
+interface DateHistogramResultsNonNullableFields {
+    results: DateHistogramResultNonNullableFields[];
+}
+interface AggregationResultsNonNullableFields {
+    values?: ValueResultsNonNullableFields;
+    ranges?: RangeResultsNonNullableFields;
+    scalar?: AggregationResultsScalarResultNonNullableFields;
+    groupedByValue?: GroupByValueResultsNonNullableFields;
+    dateHistogram?: DateHistogramResultsNonNullableFields;
+    name: string;
+    type: AggregationType;
+    fieldPath: string;
+}
+interface AggregationDataNonNullableFields {
+    results: AggregationResultsNonNullableFields[];
+}
+export interface SearchBillableItemsResponseNonNullableFields {
+    billableItems: BillableItemNonNullableFields[];
+    aggregationData?: AggregationDataNonNullableFields;
+}
+export interface UpdateBillableItem {
+    /**
+     * BillableItem ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the BillableItem is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the BillableItem.
+     *
+     * Ignored when creating a BillableItem.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the BillableItem was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the BillableItem was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * The name or title of the billable item. Used to identify the item on an invoice and display to customers.
+     * Must be between 1-100 characters. This is a required field when creating a new BillableItem.
+     * Example: "Premium Consultation", "Website Design Package", "Monthly Maintenance Service"
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string;
+    /**
+     * Detailed description of the billable item. Provides additional information about the product or service.
+     * Optional field with maximum 600 characters. Can include formatting details, specifications, or terms.
+     * Example: "One hour consultation session with a senior expert including follow-up email"
+     * @minLength 1
+     * @maxLength 600
+     */
+    description?: string | null;
+    /**
+     * Price of the billable item in decimal format with up to 4 decimal places.
+     * Represents the base cost before taxes are applied. This is a required field when creating a new BillableItem.
+     * Must be greater than 0 and less than or equal to 1,000,000,000,000,000.
+     * Examples: "99.99", "149.50", "1200.00", "0.5000" (for 50 cents)
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
+     */
+    price?: string;
+    /**
+     * Reference to a tax group that defines the tax rules applicable to this billable item.
+     * Use the Tax Groups API to retrieve available tax groups for the business.
+     * The tax group determines how taxes are calculated when this item is added to an invoice.
+     * If not specified, the default tax rules for the business will apply.
+     * Example: "b52a5d5c-f8f5-4e6c-a856-66578913921a"
+     * See: https://dev.wix.com/api/rest/wix-billing/tax-groups/introduction
+     * @format GUID
+     */
+    taxGroupId?: string | null;
+    /**
+     * The billable item image. Optional visual representation of the product or service.
+     * Image must be uploaded to Wix Media Manager before referencing here.
+     * Contains image ID, URL, dimensions, and alt text for accessibility.
+     * To upload an image, use the Media Manager API or dashboard before creating/updating the BillableItem.
+     * Example: { "id": "media/12345", "url": "https://static.wixstatic.com/media/12345.jpg", "height": 600, "width": 800, "altText": "Premium Consultation Service" }
+     */
+    image?: string;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface BillableItemsQueryResult extends QueryCursorResult {
+    items: BillableItem[];
+    query: BillableItemsQueryBuilder;
+    next: () => Promise<BillableItemsQueryResult>;
+    prev: () => Promise<BillableItemsQueryResult>;
+}
+export interface BillableItemsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'name' | 'description' | 'price' | 'taxGroupId' | 'image' | 'tags', value: any) => BillableItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | 'name' | 'description' | 'price' | 'taxGroupId' | 'image' | 'tags', value: any) => BillableItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'name' | 'description' | 'price' | 'taxGroupId', value: string) => BillableItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | 'name' | 'description' | 'price' | 'taxGroupId' | 'image' | 'tags', value: any[]) => BillableItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'name' | 'description' | 'price' | 'taxGroupId' | 'image' | 'tags', value: any) => BillableItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | 'name' | 'description' | 'price' | 'taxGroupId' | 'image' | 'tags', value: boolean) => BillableItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | 'name' | 'description' | 'price' | 'taxGroupId' | 'image' | 'tags'>) => BillableItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | 'name' | 'description' | 'price' | 'taxGroupId' | 'image' | 'tags'>) => BillableItemsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => BillableItemsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => BillableItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<BillableItemsQueryResult>;
+}
+export interface BulkCreateBillableItemsOptions {
+    /** set to `true` if you wish to receive back the created BillableItems in the response */
+    returnEntity?: boolean;
+}
+export interface BulkUpdateBillableItemsOptions {
+    /** set to `true` if you wish to receive back the updated BillableItems in the response */
+    returnEntity?: boolean;
+}
+export interface BulkUpdateBillableItemTagsOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateBillableItemTagsByFilterOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+export {};