@hitc/netsuite-types 2021.2.11 → 2021.2.15

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/dataset.d.ts CHANGED
@@ -91,8 +91,10 @@ interface CreateConditionOptions {
91
91
  children?: Condition[];
92
92
  /** Required, unless options.children is specified. */
93
93
  column?: Column;
94
+ /** Uses the query.Operator enumeration, otherwise can be 'AND' or 'OR' when you are combining condition children. */
94
95
  operator: string;
95
- values: string[]|number[]|boolean[]|Date[];
96
+ /** The values attribute is required unless the operator is 'AND' or 'OR', as it is when you are combining condition children. */
97
+ values?: string[]|number[]|boolean[]|Date[]|{ dateId: string, type: string }[]; // For example, for after Start of Last Fiscal Year, use: { dateId: "SOLFY", type: "end" }
96
98
  }
97
99
 
98
100
  interface CreateJoinOptions {
@@ -2,7 +2,7 @@ import {ServerResponse} from 'N/http';
2
2
  import {AddColumnOptions, AddEditColumnOptions, AddRowOptions, AddRowsOptions} from 'N/portlet';
3
3
  import {MessageCreateOptions} from 'N/ui/message';
4
4
 
5
- interface AddButtonOptions {
5
+ export interface AddButtonOptions {
6
6
  /** The internal ID of the button. If you are adding the button to an existing page, the internal ID must be in lowercase, contain no spaces, and include the prefix custpage. */
7
7
  id?: string;
8
8
  /** The label for this button. */
package/N/workbook.d.ts CHANGED
@@ -77,11 +77,11 @@ interface ColorRGBA {
77
77
  */
78
78
  interface ConditionalFilter {
79
79
  /** The selected filters in the condition filter. */
80
- filteredNodesSelector: AllSubNodesSelector|PathSelector|DimensionSelector;
80
+ filteredNodesSelector: PathSelector|DimensionSelector;
81
81
  /** The measure of the conditional filter. */
82
82
  measure: Measure;
83
83
  /** The selector for the other axis in the conditional filter. */
84
- otherAxisSelector: (AllSubNodesSelector|PathSelector|DimensionSelector);
84
+ otherAxisSelector: PathSelector|DimensionSelector;
85
85
  /** The actual predicate for the conditional filter, which indicates whether the condition is met. */
86
86
  predicate: Expression;
87
87
  /** The row axis indicator for the conditional filter. */
@@ -222,7 +222,7 @@ interface Legend {
222
222
  */
223
223
  interface LimitingFilter {
224
224
  /** The selections for the limiting filter. */
225
- filteredNodesSelector: AllSubNodesSelector|PathSelector|DimensionSelector;
225
+ filteredNodesSelector: PathSelector|DimensionSelector;
226
226
  /** The limit number for the limiting filter. */
227
227
  limit: number;
228
228
  /** The row axis indicator for the limiting factor.*/
@@ -258,7 +258,7 @@ interface MeasureSort {
258
258
  /** The sort of the measure sort. */
259
259
  measure: Measure;
260
260
  /** The other axis selector for the measure sort. */
261
- otherAxisSelector: AllSubNodesSelector|PathSelector|DimensionSelector;
261
+ otherAxisSelector: PathSelector|DimensionSelector;
262
262
  /** The sort for the measure sort. */
263
263
  sort: Sort;
264
264
  }
@@ -390,7 +390,7 @@ interface Series {
390
390
  interface Sort {
391
391
  /** The ascending sort indicator of the sort. */
392
392
  ascending: boolean,
393
- /** The indicator that determines if the sort is case sensitive. */
393
+ /** The indicator that determines if the sort is case-sensitive. */
394
394
  caseSensitive: boolean,
395
395
  /** The locale of the sort. */
396
396
  locale: Operator,
@@ -404,7 +404,7 @@ interface Sort {
404
404
  */
405
405
  interface SortDefinition {
406
406
  /** The selector for the sort definition. */
407
- selector: AllSubNodesSelector|DimensionSelector|PathSelector;
407
+ selector: DimensionSelector|PathSelector;
408
408
  /** The ordering elements for the sort definition. */
409
409
  sortBys: DimensionSelector|MeasureSort[];
410
410
  }
@@ -459,7 +459,7 @@ interface TableColumn {
459
459
 
460
460
  /**
461
461
  * A table definition. A table is a workbook component that enables you to view your dataset query results in a simple table.
462
- * You can create a table definition using workbook.createTableDefinition(options).
462
+ * You can create a table definition using workbook.createTable(options).
463
463
  */
464
464
  interface TableDefinition {
465
465
  /** The columns of the table definition. */
@@ -513,9 +513,7 @@ export interface Workbook {
513
513
  * A selector that is used to select nodes to use in conditions. It can be used when creating a path selector, a sort definition, a conditional filter, a limiting filter, or a measure sort.
514
514
  * You can create an AllSubNodesSelector using workbook.createAllSubNodesSelector().
515
515
  */
516
- interface AllSubNodesSelector {
517
- // TODO Update this as it is empty with NS Help
518
- }
516
+ // interface AllSubNodesSelector { } // Commented out on 6 Dec 2021 - this is no longer in the Help?
519
517
 
520
518
  interface CreateOptions {
521
519
  chartDefinition?: ChartDefinition[];
@@ -571,9 +569,9 @@ interface CreateColor {
571
569
  }
572
570
 
573
571
  interface CreateConditionalFilter {
574
- filteredNodesSelector: AllSubNodesSelector|DimensionSelector|PathSelector;
572
+ filteredNodesSelector: DimensionSelector|PathSelector;
575
573
  measure: Measure;
576
- otherAxisSelector: AllSubNodesSelector|DimensionSelector|PathSelector;
574
+ otherAxisSelector: DimensionSelector|PathSelector;
577
575
  predicate: Expression;
578
576
  row: boolean;
579
577
  }
@@ -641,7 +639,7 @@ interface CreateLegend {
641
639
  }
642
640
 
643
641
  interface CreateLimitingFilter {
644
- filteredNodesSelector: AllSubNodesSelector|DimensionSelector|PathSelector;
642
+ filteredNodesSelector: DimensionSelector|PathSelector;
645
643
  limit: number;
646
644
  row: boolean;
647
645
  sortBys: (DimensionSort|MeasureSort)[];
@@ -660,8 +658,8 @@ interface CreateMeasureSelector {
660
658
 
661
659
  interface CreateMeasureSort {
662
660
  measure: Measure;
663
- otherAxisSelector: AllSubNodesSelector|DimensionSelector|PathSelector;
664
- selector: AllSubNodesSelector|DimensionSelector|PathSelector;
661
+ otherAxisSelector: DimensionSelector|PathSelector;
662
+ selector: DimensionSelector|PathSelector;
665
663
  sort: Sort;
666
664
  }
667
665
 
@@ -672,7 +670,7 @@ interface CreateMeasureValueSelector {
672
670
  }
673
671
 
674
672
  interface CreatePathSelector {
675
- elements: (AllSubNodesSelector|DimensionSelector)[];
673
+ elements: DimensionSelector[];
676
674
  }
677
675
 
678
676
  interface CreatePivotAxis {
@@ -746,7 +744,7 @@ interface CreateSortByMeasure {
746
744
  }
747
745
 
748
746
  interface CreateSortDefinition {
749
- selector: AllSubNodesSelector|DimensionSelector|PathSelector;
747
+ selector: DimensionSelector|PathSelector;
750
748
  sortBys: (DimensionSort|MeasureSort)[];
751
749
  }
752
750
 
@@ -814,7 +812,7 @@ export function create(options: CreateOptions): Workbook;
814
812
  /**
815
813
  * Creates an AllSubNodesSelector, which can be used when creating a path selector, a sort definition, a conditional filter, a limiting filter, or a measure sort.
816
814
  */
817
- export function createAllSubNodesSelector(): AllSubNodesSelector;
815
+ // export function createAllSubNodesSelector(): AllSubNodesSelector;
818
816
 
819
817
  /**
820
818
  * Creates an aspect for a chart series. An aspect includes a measure and an aspect type.
@@ -881,9 +879,7 @@ export function createDataDimension(options: CreateDataDimension): DataDimension
881
879
  */
882
880
  export function createDataDimensionItem(options: CreateDataDimensionItem): DataDimensionItem;
883
881
 
884
- /**
885
- * Creates a data measure.
886
- */
882
+ /** Creates a data measure. TODO: Test this, this method doesn't seem to actually exist in NetSuite as of December 2021. */
887
883
  export function createDataMeasure(options: CreateDataMeasure): DataMeasure;
888
884
 
889
885
  /**
@@ -1032,7 +1028,7 @@ export function createTableColumn(options: CreateTableColumn): TableColumn;
1032
1028
  * A table is a workbook component that enables you to view your dataset query results in a simple table.
1033
1029
  * A table is based on an underlying dataset and can include an ID, a name, a dataset, and table columns,
1034
1030
  */
1035
- export function createTableDefinition(options: CreateTableDefinition): TableDefinition;
1031
+ export function createTable(options: CreateTableDefinition): TableDefinition;
1036
1032
 
1037
1033
  /**
1038
1034
  * Creates a table filter, which includes an operator and values.
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": "2021.2.11",
11
+ "version": "2021.2.15",
12
12
  "main": "index.d.ts",
13
13
  "author": "Head in the Cloud Development <gurus@headintheclouddev.com> (www.headintheclouddev.com)",
14
14
  "license": "MIT",