@sajari/sdk-node - npm Package Compare versions

Comparing version 4.0.1 to 4.1.0

build/src/generated/api/apis.d.ts

 /// <reference types="node" />
 export * from "./collectionsApi";
 import { CollectionsApi } from "./collectionsApi";
+export * from "./eventsApi";
+import { EventsApi } from "./eventsApi";
 export * from "./pipelinesApi";
@@ -18,2 +20,2 @@ import { PipelinesApi } from "./pipelinesApi";
 export { RequestFile } from "../model/models";
-export declare const APIS: (typeof CollectionsApi | typeof PipelinesApi | typeof RecordsApi | typeof SchemaApi)[];
+export declare const APIS: (typeof CollectionsApi | typeof EventsApi | typeof PipelinesApi | typeof RecordsApi | typeof SchemaApi)[];

build/src/generated/api/apis.js

@@ -16,2 +16,4 @@ "use strict";
 const collectionsApi_1 = require("./collectionsApi");
+__exportStar(require("./eventsApi"), exports);
+const eventsApi_1 = require("./eventsApi");
 __exportStar(require("./pipelinesApi"), exports);
@@ -33,3 +35,9 @@ const pipelinesApi_1 = require("./pipelinesApi");
 exports.HttpError = HttpError;
-exports.APIS = [collectionsApi_1.CollectionsApi, pipelinesApi_1.PipelinesApi, recordsApi_1.RecordsApi, schemaApi_1.SchemaApi];
+exports.APIS = [
+    collectionsApi_1.CollectionsApi,
+    eventsApi_1.EventsApi,
+    pipelinesApi_1.PipelinesApi,
+    recordsApi_1.RecordsApi,
+    schemaApi_1.SchemaApi,
+];
 //# sourceMappingURL=apis.js.map

build/src/generated/api/collectionsApi.d.ts

@@ -58,3 +58,3 @@ /**
     /**
-     * Delete a collection and all of its associated data.  > Note: this operation cannot be reversed.
+     * Delete a collection and all of its associated data.  > Note: This operation cannot be reversed.
      * @summary Delete collection
@@ -61,0 +61,0 @@ * @param collectionId The collection to delete, e.g. `my-collection`.

build/src/generated/api/collectionsApi.js

@@ -163,3 +163,3 @@ "use strict";
     /**
-     * Delete a collection and all of its associated data.  > Note: this operation cannot be reversed.
+     * Delete a collection and all of its associated data.  > Note: This operation cannot be reversed.
      * @summary Delete collection
@@ -166,0 +166,0 @@ * @param collectionId The collection to delete, e.g. `my-collection`.

build/src/generated/api/recordsApi.d.ts

@@ -88,3 +88,3 @@ /**
     /**
-     * If the record does not exist in your collection it is inserted. If it does exist it is updated.  If no pipeline is specified, the default record pipeline is used to process the record.  For example, to add a single product from your ecommerce store to a collection, use the following call:  ```json {   \"pipeline\": {     \"name\": \"my-pipeline\",     \"version\": \"1\"   },   \"record\": {     \"id\": \"54hdc7h2334h\",     \"name\": \"Smart TV\",     \"price\": 1999,     \"brand\": \"Acme\",     \"description\": \"...\",     \"in_stock\": true   } } ```
+     * If the record does not exist in your collection it is inserted. If it does exist it is updated.  If no pipeline is specified, the default record pipeline is used to process the record.  If the record is inserted, the response contains the key of the inserted record. You can use this if you need to retrieve or delete the record. If the record is updated, the response does not contain a key. Callers can use this as a signal to determine if the record is inserted/created or updated.  For example, to add a single product from your ecommerce store to a collection, use the following call:  ```json {   \"pipeline\": {     \"name\": \"my-pipeline\",     \"version\": \"1\"   },   \"record\": {     \"id\": \"54hdc7h2334h\",     \"name\": \"Smart TV\",     \"price\": 1999,     \"brand\": \"Acme\",     \"description\": \"...\",     \"in_stock\": true   } } ```
      * @summary Upsert record
@@ -91,0 +91,0 @@ * @param collectionId The collection to upsert the record in, e.g. `my-collection`.

build/src/generated/api/recordsApi.js

@@ -318,3 +318,3 @@ "use strict";
     /**
-     * If the record does not exist in your collection it is inserted. If it does exist it is updated.  If no pipeline is specified, the default record pipeline is used to process the record.  For example, to add a single product from your ecommerce store to a collection, use the following call:  ```json {   \"pipeline\": {     \"name\": \"my-pipeline\",     \"version\": \"1\"   },   \"record\": {     \"id\": \"54hdc7h2334h\",     \"name\": \"Smart TV\",     \"price\": 1999,     \"brand\": \"Acme\",     \"description\": \"...\",     \"in_stock\": true   } } ```
+     * If the record does not exist in your collection it is inserted. If it does exist it is updated.  If no pipeline is specified, the default record pipeline is used to process the record.  If the record is inserted, the response contains the key of the inserted record. You can use this if you need to retrieve or delete the record. If the record is updated, the response does not contain a key. Callers can use this as a signal to determine if the record is inserted/created or updated.  For example, to add a single product from your ecommerce store to a collection, use the following call:  ```json {   \"pipeline\": {     \"name\": \"my-pipeline\",     \"version\": \"1\"   },   \"record\": {     \"id\": \"54hdc7h2334h\",     \"name\": \"Smart TV\",     \"price\": 1999,     \"brand\": \"Acme\",     \"description\": \"...\",     \"in_stock\": true   } } ```
      * @summary Upsert record
@@ -321,0 +321,0 @@ * @param collectionId The collection to upsert the record in, e.g. `my-collection`.

build/src/generated/model/models.d.ts

@@ -54,2 +54,3 @@ /// <reference types="node" />
 export * from "./schemaFieldType";
+export * from "./sendEventRequest";
 export * from "./setDefaultPipelineRequest";
@@ -56,0 +57,0 @@ export * from "./setDefaultVersionRequest";

build/src/generated/model/models.js

@@ -65,2 +65,3 @@ "use strict";
 __exportStar(require("./schemaFieldType"), exports);
+__exportStar(require("./sendEventRequest"), exports);
 __exportStar(require("./setDefaultPipelineRequest"), exports);
@@ -123,2 +124,3 @@ __exportStar(require("./setDefaultVersionRequest"), exports);
 const schemaFieldType_1 = require("./schemaFieldType");
+const sendEventRequest_1 = require("./sendEventRequest");
 const setDefaultPipelineRequest_1 = require("./setDefaultPipelineRequest");
@@ -195,2 +197,3 @@ const setDefaultVersionRequest_1 = require("./setDefaultVersionRequest");
     SchemaField: schemaField_1.SchemaField,
+    SendEventRequest: sendEventRequest_1.SendEventRequest,
     SetDefaultPipelineRequest: setDefaultPipelineRequest_1.SetDefaultPipelineRequest,
@@ -197,0 +200,0 @@ SetDefaultVersionRequest: setDefaultVersionRequest_1.SetDefaultVersionRequest,

build/src/generated/model/queryCollectionRequest.d.ts

@@ -20,3 +20,3 @@ /**
     /**
-     * The initial values for the variables the pipeline operates on and transforms throughout its steps.  A typical variable is `q` which is the query the user entered, for example:  ```json { \"q\": \"search terms\" } ```
+     * The initial values for the variables the pipeline operates on and transforms throughout its steps.  The most important variable is `q` which is the query the user entered, for example:  ```json { \"q\": \"search terms\" } ```  To paginate through results, set the variables `page` and `resultsPerPage`, for example:  ```json { \"q\": \"search terms\", \"page\": 5, \"resultsPerPage\": 20 } ```  To sort results, set the variable `sort` to the name of one of your collection\'s schema fields, for example:  ```json { \"q\": \"search terms\", \"sort\": \"name\" } ```  To sort in reverse, prefix the schema field with a minus sign `-`, for example:  ```json { \"q\": \"search terms\", \"sort\": \"-name\" } ```
      */
@@ -23,0 +23,0 @@ "variables": object;

build/src/version.d.ts

@@ -1,1 +0,1 @@
-export declare const version = "4.0.1";
+export declare const version = "4.1.0";

build/src/version.js

@@ -5,3 +5,3 @@ "use strict";
 exports.version = void 0;
-exports.version = "4.0.1";
+exports.version = "4.1.0";
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@sajari/sdk-node",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "repository": "[e-mail]:github.com/sajari/sdk-node.git",
@@ -5,0 +5,0 @@ "author": "Sajari Pty Ltd",

README.md

@@ -93,5 +93,4 @@ # Sajari SDK for Node
 ## License
-
 MIT
 
 See [LICENSE](https://github.com/sajari/sdk-node/blob/master/LICENSE)

No alert changes

Improved metrics

Total package byte prevSize

348992

increased by4.32%

Number of package files

163

increased by2.52%

Lines of code

8036

increased by4.16%

Worsened metrics

Number of lines in readme file

96

decreased by-1.03%

No dependency changes