@hitc/netsuite-types 2024.1.10 → 2024.2.1

package/N/pgp.d.ts

@@ -0,0 +1,179 @@
+/**
+ * Use the N/pgp module to enable secure messaging, file encryption, and document signing. Based on OpenPGP encryption standards.
+ * PGP stands for Pretty Good Privacy and is most commonly used for encrypting emails.
+ */
+
+import {Signer} from "./crypto/certificate";
+
+/** Stores general configuration options that can be used for message decryption. Use the pgp.createConfig(options) method to create a new configuration object. */
+interface Config {
+  /** Enables decryption that is not secured with signing keys. */
+  readonly allowInsecureDecryptionWithSigningKeys: boolean;
+  /** Allows messages without integrity protection. */
+  readonly allowMessagesWithoutIntegrityProtection: boolean;
+  /** Allows relaxed signature parsing for configuration objects. */
+  readonly useRelaxedSignatureParsing: boolean;
+}
+
+/**
+ * Stores multiple cryptographic keys and metadata.
+ * You can use this object in the Message.decrypt(options) and MessageData.encrypt(options) methods.
+ */
+interface Key {
+  // TODO: Nothing in the documentation?
+}
+
+/** Stores an octet scalar that identifies a (sub)key. This object is used for verification signatures. */
+interface KeyId {
+  /** Returns the Key ID as a hexadecimal string. */
+  asHex: () => string;
+}
+
+/**
+ * Stores processed PGP data. Responsible for enabling message serialization and providing a set of single-step processors to covert to a readable message.
+ * Use the MessageData.toMessage() and MessageData.encrypt(options) to create a Message object.
+ */
+interface Message {
+  /** Message type that specifies how a message is processed. Enables you to pick the appropriate method to process a message. */
+  readonly type: boolean;
+  /** Converts a message to ASCII armored format. */
+  asArmored: () => string;
+  /** Converts a pgp.Message object to message data without any processing. This method only works if the message is not encrypted. */
+  toMessageData: () => MessageData;
+  /** Decrypts a message and optionally verifies the signatures. */
+  decrypt: (options: DecryptMessageOptions) => MessageData;
+}
+
+/**
+ * Stores message data. The responsibilities of this object includes:
+ * - Store message contents with meta data.
+ * - Enable reading message contents and metadata.
+ * - For further processing, determines whether data is text or binary.
+ * - Provides a set of single-step processors for various PGP use cases.
+ * Use the pgp.createMessageData(options) method to create a message data object.
+ */
+interface MessageData {
+  readonly filename: string;
+  readonly date: Date;
+  readonly format: Format;
+  /** Extracts the contents of the message as text. */
+  getText: () => string;
+  /** Creates a message with no signature, compression, or encryption. */
+  toMessage: () => Message;
+  /** Creates an encrypted message that is optionally signed. */
+  encrypt: (options: EncryptMessageDataOptions) => Message;
+}
+
+/** Stores verification results. Use the pgp.createVerification() method to create a Verification object. */
+interface Verification {
+  /** Indicates whether the message verification was successful. */
+  readonly verified: null|boolean;
+  /** List of individual verifications, one per each signature. */
+  readonly signatures: null|VerificationSignature[];
+}
+
+/** Stores a verification result for single signature. */
+interface VerificationSignature {
+  /** ID of the (sub)key that was used for signing. */
+  readonly keyId: KeyId;
+  /** Date when the message was signed. */
+  readonly dateSigned: Date;
+  /** Indicates whether verification was successful. */
+  readonly verified: boolean;
+  /** List of problems for more fine-grained decision making. */
+  readonly problems: string[];
+}
+
+/** Creates a new pgp.Config object. A configuration object stores general configuration options that can be used for message decryption. */
+export function createConfig(options: CreateConfigOptions): Config;
+
+/** Creates a new pgp.MessageData object. A message data object stores message content with metadata. */
+export function createMessageData(options: CreateMessageDataOptions): MessageData;
+
+/**
+ * Creates a certificate.Signer object for signing plain strings.
+ * If the given PGP key contains multiple valid signing sub keys, the most recently added will be used.
+ * This behavior is consistent with MessageData.encrypt(options) method.
+ */
+export function createSigner(options: { key: Key, algorithm: string }): Signer;
+
+/** Creates an empty verification object. */
+export function createVerification(): Verification;
+
+/** Loads a key contents that are securely stored in a secret. */
+export function loadKeyFromSecret(options: LoadKeyFromSecretOptions): Key;
+
+/** Parses an existing PGP key. Use pgp.loadKeyFromSecret(options) to load private keys. */
+export function parseKey(options: ParseKeyOptions): Key;
+
+/** Parses a PGP message. Parameter value is ASCII armored representation of the message. */
+export function parseMessage(options: { value: string }): Message;
+
+export enum CompressionAlgorithm {
+  ZLIB
+}
+
+export enum Format {
+  UTF8,
+  BINARY
+}
+
+interface CreateConfigOptions {
+  /** Enables decryption that is not secured with signing keys. Default value is false. */
+  allowInsecureDecryptionWithSigningKeys?: boolean;
+  /** Allows messages without integrity protection. Default value is false. */
+  allowMessagesWithoutIntegrityProtection?: boolean;
+  /** Allows relaxed signature parsing for configuration objects. Default value is false. */
+  useRelaxedSignatureParsing?: boolean;
+}
+
+interface CreateMessageDataOptions {
+  /** Content of the message. */
+  content: string;
+  /** File name if the message represents a file, empty string otherwise. */
+  filename?: string;
+  /** Date of the message or modification date of the file. Default value = new Date(). */
+  date?: Date;
+  /** Literal data packet type. Default value = Format.UTF8, if content is a string. Format.BINARY otherwise. */
+  format?: Format;
+}
+
+interface DecryptMessageOptions {
+  /** Uses one or more keys to attempt message decryption. */
+  decryptionKeys: Key|Key[];
+  /**
+   * Uses zero or more keys to attempt message signature verification. If you do not provide a verification key, the message's signature (if any) will be ignored.
+   * If you do provide a verification key, at least one signature must be verifiable by one of the provided keys, otherwise an error will be thrown.
+   * An expired key works if the signature was made before the expiration. Default value = [].
+   */
+  verificationKeys?: Key|Key[];
+  /** An empty verification object. If you provide a value for this parameter, the verification results will be flushed instead of throwing an error for invalid signature. Default value = null. */
+  verification?: Verification;
+  /** If set to true, the verification errors will not be thrown. This value is implicitly set to true when the verification parameter is provided. Default value = false. */
+  suppressVerificationErrors?: boolean;
+  /** The configuration. Default value is pgp.createConfig(options). */
+  config?: Config;
+}
+
+interface EncryptMessageDataOptions {
+  /** One or more keys used to encrypt a message. If a key contains multiple valid encryption (sub)keys, the most recent key added will be used. */
+  encryptionKeys: Key|Key[];
+  /** Zero or more keys used for signing. If a key contains multiple valid signing (sub)keys, the most recent key added will be used. Default value = []. */
+  signingKeys?: Key|Key[];
+  /** The compression algorithm to use. Default value = CompressionAlgorithm.ZLIB. */
+  compressionAlgorithm?: CompressionAlgorithm;
+}
+
+interface LoadKeyFromSecretOptions {
+  /** Secret that contains a PGP key in ASCII armored format. */
+  secret: { scriptId: string };
+  /** Secret that contains a password to unlock the key. Applicable for private keys. */
+  password?: { scriptId: string };
+}
+
+interface ParseKeyOptions {
+  /** ASCII armored key */
+  value: string;
+  /** Password to unlock the key. Applicable for private keys. */
+  password?: string;
+}

package/N/scriptTypes/restlet.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Use the N/scriptTypes/restlet module to create custom HTTP responses for your RESTlet script.
+ * This module is available only to RESTlet script type.
+ */
+
+/** An HTTP response of a RESTlet script. This object is read-only. Use restlet.createResponse(options) to create and return this object. */
+interface Response {
+  /** The content of the RESTlet HTTP response. */
+  readonly content: string;
+  /** The Content-Type header of the RESTlet HTTP response. */
+  readonly contentType: string;
+}
+
+/** Creates a custom RESTlet HTTP response. */
+export function createResponse(options: CreateResponseOptions): Response;
+
+interface CreateResponseOptions {
+  /** The content of the response. */
+  content: string;
+  /**
+   * The Content-Type header of the response.
+   * This value overrides the default Content-Type header, which is the same as the Content-Type header of the RESTlet HTTP request.
+   */
+  contentType: string;
+}

package/N/task.d.ts

@@ -184,7 +184,7 @@ interface CsvImportTaskStatus {
 interface EntityDeduplicationTaskCreateOptions {
     taskType: TaskType.ENTITY_DEDUPLICATION;
     dedupeMode?: DedupeMode;
-    entityType?: string;
+    entityType?: string | DedupeEntityType;
     masterRecordId?: string | number;
     masterSelectionMode?: MasterSelectionMode;
     recordIds?: number[];

package/N/workbook.d.ts

@@ -36,11 +36,11 @@ interface ChartDefinition {
   /** The limiting and conditional filters of the chart definition. */
   aggregationFilters: (LimitingFilter|ConditionalFilter)[];
   /** The category of the chart definition. */
-  category: string;
+  category: Category;
   /** The underlying dataset for the chart definition. */
   dataset: Dataset;
   /** The filter expressions for the chart definition. */
-  filterExpression: Expression[];
+  filterExpressions: Expression[];
   /** The ID of chart definition. */
   id: string;
   /** The legend of the chart definition. */
@@ -48,15 +48,17 @@ interface ChartDefinition {
   /** The name of the chart definition. */
   name: string;
   /** The series of the chart definition. */
-  series: Series;
+  series: Series[];
   /** The stacking type for the chart definition. */
   stacking: Stacking;
   /** The subtitle of the chart definition. */
-  subtitle: string;
+  subTitle: string;
   /** The title of chart definition. */
   title: string;
   /** The chart type of the chart definition. */
-  chartType: ChartType;
+  type: ChartType;
+  /** The dataset link of the chart definition. */
+  datasetLink?: DatasetLink;
 }
 
 /**
@@ -139,7 +141,7 @@ interface DataDimensionValue {
 }
 
 interface DataMeasure {
-  aggregation: string;
+  aggregation: string|Aggregation;
   /** This property is used if the data measure is a single-expression measure. */
   expression: Expression;
   /** This property is used if the data measure is a multiple-expression measure. */
@@ -228,7 +230,7 @@ interface LimitingFilter {
   /** The row axis indicator for the limiting factor.*/
   row: boolean;
   /** The ordering elements of the limiting filter.*/
-  sortBys: (DimensionSort|MeasureSort)[]
+  sortBys: (DimensionSort|MeasureSort)[];
 }
 
 /**
@@ -280,7 +282,7 @@ interface MeasureValueSelector {
  */
 interface PathSelector {
   /** The elements denoting 'xpath' of the path selector. */
-  elements: PathSelector|DimensionSelector;
+  elements: PathSelector|DimensionSelector|(PathSelector|DimensionSelector)[];
 }
 
 /** A pivot axis. A pivot axis is used with you create a pivot definition.
@@ -290,7 +292,7 @@ interface PivotAxis {
   /** The root data for the pivot axis. */
   root: DataDimension|Section;
   /** The sort definitions of the pivot axis. */
-  sortDefinitions: SortDefinition
+  sortDefinitions: SortDefinition|SortDefinition[];
 }
 
 /**
@@ -365,7 +367,7 @@ interface ReportStyleRule {
  */
 interface Section {
   /** The children of the section. */
-  children: DataDimension|Measure|Section[];
+  children: (DataDimension|Measure|Section)[];
   /** The format for the total line on a section. */
   totalLine: TotalLine;
 }
@@ -389,11 +391,11 @@ interface Series {
  */
 interface Sort {
   /** The ascending sort indicator of the sort. */
-  ascending: boolean,
+  ascending: boolean;
   /** The indicator that determines if the sort is case-sensitive. */
-  caseSensitive: boolean,
+  caseSensitive: boolean;
   /** The locale of the sort. */
-  locale: Operator,
+  locale: Operator;
   /** The indicator for placing nulls last of the sort. */
   nullsLast: boolean;
 }
@@ -406,7 +408,7 @@ interface SortDefinition {
   /** The selector for the sort definition. */
   selector: DimensionSelector|PathSelector;
   /** The ordering elements for the sort definition. */
-  sortBys: DimensionSelector|MeasureSort[];
+  sortBys: (DimensionSort|MeasureSort)[];
 }
 
 interface SortByDataDimensionItem {
@@ -496,7 +498,7 @@ export interface Workbook {
   /** Executes the table and returns paginated data (the same as in N/query Module). */
   runTablePaged(options: RunTablePaged): PagedData;
   /** Chart definitions that can be included in a workbook when you create a new workbook. */
-  chartDefinitions: ChartDefinition;
+  charts: ChartDefinition[];
   /** The description of the workbook. This is set when you create a workbook. */
   description: string;
   /** The ID of the workbook, that is set when you create a workbook. */
@@ -516,15 +518,15 @@ export interface Workbook {
 // interface AllSubNodesSelector { } // Commented out on 6 Dec 2021 - this is no longer in the Help?
 
 interface CreateOptions {
-  chartDefinition?: ChartDefinition[];
+  charts?: ChartDefinition[];
   description?: string;
   name?: string;
   pivots?: Pivot[];
-  tableDefinitions?: TableDefinition[];
+  tables?: TableDefinition[];
 }
 
 interface CreateAspectOptions {
-  measure: Measure;
+  measure: Measure|DataMeasure;
   type?: AspectType;
 }
 
@@ -549,16 +551,17 @@ interface CreateChartAxis {
 interface CreateChartDefinition {
   aggregationFilters?: (ConditionalFilter|LimitingFilter)[];
   category: Category;
-  dataset: Dataset;
-  filterExpressions?: Expression;
+  dataset?: Dataset;
+  filterExpressions?: Expression[];
   id: string;
   legend: Legend;
   name: string;
-  series: Series;
+  series: Series[];
   stacking?: Stacking;
   subTitle?: string;
   title?: string;
   type: ChartType;
+  datasetLink?: DatasetLink;
 }
 
 interface CreateColor {
@@ -587,7 +590,7 @@ interface CreateConditionalFormatRule {
 
 interface CreateConstant {
   constant: string|number|boolean|Date;
-  tye?: ConstantType;
+  type?: ConstantType;
 }
 
 interface CreateDataDimension {
@@ -602,7 +605,7 @@ interface CreateDataDimensionItem {
 }
 
 interface CreateDataMeasure {
-  aggregation: string;
+  aggregation: string|Aggregation;
   expression?: Expression;
   expressions?: Expression[];
   label: string;
@@ -635,7 +638,7 @@ interface CreateFontSize {
 interface CreateLegend {
   axes: ChartAxis[];
   root: Section|DataDimension;
-  sortDefinitions?: SortDefinition[]
+  sortDefinitions?: SortDefinition[];
 }
 
 interface CreateLimitingFilter {
@@ -790,11 +793,11 @@ interface Load {
 }
 
 interface RunTable {
-  id: string
+  id: string;
 }
 
 interface RunTablePaged {
-  id: string
+  id: string;
   pageSize?: number;
 }
 
@@ -840,7 +843,7 @@ export function createChartAxis(options: CreateChartAxis): ChartAxis;
  * 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.
  * For more information on charts in SuiteAnalytics, see Workbook Charts.
  */
-export function createChartDefinition(options: CreateChartDefinition): Workbook;
+export function createChart(options: CreateChartDefinition): ChartDefinition;
 
 /**
  * Creates a color.
@@ -1035,6 +1038,11 @@ export function createTable(options: CreateTableDefinition): TableDefinition;
  */
 export function createTableColumnFilter(options: CreateTableColumnFilter): TableColumnFilter;
 
+/**
+* Creates a record key.
+*/
+export function createSimpleRecordKey({ key: number }): number;
+
 /**
  * Lists all existing workbooks.
  */
@@ -1045,6 +1053,13 @@ export function list(): Object[];
  */
 export function load(options: { id: string }): Workbook;
 
+/**
+ * A selector for descendant or self nodes object.
+ *
+ * A selector for descendant or self nodes object is used as a parameter in the workbook.createMeasureValueSelector(options), and workbook.createSortByMeasure(options) methods.
+ */
+export const DescendantOrSelfNodesSelector;
+
 declare enum Aggregation {
   COUNT,
   COUNT_DISTINCT,

package/package.json

@@ -8,7 +8,7 @@
     "posttest": "npm run cleanup"
   },
   "homepage": "https://github.com/headintheclouddev/typings-suitescript-2.0",
-  "version": "2024.1.10",
+  "version": "2024.2.1",
   "author": "Head in the Cloud Development <gurus@headintheclouddev.com> (www.headintheclouddev.com)",
   "license": "MIT",
   "repository": {