wapi-client 0.12.5-beta.9 → 0.14.1

package/dist/lib/query-builder/find-query-builder.browser.js

@@ -91,6 +91,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
   stream() {
     return this.start().stream();
   }
+  /**
+   * ```javascript
+   * Select which fields should be returned
+   *
+   * .select('id', 'created_at', 'updated_at')
+   * ```
+   */
   select(first, ...select) {
     var _a, _b;
     return new _FindQueryBuilder({
@@ -107,6 +114,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       optionsSchema: this.$optionsSchema
     });
   }
+  /**
+   * ```javascript
+   * Select which fields should not be returned
+   *
+   * .deselect('id', 'created_at', 'updated_at')
+   * ```
+   */
   deselect(first, ...deselect) {
     var _a, _b;
     return new _FindQueryBuilder({
@@ -123,9 +137,14 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       optionsSchema: this.$optionsSchema
     });
   }
-  de() {
-    return [];
-  }
+  /**
+   * ```javascript
+   * Set options
+   * .options({
+   *   tracking_id: 'my-log-id',
+   * })
+   * ```
+   */
   options(options) {
     const validatedOptions = hardValidate(this.$optionsSchema, options);
     const mergedOptions = mergeFnOptionsOrderBy(validatedOptions);
@@ -138,16 +157,50 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       optionsSchema: this.$optionsSchema
     });
   }
+  /**
+   * ```javascript
+   * Limit number of returned items
+   * .limit(10)
+   * ```
+   */
   limit(limit) {
     return this.options({
       limit
     });
   }
+  /**
+   * ```javascript
+   * Add an offset
+   * .offset(10)
+   * ```
+   */
   offset(offset) {
     return this.options({
       offset
     });
   }
+  /**
+   * ```javascript
+   * Add an order by clause
+   * // as one string
+   * .orderBy('id desc nulls last')
+   * // as separate parameters
+   * .orderBy('id', 'desc', 'last')
+   * // multiple orderings
+   * .orderBy([
+   *   {
+   *     column: 'id',
+   *     order: 'desc',
+   *     nulls: 'last',
+   *   },
+   *   {
+   *     column: 'created_at',
+   *     order: 'desc',
+   *     nulls: 'last',
+   *   },
+   * ])
+   * ```
+   */
   orderBy(input, direction, nullsDirection) {
     if (!Array.isArray(input) && typeof input !== "string") {
       throw new TypeError("invalid input");
@@ -184,6 +237,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IN filter
+   *
+   * .whereIn('token', ['EUR', 'USD'])
+   * ```
+   */
   whereIn(field, value) {
     return this.addIn({
       fn: "whereIn",
@@ -191,6 +251,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IN filter
+   *
+   * .orWhereIn('token', ['EUR', 'USD'])
+   * ```
+   */
   orWhereIn(field, value) {
     return this.addIn({
       fn: "orWhereIn",
@@ -198,24 +265,52 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IS NULL filter
+   *
+   * .whereNull('status_finalized_at')
+   * ```
+   */
   whereNull(field) {
     return this.addNull({
       fn: "whereNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IS NULL filter
+   *
+   * .orWhereNull('status_finalized_at')
+   * ```
+   */
   orWhereNull(field) {
     return this.addNull({
       fn: "orWhereNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an NOT NULL filter
+   *
+   * .whereNotNull('status_finalized_at')
+   * ```
+   */
   whereNotNull(field) {
     return this.addNull({
       fn: "whereNotNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR NOT NULL filter
+   *
+   * .orWhereNotNull('status_finalized_at')
+   * ```
+   */
   orWhereNotNull(field) {
     return this.addNull({
       fn: "orWhereNotNull",
@@ -238,6 +333,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IN filter for metadata field
+   *
+   * .whereMetadataIn('myCustomField', [9, 10])
+   * ```
+   */
   whereMetadataIn(field, value) {
     return this.addMetadataIn({
       fn: "whereMetadataIn",
@@ -245,6 +347,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IN filter for metadata field
+   *
+   * .orWhereMetadataIn('myCustomField', [9, 10])
+   * ```
+   */
   orWhereMetadataIn(field, value) {
     return this.addMetadataIn({
       fn: "orWhereMetadataIn",
@@ -252,24 +361,52 @@ var FindQueryBuilder = class _FindQueryBuilder extends QueryBuilder {
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IS NULL filter for metadata field
+   *
+   * .whereMetadataNull('myCustomField')
+   * ```
+   */
   whereMetadataNull(field) {
     return this.addMetadataNull({
       fn: "whereMetadataNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IS NULL filter for metadata field
+   *
+   * .orWhereMetadataNull('myCustomField')
+   * ```
+   */
   orWhereMetadataNull(field) {
     return this.addMetadataNull({
       fn: "orWhereMetadataNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an NOT NULL filter for metadata field
+   *
+   * .whereMetadataNotNull('myCustomField')
+   * ```
+   */
   whereMetadataNotNull(field) {
     return this.addMetadataNull({
       fn: "whereMetadataNotNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR NOT NULL filter for metadata field
+   *
+   * .orWhereMetadataNotNull('myCustomField')
+   * ```
+   */
   orWhereMetadataNotNull(field) {
     return this.addMetadataNull({
       fn: "orWhereMetadataNotNull",

package/dist/lib/query-builder/find-query-builder.cjs

@@ -41,9 +41,9 @@ __export(find_query_builder_exports, {
   FindQueryBuilder: () => FindQueryBuilder
 });
 module.exports = __toCommonJS(find_query_builder_exports);
-var import_utils = require('../utils.cjs');
-var import_validation = require('../validation.cjs');
-var import_query_builder = require('./query-builder.cjs');
+var import_utils =  require("../utils.cjs");
+var import_validation =  require("../validation.cjs");
+var import_query_builder =  require("./query-builder.cjs");
 function queryBuilderOrderByToTxOrderBy(input) {
   return input.map((item) => {
     if (typeof item === "string") {
@@ -110,6 +110,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
   stream() {
     return this.start().stream();
   }
+  /**
+   * ```javascript
+   * Select which fields should be returned
+   *
+   * .select('id', 'created_at', 'updated_at')
+   * ```
+   */
   select(first, ...select) {
     var _a, _b;
     return new _FindQueryBuilder({
@@ -126,6 +133,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       optionsSchema: this.$optionsSchema
     });
   }
+  /**
+   * ```javascript
+   * Select which fields should not be returned
+   *
+   * .deselect('id', 'created_at', 'updated_at')
+   * ```
+   */
   deselect(first, ...deselect) {
     var _a, _b;
     return new _FindQueryBuilder({
@@ -142,9 +156,14 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       optionsSchema: this.$optionsSchema
     });
   }
-  de() {
-    return [];
-  }
+  /**
+   * ```javascript
+   * Set options
+   * .options({
+   *   tracking_id: 'my-log-id',
+   * })
+   * ```
+   */
   options(options) {
     const validatedOptions = (0, import_validation.hardValidate)(this.$optionsSchema, options);
     const mergedOptions = (0, import_utils.mergeFnOptionsOrderBy)(validatedOptions);
@@ -157,16 +176,50 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       optionsSchema: this.$optionsSchema
     });
   }
+  /**
+   * ```javascript
+   * Limit number of returned items
+   * .limit(10)
+   * ```
+   */
   limit(limit) {
     return this.options({
       limit
     });
   }
+  /**
+   * ```javascript
+   * Add an offset
+   * .offset(10)
+   * ```
+   */
   offset(offset) {
     return this.options({
       offset
     });
   }
+  /**
+   * ```javascript
+   * Add an order by clause
+   * // as one string
+   * .orderBy('id desc nulls last')
+   * // as separate parameters
+   * .orderBy('id', 'desc', 'last')
+   * // multiple orderings
+   * .orderBy([
+   *   {
+   *     column: 'id',
+   *     order: 'desc',
+   *     nulls: 'last',
+   *   },
+   *   {
+   *     column: 'created_at',
+   *     order: 'desc',
+   *     nulls: 'last',
+   *   },
+   * ])
+   * ```
+   */
   orderBy(input, direction, nullsDirection) {
     if (!Array.isArray(input) && typeof input !== "string") {
       throw new TypeError("invalid input");
@@ -203,6 +256,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IN filter
+   *
+   * .whereIn('token', ['EUR', 'USD'])
+   * ```
+   */
   whereIn(field, value) {
     return this.addIn({
       fn: "whereIn",
@@ -210,6 +270,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IN filter
+   *
+   * .orWhereIn('token', ['EUR', 'USD'])
+   * ```
+   */
   orWhereIn(field, value) {
     return this.addIn({
       fn: "orWhereIn",
@@ -217,24 +284,52 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IS NULL filter
+   *
+   * .whereNull('status_finalized_at')
+   * ```
+   */
   whereNull(field) {
     return this.addNull({
       fn: "whereNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IS NULL filter
+   *
+   * .orWhereNull('status_finalized_at')
+   * ```
+   */
   orWhereNull(field) {
     return this.addNull({
       fn: "orWhereNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an NOT NULL filter
+   *
+   * .whereNotNull('status_finalized_at')
+   * ```
+   */
   whereNotNull(field) {
     return this.addNull({
       fn: "whereNotNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR NOT NULL filter
+   *
+   * .orWhereNotNull('status_finalized_at')
+   * ```
+   */
   orWhereNotNull(field) {
     return this.addNull({
       fn: "orWhereNotNull",
@@ -257,6 +352,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IN filter for metadata field
+   *
+   * .whereMetadataIn('myCustomField', [9, 10])
+   * ```
+   */
   whereMetadataIn(field, value) {
     return this.addMetadataIn({
       fn: "whereMetadataIn",
@@ -264,6 +366,13 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IN filter for metadata field
+   *
+   * .orWhereMetadataIn('myCustomField', [9, 10])
+   * ```
+   */
   orWhereMetadataIn(field, value) {
     return this.addMetadataIn({
       fn: "orWhereMetadataIn",
@@ -271,24 +380,52 @@ var FindQueryBuilder = class _FindQueryBuilder extends import_query_builder.Quer
       value
     });
   }
+  /**
+   * ```javascript
+   * Add an IS NULL filter for metadata field
+   *
+   * .whereMetadataNull('myCustomField')
+   * ```
+   */
   whereMetadataNull(field) {
     return this.addMetadataNull({
       fn: "whereMetadataNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR IS NULL filter for metadata field
+   *
+   * .orWhereMetadataNull('myCustomField')
+   * ```
+   */
   orWhereMetadataNull(field) {
     return this.addMetadataNull({
       fn: "orWhereMetadataNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an NOT NULL filter for metadata field
+   *
+   * .whereMetadataNotNull('myCustomField')
+   * ```
+   */
   whereMetadataNotNull(field) {
     return this.addMetadataNull({
       fn: "whereMetadataNotNull",
       field
     });
   }
+  /**
+   * ```javascript
+   * Add an OR NOT NULL filter for metadata field
+   *
+   * .orWhereMetadataNotNull('myCustomField')
+   * ```
+   */
   orWhereMetadataNotNull(field) {
     return this.addMetadataNull({
       fn: "orWhereMetadataNotNull",