/** * Copyright 2016 Workfront * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @author Hovhannes Babayan */ /** * Prefix for identifying a Sort field. Value is "_1_Sort" for first sort field, "_2_Sort", "_3_Sort" ... "_n_Sort". * @readonly * @type {String} */ export declare const SORT = "_Sort"; /** * Suffix for specifying expression operators (ApiConstants.Operators) on a field. Value is "_Mod". * @readonly * @type {String} */ export declare const MOD = "_Mod"; /** * A delimiter which is used to separate field name and its order key.
* Can be used for filters, sorting, etc.
* Example: {name_1_Sort: 'ASC', id_2_Sort: 'DESC'} * @readonly * @type {String} */ export declare const ORDERDOT = "_"; /** * Key used to specify the index of the first result to return starting with . * @readonly * @type {String} */ export declare const FIRST = "$$FIRST"; /** * Key used to specify a limit on the number of results. If this key is present, the value is used.
* If this value cannot be parsed or if it is less than or equal to 0, no limit is enforced.
* Value is "$$LIMIT"
* @readonly * @type {String} */ export declare const LIMIT = "$$LIMIT"; /** * Prefix used to identify an Data Extension parameter in the Query framework.
* Used for retrieval of custom data fields.
* @readonly * @type {String} */ export declare const DATAEXTENSION = "DE:"; /** * Suffix for specifying which fields will be added to the GROUP BY clause in a ReportQuery. Value is "_GroupBy". * @readonly * @type {String} */ export declare const GROUPBY = "_GroupBy"; /** * Suffix for specifying force "_GroupBy". Value is "$$_ForceGroupBy". */ export declare const FORCE_GROUPBY = "$$_ForceGroupBy"; /** * Suffix for specifying aggregate functions in a ReportQuery. Value is "_AggFunc". */ export declare const AGGFUNC = "_AggFunc"; /** * Suffix for specifying comma-separated list of aggregated currency fields for the report */ export declare const AGGCURRENCY_FIELDS = "$$AggCurr"; export declare const GROUPCURRENCY_FIELDS = "$$GroupCurr"; export declare const SORTCURRENCY_FIELDS = "$$SortCurr"; export declare const FILTERCURRENCY_FIELDS = "$$FilterCurr"; /** * Key used to specify that a GROUP BY query should be done WITH ROLLUP. Value is "$$ROLLUP" */ export declare const ROLLUP = "$$ROLLUP"; /** * Prefix for constants. * @readonly * @type {String} */ export declare const INTERNAL_PREFIX = "$$"; /** * Values which can be used as wildcards * @readonly * @enum {String} */ export declare const WildCards: { TODAY: string; NOW: string; USER: string; CUSTOMER: string; ACCOUNTREP: string; }; /** * How to sort the result * @readonly * @enum {String} */ export declare const SortOrder: { ASC: string; DESC: string; CIASC: string; CIDESC: string; }; /** * Modifiers which can be used with filters (Mod suffix) * @readonly * @enum {String} */ export declare const Operators: { LESSTHAN: string; LESSTHANEQUAL: string; GREATERTHAN: string; GREATERTHANEQUAL: string; EQUAL: string; CIEQUAL: string; NOTEQUAL: string; NOTEQUALEXACT: string; CINOTEQUAL: string; CONTAINS: string; CICONTAINS: string; CICONTAINSANY: string; CICONTAINSALL: string; CINOTCONTAINSALL: string; CINOTCONTAINSANY: string; NOTCONTAINS: string; CINOTCONTAINS: string; LIKE: string; CILIKE: string; STARTSWITH: string; SOUNDEX: string; BETWEEN: string; CIBETWEEN: string; NOTBETWEEN: string; CINOTBETWEEN: string; IN: string; CIIN: string; NOTIN: string; CINOTIN: string; BITWISE_OR: string; BITWISE_AND: string; BITWISE_NAND: string; EXACT_TIME: string; LENGTH_LT: string; LENGTH_EQ: string; LENGTH_GT: string; ALLOF: string; ISNULL: string; NOTNULL: string; ISBLANK: string; NOTBLANK: string; }; /** * Aggregate functions which can be used with the AGGFUNC suffix. * @readonly * @enum {String} */ export declare const Functions: { MAX: string; MIN: string; AVG: string; SUM: string; COUNT: string; STD: string; VAR: string; DMAX: string; DMIN: string; DAVG: string; DSUM: string; DCOUNT: string; DSTD: string; DVAR: string; };