@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/TopLevel.ES6Iterator.md

@@ -1,47 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ES6Iterator
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.ES6Iterator](TopLevel.ES6Iterator.md)
-
-This isn't a built-in type. It describes the properties an object must have in order
-to work as an iterator since ECMAScript 2015.
-
-
-**API Version:**
-:::note
-Available from version 21.2.
-:::
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [next](TopLevel.ES6Iterator.md#next)() | Returns an iterator result object. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Method Details
-
-### next()
-- next(): [Object](TopLevel.Object.md)
-  - : Returns an iterator result object.
-      
-      
-      An iterator result object can have two properties: _done_ and _value_.
-      If _done_ is `false` or `undefined`, then the _value_ property contains an iterator value.
-      The _value_ property may not be present if the value would be `undefined`.
-      
-      
-      After a call that returns a result where _done_ equals
-      `true`, all subsequent calls must also return _done_ as `true`.
-
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/TopLevel.Error.md

@@ -1,124 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Error
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Error](TopLevel.Error.md)
-
-Error represents a generic exception.
-
-
-## All Known Subclasses
-[APIException](TopLevel.APIException.md)
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [message](#message): [String](TopLevel.String.md) | An error message that provides details about the exception. |
-| [name](#name): [String](TopLevel.String.md) | The name of the error based on the constructor used. |
-| [stack](#stack): [String](TopLevel.String.md) | The script stack trace. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Error](#error)() | Constructs the Error object. |
-| [Error](#errorstring)([String](TopLevel.String.md)) | Constructs the Error object  using the specified message. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function)([Error](TopLevel.Error.md), [Function](TopLevel.Function.md)) | Fills the [stack](TopLevel.Error.md#stack) property for the passed error. |
-| [toString](TopLevel.Error.md#tostring)() | Returns a String representation of the Error. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### message
-- message: [String](TopLevel.String.md)
-  - : An error message that provides details about the exception.
-
-
----
-
-### name
-- name: [String](TopLevel.String.md)
-  - : The name of the error based on the constructor used.
-
-
----
-
-### stack
-- stack: [String](TopLevel.String.md)
-  - : The script stack trace. 
-      
-      This property is filled on throwing or via an explicit call [captureStackTrace(Error, Function)](TopLevel.Error.md#capturestacktraceerror-function).
-
-
-
----
-
-## Constructor Details
-
-### Error()
-- Error()
-  - : Constructs the Error object.
-
-
----
-
-### Error(String)
-- Error(msg: [String](TopLevel.String.md))
-  - : Constructs the Error object
-      using the specified message.
-
-
-    **Parameters:**
-    - msg - the message to use,.
-
-
----
-
-## Method Details
-
-### captureStackTrace(Error, Function)
-- static captureStackTrace(error: [Error](TopLevel.Error.md), constructorOpt: [Function](TopLevel.Function.md)): void
-  - : Fills the [stack](TopLevel.Error.md#stack) property for the passed error. 
-      
-      The optional constructorOpt parameter allows you to pass in a function value. When collecting the stack trace all
-      frames above the topmost call to this function, including that call, are left out of the stack trace. This can be
-      useful to hide implementation details that won’t be useful to the user. The usual way of defining a custom error
-      that captures a stack trace would be:
-      
-      ```
-      function MyError() {
-          // fill the stack trace, but hide the call to MyError
-          Error.captureStackTrace(this, MyError);
-      }
-      ```
-
-
-    **Parameters:**
-    - error - The error whose stack trace should be filled.
-    - constructorOpt - An optional filter to hide the topmost stack frames.
-
-    **API Version:**
-:::note
-Available from version 21.2.
-:::
-
----
-
-### toString()
-- toString(): [String](TopLevel.String.md)
-  - : Returns a String representation of the Error.
-
-    **Returns:**
-    - a String representation of the Error.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/TopLevel.EvalError.md

@@ -1,47 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class EvalError
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Error](TopLevel.Error.md)
-    - [TopLevel.EvalError](TopLevel.EvalError.md)
-
-Represents an evaluation error.
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [EvalError](#evalerror)() | Constructs the error. |
-| [EvalError](#evalerrorstring)([String](TopLevel.String.md)) | Constructs the error with the   specified message. |
-
-## Method Summary
-
-### Methods inherited from class Error
-
-[captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function), [toString](TopLevel.Error.md#tostring)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Constructor Details
-
-### EvalError()
-- EvalError()
-  - : Constructs the error.
-
-
----
-
-### EvalError(String)
-- EvalError(msg: [String](TopLevel.String.md))
-  - : Constructs the error with the 
-      specified message.
-
-
-    **Parameters:**
-    - msg - the evaluation error message.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/TopLevel.Fault.md

@@ -1,133 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Fault
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Error](TopLevel.Error.md)
-    - [TopLevel.Fault](TopLevel.Fault.md)
-
-This error indicates an RPC related error in the system. The Fault
-is always related to a systems internal Java exception. The class provides
-access to some more details about this internal Java exception. In particular
-it provides details about the error send from the remote system.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [causeFullName](#causefullname): [String](TopLevel.String.md) | If the exception is associated with a root cause, the property  contains the full name of the associated Java exception. |
-| [causeMessage](#causemessage): [String](TopLevel.String.md) | If the exception is associated with a root cause, the property  contains the message of the associated Java exception. |
-| [causeName](#causename): [String](TopLevel.String.md) | If the exception is associated with a root cause, the property  contains the simplified name of the associated Java exception. |
-| [faultActor](#faultactor): [String](TopLevel.String.md) | Provides some information on who cause the fault along the message  path. |
-| [faultCode](#faultcode): [String](TopLevel.String.md) | An identifier for the specific fault. |
-| [faultDetail](#faultdetail): [String](TopLevel.String.md) | More detailed information about the fault. |
-| [faultString](#faultstring): [String](TopLevel.String.md) | A human readable description for the fault. |
-| [javaFullName](#javafullname): [String](TopLevel.String.md) | The full name of the underlying Java exception. |
-| [javaMessage](#javamessage): [String](TopLevel.String.md) | The message of the underlying Java exception. |
-| [javaName](#javaname): [String](TopLevel.String.md) | The simplified name of the underlying Java exception. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Fault](#fault)() |  |
-
-## Method Summary
-
-### Methods inherited from class Error
-
-[captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function), [toString](TopLevel.Error.md#tostring)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### causeFullName
-- causeFullName: [String](TopLevel.String.md)
-  - : If the exception is associated with a root cause, the property
-      contains the full name of the associated Java exception.
-
-
-
----
-
-### causeMessage
-- causeMessage: [String](TopLevel.String.md)
-  - : If the exception is associated with a root cause, the property
-      contains the message of the associated Java exception.
-
-
-
----
-
-### causeName
-- causeName: [String](TopLevel.String.md)
-  - : If the exception is associated with a root cause, the property
-      contains the simplified name of the associated Java exception.
-
-
-
----
-
-### faultActor
-- faultActor: [String](TopLevel.String.md)
-  - : Provides some information on who cause the fault along the message
-      path.
-
-
-
----
-
-### faultCode
-- faultCode: [String](TopLevel.String.md)
-  - : An identifier for the specific fault.
-
-
----
-
-### faultDetail
-- faultDetail: [String](TopLevel.String.md)
-  - : More detailed information about the fault.
-
-
----
-
-### faultString
-- faultString: [String](TopLevel.String.md)
-  - : A human readable description for the fault.
-
-
----
-
-### javaFullName
-- javaFullName: [String](TopLevel.String.md)
-  - : The full name of the underlying Java exception.
-
-
----
-
-### javaMessage
-- javaMessage: [String](TopLevel.String.md)
-  - : The message of the underlying Java exception.
-
-
----
-
-### javaName
-- javaName: [String](TopLevel.String.md)
-  - : The simplified name of the underlying Java exception.
-
-
----
-
-## Constructor Details
-
-### Fault()
-- Fault()
-  - : 
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/TopLevel.Float32Array.md

@@ -1,186 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Float32Array
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Float32Array](TopLevel.Float32Array.md)
-
-An optimized array to store 32-bit floating point numbers. Elements of this array are stored in an
-[ArrayBuffer](TopLevel.ArrayBuffer.md) object.
-
-
-**API Version:**
-:::note
-Available from version 21.2.
-:::
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [BYTES_PER_ELEMENT](#bytes_per_element): [Number](TopLevel.Number.md) = 4 | Number value of the element size. |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [buffer](#buffer): [ArrayBuffer](TopLevel.ArrayBuffer.md) | The array buffer referenced by this typed array. |
-| [byteLength](#bytelength): [Number](TopLevel.Number.md) | The number of bytes in the array buffer used by this typed array. |
-| [byteOffset](#byteoffset): [Number](TopLevel.Number.md) | The start offset for this typed array within the array buffer. |
-| [length](#length): [Number](TopLevel.Number.md) | The number of elements. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Float32Array](#float32array)() | Creates an empty array. |
-| [Float32Array](#float32arraynumber)([Number](TopLevel.Number.md)) | Creates an array with the given element count. |
-| [Float32Array](#float32arrayobject)([Object](TopLevel.Object.md)) | Creates an array as a copy of the passed typed array. |
-| [Float32Array](#float32arrayarray)([Array](TopLevel.Array.md)) | Creates an array as a copy of the passed array. |
-| [Float32Array](#float32arrayarraybuffer-number-number)([ArrayBuffer](TopLevel.ArrayBuffer.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md). |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [get](TopLevel.Float32Array.md#getnumber)([Number](TopLevel.Number.md)) | Returns the value at the specified index. |
-| [set](TopLevel.Float32Array.md#setobject-number)([Object](TopLevel.Object.md), [Number](TopLevel.Number.md)) | Copies all values from the source array into this typed array. |
-| [subarray](TopLevel.Float32Array.md#subarraynumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Constant Details
-
-### BYTES_PER_ELEMENT
-
-- BYTES_PER_ELEMENT: [Number](TopLevel.Number.md) = 4
-  - : Number value of the element size.
-
-
----
-
-## Property Details
-
-### buffer
-- buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md)
-  - : The array buffer referenced by this typed array.
-
-
----
-
-### byteLength
-- byteLength: [Number](TopLevel.Number.md)
-  - : The number of bytes in the array buffer used by this typed array.
-
-
----
-
-### byteOffset
-- byteOffset: [Number](TopLevel.Number.md)
-  - : The start offset for this typed array within the array buffer.
-
-
----
-
-### length
-- length: [Number](TopLevel.Number.md)
-  - : The number of elements.
-
-
----
-
-## Constructor Details
-
-### Float32Array()
-- Float32Array()
-  - : Creates an empty array.
-
-
----
-
-### Float32Array(Number)
-- Float32Array(length: [Number](TopLevel.Number.md))
-  - : Creates an array with the given element count.
-
-    **Parameters:**
-    - length - The number of elements.
-
-
----
-
-### Float32Array(Object)
-- Float32Array(typedArray: [Object](TopLevel.Object.md))
-  - : Creates an array as a copy of the passed typed array.
-
-    **Parameters:**
-    - typedArray - The source typed array.
-
-
----
-
-### Float32Array(Array)
-- Float32Array(array: [Array](TopLevel.Array.md))
-  - : Creates an array as a copy of the passed array.
-
-    **Parameters:**
-    - array - The source array.
-
-
----
-
-### Float32Array(ArrayBuffer, Number, Number)
-- Float32Array(buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md), byteOffset: [Number](TopLevel.Number.md), length: [Number](TopLevel.Number.md))
-  - : Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md).
-
-    **Parameters:**
-    - buffer - The array buffer storage object.
-    - byteOffset - Optional. The offset within the array buffer in bytes.
-    - length - Optional. The number of elements for the target typed array. The passed array buffer must be large enough to store the number of elements specified.
-
-
----
-
-## Method Details
-
-### get(Number)
-- get(index: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
-  - : Returns the value at the specified index. 
-      
-      Note: This is not ECMAScript standard. Use array element access syntax for single value access.
-
-
-    **Parameters:**
-    - index - The index to use.
-
-    **Returns:**
-    - The value at the specified index.
-
-
----
-
-### set(Object, Number)
-- set(values: [Object](TopLevel.Object.md), offset: [Number](TopLevel.Number.md)): void
-  - : Copies all values from the source array into this typed array.
-
-    **Parameters:**
-    - values - The source values. Can be an array or a typed array.
-    - offset - Optional. Target offset.
-
-
----
-
-### subarray(Number, Number)
-- subarray(begin: [Number](TopLevel.Number.md), end: [Number](TopLevel.Number.md)): [Float32Array](TopLevel.Float32Array.md)
-  - : Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store.
-
-    **Parameters:**
-    - begin - Optional. The first included element.
-    - end - Optional. The index of the end. This element is not included.
-
-    **Returns:**
-    - The new array object.
-
-
----
-
-<!-- prettier-ignore-end -->