@hitc/netsuite-types 2022.1.1 → 2022.1.4

package/N/dataset.d.ts

@@ -53,7 +53,11 @@ export interface Dataset {
   getExpressionFromColumn(options: { alias: string, columnId?: number }): Expression;
   /** Executes the dataset and returns the result set (the same as in N/query Module). */
   run(): ResultSet;
-  runPaged(): PagedData;
+  /**
+   * Executes the dataset and returns the result set as paginated data (the same as in N/query Module).
+   * The maximum number of results per page is 1000. The minimum number of results per page is 5, except for the last page, which may include fewer than 5 results.
+   */
+  runPaged(options?: { pageSize: number }): PagedData;
   save(): void; // May need to test what this returns.  Documentation says an object, but what object? The dataset itself?
   columns: Column[];
   condition: Condition;

package/N/query.d.ts

@@ -46,14 +46,27 @@ interface JoinFromOptions {
 }
 
 interface CreateConditionOptions {
-    /** Field (column) id */
-    fieldId: string;
+    /** Field (column) id. Required if options.operator and options.values are used. */
+    fieldId?: string;
 
     /** Use the Operator enum. */
     operator: Operator;
 
-    /** Array of values */
-    values: string | boolean | string[] | boolean[] | number[] | Date[]; // You wouldn't have multiple boolean values in an array, obviously. But you might specify it like: [true].
+    /**
+     * Array of values to use for the condition.
+     * Required if options.fieldId and options.operator are used, and options.operator does not have a value of query.Operator.EMPTY or query.Operator.EMPTY_NOT.
+     */
+    values: string | boolean | string[] | boolean[] | number[] | Date[] | RelativeDate[] | Period[]; // You wouldn't have multiple boolean values in an array, obviously. But you might specify it like: [true].
+
+    /**
+     * If you use the options.formula parameter, use this parameter to explicitly define the formula’s return type. This value sets the Condition.type property.
+     * Use the appropriate query.ReturnType enum value to pass in your argument. This enum holds all the supported values for this parameter.
+     * Required if options.fieldId is not used.
+     */
+    formula?: string;
+
+    /** Required if options.formula is used. */
+    type?: string;
 
     /** Aggregate function. Use the Aggregate enum. */
     aggregate?: string;
@@ -172,10 +185,11 @@ interface CreateSortOptions {
 }
 
 interface CreateQueryOptions {
-    /**
-     * The query type. Use the Type enum.
-     */
+    /** The query type. Use the Type enum. */
     type: string;
+    columns?: Column[];
+    condition?: Condition;
+    sort?: Sort[];
 }
 
 interface LoadQueryOptions {
@@ -184,9 +198,7 @@ interface LoadQueryOptions {
 }
 
 interface DeleteQueryOptions {
-    /**
-     * Id of query to be delete
-     */
+    /** The id of query to be deleted. */
     id: number;
 }
 
@@ -725,6 +737,19 @@ export interface PageRange {
     readonly size: number;
 }
 
+/** A period of time to use in query conditions. Use query.createPeriod(options) to create this object. */
+interface Period {
+    /** The adjustment of the period. This property uses values from the query.PeriodAdjustment enum. */
+    readonly adjustment: string;
+    /** The code of the period. This property uses values from the query.PeriodCode enum. */
+    readonly code: string;
+    /**
+     * The type of the period. This property uses values from the query.PeriodType enum.
+     * If you create a period using query.createPeriod(options) and do not specify a value for the options.type parameter, the default value of this property is query.PeriodType.START.
+     */
+    readonly type: string;
+}
+
 export interface Iterator {
     each(f: (result: Result) => boolean): void;
 }
@@ -882,6 +907,17 @@ interface RelativeDate {
     toJSON(): any;
 }
 
+interface CreatePeriodOptions {
+    /** The code of the period. This property uses values from the query.PeriodCode enum. */
+    code: PeriodCode;
+    /** The adjustment of the period. This property uses values from the query.PeriodAdjustment enum. */
+    adjustment?: PeriodAdjustment;
+    /** The type of the period. This property uses values from the query.PeriodType enum. The default value of this property is query.PeriodType.START. */
+    type?: PeriodType;
+}
+
+export function createPeriod(options: CreatePeriodOptions): Period;
+
 interface CreateRelativeDateOptions {
    /**
     * The ID of the relative date to create.
@@ -1233,6 +1269,49 @@ export enum FieldContext {
 	RAW = "RAW"
 }
 
+declare enum PeriodAdjustment {
+    ALL,
+    NOT_LAST
+}
+
+declare enum PeriodCode {
+    FIRST_FISCAL_QUARTER_LAST_FY,
+    FIRST_FISCAL_QUARTER_THIS_FY,
+    FISCAL_QUARTER_BEFORE_LAST,
+    FISCAL_YEAR_BEFORE_LAST,
+    FOURTH_FISCAL_QUARTER_LAST_FY,
+    FOURTH_FISCAL_QUARTER_THIS_FY,
+    LAST_FISCAL_QUARTER,
+    LAST_FISCAL_QUARTER_ONE_FISCAL_YEAR_AGO,
+    LAST_FISCAL_QUARTER_TO_PERIOD,
+    LAST_FISCAL_YEAR,
+    LAST_FISCAL_YEAR_TO_PERIOD,
+    LAST_PERIOD,
+    LAST_PERIOD_ONE_FISCAL_QUARTER_AGO,
+    LAST_PERIOD_ONE_FISCAL_YEAR_AGO,
+    LAST_ROLLING_18_PERIODS,
+    LAST_ROLLING_6_FISCAL_QUARTERS,
+    PERIOD_BEFORE_LAST,
+    SAME_FISCAL_QUARTER_LAST_FY,
+    SAME_FISCAL_QUARTER_LAST_FY_TO_PERIOD,
+    SAME_PERIOD_LAST_FY,
+    SAME_PERIOD_LAST_FISCAL_QUARTER,
+    SECOND_FISCAL_QUARTER_LAST_FY,
+    SECOND_FISCAL_QUARTER_THIS_FY,
+    THIRD_FISCAL_QUARTER_LAST_FY,
+    THIRD_FISCAL_QUARTER_THIS_FY,
+    THIS_FISCAL_QUARTER,
+    THIS_FISCAL_QUARTER_TO_PERIOD,
+    THIS_FISCAL_YEAR,
+    THIS_FISCAL_YEAR_TO_PERIOD,
+    THIS_PERIOD
+}
+
+declare enum PeriodType {
+    END,
+    START
+}
+
 export enum SortLocale {
     ARABIC = "ARABIC",
     ARABIC_ABJ_MATCH = "ARABIC_ABJ_MATCH",

package/N/ui/message.d.ts

@@ -1,4 +1,4 @@
-interface Message {
+export interface Message { // Also referenced in N/ui/serverWidget
     hide(): void;
     show(options?: MessageShowOptions): void;
 }

package/N/ui/serverWidget.d.ts

@@ -1,6 +1,6 @@
 import {ServerResponse} from 'N/http';
 import {AddColumnOptions, AddEditColumnOptions, AddRowOptions, AddRowsOptions} from 'N/portlet';
-import {MessageCreateOptions} from 'N/ui/message';
+import {Message, MessageCreateOptions} from 'N/ui/message';
 
 export interface AddButtonOptions {
     /** 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. */
@@ -449,7 +449,7 @@ export interface Form extends BaseForm {
     addButton(options: AddButtonOptions): Button;
     addCredentialField(options: AddCredentialFieldOptions): Field;
     addFieldGroup(options: AddFieldGroupOptions): FieldGroup;
-    addPageInitMessage(options: MessageCreateOptions): void;
+    addPageInitMessage(options: { message: Message } | MessageCreateOptions): void;
     addPageLink(options: AddPageLinkOptions): void;
     addResetButton(options?: AddResetButtonOptions): Button;
     addSecretKeyField(options: AddSecretKeyFieldOptions): Field;

package/package.json

@@ -8,7 +8,7 @@
     "posttest": "npm run cleanup"
   },
   "homepage": "https://github.com/headintheclouddev/typings-suitescript-2.0",
-  "version": "2022.1.1",
+  "version": "2022.1.4",
   "main": "index.d.ts",
   "author": "Head in the Cloud Development <gurus@headintheclouddev.com> (www.headintheclouddev.com)",
   "license": "MIT",