@adobe/acc-js-sdk 1.1.10 → 1.1.11

package/docs/errors.html

@@ -0,0 +1,47 @@
+---
+layout: page
+title: Handling Errors
+---
+
+
+<p>If an API call fails (SOAP fault or HTTP error), <b>CampaignException</b> object is thrown. This object contains the following attributes</p>
+
+<li><b>message</b> a message describing the error</li>
+<li><b>statusCode</b> a HTTP status code. In case of a SOAP fault, the status code will be 500
+<li><b>errorCode</b> the Campaign error code if one is available (ex: XSV-350013)
+<li><b>methodCall</b> the SOAP call which caused the error. It will contain the following attributes
+  <ul>
+    <li><b>type</b> the type of the API call ("SOAP" or "HTTP")
+    <li><b>urn</b> the SOAP call URN, i.e. the schema id. Will be empty for HTTP methods
+    <li><b>url</b> the HTTP URL
+    <li><b>methodName</b> the name of the SOAP method. For HTTP methods, the query path
+    <li><b>request</b> the raw SOAP request, as text. For HTTP requests, this is an option object containing details about the request
+    <li><b>response</b> the raw SOAP/HTTP response, as text
+  </ul>
+<li><b>faultCode</b> for SOAP faults, the Campaign error code
+<li><b>faultString</b> the error message
+<li><b>detail</b> optional additional details about the error
+
+<p>
+  In general all errors are mapped to a CampaignException and we try to keep the semantic of errors: for instance a call with an incorrect parameter will return an HTTP stauts of 400 even if it's not actually a, HTTP call. SDK specific errors will have an errorCode with the "SDK-######" format, using "SDK" as a prefix.
+</p>
+
+<pre class="code">
+try {
+  await client.logon();
+  result = await NLWS.xtkSession.getServerTime();
+} catch (ex) {
+  /*
+    CampaignException object
+    <span class="emphasis">ex.statusCode</span>: the HTTP status code, such as 500, 404…
+    <span class="emphasis">ex.errorCode</span> the Campaign error code (ex: XSV-350013)
+    <span class="emphasis">ex.faultCode</span> the Campaign iRc or some other error code (ex: -53)
+    <span class="emphasis">ex.faultString</span> the Error message
+  */
+  console.log(ex.message);  
+}
+</pre>
+
+<p>
+  It's also noteworthy that all the data returned in a CampaignException is trimmed, i.e. session and security token values are hidden, so that the exception object can be safely logged.
+</p>

package/docs/escaping.html

@@ -0,0 +1,76 @@
+---
+layout: page
+title: Escaping
+---
+
+
+<p>It's common to use variables in query conditions. For instance, in the above example, you'll want to query an account by name instead of using the hardcoded <b>ffda</b> name. The <b>expr</b> attribute takes an XTK expression as a parameter, and <b>ffda</b> is a string litteral in an xtk expression.</p>
+
+<p>To prevent xtk ingestions vulnerabilities, you should not concatenate strings and write code such as expr: "@name = '" + name + "'": if the value of the name 
+  parameter contains single quotes, your code will not work, but could also cause vulnerabilities.
+</p>
+
+
+<h1>sdk.escapeXtk</h1>
+
+<p>The <b>sdk.escapeXtk</b> can be used to properly escape string litterals in xtk expressions. The function will also surround the escaped value with single quotes.</p>
+
+<p>You can use string concatenation like this. Note the lack of single quotes around the value.</p>
+<pre class="code">
+{ expr: "@name=" + sdk.escapeXtk(name) }
+</pre>
+
+<p>or a template litteral</p>
+<pre class="code">
+`{ expr: "@name=${sdk.escapeXtk(name)}" }`
+</pre>
+
+<p>The <b>escapeXtk</b> function can also be used to create tagged string litterals. This leads to a much shorter syntax. Note that with this syntax, only the parameter values of the template litteral are escaped</p>
+<pre class="code">
+sdk.escapeXtk`{ expr: "@name=${name}" }`
+</pre>
+
+<p>This can also be used to escape other data types such as timestamps</p>
+
+<pre class="code">
+  sdk.escapeXtk`{ expr: "@lastModified > = ${yesterday}" }`
+</pre>
+
+<p>will return</p>
+<pre class="code">
+{ expr: "@lastModified > = #2021-07-07T10:03:33.332Z# }`
+</pre>
+
+
+<h1>sdk.escapeForLike</h1>
+
+<p>This function escapes values so that they can be used in SQL or XTK like conditions. For example a search term "term" can be escaped as follows to implement a search conditions</p>
+
+<pre class="code">
+expr: `Lower([${xpath}]) LIKE '%${sdk.escapeForLike(term)}%'`,
+</pre>
+
+
+<h1>sdk.expandXPath & sdk.unexpandXPath</h1>
+
+<p>In Campaign, xpaths are used to access attributes of entities. When XPaths are used in XTK expressions, there can be ambiguities, for instance, in the expression "country/@name", is "country/@name" a xpath or are we dividing the variable country by the value of the attribute @name?</p>
+
+<p>Amibiguity can be resolved by "expanding" the xpath from "country/@name" to "[country/@name]". The square brackets indicate an xpath.</p>
+
+<pre class="code">
+const expandedXPath = sdk.expandXPath(xpath);
+const unexpandedXPath = sdk.unexpandXPath(expandedXPath);
+</pre>
+
+
+
+<h1>xtkConstText</h1>
+
+<p>This function allows to convert literal values to xtk text constants, providing correct serialization. For instance, text constants will be quoted with single quotes, timestamps with the "#" character, etc.</p>
+
+<pre class="code">
+expect(sdk.xtkConstText("Hello", "string")).toBe("'Hello'");
+expect(sdk.xtkConstText(-42.3, "double")).toBe("-42.3");
+expect(sdk.xtkConstText("2022-02-15T09:49:04.000Z", "datetime"))
+    .toBe("#2022-02-15T09:49:04.000Z#");
+</pre>

package/docs/healthCheck.html

@@ -0,0 +1,66 @@
+---
+layout: page
+title: Health Check
+---
+
+<p>Campaign proposes several APIs for health check. Just like all APIs in the SDK, it's been wrapped into a function and will return a XML or JSON object depending on the current representation</p>
+
+<h1>/r/test</h1>
+<p>This API is anonymous and run directly on the Apache front server. Note that this API will failed if called on a tomcat endpoint (port 8080)</p>
+<pre class="code">
+const test = await client.test();
+</pre>
+
+<p>will return</p>
+<pre class="code">
+{
+    "status":"OK",
+    "date":"2021-08-27 03:06:02.941-07",
+    "build":"9236",
+    "sha1":"cc45440",
+    "instance":"xxx_mkt_prod1",
+    "sourceIP":"193.104.215.11",
+    "host":"xxx.campaign.adobe.com",
+    "localHost":"xxx-mkt-prod1-1"
+}
+</pre>
+
+<p class="info">Note: as this API is anonymous, one does not need to actually log on to Campaign to call it. Here's a full example. See the authentication section for more details about anonymous logon.
+</p>
+<pre class="code">
+const connectionParameters = sdk.ConnectionParameters.ofAnonymousUser("https://...");
+const client = await sdk.init(connectionParameters);
+const test = await client.test();
+</pre>
+
+
+<h1>ping</h1>
+<p>The ping API is authenticated and will return a simple status code indicating the the Campaign server is running. It will also return the current database timestamp. The API itself will return plain text, but for convenience this has been wrapped into JSON / XML in the SDK</p>
+<pre class="code">
+const ping = await client.ping();
+</pre>
+
+<p>will return</p>
+<pre class="code">
+{
+    "status":"Ok",
+    "timestamp":"2021-08-27 12:51:56.088Z"
+}
+</pre>
+
+
+<h1>mcPing</h1>
+<p>Message Center instances have a dedicated ping API which also returns the Message Center queue size and the maximum expected size (threshold). The API itself will return plain text, but for convenience this has been wrapped into JSON / XML in the SDK</p>
+<pre class="code">
+const ping = await client.mcPing();
+</pre>
+
+<p>will return</p>
+<pre class="code">
+{
+    "status":"Ok",
+    "timestamp":"2021-08-27 12:51:56.088Z",
+    "eventQueueSize":"7",
+    "eventQueueMaxSize":"400"
+}
+</pre>

package/docs/httpHeaders.html

@@ -0,0 +1,78 @@
+---
+layout: page
+title: HTTP Headers
+---
+
+<h1>Out-of-the-box headers</h1>
+<p>In version 1.1.3 and above, the SDK will pass additional HTTP headers automatically</p>
+
+
+<table>
+  <thead>
+      <tr>
+          <th>Header</th>
+          <th>Comment / Description</th>
+      </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>SOAPAction</td>
+      <td>name of the schema and SOAP method (ex: xtk:query#ExecuteQuery)</td>
+    </tr>
+    <tr>
+      <td>ACC-SDK-Version</td>
+      <td>Version of the SDK making the scores</td>
+    </tr>
+    <tr>
+      <td>ACC-SDK-Auth</td>
+      <td>Authentification type and ACC user</td>
+    </tr>
+    <tr>
+      <td>ACC-SDK-Client-App</td>
+      <td>Name of the application calling the client SDK</td>
+    </tr>
+    <tr>
+      <td>ACC-SDK-Call-RetryCount</td>
+      <td>In case an API call is retried, indicates the number of retries</td>
+    </tr>
+    <tr>
+      <td>ACC-SDK-Call-Internal</td>
+      <td>Indicates that an API call is performed byt the SDK for its own purpose</td>
+    </tr>
+  </tbody>
+</table>
+
+<p>The <b>ACC-SDK</b> headers can be removed using the connection parameter <b>noSDKHeaders</b>.</p>
+
+
+
+
+<h1>Custom HTTP headers</h1>
+<p>In version 1.1.3 and above, it is possible to pass additional HTTP headers or override HTTP headers set by the SDK. This can be done globally (i.e. for all API calls), or locally, i.e. just for a particular call, or both.</p>
+
+<p>Http headers are passed through an object whose keys represent the header name and values the corresponding header value. Nothing particular is done in term of case sensitivity, headers will be passed as passed.</p>
+
+<p>To set global HTTP headers for all API calls of a client, pass an http headers array in the connection parameters</p>
+
+<pre class="code">
+const connectionParameters = sdk.ConnectionParameters.ofUserAndPassword(
+                                    "https://myInstance.campaign.adobe.com", 
+                                    "admin", "admin",
+                                    { extraHttpHeaders: {
+                                        "X-ACC-JS-SDK-LBSAFE": "1",
+                                        "X-ACC-WEBUI-VERSION: "1.2"
+                                    } });
+</pre>
+
+
+<p>Subsequent API calls will have the corresponding headers set.</p>
+
+<p>To set more HTTP headers for a particular API call, use the "headers" method of the NLWS object.</p>
+
+<pre class="code">
+const query = client.NLWS
+    .headers({'X-Test': 'hello'})
+    .xtkQueryDef.create(queryDef);
+await query.executeQuery();
+</pre>
+

package/docs/index.html

@@ -0,0 +1,64 @@
+---
+layout: home
+title: ACC JS SDK Home
+---
+
+<p>The <b>ACC JavaScript SDK</b> is a JavaScript SDK which allows you to call Campaign APIs in a simple, expressive and JavaScript idiomatic way. It hides away the Campaign complexities associated with having to make SOAP calls, XML to JSON conversion, type formatting, etc.</p>
+
+<p>The API is fully asynchronous using promises and works as well on the server side than on the client side in the browser.</p>
+
+<button class="cta" onclick="location.href='./connecting.html'">View the docs</button>
+
+<!--
+<div class="card-row">
+  <div class="card">
+    <h1>Simple</h1>
+  </div>
+  <div class="card">
+    <h1>Light</h1>
+  </div>
+</div>
+-->
+
+<div class="marquee">Get up and running in seconds</div>
+
+<p>Install</p>
+
+<pre class="code">
+npm install --save @adobe/acc-js-sdk
+</pre>
+
+<p></p>
+<p>Use</p>
+<pre class="code">
+const sdk = require('@adobe/acc-js-sdk');
+
+(async () => {
+    // Logon to a Campaign instance with user and password
+    const connectionParameters = sdk.ConnectionParameters.ofUserAndPassword(
+                                        "https://myInstance.campaign.adobe.com", 
+                                        "admin", "admin");
+    const client = await sdk.init(connectionParameters);
+    await client.logon();
+
+    // Get recipients
+    const queryDef = {
+        schema: "nms:recipient",
+        operation: "select",
+        lineCount: 10,
+        select: {
+            node: [
+                { expr: "@id" },
+                { expr: "@firstName" },
+                { expr: "@lastName" },
+                { expr: "@email" }
+            ]
+        }
+    };
+    const query = client.NLWS.xtkQueryDef.create(queryDef);
+    const recipients = await query.executeQuery();
+    console.log(`Recipients: ${JSON.stringify(recipients)}`);
+})().catch((error) => {
+    console.log(error);
+});
+</pre>

package/docs/installation.html

@@ -0,0 +1,34 @@
+---
+layout: page
+title: Installation
+---
+
+<p>Install
+</p>
+<pre class="code">
+npm install --save @adobe/acc-js-sdk
+</pre>
+
+<p>The SDK entrypoint is the <b>sdk</b> object from which everything else can be created.
+</p>
+
+<pre class="code">
+const sdk = require('@adobe/acc-js-sdk');
+</pre>
+
+<p>You can get version information about the SDK
+</p>
+
+<pre class="code">
+console.log(sdk.getSDKVersion());
+</pre>
+
+<p>which will return the SDK name and version (the actual name and version number will depend on the version you have installed)
+    </p>
+<pre class="code">
+{
+  version: "1.0.0",
+  name: "@adobe/acc-js-sdk",
+  description: "ACC Javascript SDK",
+}
+</pre>

package/docs/license.html

@@ -0,0 +1,208 @@
+---
+layout: page
+title: License
+---
+
+<pre class="license">
+  Apache License
+  Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2020 Adobe
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+</pre>

package/docs/messageCenter.html

@@ -0,0 +1,80 @@
+---
+layout: page
+title: Message Center
+---
+
+
+<p>The Message Center API (<b>nms:rtEvent#PushEvent</b>) can be used to send transactional messages. It should be called on the Message Center execution instances, not on the marketing instances.</p>
+
+<h1>Authentication</h1>
+<p>Two authentication mechanism are possible for Message Center. It is possible to use a user/password authentication and call the Logon method to get a session and security token, as all other APIs. When using this authentication mechanism, the caller is responsible to handle token expiration and must explicitely handle the case when the Message Center API call fails because of an expired token.</p>
+
+<p>Another common authentication strategy is to define a trusted Security Zone for message center clients and setup this security zone to use the "user/password" as a session token.</p>
+
+<p>Here's an example of authentication with this method</p>
+<pre class="code">
+const connectionParameters = sdk.ConnectionParameters.ofSessionToken(url, "mc/mc");
+const client = await sdk.init(connectionParameters);
+</pre>
+
+
+
+
+
+
+<h1>Pushing events</h1>
+
+<p>Events can be pushed using the <b>nms:rtEvent#PushEvent</b> API call. For instance</p>
+<pre class="code">
+var result = await NLWS.nmsRtEvent.pushEvent({
+    wishedChannel: 0,
+    type: "welcome",
+    email: "aggmorin@gmail.com",
+    ctx: {
+      $title: "Alex"
+    }
+});
+console.log(`>> Result: ${result}`);
+</pre>
+
+<p>There are a couple of noteworthy things to say about this API when using SimpleJson serialization.</p>
+<ul>
+    <li>The payload passed to the pushEvent API call is actuall a nms:rtEvent entity. Hence the wishedChannel, etc. are actually XML attributes. The default SimpleJson conversion works fine here, no need to prefix the attributes with the "@" sign.</li>
+    <li>However, the <b>ctx</b> section is not structured. We do not have a schema to validate or guide the conversion. It is common to use XML elements instead of attributes in the ctx context. In the message center template, you'll find things like <b>&lt;%= rtEvent.ctx.title %></b>. The fact that "title" is used (in stead of "@title") implied that the ctx node will contain a title element, not a title attribute. For the SimpleJson conversion to work, it's therefore important to indicate "$title" as the JSON attribute name. This will guide the SimpleJson converted to use an XML element instead of an XML attribute</li>
+</ul>
+
+<h1>Getting event status</h1>
+
+<p class="warning">There's no scalable API to get the status of a message center event. One can use the QueryDef API to query the nms:rtEvent table for testing purpose though.</p>
+
+<p>To do so, the first step is to decode the event id returned by PushEvent. It is a 64 bit number, whose high byte is the message center cell (instance) id which handled the event. It's a number between 0 and 255. The lower bytes represent the primary key of the event. Note that this is subject to change in future versions of Campaign and should not be considered stable.</p>
+
+<p>Clear high byte</p>
+<pre class="code">
+eventId = Number(BigInt(eventId) & BigInt("0xFFFFFFFFFFFFFF"));
+</pre>
+
+<p>Get event status</p>
+<pre class="code">
+var queryDef = {
+schema: "nms:rtEvent",
+operation: "get",
+select: {
+    node: [
+        { expr: "@id" },
+        { expr: "@status" },
+        { expr: "@created" },
+        { expr: "@processing" },
+        { expr: "@processed" }
+    ]
+},
+where: {
+    condition: [
+        { expr:`@id=${eventId}` }
+    ]
+}
+}
+query = NLWS.xtkQueryDef.create(queryDef);
+var event = await query.executeQuery();
+console.log(`>> Event: ${JSON.stringify(event)}`);
+</pre>

package/docs/methodLevelRepresentation.html

@@ -0,0 +1,12 @@
+---
+layout: page
+title: Method-level representation
+---
+
+<p>The client object is created with a default representation which is used for all API calls in the context of this client. Since version 1.1.2, it is also possible to set the representation at the method level, i.e. use a particular representation for a particular API call.</p>
+
+<ul>
+<li> <b>client.NLWS</b>: use the default representation set at the client level</li>
+<li> <b>client.NLWS.xml</b>: use the XML reresentation</li>
+<li> <b>client.NLWS.json</b>: use the SimpleJson representation</li>
+</ul>