SAJARI-2744 Release for UpdateRecord support in the SDK

sajari · Nov 4, 2021 · fb5e6ad · fb5e6ad
1 parent 5b6964a
commit fb5e6ad
Show file tree

Hide file tree

Showing 147 changed files with 2,599 additions and 1,282 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -62,12 +62,11 @@ docs/SendEventRequest.md
 docs/SetDefaultPipelineRequest.md
 docs/SetDefaultVersionRequest.md
 docs/Status.md
+docs/UpdateRecordRequest.md
 docs/UpsertRecordRequest.md
 docs/UpsertRecordRequestPipeline.md
 docs/UpsertRecordResponse.md
-src/Com.Sajari.Sdk.Test/Api/EventsApiTests.cs
 src/Com.Sajari.Sdk.Test/Com.Sajari.Sdk.Test.csproj
-src/Com.Sajari.Sdk.Test/Model/SendEventRequestTests.cs
 src/Com.Sajari.Sdk/Api/CollectionsApi.cs
 src/Com.Sajari.Sdk/Api/EventsApi.cs
 src/Com.Sajari.Sdk/Api/PipelinesApi.cs
@@ -146,6 +145,7 @@ src/Com.Sajari.Sdk/Model/SendEventRequest.cs
 src/Com.Sajari.Sdk/Model/SetDefaultPipelineRequest.cs
 src/Com.Sajari.Sdk/Model/SetDefaultVersionRequest.cs
 src/Com.Sajari.Sdk/Model/Status.cs
+src/Com.Sajari.Sdk/Model/UpdateRecordRequest.cs
 src/Com.Sajari.Sdk/Model/UpsertRecordRequest.cs
 src/Com.Sajari.Sdk/Model/UpsertRecordRequestPipeline.cs
 src/Com.Sajari.Sdk/Model/UpsertRecordResponse.cs
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-5.0.0-SNAPSHOT
+5.3.0
diff --git a/Com.Sajari.Sdk.sln b/Com.Sajari.Sdk.sln
@@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 14
 VisualStudioVersion = 14.0.25420.1
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Com.Sajari.Sdk", "src\Com.Sajari.Sdk\Com.Sajari.Sdk.csproj", "{8C4ED383-DD7C-4961-A23C-E3C8108A7A75}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Com.Sajari.Sdk", "src\Com.Sajari.Sdk\Com.Sajari.Sdk.csproj", "{028A2A5B-F258-4825-8462-DF48027A4BD0}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Com.Sajari.Sdk.Test", "src\Com.Sajari.Sdk.Test\Com.Sajari.Sdk.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
 EndProject
@@ -12,10 +12,10 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{8C4ED383-DD7C-4961-A23C-E3C8108A7A75}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{8C4ED383-DD7C-4961-A23C-E3C8108A7A75}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{8C4ED383-DD7C-4961-A23C-E3C8108A7A75}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{8C4ED383-DD7C-4961-A23C-E3C8108A7A75}.Release|Any CPU.Build.0 = Release|Any CPU
+		{028A2A5B-F258-4825-8462-DF48027A4BD0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{028A2A5B-F258-4825-8462-DF48027A4BD0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{028A2A5B-F258-4825-8462-DF48027A4BD0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{028A2A5B-F258-4825-8462-DF48027A4BD0}.Release|Any CPU.Build.0 = Release|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ Sajari is a smart, highly-configurable, real-time search service that enables th
 This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v4
-- SDK version: 4.1.0
+- SDK version: 4.2.0
 - Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
     For more information, please visit [https://www.sajari.com/company/contact](https://www.sajari.com/company/contact)
 
@@ -18,10 +18,10 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
 <a name="dependencies"></a>
 ## Dependencies
 
-- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.12.0 or later
+- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.11.7 or later
 - [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 12.0.3 or later
-- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.7.0 or later
-- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
+- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later
+- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later
 
 The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
 ```
@@ -31,7 +31,8 @@ Install-Package JsonSubTypes
 Install-Package System.ComponentModel.Annotations
 ```
 
-NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742)
+NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742).
+NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
 
 <a name="installation"></a>
 ## Installation
@@ -74,8 +75,8 @@ namespace Example
             Configuration config = new Configuration();
             config.BasePath = "https://api-gateway.sajari.com";
             // Configure HTTP basic authorization: BasicAuth
-            config.Username = "KEY_ID";
-            config.Password = "KEY_SECRET";
+            config.Username = "YOUR_USERNAME";
+            config.Password = "YOUR_PASSWORD";
 
             var apiInstance = new CollectionsApi(config);
             var collectionId = collectionId_example;  // string | The ID to use for the collection.  This must start with an alphanumeric character followed by one or more alphanumeric or `-` characters. Strictly speaking, it must match the regular expression: `^[A-Za-z][A-Za-z0-9\\-]*$`.
@@ -110,9 +111,11 @@ Class | Method | HTTP request | Description
 *CollectionsApi* | [**DeleteCollection**](docs/CollectionsApi.md#deletecollection) | **DELETE** /v4/collections/{collection_id} | Delete collection
 *CollectionsApi* | [**GetCollection**](docs/CollectionsApi.md#getcollection) | **GET** /v4/collections/{collection_id} | Get collection
 *CollectionsApi* | [**ListCollections**](docs/CollectionsApi.md#listcollections) | **GET** /v4/collections | List collections
-*CollectionsApi* | [**QueryCollection**](docs/CollectionsApi.md#querycollection) | **POST** /v4/collections/{collection_id}:queryCollection | Query collection
+*CollectionsApi* | [**QueryCollection**](docs/CollectionsApi.md#querycollection) | **POST** /v4/collections/{collection_id}:query | Query collection
+*CollectionsApi* | [**QueryCollection2**](docs/CollectionsApi.md#querycollection2) | **POST** /v4/collections/{collection_id}:queryCollection | Query collection
 *CollectionsApi* | [**UpdateCollection**](docs/CollectionsApi.md#updatecollection) | **PATCH** /v4/collections/{collection_id} | Update collection
-*EventsApi* | [**SendEvent**](docs/EventsApi.md#sendevent) | **POST** /v4/events:sendEvent | Send event
+*EventsApi* | [**SendEvent**](docs/EventsApi.md#sendevent) | **POST** /v4/events:send | Send event
+*EventsApi* | [**SendEvent2**](docs/EventsApi.md#sendevent2) | **POST** /v4/events:sendEvent | Send event
 *PipelinesApi* | [**CreatePipeline**](docs/PipelinesApi.md#createpipeline) | **POST** /v4/collections/{collection_id}/pipelines | Create pipeline
 *PipelinesApi* | [**GeneratePipelines**](docs/PipelinesApi.md#generatepipelines) | **POST** /v4/collections/{collection_id}:generatePipelines | Generate pipelines
 *PipelinesApi* | [**GetDefaultPipeline**](docs/PipelinesApi.md#getdefaultpipeline) | **GET** /v4/collections/{collection_id}:getDefaultPipeline | Get default pipeline
@@ -124,6 +127,7 @@ Class | Method | HTTP request | Description
 *RecordsApi* | [**BatchUpsertRecords**](docs/RecordsApi.md#batchupsertrecords) | **POST** /v4/collections/{collection_id}/records:batchUpsert | Batch upsert records
 *RecordsApi* | [**DeleteRecord**](docs/RecordsApi.md#deleterecord) | **POST** /v4/collections/{collection_id}/records:delete | Delete record
 *RecordsApi* | [**GetRecord**](docs/RecordsApi.md#getrecord) | **POST** /v4/collections/{collection_id}/records:get | Get record
+*RecordsApi* | [**UpdateRecord**](docs/RecordsApi.md#updaterecord) | **POST** /v4/collections/{collection_id}/records:update | Update record
 *RecordsApi* | [**UpsertRecord**](docs/RecordsApi.md#upsertrecord) | **POST** /v4/collections/{collection_id}/records:upsert | Upsert record
 *SchemaApi* | [**BatchCreateSchemaFields**](docs/SchemaApi.md#batchcreateschemafields) | **POST** /v4/collections/{collection_id}/schemaFields:batchCreate | Batch create schema fields
 *SchemaApi* | [**CreateSchemaField**](docs/SchemaApi.md#createschemafield) | **POST** /v4/collections/{collection_id}/schemaFields | Create schema field
@@ -188,6 +192,7 @@ Class | Method | HTTP request | Description
  - [Model.SetDefaultPipelineRequest](docs/SetDefaultPipelineRequest.md)
  - [Model.SetDefaultVersionRequest](docs/SetDefaultVersionRequest.md)
  - [Model.Status](docs/Status.md)
+ - [Model.UpdateRecordRequest](docs/UpdateRecordRequest.md)
  - [Model.UpsertRecordRequest](docs/UpsertRecordRequest.md)
  - [Model.UpsertRecordRequestPipeline](docs/UpsertRecordRequestPipeline.md)
  - [Model.UpsertRecordResponse](docs/UpsertRecordResponse.md)

diff --git a/docs/BatchCreateSchemaFieldsRequest.md b/docs/BatchCreateSchemaFieldsRequest.md
@@ -1,4 +1,5 @@
 # Com.Sajari.Sdk.Model.BatchCreateSchemaFieldsRequest
+
 ## Properties
 
 Name | Type | Description | Notes

diff --git a/docs/BatchCreateSchemaFieldsResponse.md b/docs/BatchCreateSchemaFieldsResponse.md
@@ -1,10 +1,11 @@
 # Com.Sajari.Sdk.Model.BatchCreateSchemaFieldsResponse
+
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Fields** | [**List&lt;SchemaField&gt;**](SchemaField.md) | Schema fields created. | [optional] 
 **Errors** | [**List&lt;BatchCreateSchemaFieldsResponseError&gt;**](BatchCreateSchemaFieldsResponseError.md) | Errors that occurred. | [optional] 
+**Fields** | [**List&lt;SchemaField&gt;**](SchemaField.md) | Schema fields created. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/BatchCreateSchemaFieldsResponseError.md b/docs/BatchCreateSchemaFieldsResponseError.md
@@ -1,4 +1,5 @@
 # Com.Sajari.Sdk.Model.BatchCreateSchemaFieldsResponseError
+
 ## Properties
 
 Name | Type | Description | Notes

diff --git a/docs/BatchUpsertRecordsRequest.md b/docs/BatchUpsertRecordsRequest.md
@@ -1,11 +1,12 @@
 # Com.Sajari.Sdk.Model.BatchUpsertRecordsRequest
+
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Pipeline** | [**BatchUpsertRecordsRequestPipeline**](BatchUpsertRecordsRequestPipeline.md) |  | [optional] 
-**Records** | **List&lt;Object&gt;** | A list of records to upsert. | 
-**Variables** | **Object** | The initial values for the variables the pipeline operates on and transforms throughout its steps. | [optional] 
+**Records** | **List&lt;Object&gt;** | A list of records to upsert.  A maximum of 200 records can be upsert in a batch. | 
+**Variables** | **Dictionary&lt;string, Object&gt;** | The initial values for the variables the pipeline operates on and transforms throughout its steps. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/BatchUpsertRecordsRequestPipeline.md b/docs/BatchUpsertRecordsRequestPipeline.md
@@ -1,11 +1,12 @@
 # Com.Sajari.Sdk.Model.BatchUpsertRecordsRequestPipeline
 The pipeline to use when upserting the records.  If not provided the default record pipeline is used.
+
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Name** | **string** | The record pipeline&#39;s name, e.g. &#x60;my-pipeline&#x60;. | 
-**Version** | **string** | The record pipeline&#39;s version, e.g. &#x60;42&#x60;.  If not provided the default version is used. | [optional] 
+**_Version** | **string** | The record pipeline&#39;s version, e.g. &#x60;42&#x60;.  If not provided the default version is used. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/BatchUpsertRecordsResponse.md b/docs/BatchUpsertRecordsResponse.md
@@ -1,11 +1,12 @@
 # Com.Sajari.Sdk.Model.BatchUpsertRecordsResponse
+
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**Errors** | [**List&lt;BatchUpsertRecordsResponseError&gt;**](BatchUpsertRecordsResponseError.md) | Errors that occurred. | [optional] 
 **Keys** | [**List&lt;BatchUpsertRecordsResponseKey&gt;**](BatchUpsertRecordsResponseKey.md) | A list of keys of the records that were inserted.  If a record was inserted, keys contains an entry containing the index of the inserted record from &#x60;records&#x60; and the key. You can use the key if you need to retrieve or delete the record.  If a record was updated, keys contains no such entry for the updated record. | [optional] 
 **Variables** | [**List&lt;BatchUpsertRecordsResponseVariables&gt;**](BatchUpsertRecordsResponseVariables.md) | A list of modified variables returned by the pipeline after it has finished processing each record. | [optional] 
-**Errors** | [**List&lt;BatchUpsertRecordsResponseError&gt;**](BatchUpsertRecordsResponseError.md) | Errors that occurred. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/BatchUpsertRecordsResponseError.md b/docs/BatchUpsertRecordsResponseError.md
@@ -1,4 +1,5 @@
 # Com.Sajari.Sdk.Model.BatchUpsertRecordsResponseError
+
 ## Properties
 
 Name | Type | Description | Notes

diff --git a/docs/BatchUpsertRecordsResponseKey.md b/docs/BatchUpsertRecordsResponseKey.md
@@ -1,4 +1,5 @@
 # Com.Sajari.Sdk.Model.BatchUpsertRecordsResponseKey
+
 ## Properties
 
 Name | Type | Description | Notes

diff --git a/docs/BatchUpsertRecordsResponseVariables.md b/docs/BatchUpsertRecordsResponseVariables.md
@@ -1,10 +1,11 @@
 # Com.Sajari.Sdk.Model.BatchUpsertRecordsResponseVariables
+
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Index** | **int** | Index of the record in &#x60;records&#x60; that these variables correspond to. | [optional] 
-**Variables** | **Object** | The variables. | [optional] 
+**Variables** | **Dictionary&lt;string, Object&gt;** | The variables. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/Collection.md b/docs/Collection.md
@@ -1,13 +1,14 @@
 # Com.Sajari.Sdk.Model.Collection
+
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Id** | **string** | Output only. The collection&#39;s ID. | [optional] [readonly] 
 **AccountId** | **string** | Output only. The ID of the account that owns this collection. | [optional] [readonly] 
-**CreateTime** | **DateTime** | Output only. Creation time of the collection. | [optional] [readonly] 
-**DisplayName** | **string** | The collection&#39;s display name. You can change this at any time. | 
 **AuthorizedQueryDomains** | **List&lt;string&gt;** | The list of authorized query domains for the collection.  Client-side / browser requests to the [QueryCollection](/api#operation/QueryCollection) call can be made by any authorized query domain or any of its subdomains. This allows your interface to make search requests without having to provide an API key in the client-side request. | [optional] 
+**CreateTime** | **DateTime** | Output only. Time the collection was created. | [optional] [readonly] 
+**DisplayName** | **string** | The collection&#39;s display name. You can change this at any time. | 
+**Id** | **string** | Output only. The collection&#39;s ID. | [optional] [readonly] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)