@hitc/netsuite-types 2024.2.0 → 2024.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/N/task.d.ts +1 -1
- package/N/workbook.d.ts +42 -27
- package/package.json +1 -1
package/N/task.d.ts
CHANGED
|
@@ -184,7 +184,7 @@ interface CsvImportTaskStatus {
|
|
|
184
184
|
interface EntityDeduplicationTaskCreateOptions {
|
|
185
185
|
taskType: TaskType.ENTITY_DEDUPLICATION;
|
|
186
186
|
dedupeMode?: DedupeMode;
|
|
187
|
-
entityType?: string;
|
|
187
|
+
entityType?: string | DedupeEntityType;
|
|
188
188
|
masterRecordId?: string | number;
|
|
189
189
|
masterSelectionMode?: MasterSelectionMode;
|
|
190
190
|
recordIds?: number[];
|
package/N/workbook.d.ts
CHANGED
|
@@ -36,11 +36,11 @@ interface ChartDefinition {
|
|
|
36
36
|
/** The limiting and conditional filters of the chart definition. */
|
|
37
37
|
aggregationFilters: (LimitingFilter|ConditionalFilter)[];
|
|
38
38
|
/** The category of the chart definition. */
|
|
39
|
-
category:
|
|
39
|
+
category: Category;
|
|
40
40
|
/** The underlying dataset for the chart definition. */
|
|
41
41
|
dataset: Dataset;
|
|
42
42
|
/** The filter expressions for the chart definition. */
|
|
43
|
-
|
|
43
|
+
filterExpressions: Expression[];
|
|
44
44
|
/** The ID of chart definition. */
|
|
45
45
|
id: string;
|
|
46
46
|
/** The legend of the chart definition. */
|
|
@@ -48,15 +48,17 @@ interface ChartDefinition {
|
|
|
48
48
|
/** The name of the chart definition. */
|
|
49
49
|
name: string;
|
|
50
50
|
/** The series of the chart definition. */
|
|
51
|
-
series: Series;
|
|
51
|
+
series: Series[];
|
|
52
52
|
/** The stacking type for the chart definition. */
|
|
53
53
|
stacking: Stacking;
|
|
54
54
|
/** The subtitle of the chart definition. */
|
|
55
|
-
|
|
55
|
+
subTitle: string;
|
|
56
56
|
/** The title of chart definition. */
|
|
57
57
|
title: string;
|
|
58
58
|
/** The chart type of the chart definition. */
|
|
59
|
-
|
|
59
|
+
type: ChartType;
|
|
60
|
+
/** The dataset link of the chart definition. */
|
|
61
|
+
datasetLink?: DatasetLink;
|
|
60
62
|
}
|
|
61
63
|
|
|
62
64
|
/**
|
|
@@ -139,7 +141,7 @@ interface DataDimensionValue {
|
|
|
139
141
|
}
|
|
140
142
|
|
|
141
143
|
interface DataMeasure {
|
|
142
|
-
aggregation: string;
|
|
144
|
+
aggregation: string|Aggregation;
|
|
143
145
|
/** This property is used if the data measure is a single-expression measure. */
|
|
144
146
|
expression: Expression;
|
|
145
147
|
/** This property is used if the data measure is a multiple-expression measure. */
|
|
@@ -228,7 +230,7 @@ interface LimitingFilter {
|
|
|
228
230
|
/** The row axis indicator for the limiting factor.*/
|
|
229
231
|
row: boolean;
|
|
230
232
|
/** The ordering elements of the limiting filter.*/
|
|
231
|
-
sortBys: (DimensionSort|MeasureSort)[]
|
|
233
|
+
sortBys: (DimensionSort|MeasureSort)[];
|
|
232
234
|
}
|
|
233
235
|
|
|
234
236
|
/**
|
|
@@ -280,7 +282,7 @@ interface MeasureValueSelector {
|
|
|
280
282
|
*/
|
|
281
283
|
interface PathSelector {
|
|
282
284
|
/** The elements denoting 'xpath' of the path selector. */
|
|
283
|
-
elements: PathSelector|DimensionSelector;
|
|
285
|
+
elements: PathSelector|DimensionSelector|(PathSelector|DimensionSelector)[];
|
|
284
286
|
}
|
|
285
287
|
|
|
286
288
|
/** A pivot axis. A pivot axis is used with you create a pivot definition.
|
|
@@ -290,7 +292,7 @@ interface PivotAxis {
|
|
|
290
292
|
/** The root data for the pivot axis. */
|
|
291
293
|
root: DataDimension|Section;
|
|
292
294
|
/** The sort definitions of the pivot axis. */
|
|
293
|
-
sortDefinitions: SortDefinition
|
|
295
|
+
sortDefinitions: SortDefinition|SortDefinition[];
|
|
294
296
|
}
|
|
295
297
|
|
|
296
298
|
/**
|
|
@@ -365,7 +367,7 @@ interface ReportStyleRule {
|
|
|
365
367
|
*/
|
|
366
368
|
interface Section {
|
|
367
369
|
/** The children of the section. */
|
|
368
|
-
children: DataDimension|Measure|Section[];
|
|
370
|
+
children: (DataDimension|Measure|Section)[];
|
|
369
371
|
/** The format for the total line on a section. */
|
|
370
372
|
totalLine: TotalLine;
|
|
371
373
|
}
|
|
@@ -389,11 +391,11 @@ interface Series {
|
|
|
389
391
|
*/
|
|
390
392
|
interface Sort {
|
|
391
393
|
/** The ascending sort indicator of the sort. */
|
|
392
|
-
ascending: boolean
|
|
394
|
+
ascending: boolean;
|
|
393
395
|
/** The indicator that determines if the sort is case-sensitive. */
|
|
394
|
-
caseSensitive: boolean
|
|
396
|
+
caseSensitive: boolean;
|
|
395
397
|
/** The locale of the sort. */
|
|
396
|
-
locale: Operator
|
|
398
|
+
locale: Operator;
|
|
397
399
|
/** The indicator for placing nulls last of the sort. */
|
|
398
400
|
nullsLast: boolean;
|
|
399
401
|
}
|
|
@@ -406,7 +408,7 @@ interface SortDefinition {
|
|
|
406
408
|
/** The selector for the sort definition. */
|
|
407
409
|
selector: DimensionSelector|PathSelector;
|
|
408
410
|
/** The ordering elements for the sort definition. */
|
|
409
|
-
sortBys:
|
|
411
|
+
sortBys: (DimensionSort|MeasureSort)[];
|
|
410
412
|
}
|
|
411
413
|
|
|
412
414
|
interface SortByDataDimensionItem {
|
|
@@ -496,7 +498,7 @@ export interface Workbook {
|
|
|
496
498
|
/** Executes the table and returns paginated data (the same as in N/query Module). */
|
|
497
499
|
runTablePaged(options: RunTablePaged): PagedData;
|
|
498
500
|
/** Chart definitions that can be included in a workbook when you create a new workbook. */
|
|
499
|
-
|
|
501
|
+
charts: ChartDefinition[];
|
|
500
502
|
/** The description of the workbook. This is set when you create a workbook. */
|
|
501
503
|
description: string;
|
|
502
504
|
/** The ID of the workbook, that is set when you create a workbook. */
|
|
@@ -516,15 +518,15 @@ export interface Workbook {
|
|
|
516
518
|
// interface AllSubNodesSelector { } // Commented out on 6 Dec 2021 - this is no longer in the Help?
|
|
517
519
|
|
|
518
520
|
interface CreateOptions {
|
|
519
|
-
|
|
521
|
+
charts?: ChartDefinition[];
|
|
520
522
|
description?: string;
|
|
521
523
|
name?: string;
|
|
522
524
|
pivots?: Pivot[];
|
|
523
|
-
|
|
525
|
+
tables?: TableDefinition[];
|
|
524
526
|
}
|
|
525
527
|
|
|
526
528
|
interface CreateAspectOptions {
|
|
527
|
-
measure: Measure;
|
|
529
|
+
measure: Measure|DataMeasure;
|
|
528
530
|
type?: AspectType;
|
|
529
531
|
}
|
|
530
532
|
|
|
@@ -549,16 +551,17 @@ interface CreateChartAxis {
|
|
|
549
551
|
interface CreateChartDefinition {
|
|
550
552
|
aggregationFilters?: (ConditionalFilter|LimitingFilter)[];
|
|
551
553
|
category: Category;
|
|
552
|
-
dataset
|
|
553
|
-
filterExpressions?: Expression;
|
|
554
|
+
dataset?: Dataset;
|
|
555
|
+
filterExpressions?: Expression[];
|
|
554
556
|
id: string;
|
|
555
557
|
legend: Legend;
|
|
556
558
|
name: string;
|
|
557
|
-
series: Series;
|
|
559
|
+
series: Series[];
|
|
558
560
|
stacking?: Stacking;
|
|
559
561
|
subTitle?: string;
|
|
560
562
|
title?: string;
|
|
561
563
|
type: ChartType;
|
|
564
|
+
datasetLink?: DatasetLink;
|
|
562
565
|
}
|
|
563
566
|
|
|
564
567
|
interface CreateColor {
|
|
@@ -587,7 +590,7 @@ interface CreateConditionalFormatRule {
|
|
|
587
590
|
|
|
588
591
|
interface CreateConstant {
|
|
589
592
|
constant: string|number|boolean|Date;
|
|
590
|
-
|
|
593
|
+
type?: ConstantType;
|
|
591
594
|
}
|
|
592
595
|
|
|
593
596
|
interface CreateDataDimension {
|
|
@@ -602,7 +605,7 @@ interface CreateDataDimensionItem {
|
|
|
602
605
|
}
|
|
603
606
|
|
|
604
607
|
interface CreateDataMeasure {
|
|
605
|
-
aggregation: string;
|
|
608
|
+
aggregation: string|Aggregation;
|
|
606
609
|
expression?: Expression;
|
|
607
610
|
expressions?: Expression[];
|
|
608
611
|
label: string;
|
|
@@ -635,7 +638,7 @@ interface CreateFontSize {
|
|
|
635
638
|
interface CreateLegend {
|
|
636
639
|
axes: ChartAxis[];
|
|
637
640
|
root: Section|DataDimension;
|
|
638
|
-
sortDefinitions?: SortDefinition[]
|
|
641
|
+
sortDefinitions?: SortDefinition[];
|
|
639
642
|
}
|
|
640
643
|
|
|
641
644
|
interface CreateLimitingFilter {
|
|
@@ -790,11 +793,11 @@ interface Load {
|
|
|
790
793
|
}
|
|
791
794
|
|
|
792
795
|
interface RunTable {
|
|
793
|
-
id: string
|
|
796
|
+
id: string;
|
|
794
797
|
}
|
|
795
798
|
|
|
796
799
|
interface RunTablePaged {
|
|
797
|
-
id: string
|
|
800
|
+
id: string;
|
|
798
801
|
pageSize?: number;
|
|
799
802
|
}
|
|
800
803
|
|
|
@@ -840,7 +843,7 @@ export function createChartAxis(options: CreateChartAxis): ChartAxis;
|
|
|
840
843
|
* A chart is built from an underlying dataset and can also include a category, a legend, series, a type, expressions, filters, stacking behavior indicators, along with an ID, a name, a title, and a subtitle.
|
|
841
844
|
* For more information on charts in SuiteAnalytics, see Workbook Charts.
|
|
842
845
|
*/
|
|
843
|
-
export function
|
|
846
|
+
export function createChart(options: CreateChartDefinition): ChartDefinition;
|
|
844
847
|
|
|
845
848
|
/**
|
|
846
849
|
* Creates a color.
|
|
@@ -1035,6 +1038,11 @@ export function createTable(options: CreateTableDefinition): TableDefinition;
|
|
|
1035
1038
|
*/
|
|
1036
1039
|
export function createTableColumnFilter(options: CreateTableColumnFilter): TableColumnFilter;
|
|
1037
1040
|
|
|
1041
|
+
/**
|
|
1042
|
+
* Creates a record key.
|
|
1043
|
+
*/
|
|
1044
|
+
export function createSimpleRecordKey({ key: number }): number;
|
|
1045
|
+
|
|
1038
1046
|
/**
|
|
1039
1047
|
* Lists all existing workbooks.
|
|
1040
1048
|
*/
|
|
@@ -1045,6 +1053,13 @@ export function list(): Object[];
|
|
|
1045
1053
|
*/
|
|
1046
1054
|
export function load(options: { id: string }): Workbook;
|
|
1047
1055
|
|
|
1056
|
+
/**
|
|
1057
|
+
* A selector for descendant or self nodes object.
|
|
1058
|
+
*
|
|
1059
|
+
* A selector for descendant or self nodes object is used as a parameter in the workbook.createMeasureValueSelector(options), and workbook.createSortByMeasure(options) methods.
|
|
1060
|
+
*/
|
|
1061
|
+
export const DescendantOrSelfNodesSelector: unknown;
|
|
1062
|
+
|
|
1048
1063
|
declare enum Aggregation {
|
|
1049
1064
|
COUNT,
|
|
1050
1065
|
COUNT_DISTINCT,
|
package/package.json
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"posttest": "npm run cleanup"
|
|
9
9
|
},
|
|
10
10
|
"homepage": "https://github.com/headintheclouddev/typings-suitescript-2.0",
|
|
11
|
-
"version": "2024.2.
|
|
11
|
+
"version": "2024.2.2",
|
|
12
12
|
"author": "Head in the Cloud Development <gurus@headintheclouddev.com> (www.headintheclouddev.com)",
|
|
13
13
|
"license": "MIT",
|
|
14
14
|
"repository": {
|