diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index c7f5182..f575dd6 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -18,6 +18,7 @@ docs/BatchUpsertRecordsResponseError.md docs/BatchUpsertRecordsResponseKey.md docs/BatchUpsertRecordsResponseVariables.md docs/Collection.md +docs/CollectionType.md docs/CollectionsApi.md docs/DeleteRecordRequest.md docs/Error.md @@ -28,10 +29,12 @@ docs/ExperimentRequestPipeline.md docs/ExperimentResponse.md docs/GeneratePipelinesRequest.md docs/GeneratePipelinesResponse.md +docs/GetCollectionRequestView.md docs/GetDefaultPipelineResponse.md docs/GetDefaultVersionRequestView.md docs/GetPipelineRequestView.md docs/GetRecordRequest.md +docs/ListCollectionsRequestView.md docs/ListCollectionsResponse.md docs/ListPipelinesRequestView.md docs/ListPipelinesResponse.md @@ -94,14 +97,6 @@ docs/UpsertRecordRequest.md docs/UpsertRecordRequestPipeline.md docs/UpsertRecordResponse.md src/Com.Sajari.Sdk.Test/Com.Sajari.Sdk.Test.csproj -src/Com.Sajari.Sdk.Test/Model/BannerTests.cs -src/Com.Sajari.Sdk.Test/Model/EventTests.cs -src/Com.Sajari.Sdk.Test/Model/ExperimentRequestPipelineTests.cs -src/Com.Sajari.Sdk.Test/Model/ExperimentRequestTests.cs -src/Com.Sajari.Sdk.Test/Model/ExperimentResponseTests.cs -src/Com.Sajari.Sdk.Test/Model/ListPromotionsRequestPromotionViewTests.cs -src/Com.Sajari.Sdk.Test/Model/PromotionPinModeTests.cs -src/Com.Sajari.Sdk.Test/Model/TextPositionTests.cs src/Com.Sajari.Sdk/Api/CollectionsApi.cs src/Com.Sajari.Sdk/Api/EventsApi.cs src/Com.Sajari.Sdk/Api/PipelinesApi.cs @@ -143,6 +138,7 @@ src/Com.Sajari.Sdk/Model/BatchUpsertRecordsResponseError.cs src/Com.Sajari.Sdk/Model/BatchUpsertRecordsResponseKey.cs src/Com.Sajari.Sdk/Model/BatchUpsertRecordsResponseVariables.cs src/Com.Sajari.Sdk/Model/Collection.cs +src/Com.Sajari.Sdk/Model/CollectionType.cs src/Com.Sajari.Sdk/Model/DeleteRecordRequest.cs src/Com.Sajari.Sdk/Model/Error.cs src/Com.Sajari.Sdk/Model/Event.cs @@ -151,10 +147,12 @@ src/Com.Sajari.Sdk/Model/ExperimentRequestPipeline.cs src/Com.Sajari.Sdk/Model/ExperimentResponse.cs src/Com.Sajari.Sdk/Model/GeneratePipelinesRequest.cs src/Com.Sajari.Sdk/Model/GeneratePipelinesResponse.cs +src/Com.Sajari.Sdk/Model/GetCollectionRequestView.cs src/Com.Sajari.Sdk/Model/GetDefaultPipelineResponse.cs src/Com.Sajari.Sdk/Model/GetDefaultVersionRequestView.cs src/Com.Sajari.Sdk/Model/GetPipelineRequestView.cs src/Com.Sajari.Sdk/Model/GetRecordRequest.cs +src/Com.Sajari.Sdk/Model/ListCollectionsRequestView.cs src/Com.Sajari.Sdk/Model/ListCollectionsResponse.cs src/Com.Sajari.Sdk/Model/ListPipelinesRequestView.cs src/Com.Sajari.Sdk/Model/ListPipelinesResponse.cs diff --git a/Com.Sajari.Sdk.sln b/Com.Sajari.Sdk.sln index 801832a..3891fa6 100644 --- 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", "{AB2FC7D6-7D1E-495D-B4ED-C2CC60E8488D}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Com.Sajari.Sdk", "src\Com.Sajari.Sdk\Com.Sajari.Sdk.csproj", "{9209CA73-88E1-456D-BE89-9978B4E998A8}" 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 - {AB2FC7D6-7D1E-495D-B4ED-C2CC60E8488D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {AB2FC7D6-7D1E-495D-B4ED-C2CC60E8488D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {AB2FC7D6-7D1E-495D-B4ED-C2CC60E8488D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {AB2FC7D6-7D1E-495D-B4ED-C2CC60E8488D}.Release|Any CPU.Build.0 = Release|Any CPU + {9209CA73-88E1-456D-BE89-9978B4E998A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9209CA73-88E1-456D-BE89-9978B4E998A8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9209CA73-88E1-456D-BE89-9978B4E998A8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9209CA73-88E1-456D-BE89-9978B4E998A8}.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 index ae383d7..2c56c41 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Search.io offers a search and discovery service with Neuralsearch®, the world's This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v4 -- SDK version: 5.0.0 +- SDK version: 5.1.0 - Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit [https://www.search.io/company/contact](https://www.search.io/company/contact) @@ -81,11 +81,12 @@ namespace Example 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\\-]*$`. var collection = new Collection(); // Collection | Details of the collection to create. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Create collection - Collection result = apiInstance.CreateCollection(collectionId, collection); + Collection result = apiInstance.CreateCollection(collectionId, collection, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -144,7 +145,9 @@ Class | Method | HTTP request | Description *RedirectsApi* | [**UpdateRedirect**](docs/RedirectsApi.md#updateredirect) | **PATCH** /v4/collections/{collection_id}/redirects/{redirect_id} | Update redirect *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 +*SchemaApi* | [**DeleteSchemaField**](docs/SchemaApi.md#deleteschemafield) | **DELETE** /v4/collections/{collection_id}/schemaFields/{schema_field_name} | Delete schema field *SchemaApi* | [**ListSchemaFields**](docs/SchemaApi.md#listschemafields) | **GET** /v4/collections/{collection_id}/schemaFields | List schema fields +*SchemaApi* | [**UpdateSchemaField**](docs/SchemaApi.md#updateschemafield) | **PATCH** /v4/collections/{collection_id}/schemaFields/{schema_field_name} | Update schema field @@ -166,6 +169,7 @@ Class | Method | HTTP request | Description - [Model.BatchUpsertRecordsResponseKey](docs/BatchUpsertRecordsResponseKey.md) - [Model.BatchUpsertRecordsResponseVariables](docs/BatchUpsertRecordsResponseVariables.md) - [Model.Collection](docs/Collection.md) + - [Model.CollectionType](docs/CollectionType.md) - [Model.DeleteRecordRequest](docs/DeleteRecordRequest.md) - [Model.Error](docs/Error.md) - [Model.Event](docs/Event.md) @@ -174,10 +178,12 @@ Class | Method | HTTP request | Description - [Model.ExperimentResponse](docs/ExperimentResponse.md) - [Model.GeneratePipelinesRequest](docs/GeneratePipelinesRequest.md) - [Model.GeneratePipelinesResponse](docs/GeneratePipelinesResponse.md) + - [Model.GetCollectionRequestView](docs/GetCollectionRequestView.md) - [Model.GetDefaultPipelineResponse](docs/GetDefaultPipelineResponse.md) - [Model.GetDefaultVersionRequestView](docs/GetDefaultVersionRequestView.md) - [Model.GetPipelineRequestView](docs/GetPipelineRequestView.md) - [Model.GetRecordRequest](docs/GetRecordRequest.md) + - [Model.ListCollectionsRequestView](docs/ListCollectionsRequestView.md) - [Model.ListCollectionsResponse](docs/ListCollectionsResponse.md) - [Model.ListPipelinesRequestView](docs/ListPipelinesRequestView.md) - [Model.ListPipelinesResponse](docs/ListPipelinesResponse.md) diff --git a/docs/Collection.md b/docs/Collection.md index 01e6bc3..c58dafe 100644 --- a/docs/Collection.md +++ b/docs/Collection.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AccountId** | **string** | Output only. The ID of the account that owns this collection. | [optional] [readonly] **AuthorizedQueryDomains** | **List<string>** | The list of authorized query domains for the collection. Client-side / browser requests to the [QueryCollection](/docs/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] +**CreateTime** | **DateTime** | Output only. The time the collection was created. | [optional] [readonly] **DisplayName** | **string** | The collection's display name. You can change this at any time. | **Id** | **string** | Output only. The collection's ID. | [optional] [readonly] diff --git a/docs/CollectionType.md b/docs/CollectionType.md new file mode 100644 index 0000000..35a54f1 --- /dev/null +++ b/docs/CollectionType.md @@ -0,0 +1,10 @@ +# Com.Sajari.Sdk.Model.CollectionType + - TYPE_UNSPECIFIED: Type not specified. - WEBSITE: The type for website collections. - SHOPIFY: The type for the collection backing a Shopify account. - CUSTOM: The legacy custom type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/CollectionsApi.md b/docs/CollectionsApi.md index 342c846..b98924b 100644 --- a/docs/CollectionsApi.md +++ b/docs/CollectionsApi.md @@ -17,7 +17,7 @@ Method | HTTP request | Description # **CreateCollection** -> Collection CreateCollection (string collectionId, Collection collection) +> Collection CreateCollection (string collectionId, Collection collection, string accountId = null) Create collection @@ -46,11 +46,12 @@ namespace Example 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\\-]*$`. var collection = new Collection(); // Collection | Details of the collection to create. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Create collection - Collection result = apiInstance.CreateCollection(collectionId, collection); + Collection result = apiInstance.CreateCollection(collectionId, collection, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -70,6 +71,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **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\\-]*$`. | **collection** | [**Collection**](Collection.md)| Details of the collection to create. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -101,7 +103,7 @@ Name | Type | Description | Notes # **DeleteCollection** -> Object DeleteCollection (string collectionId) +> Object DeleteCollection (string collectionId, string accountId = null) Delete collection @@ -129,11 +131,12 @@ namespace Example var apiInstance = new CollectionsApi(config); var collectionId = "collectionId_example"; // string | The collection to delete, e.g. `my-collection`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Delete collection - Object result = apiInstance.DeleteCollection(collectionId); + Object result = apiInstance.DeleteCollection(collectionId, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -152,6 +155,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection to delete, e.g. `my-collection`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -263,7 +267,7 @@ Name | Type | Description | Notes # **GetCollection** -> Collection GetCollection (string collectionId) +> Collection GetCollection (string collectionId, string accountId = null, string view = null) Get collection @@ -291,11 +295,13 @@ namespace Example var apiInstance = new CollectionsApi(config); var collectionId = "collectionId_example"; // string | The collection to retrieve, e.g. `my-collection`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) + var view = "VIEW_UNSPECIFIED"; // string | The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional) (default to VIEW_UNSPECIFIED) try { // Get collection - Collection result = apiInstance.GetCollection(collectionId); + Collection result = apiInstance.GetCollection(collectionId, accountId, view); Debug.WriteLine(result); } catch (ApiException e) @@ -314,6 +320,8 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection to retrieve, e.g. `my-collection`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] + **view** | **string**| The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. | [optional] [default to VIEW_UNSPECIFIED] ### Return type @@ -343,7 +351,7 @@ Name | Type | Description | Notes # **ListCollections** -> ListCollectionsResponse ListCollections (int? pageSize = null, string pageToken = null) +> ListCollectionsResponse ListCollections (string accountId = null, int? pageSize = null, string pageToken = null, string view = null) List collections @@ -370,13 +378,15 @@ namespace Example config.Password = "YOUR_PASSWORD"; var apiInstance = new CollectionsApi(config); + var accountId = "accountId_example"; // string | The account that owns this set of collections, e.g. `1618535966441231024`. (optional) var pageSize = 56; // int? | The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) var pageToken = "pageToken_example"; // string | A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + var view = "VIEW_UNSPECIFIED"; // string | The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional) (default to VIEW_UNSPECIFIED) try { // List collections - ListCollectionsResponse result = apiInstance.ListCollections(pageSize, pageToken); + ListCollectionsResponse result = apiInstance.ListCollections(accountId, pageSize, pageToken, view); Debug.WriteLine(result); } catch (ApiException e) @@ -394,8 +404,10 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **accountId** | **string**| The account that owns this set of collections, e.g. `1618535966441231024`. | [optional] **pageSize** | **int?**| The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. | [optional] **pageToken** | **string**| A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. | [optional] + **view** | **string**| The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. | [optional] [default to VIEW_UNSPECIFIED] ### Return type @@ -595,7 +607,7 @@ Name | Type | Description | Notes Track event -Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. +Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. ### Example ```csharp @@ -675,7 +687,7 @@ Name | Type | Description | Notes # **UpdateCollection** -> Collection UpdateCollection (string collectionId, Collection collection, string updateMask = null) +> Collection UpdateCollection (string collectionId, Collection collection, string accountId = null, string updateMask = null) Update collection @@ -704,12 +716,13 @@ namespace Example var apiInstance = new CollectionsApi(config); var collectionId = "collectionId_example"; // string | The collection to update, e.g. `my-collection`. var collection = new Collection(); // Collection | The details of the collection to update. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) var updateMask = "updateMask_example"; // string | The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) try { // Update collection - Collection result = apiInstance.UpdateCollection(collectionId, collection, updateMask); + Collection result = apiInstance.UpdateCollection(collectionId, collection, accountId, updateMask); Debug.WriteLine(result); } catch (ApiException e) @@ -729,6 +742,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection to update, e.g. `my-collection`. | **collection** | [**Collection**](Collection.md)| The details of the collection to update. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] **updateMask** | **string**| The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. | [optional] ### Return type diff --git a/docs/Event.md b/docs/Event.md index 394638b..84a4d46 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **QueryId** | **string** | The query identifier. | **RedirectId** | **string** | The identifier of the redirect the event is about. | [optional] **ResultId** | **string** | The identifier of the result the event is about. | [optional] -**Type** | **string** | The type of event, e.g. `click`, `purchase`, `add_to_cart`. | +**Type** | **string** | The type of event, e.g. `click`, `redirect`, `purchase`, `add_to_cart`. | [[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/EventsApi.md b/docs/EventsApi.md index 1e48bc4..000f28a 100644 --- a/docs/EventsApi.md +++ b/docs/EventsApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description Send event -Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. +Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. ### Example ```csharp @@ -97,7 +97,7 @@ Name | Type | Description | Notes Send event -Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. +Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. ### Example ```csharp diff --git a/docs/GetCollectionRequestView.md b/docs/GetCollectionRequestView.md new file mode 100644 index 0000000..f8fdd0e --- /dev/null +++ b/docs/GetCollectionRequestView.md @@ -0,0 +1,10 @@ +# Com.Sajari.Sdk.Model.GetCollectionRequestView + - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/ListCollectionsRequestView.md b/docs/ListCollectionsRequestView.md new file mode 100644 index 0000000..8322ea6 --- /dev/null +++ b/docs/ListCollectionsRequestView.md @@ -0,0 +1,10 @@ +# Com.Sajari.Sdk.Model.ListCollectionsRequestView + - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/PipelinesApi.md b/docs/PipelinesApi.md index 055402b..a2655ac 100644 --- a/docs/PipelinesApi.md +++ b/docs/PipelinesApi.md @@ -16,7 +16,7 @@ Method | HTTP request | Description # **CreatePipeline** -> Pipeline CreatePipeline (string collectionId, Pipeline pipeline) +> Pipeline CreatePipeline (string collectionId, Pipeline pipeline, string accountId = null) Create pipeline @@ -45,11 +45,12 @@ namespace Example var apiInstance = new PipelinesApi(config); var collectionId = "collectionId_example"; // string | The collection to create the pipeline in, e.g. `my-collection`. var pipeline = new Pipeline(); // Pipeline | The pipeline to create. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Create pipeline - Pipeline result = apiInstance.CreatePipeline(collectionId, pipeline); + Pipeline result = apiInstance.CreatePipeline(collectionId, pipeline, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -69,6 +70,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection to create the pipeline in, e.g. `my-collection`. | **pipeline** | [**Pipeline**](Pipeline.md)| The pipeline to create. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -262,7 +264,7 @@ Name | Type | Description | Notes # **GetDefaultVersion** -> Pipeline GetDefaultVersion (string collectionId, string type, string name, string view = null) +> Pipeline GetDefaultVersion (string collectionId, string type, string name, string accountId = null, string view = null) Get default pipeline version @@ -292,12 +294,13 @@ namespace Example var collectionId = "collectionId_example"; // string | The collection that owns the pipeline to get the default version of, e.g. `my-collection`. var type = "TYPE_UNSPECIFIED"; // string | The type of the pipeline to get the default version of. var name = "name_example"; // string | The name of the pipeline to get the default version of, e.g. `my-pipeline`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) var view = "VIEW_UNSPECIFIED"; // string | The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional) (default to VIEW_UNSPECIFIED) try { // Get default pipeline version - Pipeline result = apiInstance.GetDefaultVersion(collectionId, type, name, view); + Pipeline result = apiInstance.GetDefaultVersion(collectionId, type, name, accountId, view); Debug.WriteLine(result); } catch (ApiException e) @@ -318,6 +321,7 @@ Name | Type | Description | Notes **collectionId** | **string**| The collection that owns the pipeline to get the default version of, e.g. `my-collection`. | **type** | **string**| The type of the pipeline to get the default version of. | **name** | **string**| The name of the pipeline to get the default version of, e.g. `my-pipeline`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] **view** | **string**| The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. | [optional] [default to VIEW_UNSPECIFIED] ### Return type @@ -348,7 +352,7 @@ Name | Type | Description | Notes # **GetPipeline** -> Pipeline GetPipeline (string collectionId, string type, string name, string version, string view = null) +> Pipeline GetPipeline (string collectionId, string type, string name, string version, string accountId = null, string view = null) Get pipeline @@ -379,12 +383,13 @@ namespace Example var type = "TYPE_UNSPECIFIED"; // string | The type of the pipeline to retrieve. var name = "name_example"; // string | The name of the pipeline to retrieve, e.g. `my-pipeline`. var version = "version_example"; // string | The version of the pipeline to retrieve, e.g. `42`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) var view = "VIEW_UNSPECIFIED"; // string | The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional) (default to VIEW_UNSPECIFIED) try { // Get pipeline - Pipeline result = apiInstance.GetPipeline(collectionId, type, name, version, view); + Pipeline result = apiInstance.GetPipeline(collectionId, type, name, version, accountId, view); Debug.WriteLine(result); } catch (ApiException e) @@ -406,6 +411,7 @@ Name | Type | Description | Notes **type** | **string**| The type of the pipeline to retrieve. | **name** | **string**| The name of the pipeline to retrieve, e.g. `my-pipeline`. | **version** | **string**| The version of the pipeline to retrieve, e.g. `42`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] **view** | **string**| The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. | [optional] [default to VIEW_UNSPECIFIED] ### Return type @@ -436,7 +442,7 @@ Name | Type | Description | Notes # **ListPipelines** -> ListPipelinesResponse ListPipelines (string collectionId, int? pageSize = null, string pageToken = null, string view = null) +> ListPipelinesResponse ListPipelines (string collectionId, string accountId = null, int? pageSize = null, string pageToken = null, string view = null) List pipelines @@ -464,6 +470,7 @@ namespace Example var apiInstance = new PipelinesApi(config); var collectionId = "collectionId_example"; // string | The collection that owns this set of pipelines, e.g. `my-collection`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) var pageSize = 56; // int? | The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) var pageToken = "pageToken_example"; // string | A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) var view = "VIEW_UNSPECIFIED"; // string | The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional) (default to VIEW_UNSPECIFIED) @@ -471,7 +478,7 @@ namespace Example try { // List pipelines - ListPipelinesResponse result = apiInstance.ListPipelines(collectionId, pageSize, pageToken, view); + ListPipelinesResponse result = apiInstance.ListPipelines(collectionId, accountId, pageSize, pageToken, view); Debug.WriteLine(result); } catch (ApiException e) @@ -490,6 +497,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection that owns this set of pipelines, e.g. `my-collection`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] **pageSize** | **int?**| The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. | [optional] **pageToken** | **string**| A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. | [optional] **view** | **string**| The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. | [optional] [default to VIEW_UNSPECIFIED] diff --git a/docs/Promotion.md b/docs/Promotion.md index e3d6cb2..590aed2 100644 --- a/docs/Promotion.md +++ b/docs/Promotion.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **EndTime** | **DateTime** | If specified, the promotion is considered disabled after this time. | [optional] **Exclusions** | [**List<PromotionExclusion>**](PromotionExclusion.md) | The records to exclude from search results, if the promotion is enabled. | [optional] **FilterBoosts** | [**List<PromotionFilterBoost>**](PromotionFilterBoost.md) | The filter boosts to apply to searches, if the promotion is enabled. | [optional] -**FilterConditions** | [**List<PromotionFilterCondition>**](PromotionFilterCondition.md) | The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. | [optional] +**FilterConditions** | [**List<PromotionFilterCondition>**](PromotionFilterCondition.md) | The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. A filter condition is comprised of a set of filters of the form `field = value` and matches a query if all of those filters are present in the query. For example, a query with the filter `productType = 'shirt' AND size = 'medium'` triggers a promotion with the filter condition `productType = 'shirt'`, but not one with both `productType = 'shirt', and `size = 'small'`. | [optional] **Id** | **string** | The promotion's ID. | [optional] **Pins** | [**List<PromotionPin>**](PromotionPin.md) | The items to fix to specific positions in the search results. | [optional] **RangeBoosts** | [**List<PromotionRangeBoost>**](PromotionRangeBoost.md) | The range boosts to apply to searches, if the promotion is enabled. | [optional] diff --git a/docs/PromotionFilterCondition.md b/docs/PromotionFilterCondition.md index 4463162..078f2bc 100644 --- a/docs/PromotionFilterCondition.md +++ b/docs/PromotionFilterCondition.md @@ -1,11 +1,11 @@ # Com.Sajari.Sdk.Model.PromotionFilterCondition -A set of filters of the form `field = 'value'`. Matches a query if the set of filters in the condition matches exactly the set of filters associated with it. +A set of filters of the form `field = 'value'`. Matches a query if all filters are present in that query. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Filter** | **List<string>** | A filter of the form `field = 'value'`. | [optional] +**Filter** | **List<string>** | A filter of the form `field = 'value'`. All of these filters must be present in a query's filter in order for the promotion to be considered active. | [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/PromotionsApi.md b/docs/PromotionsApi.md index 205540d..7374011 100644 --- a/docs/PromotionsApi.md +++ b/docs/PromotionsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **CreatePromotion** -> Promotion CreatePromotion (string collectionId, Promotion promotion) +> Promotion CreatePromotion (string collectionId, Promotion promotion, string accountId = null) Create promotion @@ -42,11 +42,12 @@ namespace Example var apiInstance = new PromotionsApi(config); var collectionId = "collectionId_example"; // string | The collection to create a promotion in, e.g. `my-collection`. var promotion = new Promotion(); // Promotion | The promotion to create. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Create promotion - Promotion result = apiInstance.CreatePromotion(collectionId, promotion); + Promotion result = apiInstance.CreatePromotion(collectionId, promotion, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -66,6 +67,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection to create a promotion in, e.g. `my-collection`. | **promotion** | [**Promotion**](Promotion.md)| The promotion to create. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -95,7 +97,7 @@ Name | Type | Description | Notes # **DeletePromotion** -> Object DeletePromotion (string collectionId, string promotionId) +> Object DeletePromotion (string collectionId, string promotionId, string accountId = null) Delete promotion @@ -124,11 +126,12 @@ namespace Example var apiInstance = new PromotionsApi(config); var collectionId = "collectionId_example"; // string | The collection the promotion belongs to, e.g. `my-collection`. var promotionId = "promotionId_example"; // string | The promotion to delete, e.g. `1234`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Delete promotion - Object result = apiInstance.DeletePromotion(collectionId, promotionId); + Object result = apiInstance.DeletePromotion(collectionId, promotionId, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -148,6 +151,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection the promotion belongs to, e.g. `my-collection`. | **promotionId** | **string**| The promotion to delete, e.g. `1234`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -177,7 +181,7 @@ Name | Type | Description | Notes # **GetPromotion** -> Promotion GetPromotion (string collectionId, string promotionId) +> Promotion GetPromotion (string collectionId, string promotionId, string accountId = null) Get promotion @@ -206,11 +210,12 @@ namespace Example var apiInstance = new PromotionsApi(config); var collectionId = "collectionId_example"; // string | The collection that owns the promotion, e.g. `my-collection`. var promotionId = "promotionId_example"; // string | The promotion to retrieve, e.g. `1234`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Get promotion - Promotion result = apiInstance.GetPromotion(collectionId, promotionId); + Promotion result = apiInstance.GetPromotion(collectionId, promotionId, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -230,6 +235,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection that owns the promotion, e.g. `my-collection`. | **promotionId** | **string**| The promotion to retrieve, e.g. `1234`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -259,7 +265,7 @@ Name | Type | Description | Notes # **ListPromotions** -> ListPromotionsResponse ListPromotions (string collectionId, int? pageSize = null, string pageToken = null, string view = null) +> ListPromotionsResponse ListPromotions (string collectionId, string accountId = null, int? pageSize = null, string pageToken = null, string view = null) List promotions @@ -287,6 +293,7 @@ namespace Example var apiInstance = new PromotionsApi(config); var collectionId = "collectionId_example"; // string | The collection that owns this set of promotions, e.g. `my-collection`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) var pageSize = 56; // int? | The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) var pageToken = "pageToken_example"; // string | A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) var view = "PROMOTION_VIEW_UNSPECIFIED"; // string | The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional) (default to PROMOTION_VIEW_UNSPECIFIED) @@ -294,7 +301,7 @@ namespace Example try { // List promotions - ListPromotionsResponse result = apiInstance.ListPromotions(collectionId, pageSize, pageToken, view); + ListPromotionsResponse result = apiInstance.ListPromotions(collectionId, accountId, pageSize, pageToken, view); Debug.WriteLine(result); } catch (ApiException e) @@ -313,6 +320,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection that owns this set of promotions, e.g. `my-collection`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] **pageSize** | **int?**| The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. | [optional] **pageToken** | **string**| A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. | [optional] **view** | **string**| The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. | [optional] [default to PROMOTION_VIEW_UNSPECIFIED] @@ -345,7 +353,7 @@ Name | Type | Description | Notes # **UpdatePromotion** -> Promotion UpdatePromotion (string collectionId, string promotionId, string updateMask, Promotion promotion) +> Promotion UpdatePromotion (string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = null) Update promotion @@ -376,11 +384,12 @@ namespace Example var promotionId = "promotionId_example"; // string | The promotion to update, e.g. `1234`. var updateMask = "updateMask_example"; // string | The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. var promotion = new Promotion(); // Promotion | Details of the promotion to update. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Update promotion - Promotion result = apiInstance.UpdatePromotion(collectionId, promotionId, updateMask, promotion); + Promotion result = apiInstance.UpdatePromotion(collectionId, promotionId, updateMask, promotion, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -402,6 +411,7 @@ Name | Type | Description | Notes **promotionId** | **string**| The promotion to update, e.g. `1234`. | **updateMask** | **string**| The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. | **promotion** | [**Promotion**](Promotion.md)| Details of the promotion to update. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type diff --git a/docs/RedirectsApi.md b/docs/RedirectsApi.md index 949684c..ca7906e 100644 --- a/docs/RedirectsApi.md +++ b/docs/RedirectsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **CreateRedirect** -> Redirect CreateRedirect (string collectionId, Redirect redirect) +> Redirect CreateRedirect (string collectionId, Redirect redirect, string accountId = null) Create redirect @@ -42,11 +42,12 @@ namespace Example var apiInstance = new RedirectsApi(config); var collectionId = "collectionId_example"; // string | The collection to create a redirect in, e.g. `my-collection`. var redirect = new Redirect(); // Redirect | The redirect to create. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Create redirect - Redirect result = apiInstance.CreateRedirect(collectionId, redirect); + Redirect result = apiInstance.CreateRedirect(collectionId, redirect, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -66,6 +67,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection to create a redirect in, e.g. `my-collection`. | **redirect** | [**Redirect**](Redirect.md)| The redirect to create. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -95,7 +97,7 @@ Name | Type | Description | Notes # **DeleteRedirect** -> Object DeleteRedirect (string collectionId, string redirectId) +> Object DeleteRedirect (string collectionId, string redirectId, string accountId = null) Delete redirect @@ -124,11 +126,12 @@ namespace Example var apiInstance = new RedirectsApi(config); var collectionId = "collectionId_example"; // string | The collection the redirect belongs to, e.g. `my-collection`. var redirectId = "redirectId_example"; // string | The redirect to delete, e.g. `1234`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Delete redirect - Object result = apiInstance.DeleteRedirect(collectionId, redirectId); + Object result = apiInstance.DeleteRedirect(collectionId, redirectId, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -148,6 +151,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection the redirect belongs to, e.g. `my-collection`. | **redirectId** | **string**| The redirect to delete, e.g. `1234`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -177,7 +181,7 @@ Name | Type | Description | Notes # **GetRedirect** -> Redirect GetRedirect (string collectionId, string redirectId) +> Redirect GetRedirect (string collectionId, string redirectId, string accountId = null) Get redirect @@ -206,11 +210,12 @@ namespace Example var apiInstance = new RedirectsApi(config); var collectionId = "collectionId_example"; // string | The collection that owns the redirect, e.g. `my-collection`. var redirectId = "redirectId_example"; // string | The redirect to retrieve, e.g. `1234`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Get redirect - Redirect result = apiInstance.GetRedirect(collectionId, redirectId); + Redirect result = apiInstance.GetRedirect(collectionId, redirectId, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -230,6 +235,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection that owns the redirect, e.g. `my-collection`. | **redirectId** | **string**| The redirect to retrieve, e.g. `1234`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type @@ -259,7 +265,7 @@ Name | Type | Description | Notes # **ListRedirects** -> ListRedirectsResponse ListRedirects (string collectionId, int? pageSize = null, string pageToken = null) +> ListRedirectsResponse ListRedirects (string collectionId, string accountId = null, int? pageSize = null, string pageToken = null) List redirects @@ -287,13 +293,14 @@ namespace Example var apiInstance = new RedirectsApi(config); var collectionId = "collectionId_example"; // string | The collection that owns this set of redirects, e.g. `my-collection`. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) var pageSize = 56; // int? | The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) var pageToken = "pageToken_example"; // string | A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) try { // List redirects - ListRedirectsResponse result = apiInstance.ListRedirects(collectionId, pageSize, pageToken); + ListRedirectsResponse result = apiInstance.ListRedirects(collectionId, accountId, pageSize, pageToken); Debug.WriteLine(result); } catch (ApiException e) @@ -312,6 +319,7 @@ namespace Example Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **collectionId** | **string**| The collection that owns this set of redirects, e.g. `my-collection`. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] **pageSize** | **int?**| The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. | [optional] **pageToken** | **string**| A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. | [optional] @@ -343,7 +351,7 @@ Name | Type | Description | Notes # **UpdateRedirect** -> Redirect UpdateRedirect (string collectionId, string redirectId, string updateMask, Redirect redirect) +> Redirect UpdateRedirect (string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = null) Update redirect @@ -374,11 +382,12 @@ namespace Example var redirectId = "redirectId_example"; // string | The redirect to update, e.g. `1234`. var updateMask = "updateMask_example"; // string | The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. var redirect = new Redirect(); // Redirect | Details of the redirect to update. + var accountId = "accountId_example"; // string | The account that owns the collection, e.g. `1618535966441231024`. (optional) try { // Update redirect - Redirect result = apiInstance.UpdateRedirect(collectionId, redirectId, updateMask, redirect); + Redirect result = apiInstance.UpdateRedirect(collectionId, redirectId, updateMask, redirect, accountId); Debug.WriteLine(result); } catch (ApiException e) @@ -400,6 +409,7 @@ Name | Type | Description | Notes **redirectId** | **string**| The redirect to update, e.g. `1234`. | **updateMask** | **string**| The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. | **redirect** | [**Redirect**](Redirect.md)| Details of the redirect to update. | + **accountId** | **string**| The account that owns the collection, e.g. `1618535966441231024`. | [optional] ### Return type diff --git a/docs/SchemaApi.md b/docs/SchemaApi.md index 99daf9c..3761f88 100644 --- a/docs/SchemaApi.md +++ b/docs/SchemaApi.md @@ -6,7 +6,9 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**BatchCreateSchemaFields**](SchemaApi.md#batchcreateschemafields) | **POST** /v4/collections/{collection_id}/schemaFields:batchCreate | Batch create schema fields [**CreateSchemaField**](SchemaApi.md#createschemafield) | **POST** /v4/collections/{collection_id}/schemaFields | Create schema field +[**DeleteSchemaField**](SchemaApi.md#deleteschemafield) | **DELETE** /v4/collections/{collection_id}/schemaFields/{schema_field_name} | Delete schema field [**ListSchemaFields**](SchemaApi.md#listschemafields) | **GET** /v4/collections/{collection_id}/schemaFields | List schema fields +[**UpdateSchemaField**](SchemaApi.md#updateschemafield) | **PATCH** /v4/collections/{collection_id}/schemaFields/{schema_field_name} | Update schema field @@ -161,6 +163,88 @@ Name | Type | Description | Notes - **Accept**: application/json +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A successful response. | - | +| **401** | Returned when the request does not have valid authentication credentials. | - | +| **403** | Returned when the user does not have permission to access the resource. | - | +| **404** | Returned when the resource does not exist. | - | +| **500** | Returned when the API encounters an internal error. | - | +| **0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **DeleteSchemaField** +> Object DeleteSchemaField (string collectionId, string schemaFieldName) + +Delete schema field + +Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using Com.Sajari.Sdk.Api; +using Com.Sajari.Sdk.Client; +using Com.Sajari.Sdk.Model; + +namespace Example +{ + public class DeleteSchemaFieldExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.search.io"; + // Configure HTTP basic authorization: BasicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new SchemaApi(config); + var collectionId = "collectionId_example"; // string | The collection the schema field belongs to, e.g. `my-collection`. + var schemaFieldName = "schemaFieldName_example"; // string | The name of the schema field to delete. + + try + { + // Delete schema field + Object result = apiInstance.DeleteSchemaField(collectionId, schemaFieldName); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling SchemaApi.DeleteSchemaField: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collectionId** | **string**| The collection the schema field belongs to, e.g. `my-collection`. | + **schemaFieldName** | **string**| The name of the schema field to delete. | + +### Return type + +**Object** + +### Authorization + +[BasicAuth](../README.md#BasicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -257,3 +341,89 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **UpdateSchemaField** +> SchemaField UpdateSchemaField (string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = null) + +Update schema field + +Update the details of a schema field. Only `name` and `description` can be updated. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using Com.Sajari.Sdk.Api; +using Com.Sajari.Sdk.Client; +using Com.Sajari.Sdk.Model; + +namespace Example +{ + public class UpdateSchemaFieldExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.search.io"; + // Configure HTTP basic authorization: BasicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new SchemaApi(config); + var collectionId = "collectionId_example"; // string | The collection the schema field belongs to, e.g. `my-collection`. + var schemaFieldName = "schemaFieldName_example"; // string | The name of the schema field to update. + var schemaField = new SchemaField(); // SchemaField | The schema field details to update. + var updateMask = "updateMask_example"; // string | The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + + try + { + // Update schema field + SchemaField result = apiInstance.UpdateSchemaField(collectionId, schemaFieldName, schemaField, updateMask); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling SchemaApi.UpdateSchemaField: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collectionId** | **string**| The collection the schema field belongs to, e.g. `my-collection`. | + **schemaFieldName** | **string**| The name of the schema field to update. | + **schemaField** | [**SchemaField**](SchemaField.md)| The schema field details to update. | + **updateMask** | **string**| The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. | [optional] + +### Return type + +[**SchemaField**](SchemaField.md) + +### Authorization + +[BasicAuth](../README.md#BasicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A successful response. | - | +| **401** | Returned when the request does not have valid authentication credentials. | - | +| **403** | Returned when the user does not have permission to access the resource. | - | +| **404** | Returned when the resource does not exist. | - | +| **500** | Returned when the API encounters an internal error. | - | +| **0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SendEventRequest.md b/docs/SendEventRequest.md index 76086da..340d26c 100644 --- a/docs/SendEventRequest.md +++ b/docs/SendEventRequest.md @@ -6,7 +6,7 @@ A request to send an event to the ranking system after a user interacts with a s Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Metadata** | **Dictionary<string, Object>** | An object made up of field-value pairs that contains additional metadata to record with the event. Every value in the object must be one of the following primitive types: - boolean - number - string | [optional] -**Name** | **string** | The name of event, e.g. `click`, `purchase`. | +**Name** | **string** | The name of event, e.g. `click`, `redirect`, `purchase`. | **Token** | **string** | The token corresponding to the search result that was interacted with, e.g. `eyJ...`. | **Weight** | **int** | The weight assigned to the event. Generally a sensible weight is 1. If you want to weight an event in a certain way you can use a value other than 1. For example, if you want to capture profit in an event, you could set the weight to a value that represents the profit. | [optional] diff --git a/generate/Dockerfile.generate b/generate/Dockerfile.generate index f341e1d..ec76bd2 100644 --- a/generate/Dockerfile.generate +++ b/generate/Dockerfile.generate @@ -1 +1 @@ -FROM openapitools/openapi-generator-cli:latest-release +FROM openapitools/openapi-generator-cli@sha256:bc3f07ee4032923c7158b1a4a59aadd1861c6b4227c58d8ded5ee2b6c075bf72 \ No newline at end of file diff --git a/generate/generate.sh b/generate/generate.sh index 6b2889c..2c62eaa 100755 --- a/generate/generate.sh +++ b/generate/generate.sh @@ -13,7 +13,7 @@ if [ -z "$GEN_PATH" ]; then die "GEN_PATH must be set, e.g. /path/to/sajari/sdk-dotnet" fi -VERSION=5.0.0 +VERSION=5.1.0 docker-entrypoint.sh generate \ -i /openapi.json \ diff --git a/src/Com.Sajari.Sdk.Test/Model/CollectionTypeTests.cs b/src/Com.Sajari.Sdk.Test/Model/CollectionTypeTests.cs new file mode 100644 index 0000000..4b2cb9a --- /dev/null +++ b/src/Com.Sajari.Sdk.Test/Model/CollectionTypeTests.cs @@ -0,0 +1,63 @@ +/* + * Search.io API + * + * Search.io offers a search and discovery service with Neuralsearch®, the world's first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence. + * + * The version of the OpenAPI document: v4 + * Contact: support@search.io + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Com.Sajari.Sdk.Api; +using Com.Sajari.Sdk.Model; +using Com.Sajari.Sdk.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Com.Sajari.Sdk.Test.Model +{ + /// + /// Class for testing CollectionType + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the model. + /// + public class CollectionTypeTests : IDisposable + { + // TODO uncomment below to declare an instance variable for CollectionType + //private CollectionType instance; + + public CollectionTypeTests() + { + // TODO uncomment below to create an instance of CollectionType + //instance = new CollectionType(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of CollectionType + /// + [Fact] + public void CollectionTypeInstanceTest() + { + // TODO uncomment below to test "IsType" CollectionType + //Assert.IsType(instance); + } + + + + } + +} diff --git a/src/Com.Sajari.Sdk.Test/Model/GetCollectionRequestViewTests.cs b/src/Com.Sajari.Sdk.Test/Model/GetCollectionRequestViewTests.cs new file mode 100644 index 0000000..9dd8817 --- /dev/null +++ b/src/Com.Sajari.Sdk.Test/Model/GetCollectionRequestViewTests.cs @@ -0,0 +1,63 @@ +/* + * Search.io API + * + * Search.io offers a search and discovery service with Neuralsearch®, the world's first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence. + * + * The version of the OpenAPI document: v4 + * Contact: support@search.io + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Com.Sajari.Sdk.Api; +using Com.Sajari.Sdk.Model; +using Com.Sajari.Sdk.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Com.Sajari.Sdk.Test.Model +{ + /// + /// Class for testing GetCollectionRequestView + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the model. + /// + public class GetCollectionRequestViewTests : IDisposable + { + // TODO uncomment below to declare an instance variable for GetCollectionRequestView + //private GetCollectionRequestView instance; + + public GetCollectionRequestViewTests() + { + // TODO uncomment below to create an instance of GetCollectionRequestView + //instance = new GetCollectionRequestView(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of GetCollectionRequestView + /// + [Fact] + public void GetCollectionRequestViewInstanceTest() + { + // TODO uncomment below to test "IsType" GetCollectionRequestView + //Assert.IsType(instance); + } + + + + } + +} diff --git a/src/Com.Sajari.Sdk.Test/Model/ListCollectionsRequestViewTests.cs b/src/Com.Sajari.Sdk.Test/Model/ListCollectionsRequestViewTests.cs new file mode 100644 index 0000000..35cfcaf --- /dev/null +++ b/src/Com.Sajari.Sdk.Test/Model/ListCollectionsRequestViewTests.cs @@ -0,0 +1,63 @@ +/* + * Search.io API + * + * Search.io offers a search and discovery service with Neuralsearch®, the world's first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence. + * + * The version of the OpenAPI document: v4 + * Contact: support@search.io + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Com.Sajari.Sdk.Api; +using Com.Sajari.Sdk.Model; +using Com.Sajari.Sdk.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Com.Sajari.Sdk.Test.Model +{ + /// + /// Class for testing ListCollectionsRequestView + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the model. + /// + public class ListCollectionsRequestViewTests : IDisposable + { + // TODO uncomment below to declare an instance variable for ListCollectionsRequestView + //private ListCollectionsRequestView instance; + + public ListCollectionsRequestViewTests() + { + // TODO uncomment below to create an instance of ListCollectionsRequestView + //instance = new ListCollectionsRequestView(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of ListCollectionsRequestView + /// + [Fact] + public void ListCollectionsRequestViewInstanceTest() + { + // TODO uncomment below to test "IsType" ListCollectionsRequestView + //Assert.IsType(instance); + } + + + + } + +} diff --git a/src/Com.Sajari.Sdk/Api/CollectionsApi.cs b/src/Com.Sajari.Sdk/Api/CollectionsApi.cs index 87c2ca5..0185547 100644 --- a/src/Com.Sajari.Sdk/Api/CollectionsApi.cs +++ b/src/Com.Sajari.Sdk/Api/CollectionsApi.cs @@ -36,8 +36,9 @@ public interface ICollectionsApiSync : IApiAccessor /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Collection - Collection CreateCollection(string collectionId, Collection collection); + Collection CreateCollection(string collectionId, Collection collection, string accountId = default(string)); /// /// Create collection @@ -48,8 +49,9 @@ public interface ICollectionsApiSync : IApiAccessor /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Collection - ApiResponse CreateCollectionWithHttpInfo(string collectionId, Collection collection); + ApiResponse CreateCollectionWithHttpInfo(string collectionId, Collection collection, string accountId = default(string)); /// /// Delete collection /// @@ -58,8 +60,9 @@ public interface ICollectionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Object - Object DeleteCollection(string collectionId); + Object DeleteCollection(string collectionId, string accountId = default(string)); /// /// Delete collection @@ -69,8 +72,9 @@ public interface ICollectionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Object - ApiResponse DeleteCollectionWithHttpInfo(string collectionId); + ApiResponse DeleteCollectionWithHttpInfo(string collectionId, string accountId = default(string)); /// /// Experiment /// @@ -102,8 +106,10 @@ public interface ICollectionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Collection - Collection GetCollection(string collectionId); + Collection GetCollection(string collectionId, string accountId = default(string), string view = default(string)); /// /// Get collection @@ -113,8 +119,10 @@ public interface ICollectionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of Collection - ApiResponse GetCollectionWithHttpInfo(string collectionId); + ApiResponse GetCollectionWithHttpInfo(string collectionId, string accountId = default(string), string view = default(string)); /// /// List collections /// @@ -122,10 +130,12 @@ public interface ICollectionsApiSync : IApiAccessor /// Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// ListCollectionsResponse - ListCollectionsResponse ListCollections(int? pageSize = default(int?), string pageToken = default(string)); + ListCollectionsResponse ListCollections(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); /// /// List collections @@ -134,10 +144,12 @@ public interface ICollectionsApiSync : IApiAccessor /// Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of ListCollectionsResponse - ApiResponse ListCollectionsWithHttpInfo(int? pageSize = default(int?), string pageToken = default(string)); + ApiResponse ListCollectionsWithHttpInfo(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); /// /// Query collection /// @@ -192,7 +204,7 @@ public interface ICollectionsApiSync : IApiAccessor /// Track event /// /// - /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -205,7 +217,7 @@ public interface ICollectionsApiSync : IApiAccessor /// Track event /// /// - /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -222,9 +234,10 @@ public interface ICollectionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// Collection - Collection UpdateCollection(string collectionId, Collection collection, string updateMask = default(string)); + Collection UpdateCollection(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string)); /// /// Update collection @@ -235,9 +248,10 @@ public interface ICollectionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// ApiResponse of Collection - ApiResponse UpdateCollectionWithHttpInfo(string collectionId, Collection collection, string updateMask = default(string)); + ApiResponse UpdateCollectionWithHttpInfo(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string)); #endregion Synchronous Operations } @@ -256,9 +270,10 @@ public interface ICollectionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Collection - System.Threading.Tasks.Task CreateCollectionAsync(string collectionId, Collection collection, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateCollectionAsync(string collectionId, Collection collection, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Create collection @@ -269,9 +284,10 @@ public interface ICollectionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Collection) - System.Threading.Tasks.Task> CreateCollectionWithHttpInfoAsync(string collectionId, Collection collection, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateCollectionWithHttpInfoAsync(string collectionId, Collection collection, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Delete collection /// @@ -280,9 +296,10 @@ public interface ICollectionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Object - System.Threading.Tasks.Task DeleteCollectionAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task DeleteCollectionAsync(string collectionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Delete collection @@ -292,9 +309,10 @@ public interface ICollectionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Object) - System.Threading.Tasks.Task> DeleteCollectionWithHttpInfoAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> DeleteCollectionWithHttpInfoAsync(string collectionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Experiment /// @@ -328,9 +346,11 @@ public interface ICollectionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of Collection - System.Threading.Tasks.Task GetCollectionAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task GetCollectionAsync(string collectionId, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get collection @@ -340,9 +360,11 @@ public interface ICollectionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Collection) - System.Threading.Tasks.Task> GetCollectionWithHttpInfoAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> GetCollectionWithHttpInfoAsync(string collectionId, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List collections /// @@ -350,11 +372,13 @@ public interface ICollectionsApiAsync : IApiAccessor /// Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ListCollectionsResponse - System.Threading.Tasks.Task ListCollectionsAsync(int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task ListCollectionsAsync(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List collections @@ -363,11 +387,13 @@ public interface ICollectionsApiAsync : IApiAccessor /// Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListCollectionsResponse) - System.Threading.Tasks.Task> ListCollectionsWithHttpInfoAsync(int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ListCollectionsWithHttpInfoAsync(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Query collection /// @@ -426,7 +452,7 @@ public interface ICollectionsApiAsync : IApiAccessor /// Track event /// /// - /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -440,7 +466,7 @@ public interface ICollectionsApiAsync : IApiAccessor /// Track event /// /// - /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -458,10 +484,11 @@ public interface ICollectionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// Cancellation Token to cancel the request. /// Task of Collection - System.Threading.Tasks.Task UpdateCollectionAsync(string collectionId, Collection collection, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCollectionAsync(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Update collection @@ -472,10 +499,11 @@ public interface ICollectionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Collection) - System.Threading.Tasks.Task> UpdateCollectionWithHttpInfoAsync(string collectionId, Collection collection, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCollectionWithHttpInfoAsync(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -602,10 +630,11 @@ public Com.Sajari.Sdk.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Collection - public Collection CreateCollection(string collectionId, Collection collection) + public Collection CreateCollection(string collectionId, Collection collection, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreateCollectionWithHttpInfo(collectionId, collection); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreateCollectionWithHttpInfo(collectionId, collection, accountId); return localVarResponse.Data; } @@ -615,8 +644,9 @@ public Collection CreateCollection(string collectionId, Collection collection) /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Collection - public Com.Sajari.Sdk.Client.ApiResponse CreateCollectionWithHttpInfo(string collectionId, Collection collection) + public Com.Sajari.Sdk.Client.ApiResponse CreateCollectionWithHttpInfo(string collectionId, Collection collection, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -654,6 +684,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateCollectionWithHttpInf } localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "collection_id", collectionId)); + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = collection; // authentication (BasicAuth) required @@ -683,11 +717,12 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateCollectionWithHttpInf /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Collection - public async System.Threading.Tasks.Task CreateCollectionAsync(string collectionId, Collection collection, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateCollectionAsync(string collectionId, Collection collection, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreateCollectionWithHttpInfoAsync(collectionId, collection, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreateCollectionWithHttpInfoAsync(collectionId, collection, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -697,9 +732,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateCollectionWithHttpInf /// Thrown when fails to make API call /// 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\\-]*$`. /// Details of the collection to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Collection) - public async System.Threading.Tasks.Task> CreateCollectionWithHttpInfoAsync(string collectionId, Collection collection, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateCollectionWithHttpInfoAsync(string collectionId, Collection collection, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -738,6 +774,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateCollectionWithHttpInf } localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "collection_id", collectionId)); + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = collection; // authentication (BasicAuth) required @@ -767,10 +807,11 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateCollectionWithHttpInf /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Object - public Object DeleteCollection(string collectionId) + public Object DeleteCollection(string collectionId, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = DeleteCollectionWithHttpInfo(collectionId); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = DeleteCollectionWithHttpInfo(collectionId, accountId); return localVarResponse.Data; } @@ -779,8 +820,9 @@ public Object DeleteCollection(string collectionId) /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Object - public Com.Sajari.Sdk.Client.ApiResponse DeleteCollectionWithHttpInfo(string collectionId) + public Com.Sajari.Sdk.Client.ApiResponse DeleteCollectionWithHttpInfo(string collectionId, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -811,6 +853,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteCollectionWithHttpInfo(st } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -838,11 +884,12 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteCollectionWithHttpInfo(st /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Object - public async System.Threading.Tasks.Task DeleteCollectionAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task DeleteCollectionAsync(string collectionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await DeleteCollectionWithHttpInfoAsync(collectionId, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await DeleteCollectionWithHttpInfoAsync(collectionId, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -851,9 +898,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteCollectionWithHttpInfo(st /// /// Thrown when fails to make API call /// The collection to delete, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Object) - public async System.Threading.Tasks.Task> DeleteCollectionWithHttpInfoAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> DeleteCollectionWithHttpInfoAsync(string collectionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -885,6 +933,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteCollectionWithHttpInfo(st } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1079,10 +1131,12 @@ public Com.Sajari.Sdk.Client.ApiResponse ExperimentWithHttpI /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Collection - public Collection GetCollection(string collectionId) + public Collection GetCollection(string collectionId, string accountId = default(string), string view = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetCollectionWithHttpInfo(collectionId); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetCollectionWithHttpInfo(collectionId, accountId, view); return localVarResponse.Data; } @@ -1091,8 +1145,10 @@ public Collection GetCollection(string collectionId) /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of Collection - public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(string collectionId) + public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(string collectionId, string accountId = default(string), string view = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1123,6 +1179,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (view != null) + { + localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); + } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1150,11 +1214,13 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of Collection - public async System.Threading.Tasks.Task GetCollectionAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task GetCollectionAsync(string collectionId, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetCollectionWithHttpInfoAsync(collectionId, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetCollectionWithHttpInfoAsync(collectionId, accountId, view, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1163,9 +1229,11 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s /// /// Thrown when fails to make API call /// The collection to retrieve, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) + /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Collection) - public async System.Threading.Tasks.Task> GetCollectionWithHttpInfoAsync(string collectionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> GetCollectionWithHttpInfoAsync(string collectionId, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1197,6 +1265,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (view != null) + { + localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); + } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1224,12 +1300,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s /// List collections Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// ListCollectionsResponse - public ListCollectionsResponse ListCollections(int? pageSize = default(int?), string pageToken = default(string)) + public ListCollectionsResponse ListCollections(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListCollectionsWithHttpInfo(pageSize, pageToken); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListCollectionsWithHttpInfo(accountId, pageSize, pageToken, view); return localVarResponse.Data; } @@ -1237,10 +1315,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s /// List collections Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of ListCollectionsResponse - public Com.Sajari.Sdk.Client.ApiResponse ListCollectionsWithHttpInfo(int? pageSize = default(int?), string pageToken = default(string)) + public Com.Sajari.Sdk.Client.ApiResponse ListCollectionsWithHttpInfo(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) { Com.Sajari.Sdk.Client.RequestOptions localVarRequestOptions = new Com.Sajari.Sdk.Client.RequestOptions(); @@ -1272,6 +1352,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "page_token", pageToken)); } + if (view != null) + { + localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); + } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1298,13 +1386,15 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s /// List collections Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ListCollectionsResponse - public async System.Threading.Tasks.Task ListCollectionsAsync(int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ListCollectionsAsync(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListCollectionsWithHttpInfoAsync(pageSize, pageToken, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListCollectionsWithHttpInfoAsync(accountId, pageSize, pageToken, view, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1312,11 +1402,13 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s /// List collections Retrieve a list of collections in an account. /// /// Thrown when fails to make API call + /// The account that owns this set of collections, e.g. `1618535966441231024`. (optional) /// The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100. (optional) /// A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token. (optional) + /// The amount of information to include in each retrieved collection. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListCollectionsResponse) - public async System.Threading.Tasks.Task> ListCollectionsWithHttpInfoAsync(int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ListCollectionsWithHttpInfoAsync(string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { Com.Sajari.Sdk.Client.RequestOptions localVarRequestOptions = new Com.Sajari.Sdk.Client.RequestOptions(); @@ -1349,6 +1441,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetCollectionWithHttpInfo(s { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "page_token", pageToken)); } + if (view != null) + { + localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); + } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1721,7 +1821,7 @@ public Com.Sajari.Sdk.Client.ApiResponse QueryCollectio } /// - /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -1735,7 +1835,7 @@ public Object TrackEvent(string accountId, string collectionId, Event _event) } /// - /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -1811,7 +1911,7 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a } /// - /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -1826,7 +1926,7 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a } /// - /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header. + /// Track event Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -1910,11 +2010,12 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// Collection - public Collection UpdateCollection(string collectionId, Collection collection, string updateMask = default(string)) + public Collection UpdateCollection(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = UpdateCollectionWithHttpInfo(collectionId, collection, updateMask); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = UpdateCollectionWithHttpInfo(collectionId, collection, accountId, updateMask); return localVarResponse.Data; } @@ -1924,9 +2025,10 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// ApiResponse of Collection - public Com.Sajari.Sdk.Client.ApiResponse UpdateCollectionWithHttpInfo(string collectionId, Collection collection, string updateMask = default(string)) + public Com.Sajari.Sdk.Client.ApiResponse UpdateCollectionWithHttpInfo(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1968,6 +2070,10 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = collection; // authentication (BasicAuth) required @@ -1997,12 +2103,13 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// Cancellation Token to cancel the request. /// Task of Collection - public async System.Threading.Tasks.Task UpdateCollectionAsync(string collectionId, Collection collection, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCollectionAsync(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await UpdateCollectionWithHttpInfoAsync(collectionId, collection, updateMask, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await UpdateCollectionWithHttpInfoAsync(collectionId, collection, accountId, updateMask, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -2012,10 +2119,11 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a /// Thrown when fails to make API call /// The collection to update, e.g. `my-collection`. /// The details of the collection to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Collection) - public async System.Threading.Tasks.Task> UpdateCollectionWithHttpInfoAsync(string collectionId, Collection collection, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCollectionWithHttpInfoAsync(string collectionId, Collection collection, string accountId = default(string), string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -2058,6 +2166,10 @@ public Com.Sajari.Sdk.Client.ApiResponse TrackEventWithHttpInfo(string a { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = collection; // authentication (BasicAuth) required diff --git a/src/Com.Sajari.Sdk/Api/EventsApi.cs b/src/Com.Sajari.Sdk/Api/EventsApi.cs index 0f8bdf8..2387aad 100644 --- a/src/Com.Sajari.Sdk/Api/EventsApi.cs +++ b/src/Com.Sajari.Sdk/Api/EventsApi.cs @@ -31,7 +31,7 @@ public interface IEventsApiSync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -43,7 +43,7 @@ public interface IEventsApiSync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -54,7 +54,7 @@ public interface IEventsApiSync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// @@ -66,7 +66,7 @@ public interface IEventsApiSync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// @@ -86,7 +86,7 @@ public interface IEventsApiAsync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -99,7 +99,7 @@ public interface IEventsApiAsync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -111,7 +111,7 @@ public interface IEventsApiAsync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// @@ -124,7 +124,7 @@ public interface IEventsApiAsync : IApiAccessor /// Send event /// /// - /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// @@ -253,7 +253,7 @@ public Com.Sajari.Sdk.Client.ExceptionFactory ExceptionFactory } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -266,7 +266,7 @@ public Object SendEvent(string accountId, SendEventRequest sendEventRequest) } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -334,7 +334,7 @@ public Com.Sajari.Sdk.Client.ApiResponse SendEventWithHttpInfo(string ac } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -348,7 +348,7 @@ public Com.Sajari.Sdk.Client.ApiResponse SendEventWithHttpInfo(string ac } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// The account that owns the collection, e.g. `1618535966441231024`. @@ -419,7 +419,7 @@ public Com.Sajari.Sdk.Client.ApiResponse SendEventWithHttpInfo(string ac } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// @@ -432,7 +432,7 @@ public Object SendEvent2(SendEventRequest sendEventRequest) } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// @@ -493,7 +493,7 @@ public Com.Sajari.Sdk.Client.ApiResponse SendEvent2WithHttpInfo(SendEven } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// @@ -507,7 +507,7 @@ public Com.Sajari.Sdk.Client.ApiResponse SendEvent2WithHttpInfo(SendEven } /// - /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` Note: You must pass an `Account-Id` header. + /// Send event Send an event to the ranking system after a user interacts with a search result. When querying a collection, you can set the tracking type of the query request. When it is `CLICK` or `POS_NEG`, a token is generated for each result in the query response. You can use this token to provide feedback to the ranking system. Each time you want to record an event on a particular search result, use the send event call and provide: - The `name` of the event, e.g. `click`, `redirect`, `purchase`. - The `token` from the search result. - The `weight` to assign to the event, e.g. `1`. - An object containing any additional `metadata`. For example, to send an event where a customer purchased a product, use the following call: ```json { \"name\": \"purchase\", \"token\": \"eyJ...\", \"weight\": 1, \"metadata\": { \"discount\": 0.2, \"margin\": 30.0, \"customer_id\": \"12345\", \"ui_test_segment\": \"A\" } } ``` When sending event tokens returned from redirects, set `name` to `redirect`. Note: You must pass an `Account-Id` header. /// /// Thrown when fails to make API call /// diff --git a/src/Com.Sajari.Sdk/Api/PipelinesApi.cs b/src/Com.Sajari.Sdk/Api/PipelinesApi.cs index 224220b..29ddf38 100644 --- a/src/Com.Sajari.Sdk/Api/PipelinesApi.cs +++ b/src/Com.Sajari.Sdk/Api/PipelinesApi.cs @@ -36,8 +36,9 @@ public interface IPipelinesApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Pipeline - Pipeline CreatePipeline(string collectionId, Pipeline pipeline); + Pipeline CreatePipeline(string collectionId, Pipeline pipeline, string accountId = default(string)); /// /// Create pipeline @@ -48,8 +49,9 @@ public interface IPipelinesApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Pipeline - ApiResponse CreatePipelineWithHttpInfo(string collectionId, Pipeline pipeline); + ApiResponse CreatePipelineWithHttpInfo(string collectionId, Pipeline pipeline, string accountId = default(string)); /// /// Generate pipelines /// @@ -106,9 +108,10 @@ public interface IPipelinesApiSync : IApiAccessor /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Pipeline - Pipeline GetDefaultVersion(string collectionId, string type, string name, string view = default(string)); + Pipeline GetDefaultVersion(string collectionId, string type, string name, string accountId = default(string), string view = default(string)); /// /// Get default pipeline version @@ -120,9 +123,10 @@ public interface IPipelinesApiSync : IApiAccessor /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of Pipeline - ApiResponse GetDefaultVersionWithHttpInfo(string collectionId, string type, string name, string view = default(string)); + ApiResponse GetDefaultVersionWithHttpInfo(string collectionId, string type, string name, string accountId = default(string), string view = default(string)); /// /// Get pipeline /// @@ -134,9 +138,10 @@ public interface IPipelinesApiSync : IApiAccessor /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Pipeline - Pipeline GetPipeline(string collectionId, string type, string name, string version, string view = default(string)); + Pipeline GetPipeline(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string)); /// /// Get pipeline @@ -149,9 +154,10 @@ public interface IPipelinesApiSync : IApiAccessor /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of Pipeline - ApiResponse GetPipelineWithHttpInfo(string collectionId, string type, string name, string version, string view = default(string)); + ApiResponse GetPipelineWithHttpInfo(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string)); /// /// List pipelines /// @@ -160,11 +166,12 @@ public interface IPipelinesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ListPipelinesResponse - ListPipelinesResponse ListPipelines(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); + ListPipelinesResponse ListPipelines(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); /// /// List pipelines @@ -174,11 +181,12 @@ public interface IPipelinesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of ListPipelinesResponse - ApiResponse ListPipelinesWithHttpInfo(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); + ApiResponse ListPipelinesWithHttpInfo(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); /// /// Set default pipeline /// @@ -247,9 +255,10 @@ public interface IPipelinesApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Pipeline - System.Threading.Tasks.Task CreatePipelineAsync(string collectionId, Pipeline pipeline, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreatePipelineAsync(string collectionId, Pipeline pipeline, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Create pipeline @@ -260,9 +269,10 @@ public interface IPipelinesApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Pipeline) - System.Threading.Tasks.Task> CreatePipelineWithHttpInfoAsync(string collectionId, Pipeline pipeline, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreatePipelineWithHttpInfoAsync(string collectionId, Pipeline pipeline, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Generate pipelines /// @@ -323,10 +333,11 @@ public interface IPipelinesApiAsync : IApiAccessor /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of Pipeline - System.Threading.Tasks.Task GetDefaultVersionAsync(string collectionId, string type, string name, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task GetDefaultVersionAsync(string collectionId, string type, string name, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get default pipeline version @@ -338,10 +349,11 @@ public interface IPipelinesApiAsync : IApiAccessor /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Pipeline) - System.Threading.Tasks.Task> GetDefaultVersionWithHttpInfoAsync(string collectionId, string type, string name, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> GetDefaultVersionWithHttpInfoAsync(string collectionId, string type, string name, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get pipeline /// @@ -353,10 +365,11 @@ public interface IPipelinesApiAsync : IApiAccessor /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of Pipeline - System.Threading.Tasks.Task GetPipelineAsync(string collectionId, string type, string name, string version, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task GetPipelineAsync(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get pipeline @@ -369,10 +382,11 @@ public interface IPipelinesApiAsync : IApiAccessor /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Pipeline) - System.Threading.Tasks.Task> GetPipelineWithHttpInfoAsync(string collectionId, string type, string name, string version, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> GetPipelineWithHttpInfoAsync(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List pipelines /// @@ -381,12 +395,13 @@ public interface IPipelinesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ListPipelinesResponse - System.Threading.Tasks.Task ListPipelinesAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task ListPipelinesAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List pipelines @@ -396,12 +411,13 @@ public interface IPipelinesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListPipelinesResponse) - System.Threading.Tasks.Task> ListPipelinesWithHttpInfoAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ListPipelinesWithHttpInfoAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Set default pipeline /// @@ -582,10 +598,11 @@ public Com.Sajari.Sdk.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Pipeline - public Pipeline CreatePipeline(string collectionId, Pipeline pipeline) + public Pipeline CreatePipeline(string collectionId, Pipeline pipeline, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreatePipelineWithHttpInfo(collectionId, pipeline); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreatePipelineWithHttpInfo(collectionId, pipeline, accountId); return localVarResponse.Data; } @@ -595,8 +612,9 @@ public Pipeline CreatePipeline(string collectionId, Pipeline pipeline) /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Pipeline - public Com.Sajari.Sdk.Client.ApiResponse CreatePipelineWithHttpInfo(string collectionId, Pipeline pipeline) + public Com.Sajari.Sdk.Client.ApiResponse CreatePipelineWithHttpInfo(string collectionId, Pipeline pipeline, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -636,6 +654,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePipelineWithHttpInfo(st } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = pipeline; // authentication (BasicAuth) required @@ -665,11 +687,12 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePipelineWithHttpInfo(st /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Pipeline - public async System.Threading.Tasks.Task CreatePipelineAsync(string collectionId, Pipeline pipeline, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreatePipelineAsync(string collectionId, Pipeline pipeline, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreatePipelineWithHttpInfoAsync(collectionId, pipeline, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreatePipelineWithHttpInfoAsync(collectionId, pipeline, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -679,9 +702,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePipelineWithHttpInfo(st /// Thrown when fails to make API call /// The collection to create the pipeline in, e.g. `my-collection`. /// The pipeline to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Pipeline) - public async System.Threading.Tasks.Task> CreatePipelineWithHttpInfoAsync(string collectionId, Pipeline pipeline, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreatePipelineWithHttpInfoAsync(string collectionId, Pipeline pipeline, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -722,6 +746,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePipelineWithHttpInfo(st } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = pipeline; // authentication (BasicAuth) required @@ -1085,11 +1113,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Pipeline - public Pipeline GetDefaultVersion(string collectionId, string type, string name, string view = default(string)) + public Pipeline GetDefaultVersion(string collectionId, string type, string name, string accountId = default(string), string view = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetDefaultVersionWithHttpInfo(collectionId, type, name, view); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetDefaultVersionWithHttpInfo(collectionId, type, name, accountId, view); return localVarResponse.Data; } @@ -1100,9 +1129,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of Pipeline - public Com.Sajari.Sdk.Client.ApiResponse GetDefaultVersionWithHttpInfo(string collectionId, string type, string name, string view = default(string)) + public Com.Sajari.Sdk.Client.ApiResponse GetDefaultVersionWithHttpInfo(string collectionId, string type, string name, string accountId = default(string), string view = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1152,6 +1182,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1181,12 +1215,13 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of Pipeline - public async System.Threading.Tasks.Task GetDefaultVersionAsync(string collectionId, string type, string name, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task GetDefaultVersionAsync(string collectionId, string type, string name, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetDefaultVersionWithHttpInfoAsync(collectionId, type, name, view, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetDefaultVersionWithHttpInfoAsync(collectionId, type, name, accountId, view, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1197,10 +1232,11 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The collection that owns the pipeline to get the default version of, e.g. `my-collection`. /// The type of the pipeline to get the default version of. /// The name of the pipeline to get the default version of, e.g. `my-pipeline`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Pipeline) - public async System.Threading.Tasks.Task> GetDefaultVersionWithHttpInfoAsync(string collectionId, string type, string name, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> GetDefaultVersionWithHttpInfoAsync(string collectionId, string type, string name, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1251,6 +1287,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1282,11 +1322,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Pipeline - public Pipeline GetPipeline(string collectionId, string type, string name, string version, string view = default(string)) + public Pipeline GetPipeline(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetPipelineWithHttpInfo(collectionId, type, name, version, view); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetPipelineWithHttpInfo(collectionId, type, name, version, accountId, view); return localVarResponse.Data; } @@ -1298,9 +1339,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of Pipeline - public Com.Sajari.Sdk.Client.ApiResponse GetPipelineWithHttpInfo(string collectionId, string type, string name, string version, string view = default(string)) + public Com.Sajari.Sdk.Client.ApiResponse GetPipelineWithHttpInfo(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1357,6 +1399,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1387,12 +1433,13 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of Pipeline - public async System.Threading.Tasks.Task GetPipelineAsync(string collectionId, string type, string name, string version, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task GetPipelineAsync(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetPipelineWithHttpInfoAsync(collectionId, type, name, version, view, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetPipelineWithHttpInfoAsync(collectionId, type, name, version, accountId, view, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1404,10 +1451,11 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// The type of the pipeline to retrieve. /// The name of the pipeline to retrieve, e.g. `my-pipeline`. /// The version of the pipeline to retrieve, e.g. `42`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The amount of information to include in the retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Pipeline) - public async System.Threading.Tasks.Task> GetPipelineWithHttpInfoAsync(string collectionId, string type, string name, string version, string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> GetPipelineWithHttpInfoAsync(string collectionId, string type, string name, string version, string accountId = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1465,6 +1513,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1493,13 +1545,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ListPipelinesResponse - public ListPipelinesResponse ListPipelines(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) + public ListPipelinesResponse ListPipelines(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListPipelinesWithHttpInfo(collectionId, pageSize, pageToken, view); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListPipelinesWithHttpInfo(collectionId, accountId, pageSize, pageToken, view); return localVarResponse.Data; } @@ -1508,11 +1561,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// ApiResponse of ListPipelinesResponse - public Com.Sajari.Sdk.Client.ApiResponse ListPipelinesWithHttpInfo(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) + public Com.Sajari.Sdk.Client.ApiResponse ListPipelinesWithHttpInfo(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1555,6 +1609,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1582,14 +1640,15 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ListPipelinesResponse - public async System.Threading.Tasks.Task ListPipelinesAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ListPipelinesAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListPipelinesWithHttpInfoAsync(collectionId, pageSize, pageToken, view, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListPipelinesWithHttpInfoAsync(collectionId, accountId, pageSize, pageToken, view, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1598,12 +1657,13 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP /// /// Thrown when fails to make API call /// The collection that owns this set of pipelines, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPipelines](/docs/api#operation/ListPipelines) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPipelines](/docs/api#operation/ListPipelines) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved pipeline. - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including type, name, version and description but not the full step configuration. This is the default value (for both [ListPipelines](/docs/api#operation/ListPipelines) and [GetPipeline](/docs/api#operation/GetPipeline)). - FULL: Include the information from `BASIC`, plus full step configuration. (optional, default to VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListPipelinesResponse) - public async System.Threading.Tasks.Task> ListPipelinesWithHttpInfoAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ListPipelinesWithHttpInfoAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1647,6 +1707,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetDefaultP { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required diff --git a/src/Com.Sajari.Sdk/Api/PromotionsApi.cs b/src/Com.Sajari.Sdk/Api/PromotionsApi.cs index e222e50..b4a368c 100644 --- a/src/Com.Sajari.Sdk/Api/PromotionsApi.cs +++ b/src/Com.Sajari.Sdk/Api/PromotionsApi.cs @@ -36,8 +36,9 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Promotion - Promotion CreatePromotion(string collectionId, Promotion promotion); + Promotion CreatePromotion(string collectionId, Promotion promotion, string accountId = default(string)); /// /// Create promotion @@ -48,8 +49,9 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Promotion - ApiResponse CreatePromotionWithHttpInfo(string collectionId, Promotion promotion); + ApiResponse CreatePromotionWithHttpInfo(string collectionId, Promotion promotion, string accountId = default(string)); /// /// Delete promotion /// @@ -59,8 +61,9 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Object - Object DeletePromotion(string collectionId, string promotionId); + Object DeletePromotion(string collectionId, string promotionId, string accountId = default(string)); /// /// Delete promotion @@ -71,8 +74,9 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Object - ApiResponse DeletePromotionWithHttpInfo(string collectionId, string promotionId); + ApiResponse DeletePromotionWithHttpInfo(string collectionId, string promotionId, string accountId = default(string)); /// /// Get promotion /// @@ -82,8 +86,9 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Promotion - Promotion GetPromotion(string collectionId, string promotionId); + Promotion GetPromotion(string collectionId, string promotionId, string accountId = default(string)); /// /// Get promotion @@ -94,8 +99,9 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Promotion - ApiResponse GetPromotionWithHttpInfo(string collectionId, string promotionId); + ApiResponse GetPromotionWithHttpInfo(string collectionId, string promotionId, string accountId = default(string)); /// /// List promotions /// @@ -104,11 +110,12 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// ListPromotionsResponse - ListPromotionsResponse ListPromotions(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); + ListPromotionsResponse ListPromotions(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); /// /// List promotions @@ -118,11 +125,12 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// ApiResponse of ListPromotionsResponse - ApiResponse ListPromotionsWithHttpInfo(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); + ApiResponse ListPromotionsWithHttpInfo(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)); /// /// Update promotion /// @@ -134,8 +142,9 @@ public interface IPromotionsApiSync : IApiAccessor /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Promotion - Promotion UpdatePromotion(string collectionId, string promotionId, string updateMask, Promotion promotion); + Promotion UpdatePromotion(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string)); /// /// Update promotion @@ -148,8 +157,9 @@ public interface IPromotionsApiSync : IApiAccessor /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Promotion - ApiResponse UpdatePromotionWithHttpInfo(string collectionId, string promotionId, string updateMask, Promotion promotion); + ApiResponse UpdatePromotionWithHttpInfo(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string)); #endregion Synchronous Operations } @@ -168,9 +178,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Promotion - System.Threading.Tasks.Task CreatePromotionAsync(string collectionId, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreatePromotionAsync(string collectionId, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Create promotion @@ -181,9 +192,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Promotion) - System.Threading.Tasks.Task> CreatePromotionWithHttpInfoAsync(string collectionId, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreatePromotionWithHttpInfoAsync(string collectionId, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Delete promotion /// @@ -193,9 +205,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Object - System.Threading.Tasks.Task DeletePromotionAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task DeletePromotionAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Delete promotion @@ -206,9 +219,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Object) - System.Threading.Tasks.Task> DeletePromotionWithHttpInfoAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> DeletePromotionWithHttpInfoAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get promotion /// @@ -218,9 +232,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Promotion - System.Threading.Tasks.Task GetPromotionAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task GetPromotionAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get promotion @@ -231,9 +246,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Promotion) - System.Threading.Tasks.Task> GetPromotionWithHttpInfoAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> GetPromotionWithHttpInfoAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List promotions /// @@ -242,12 +258,13 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ListPromotionsResponse - System.Threading.Tasks.Task ListPromotionsAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task ListPromotionsAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List promotions @@ -257,12 +274,13 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListPromotionsResponse) - System.Threading.Tasks.Task> ListPromotionsWithHttpInfoAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ListPromotionsWithHttpInfoAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Update promotion /// @@ -274,9 +292,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Promotion - System.Threading.Tasks.Task UpdatePromotionAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdatePromotionAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Update promotion @@ -289,9 +308,10 @@ public interface IPromotionsApiAsync : IApiAccessor /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Promotion) - System.Threading.Tasks.Task> UpdatePromotionWithHttpInfoAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdatePromotionWithHttpInfoAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -418,10 +438,11 @@ public Com.Sajari.Sdk.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Promotion - public Promotion CreatePromotion(string collectionId, Promotion promotion) + public Promotion CreatePromotion(string collectionId, Promotion promotion, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreatePromotionWithHttpInfo(collectionId, promotion); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreatePromotionWithHttpInfo(collectionId, promotion, accountId); return localVarResponse.Data; } @@ -431,8 +452,9 @@ public Promotion CreatePromotion(string collectionId, Promotion promotion) /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Promotion - public Com.Sajari.Sdk.Client.ApiResponse CreatePromotionWithHttpInfo(string collectionId, Promotion promotion) + public Com.Sajari.Sdk.Client.ApiResponse CreatePromotionWithHttpInfo(string collectionId, Promotion promotion, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -470,6 +492,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePromotionWithHttpInfo( } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = promotion; // authentication (BasicAuth) required @@ -499,11 +525,12 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePromotionWithHttpInfo( /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Promotion - public async System.Threading.Tasks.Task CreatePromotionAsync(string collectionId, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreatePromotionAsync(string collectionId, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreatePromotionWithHttpInfoAsync(collectionId, promotion, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreatePromotionWithHttpInfoAsync(collectionId, promotion, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -513,9 +540,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePromotionWithHttpInfo( /// Thrown when fails to make API call /// The collection to create a promotion in, e.g. `my-collection`. /// The promotion to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Promotion) - public async System.Threading.Tasks.Task> CreatePromotionWithHttpInfoAsync(string collectionId, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreatePromotionWithHttpInfoAsync(string collectionId, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -554,6 +582,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePromotionWithHttpInfo( } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = promotion; // authentication (BasicAuth) required @@ -584,10 +616,11 @@ public Com.Sajari.Sdk.Client.ApiResponse CreatePromotionWithHttpInfo( /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Object - public Object DeletePromotion(string collectionId, string promotionId) + public Object DeletePromotion(string collectionId, string promotionId, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = DeletePromotionWithHttpInfo(collectionId, promotionId); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = DeletePromotionWithHttpInfo(collectionId, promotionId, accountId); return localVarResponse.Data; } @@ -597,8 +630,9 @@ public Object DeletePromotion(string collectionId, string promotionId) /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Object - public Com.Sajari.Sdk.Client.ApiResponse DeletePromotionWithHttpInfo(string collectionId, string promotionId) + public Com.Sajari.Sdk.Client.ApiResponse DeletePromotionWithHttpInfo(string collectionId, string promotionId, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -636,6 +670,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeletePromotionWithHttpInfo(str localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("promotion_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(promotionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -664,11 +702,12 @@ public Com.Sajari.Sdk.Client.ApiResponse DeletePromotionWithHttpInfo(str /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Object - public async System.Threading.Tasks.Task DeletePromotionAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task DeletePromotionAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await DeletePromotionWithHttpInfoAsync(collectionId, promotionId, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await DeletePromotionWithHttpInfoAsync(collectionId, promotionId, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -678,9 +717,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeletePromotionWithHttpInfo(str /// Thrown when fails to make API call /// The collection the promotion belongs to, e.g. `my-collection`. /// The promotion to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Object) - public async System.Threading.Tasks.Task> DeletePromotionWithHttpInfoAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> DeletePromotionWithHttpInfoAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -719,6 +759,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeletePromotionWithHttpInfo(str localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("promotion_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(promotionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -748,10 +792,11 @@ public Com.Sajari.Sdk.Client.ApiResponse DeletePromotionWithHttpInfo(str /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Promotion - public Promotion GetPromotion(string collectionId, string promotionId) + public Promotion GetPromotion(string collectionId, string promotionId, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetPromotionWithHttpInfo(collectionId, promotionId); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetPromotionWithHttpInfo(collectionId, promotionId, accountId); return localVarResponse.Data; } @@ -761,8 +806,9 @@ public Promotion GetPromotion(string collectionId, string promotionId) /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Promotion - public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(string collectionId, string promotionId) + public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(string collectionId, string promotionId, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -800,6 +846,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("promotion_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(promotionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -828,11 +878,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Promotion - public async System.Threading.Tasks.Task GetPromotionAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task GetPromotionAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetPromotionWithHttpInfoAsync(collectionId, promotionId, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetPromotionWithHttpInfoAsync(collectionId, promotionId, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -842,9 +893,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str /// Thrown when fails to make API call /// The collection that owns the promotion, e.g. `my-collection`. /// The promotion to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Promotion) - public async System.Threading.Tasks.Task> GetPromotionWithHttpInfoAsync(string collectionId, string promotionId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> GetPromotionWithHttpInfoAsync(string collectionId, string promotionId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -883,6 +935,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("promotion_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(promotionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -911,13 +967,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// ListPromotionsResponse - public ListPromotionsResponse ListPromotions(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) + public ListPromotionsResponse ListPromotions(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListPromotionsWithHttpInfo(collectionId, pageSize, pageToken, view); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListPromotionsWithHttpInfo(collectionId, accountId, pageSize, pageToken, view); return localVarResponse.Data; } @@ -926,11 +983,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// ApiResponse of ListPromotionsResponse - public Com.Sajari.Sdk.Client.ApiResponse ListPromotionsWithHttpInfo(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) + public Com.Sajari.Sdk.Client.ApiResponse ListPromotionsWithHttpInfo(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -973,6 +1031,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1000,14 +1062,15 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ListPromotionsResponse - public async System.Threading.Tasks.Task ListPromotionsAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ListPromotionsAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListPromotionsWithHttpInfoAsync(collectionId, pageSize, pageToken, view, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListPromotionsWithHttpInfoAsync(collectionId, accountId, pageSize, pageToken, view, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1016,12 +1079,13 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str /// /// Thrown when fails to make API call /// The collection that owns this set of promotions, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token. (optional) /// The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value. (optional, default to PROMOTION_VIEW_UNSPECIFIED) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListPromotionsResponse) - public async System.Threading.Tasks.Task> ListPromotionsWithHttpInfoAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ListPromotionsWithHttpInfoAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), string view = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1065,6 +1129,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "view", view)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1096,10 +1164,11 @@ public Com.Sajari.Sdk.Client.ApiResponse GetPromotionWithHttpInfo(str /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Promotion - public Promotion UpdatePromotion(string collectionId, string promotionId, string updateMask, Promotion promotion) + public Promotion UpdatePromotion(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = UpdatePromotionWithHttpInfo(collectionId, promotionId, updateMask, promotion); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = UpdatePromotionWithHttpInfo(collectionId, promotionId, updateMask, promotion, accountId); return localVarResponse.Data; } @@ -1111,8 +1180,9 @@ public Promotion UpdatePromotion(string collectionId, string promotionId, string /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Promotion - public Com.Sajari.Sdk.Client.ApiResponse UpdatePromotionWithHttpInfo(string collectionId, string promotionId, string updateMask, Promotion promotion) + public Com.Sajari.Sdk.Client.ApiResponse UpdatePromotionWithHttpInfo(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1164,6 +1234,10 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdatePromotionWithHttpInfo( localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("promotion_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(promotionId)); // path parameter localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = promotion; // authentication (BasicAuth) required @@ -1195,11 +1269,12 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdatePromotionWithHttpInfo( /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Promotion - public async System.Threading.Tasks.Task UpdatePromotionAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdatePromotionAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await UpdatePromotionWithHttpInfoAsync(collectionId, promotionId, updateMask, promotion, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await UpdatePromotionWithHttpInfoAsync(collectionId, promotionId, updateMask, promotion, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1211,9 +1286,10 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdatePromotionWithHttpInfo( /// The promotion to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value. /// Details of the promotion to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Promotion) - public async System.Threading.Tasks.Task> UpdatePromotionWithHttpInfoAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdatePromotionWithHttpInfoAsync(string collectionId, string promotionId, string updateMask, Promotion promotion, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1266,6 +1342,10 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdatePromotionWithHttpInfo( localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("promotion_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(promotionId)); // path parameter localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = promotion; // authentication (BasicAuth) required diff --git a/src/Com.Sajari.Sdk/Api/RedirectsApi.cs b/src/Com.Sajari.Sdk/Api/RedirectsApi.cs index c4cb7b8..f192dad 100644 --- a/src/Com.Sajari.Sdk/Api/RedirectsApi.cs +++ b/src/Com.Sajari.Sdk/Api/RedirectsApi.cs @@ -36,8 +36,9 @@ public interface IRedirectsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Redirect - Redirect CreateRedirect(string collectionId, Redirect redirect); + Redirect CreateRedirect(string collectionId, Redirect redirect, string accountId = default(string)); /// /// Create redirect @@ -48,8 +49,9 @@ public interface IRedirectsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Redirect - ApiResponse CreateRedirectWithHttpInfo(string collectionId, Redirect redirect); + ApiResponse CreateRedirectWithHttpInfo(string collectionId, Redirect redirect, string accountId = default(string)); /// /// Delete redirect /// @@ -59,8 +61,9 @@ public interface IRedirectsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Object - Object DeleteRedirect(string collectionId, string redirectId); + Object DeleteRedirect(string collectionId, string redirectId, string accountId = default(string)); /// /// Delete redirect @@ -71,8 +74,9 @@ public interface IRedirectsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Object - ApiResponse DeleteRedirectWithHttpInfo(string collectionId, string redirectId); + ApiResponse DeleteRedirectWithHttpInfo(string collectionId, string redirectId, string accountId = default(string)); /// /// Get redirect /// @@ -82,8 +86,9 @@ public interface IRedirectsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Redirect - Redirect GetRedirect(string collectionId, string redirectId); + Redirect GetRedirect(string collectionId, string redirectId, string accountId = default(string)); /// /// Get redirect @@ -94,8 +99,9 @@ public interface IRedirectsApiSync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Redirect - ApiResponse GetRedirectWithHttpInfo(string collectionId, string redirectId); + ApiResponse GetRedirectWithHttpInfo(string collectionId, string redirectId, string accountId = default(string)); /// /// List redirects /// @@ -104,10 +110,11 @@ public interface IRedirectsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// ListRedirectsResponse - ListRedirectsResponse ListRedirects(string collectionId, int? pageSize = default(int?), string pageToken = default(string)); + ListRedirectsResponse ListRedirects(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string)); /// /// List redirects @@ -117,10 +124,11 @@ public interface IRedirectsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// ApiResponse of ListRedirectsResponse - ApiResponse ListRedirectsWithHttpInfo(string collectionId, int? pageSize = default(int?), string pageToken = default(string)); + ApiResponse ListRedirectsWithHttpInfo(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string)); /// /// Update redirect /// @@ -132,8 +140,9 @@ public interface IRedirectsApiSync : IApiAccessor /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Redirect - Redirect UpdateRedirect(string collectionId, string redirectId, string updateMask, Redirect redirect); + Redirect UpdateRedirect(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string)); /// /// Update redirect @@ -146,8 +155,9 @@ public interface IRedirectsApiSync : IApiAccessor /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Redirect - ApiResponse UpdateRedirectWithHttpInfo(string collectionId, string redirectId, string updateMask, Redirect redirect); + ApiResponse UpdateRedirectWithHttpInfo(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string)); #endregion Synchronous Operations } @@ -166,9 +176,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Redirect - System.Threading.Tasks.Task CreateRedirectAsync(string collectionId, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateRedirectAsync(string collectionId, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Create redirect @@ -179,9 +190,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Redirect) - System.Threading.Tasks.Task> CreateRedirectWithHttpInfoAsync(string collectionId, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateRedirectWithHttpInfoAsync(string collectionId, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Delete redirect /// @@ -191,9 +203,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Object - System.Threading.Tasks.Task DeleteRedirectAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task DeleteRedirectAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Delete redirect @@ -204,9 +217,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Object) - System.Threading.Tasks.Task> DeleteRedirectWithHttpInfoAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> DeleteRedirectWithHttpInfoAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get redirect /// @@ -216,9 +230,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Redirect - System.Threading.Tasks.Task GetRedirectAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task GetRedirectAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Get redirect @@ -229,9 +244,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Redirect) - System.Threading.Tasks.Task> GetRedirectWithHttpInfoAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> GetRedirectWithHttpInfoAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List redirects /// @@ -240,11 +256,12 @@ public interface IRedirectsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// Cancellation Token to cancel the request. /// Task of ListRedirectsResponse - System.Threading.Tasks.Task ListRedirectsAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task ListRedirectsAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// List redirects @@ -254,11 +271,12 @@ public interface IRedirectsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListRedirectsResponse) - System.Threading.Tasks.Task> ListRedirectsWithHttpInfoAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ListRedirectsWithHttpInfoAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Update redirect /// @@ -270,9 +288,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Redirect - System.Threading.Tasks.Task UpdateRedirectAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateRedirectAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// /// Update redirect @@ -285,9 +304,10 @@ public interface IRedirectsApiAsync : IApiAccessor /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Redirect) - System.Threading.Tasks.Task> UpdateRedirectWithHttpInfoAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateRedirectWithHttpInfoAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -414,10 +434,11 @@ public Com.Sajari.Sdk.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Redirect - public Redirect CreateRedirect(string collectionId, Redirect redirect) + public Redirect CreateRedirect(string collectionId, Redirect redirect, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreateRedirectWithHttpInfo(collectionId, redirect); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = CreateRedirectWithHttpInfo(collectionId, redirect, accountId); return localVarResponse.Data; } @@ -427,8 +448,9 @@ public Redirect CreateRedirect(string collectionId, Redirect redirect) /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Redirect - public Com.Sajari.Sdk.Client.ApiResponse CreateRedirectWithHttpInfo(string collectionId, Redirect redirect) + public Com.Sajari.Sdk.Client.ApiResponse CreateRedirectWithHttpInfo(string collectionId, Redirect redirect, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -466,6 +488,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateRedirectWithHttpInfo(st } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = redirect; // authentication (BasicAuth) required @@ -495,11 +521,12 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateRedirectWithHttpInfo(st /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Redirect - public async System.Threading.Tasks.Task CreateRedirectAsync(string collectionId, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateRedirectAsync(string collectionId, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreateRedirectWithHttpInfoAsync(collectionId, redirect, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await CreateRedirectWithHttpInfoAsync(collectionId, redirect, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -509,9 +536,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateRedirectWithHttpInfo(st /// Thrown when fails to make API call /// The collection to create a redirect in, e.g. `my-collection`. /// The redirect to create. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Redirect) - public async System.Threading.Tasks.Task> CreateRedirectWithHttpInfoAsync(string collectionId, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateRedirectWithHttpInfoAsync(string collectionId, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -550,6 +578,10 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateRedirectWithHttpInfo(st } localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = redirect; // authentication (BasicAuth) required @@ -580,10 +612,11 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateRedirectWithHttpInfo(st /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Object - public Object DeleteRedirect(string collectionId, string redirectId) + public Object DeleteRedirect(string collectionId, string redirectId, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = DeleteRedirectWithHttpInfo(collectionId, redirectId); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = DeleteRedirectWithHttpInfo(collectionId, redirectId, accountId); return localVarResponse.Data; } @@ -593,8 +626,9 @@ public Object DeleteRedirect(string collectionId, string redirectId) /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Object - public Com.Sajari.Sdk.Client.ApiResponse DeleteRedirectWithHttpInfo(string collectionId, string redirectId) + public Com.Sajari.Sdk.Client.ApiResponse DeleteRedirectWithHttpInfo(string collectionId, string redirectId, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -632,6 +666,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteRedirectWithHttpInfo(stri localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("redirect_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(redirectId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -660,11 +698,12 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteRedirectWithHttpInfo(stri /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Object - public async System.Threading.Tasks.Task DeleteRedirectAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task DeleteRedirectAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await DeleteRedirectWithHttpInfoAsync(collectionId, redirectId, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await DeleteRedirectWithHttpInfoAsync(collectionId, redirectId, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -674,9 +713,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteRedirectWithHttpInfo(stri /// Thrown when fails to make API call /// The collection the redirect belongs to, e.g. `my-collection`. /// The redirect to delete, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Object) - public async System.Threading.Tasks.Task> DeleteRedirectWithHttpInfoAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> DeleteRedirectWithHttpInfoAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -715,6 +755,10 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteRedirectWithHttpInfo(stri localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("redirect_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(redirectId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -744,10 +788,11 @@ public Com.Sajari.Sdk.Client.ApiResponse DeleteRedirectWithHttpInfo(stri /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Redirect - public Redirect GetRedirect(string collectionId, string redirectId) + public Redirect GetRedirect(string collectionId, string redirectId, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetRedirectWithHttpInfo(collectionId, redirectId); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = GetRedirectWithHttpInfo(collectionId, redirectId, accountId); return localVarResponse.Data; } @@ -757,8 +802,9 @@ public Redirect GetRedirect(string collectionId, string redirectId) /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Redirect - public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(string collectionId, string redirectId) + public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(string collectionId, string redirectId, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -796,6 +842,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("redirect_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(redirectId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -824,11 +874,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Redirect - public async System.Threading.Tasks.Task GetRedirectAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task GetRedirectAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetRedirectWithHttpInfoAsync(collectionId, redirectId, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await GetRedirectWithHttpInfoAsync(collectionId, redirectId, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -838,9 +889,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin /// Thrown when fails to make API call /// The collection that owns the redirect, e.g. `my-collection`. /// The redirect to retrieve, e.g. `1234`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Redirect) - public async System.Threading.Tasks.Task> GetRedirectWithHttpInfoAsync(string collectionId, string redirectId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> GetRedirectWithHttpInfoAsync(string collectionId, string redirectId, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -879,6 +931,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("redirect_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(redirectId)); // path parameter + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -907,12 +963,13 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// ListRedirectsResponse - public ListRedirectsResponse ListRedirects(string collectionId, int? pageSize = default(int?), string pageToken = default(string)) + public ListRedirectsResponse ListRedirects(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListRedirectsWithHttpInfo(collectionId, pageSize, pageToken); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = ListRedirectsWithHttpInfo(collectionId, accountId, pageSize, pageToken); return localVarResponse.Data; } @@ -921,10 +978,11 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// ApiResponse of ListRedirectsResponse - public Com.Sajari.Sdk.Client.ApiResponse ListRedirectsWithHttpInfo(string collectionId, int? pageSize = default(int?), string pageToken = default(string)) + public Com.Sajari.Sdk.Client.ApiResponse ListRedirectsWithHttpInfo(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -963,6 +1021,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "page_token", pageToken)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -990,13 +1052,14 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// Cancellation Token to cancel the request. /// Task of ListRedirectsResponse - public async System.Threading.Tasks.Task ListRedirectsAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ListRedirectsAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListRedirectsWithHttpInfoAsync(collectionId, pageSize, pageToken, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await ListRedirectsWithHttpInfoAsync(collectionId, accountId, pageSize, pageToken, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1005,11 +1068,12 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin /// /// Thrown when fails to make API call /// The collection that owns this set of redirects, e.g. `my-collection`. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// The maximum number of redirects to return. The service may return fewer than this value. If unspecified, at most 50 redirects are returned. The maximum value is 1000; values above 1000 are coerced to 1000. (optional) /// A page token, received from a previous [ListRedirects](/docs/api#operation/ListRedirects) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListRedirects](/docs/api#operation/ListRedirects) must match the call that provided the page token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListRedirectsResponse) - public async System.Threading.Tasks.Task> ListRedirectsWithHttpInfoAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ListRedirectsWithHttpInfoAsync(string collectionId, string accountId = default(string), int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1049,6 +1113,10 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin { localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "page_token", pageToken)); } + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } // authentication (BasicAuth) required // http basic authentication required @@ -1080,10 +1148,11 @@ public Com.Sajari.Sdk.Client.ApiResponse GetRedirectWithHttpInfo(strin /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Redirect - public Redirect UpdateRedirect(string collectionId, string redirectId, string updateMask, Redirect redirect) + public Redirect UpdateRedirect(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = UpdateRedirectWithHttpInfo(collectionId, redirectId, updateMask, redirect); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = UpdateRedirectWithHttpInfo(collectionId, redirectId, updateMask, redirect, accountId); return localVarResponse.Data; } @@ -1095,8 +1164,9 @@ public Redirect UpdateRedirect(string collectionId, string redirectId, string up /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// ApiResponse of Redirect - public Com.Sajari.Sdk.Client.ApiResponse UpdateRedirectWithHttpInfo(string collectionId, string redirectId, string updateMask, Redirect redirect) + public Com.Sajari.Sdk.Client.ApiResponse UpdateRedirectWithHttpInfo(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1148,6 +1218,10 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdateRedirectWithHttpInfo(st localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("redirect_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(redirectId)); // path parameter localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = redirect; // authentication (BasicAuth) required @@ -1179,11 +1253,12 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdateRedirectWithHttpInfo(st /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of Redirect - public async System.Threading.Tasks.Task UpdateRedirectAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateRedirectAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await UpdateRedirectWithHttpInfoAsync(collectionId, redirectId, updateMask, redirect, cancellationToken).ConfigureAwait(false); + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await UpdateRedirectWithHttpInfoAsync(collectionId, redirectId, updateMask, redirect, accountId, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1195,9 +1270,10 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdateRedirectWithHttpInfo(st /// The redirect to update, e.g. `1234`. /// The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `condition`, `target`. For each field that you want to update, provide a corresponding value in the redirect object containing the new value. /// Details of the redirect to update. + /// The account that owns the collection, e.g. `1618535966441231024`. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (Redirect) - public async System.Threading.Tasks.Task> UpdateRedirectWithHttpInfoAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateRedirectWithHttpInfoAsync(string collectionId, string redirectId, string updateMask, Redirect redirect, string accountId = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'collectionId' is set if (collectionId == null) @@ -1250,6 +1326,10 @@ public Com.Sajari.Sdk.Client.ApiResponse UpdateRedirectWithHttpInfo(st localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter localVarRequestOptions.PathParameters.Add("redirect_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(redirectId)); // path parameter localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); + if (accountId != null) + { + localVarRequestOptions.HeaderParameters.Add("Account-Id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(accountId)); // header parameter + } localVarRequestOptions.Data = redirect; // authentication (BasicAuth) required diff --git a/src/Com.Sajari.Sdk/Api/SchemaApi.cs b/src/Com.Sajari.Sdk/Api/SchemaApi.cs index d0b5084..183e86e 100644 --- a/src/Com.Sajari.Sdk/Api/SchemaApi.cs +++ b/src/Com.Sajari.Sdk/Api/SchemaApi.cs @@ -74,6 +74,29 @@ public interface ISchemaApiSync : IApiAccessor /// ApiResponse of SchemaField ApiResponse CreateSchemaFieldWithHttpInfo(string collectionId, SchemaField schemaField); /// + /// Delete schema field + /// + /// + /// Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// Object + Object DeleteSchemaField(string collectionId, string schemaFieldName); + + /// + /// Delete schema field + /// + /// + /// Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// ApiResponse of Object + ApiResponse DeleteSchemaFieldWithHttpInfo(string collectionId, string schemaFieldName); + /// /// List schema fields /// /// @@ -98,6 +121,33 @@ public interface ISchemaApiSync : IApiAccessor /// A page token, received from a previous [ListSchemaFields](/docs/api#operation/ListSchemaFields) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListSchemaFields](/docs/api#operation/ListSchemaFields) must match the call that provided the page token. (optional) /// ApiResponse of ListSchemaFieldsResponse ApiResponse ListSchemaFieldsWithHttpInfo(string collectionId, int? pageSize = default(int?), string pageToken = default(string)); + /// + /// Update schema field + /// + /// + /// Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// SchemaField + SchemaField UpdateSchemaField(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string)); + + /// + /// Update schema field + /// + /// + /// Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// ApiResponse of SchemaField + ApiResponse UpdateSchemaFieldWithHttpInfo(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string)); #endregion Synchronous Operations } @@ -158,6 +208,31 @@ public interface ISchemaApiAsync : IApiAccessor /// Task of ApiResponse (SchemaField) System.Threading.Tasks.Task> CreateSchemaFieldWithHttpInfoAsync(string collectionId, SchemaField schemaField, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// + /// Delete schema field + /// + /// + /// Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// Cancellation Token to cancel the request. + /// Task of Object + System.Threading.Tasks.Task DeleteSchemaFieldAsync(string collectionId, string schemaFieldName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + + /// + /// Delete schema field + /// + /// + /// Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (Object) + System.Threading.Tasks.Task> DeleteSchemaFieldWithHttpInfoAsync(string collectionId, string schemaFieldName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// /// List schema fields /// /// @@ -184,6 +259,35 @@ public interface ISchemaApiAsync : IApiAccessor /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListSchemaFieldsResponse) System.Threading.Tasks.Task> ListSchemaFieldsWithHttpInfoAsync(string collectionId, int? pageSize = default(int?), string pageToken = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// + /// Update schema field + /// + /// + /// Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// Cancellation Token to cancel the request. + /// Task of SchemaField + System.Threading.Tasks.Task UpdateSchemaFieldAsync(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + + /// + /// Update schema field + /// + /// + /// Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SchemaField) + System.Threading.Tasks.Task> UpdateSchemaFieldWithHttpInfoAsync(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -636,6 +740,170 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateSchemaFieldWithHttpI return localVarResponse; } + /// + /// Delete schema field Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// Object + public Object DeleteSchemaField(string collectionId, string schemaFieldName) + { + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = DeleteSchemaFieldWithHttpInfo(collectionId, schemaFieldName); + return localVarResponse.Data; + } + + /// + /// Delete schema field Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// ApiResponse of Object + public Com.Sajari.Sdk.Client.ApiResponse DeleteSchemaFieldWithHttpInfo(string collectionId, string schemaFieldName) + { + // verify the required parameter 'collectionId' is set + if (collectionId == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'collectionId' when calling SchemaApi->DeleteSchemaField"); + } + + // verify the required parameter 'schemaFieldName' is set + if (schemaFieldName == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'schemaFieldName' when calling SchemaApi->DeleteSchemaField"); + } + + Com.Sajari.Sdk.Client.RequestOptions localVarRequestOptions = new Com.Sajari.Sdk.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + var localVarContentType = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + localVarRequestOptions.PathParameters.Add("schema_field_name", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(schemaFieldName)); // path parameter + + // authentication (BasicAuth) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Com.Sajari.Sdk.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = this.Client.Delete("/v4/collections/{collection_id}/schemaFields/{schema_field_name}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("DeleteSchemaField", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Delete schema field Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// Cancellation Token to cancel the request. + /// Task of Object + public async System.Threading.Tasks.Task DeleteSchemaFieldAsync(string collectionId, string schemaFieldName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await DeleteSchemaFieldWithHttpInfoAsync(collectionId, schemaFieldName, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Delete schema field Deleting a schema field removes it from all records within the collection, however, references to the schema field in pipelines are not removed. > Note: This operation cannot be reversed. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to delete. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (Object) + public async System.Threading.Tasks.Task> DeleteSchemaFieldWithHttpInfoAsync(string collectionId, string schemaFieldName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + // verify the required parameter 'collectionId' is set + if (collectionId == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'collectionId' when calling SchemaApi->DeleteSchemaField"); + } + + // verify the required parameter 'schemaFieldName' is set + if (schemaFieldName == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'schemaFieldName' when calling SchemaApi->DeleteSchemaField"); + } + + + Com.Sajari.Sdk.Client.RequestOptions localVarRequestOptions = new Com.Sajari.Sdk.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + var localVarContentType = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + localVarRequestOptions.PathParameters.Add("schema_field_name", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(schemaFieldName)); // path parameter + + // authentication (BasicAuth) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Com.Sajari.Sdk.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.DeleteAsync("/v4/collections/{collection_id}/schemaFields/{schema_field_name}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("DeleteSchemaField", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + /// /// List schema fields Retrieve a list of schema fields in a collection. /// @@ -806,5 +1074,201 @@ public Com.Sajari.Sdk.Client.ApiResponse CreateSchemaFieldWithHttpI return localVarResponse; } + /// + /// Update schema field Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// SchemaField + public SchemaField UpdateSchemaField(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string)) + { + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = UpdateSchemaFieldWithHttpInfo(collectionId, schemaFieldName, schemaField, updateMask); + return localVarResponse.Data; + } + + /// + /// Update schema field Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// ApiResponse of SchemaField + public Com.Sajari.Sdk.Client.ApiResponse UpdateSchemaFieldWithHttpInfo(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string)) + { + // verify the required parameter 'collectionId' is set + if (collectionId == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'collectionId' when calling SchemaApi->UpdateSchemaField"); + } + + // verify the required parameter 'schemaFieldName' is set + if (schemaFieldName == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'schemaFieldName' when calling SchemaApi->UpdateSchemaField"); + } + + // verify the required parameter 'schemaField' is set + if (schemaField == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'schemaField' when calling SchemaApi->UpdateSchemaField"); + } + + Com.Sajari.Sdk.Client.RequestOptions localVarRequestOptions = new Com.Sajari.Sdk.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + "application/json" + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + var localVarContentType = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + localVarRequestOptions.PathParameters.Add("schema_field_name", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(schemaFieldName)); // path parameter + if (updateMask != null) + { + localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); + } + localVarRequestOptions.Data = schemaField; + + // authentication (BasicAuth) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Com.Sajari.Sdk.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = this.Client.Patch("/v4/collections/{collection_id}/schemaFields/{schema_field_name}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("UpdateSchemaField", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Update schema field Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// Cancellation Token to cancel the request. + /// Task of SchemaField + public async System.Threading.Tasks.Task UpdateSchemaFieldAsync(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + Com.Sajari.Sdk.Client.ApiResponse localVarResponse = await UpdateSchemaFieldWithHttpInfoAsync(collectionId, schemaFieldName, schemaField, updateMask, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Update schema field Update the details of a schema field. Only `name` and `description` can be updated. + /// + /// Thrown when fails to make API call + /// The collection the schema field belongs to, e.g. `my-collection`. + /// The name of the schema field to update. + /// The schema field details to update. + /// The list of fields to update, separated by a comma, e.g. `name,description`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the schema field object containing the new value. (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (SchemaField) + public async System.Threading.Tasks.Task> UpdateSchemaFieldWithHttpInfoAsync(string collectionId, string schemaFieldName, SchemaField schemaField, string updateMask = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + // verify the required parameter 'collectionId' is set + if (collectionId == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'collectionId' when calling SchemaApi->UpdateSchemaField"); + } + + // verify the required parameter 'schemaFieldName' is set + if (schemaFieldName == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'schemaFieldName' when calling SchemaApi->UpdateSchemaField"); + } + + // verify the required parameter 'schemaField' is set + if (schemaField == null) + { + throw new Com.Sajari.Sdk.Client.ApiException(400, "Missing required parameter 'schemaField' when calling SchemaApi->UpdateSchemaField"); + } + + + Com.Sajari.Sdk.Client.RequestOptions localVarRequestOptions = new Com.Sajari.Sdk.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + "application/json" + }; + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + var localVarContentType = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Com.Sajari.Sdk.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("collection_id", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(collectionId)); // path parameter + localVarRequestOptions.PathParameters.Add("schema_field_name", Com.Sajari.Sdk.Client.ClientUtils.ParameterToString(schemaFieldName)); // path parameter + if (updateMask != null) + { + localVarRequestOptions.QueryParameters.Add(Com.Sajari.Sdk.Client.ClientUtils.ParameterToMultiMap("", "update_mask", updateMask)); + } + localVarRequestOptions.Data = schemaField; + + // authentication (BasicAuth) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Com.Sajari.Sdk.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.PatchAsync("/v4/collections/{collection_id}/schemaFields/{schema_field_name}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("UpdateSchemaField", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + } } diff --git a/src/Com.Sajari.Sdk/Client/Configuration.cs b/src/Com.Sajari.Sdk/Client/Configuration.cs index 30f5ac2..48f3291 100644 --- a/src/Com.Sajari.Sdk/Client/Configuration.cs +++ b/src/Com.Sajari.Sdk/Client/Configuration.cs @@ -32,7 +32,7 @@ public class Configuration : IReadableConfiguration /// Version of the package. /// /// Version of the package. - public const string Version = "5.0.0"; + public const string Version = "5.1.0"; /// /// Identifier for ISO 8601 DateTime Format @@ -102,7 +102,7 @@ public class Configuration : IReadableConfiguration public Configuration() { Proxy = null; - UserAgent = "sajari-sdk-csharp-5.0.0"; + UserAgent = "sajari-sdk-csharp-5.1.0"; BasePath = "https://api.search.io"; DefaultHeaders = new ConcurrentDictionary(); ApiKey = new ConcurrentDictionary(); @@ -447,7 +447,7 @@ public static string ToDebugReport() report += " OS: " + System.Environment.OSVersion + "\n"; report += " .NET Framework Version: " + System.Environment.Version + "\n"; report += " Version of the API: v4\n"; - report += " SDK Package Version: 5.0.0\n"; + report += " SDK Package Version: 5.1.0\n"; return report; } diff --git a/src/Com.Sajari.Sdk/Com.Sajari.Sdk.csproj b/src/Com.Sajari.Sdk/Com.Sajari.Sdk.csproj index f03d771..2e34c66 100644 --- a/src/Com.Sajari.Sdk/Com.Sajari.Sdk.csproj +++ b/src/Com.Sajari.Sdk/Com.Sajari.Sdk.csproj @@ -12,7 +12,7 @@ A library generated from a OpenAPI doc No Copyright Com.Sajari.Sdk - 5.0.0 + 5.1.0 bin\$(Configuration)\$(TargetFramework)\Com.Sajari.Sdk.xml https://github.com/sajari/GIT_USER_ID/sdk-dotnet.git git diff --git a/src/Com.Sajari.Sdk/Model/Collection.cs b/src/Com.Sajari.Sdk/Model/Collection.cs index dccb12b..d6ef600 100644 --- a/src/Com.Sajari.Sdk/Model/Collection.cs +++ b/src/Com.Sajari.Sdk/Model/Collection.cs @@ -75,9 +75,9 @@ public bool ShouldSerializeAccountId() public List AuthorizedQueryDomains { get; set; } /// - /// Output only. Time the collection was created. + /// Output only. The time the collection was created. /// - /// Output only. Time the collection was created. + /// Output only. The time the collection was created. [DataMember(Name = "create_time", EmitDefaultValue = false)] public DateTime CreateTime { get; private set; } diff --git a/src/Com.Sajari.Sdk/Model/CollectionType.cs b/src/Com.Sajari.Sdk/Model/CollectionType.cs new file mode 100644 index 0000000..7e2addc --- /dev/null +++ b/src/Com.Sajari.Sdk/Model/CollectionType.cs @@ -0,0 +1,62 @@ +/* + * Search.io API + * + * Search.io offers a search and discovery service with Neuralsearch®, the world's first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence. + * + * The version of the OpenAPI document: v4 + * Contact: support@search.io + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Com.Sajari.Sdk.Client.OpenAPIDateConverter; + +namespace Com.Sajari.Sdk.Model +{ + /// + /// - TYPE_UNSPECIFIED: Type not specified. - WEBSITE: The type for website collections. - SHOPIFY: The type for the collection backing a Shopify account. - CUSTOM: The legacy custom type. + /// + /// - TYPE_UNSPECIFIED: Type not specified. - WEBSITE: The type for website collections. - SHOPIFY: The type for the collection backing a Shopify account. - CUSTOM: The legacy custom type. + [JsonConverter(typeof(StringEnumConverter))] + public enum CollectionType + { + /// + /// Enum TYPEUNSPECIFIED for value: TYPE_UNSPECIFIED + /// + [EnumMember(Value = "TYPE_UNSPECIFIED")] + TYPEUNSPECIFIED = 1, + + /// + /// Enum WEBSITE for value: WEBSITE + /// + [EnumMember(Value = "WEBSITE")] + WEBSITE = 2, + + /// + /// Enum SHOPIFY for value: SHOPIFY + /// + [EnumMember(Value = "SHOPIFY")] + SHOPIFY = 3, + + /// + /// Enum CUSTOM for value: CUSTOM + /// + [EnumMember(Value = "CUSTOM")] + CUSTOM = 4 + + } + +} diff --git a/src/Com.Sajari.Sdk/Model/Event.cs b/src/Com.Sajari.Sdk/Model/Event.cs index 88bc230..d0ad11f 100644 --- a/src/Com.Sajari.Sdk/Model/Event.cs +++ b/src/Com.Sajari.Sdk/Model/Event.cs @@ -45,7 +45,7 @@ protected Event() { } /// The query identifier. (required). /// The identifier of the redirect the event is about.. /// The identifier of the result the event is about.. - /// The type of event, e.g. `click`, `purchase`, `add_to_cart`. (required). + /// The type of event, e.g. `click`, `redirect`, `purchase`, `add_to_cart`. (required). public Event(string bannerId = default(string), Dictionary metadata = default(Dictionary), string queryId = default(string), string redirectId = default(string), string resultId = default(string), string type = default(string)) { // to ensure "queryId" is required (not null) @@ -100,9 +100,9 @@ protected Event() { } public string ResultId { get; set; } /// - /// The type of event, e.g. `click`, `purchase`, `add_to_cart`. + /// The type of event, e.g. `click`, `redirect`, `purchase`, `add_to_cart`. /// - /// The type of event, e.g. `click`, `purchase`, `add_to_cart`. + /// The type of event, e.g. `click`, `redirect`, `purchase`, `add_to_cart`. [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = false)] public string Type { get; set; } diff --git a/src/Com.Sajari.Sdk/Model/GetCollectionRequestView.cs b/src/Com.Sajari.Sdk/Model/GetCollectionRequestView.cs new file mode 100644 index 0000000..58fd2b1 --- /dev/null +++ b/src/Com.Sajari.Sdk/Model/GetCollectionRequestView.cs @@ -0,0 +1,56 @@ +/* + * Search.io API + * + * Search.io offers a search and discovery service with Neuralsearch®, the world's first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence. + * + * The version of the OpenAPI document: v4 + * Contact: support@search.io + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Com.Sajari.Sdk.Client.OpenAPIDateConverter; + +namespace Com.Sajari.Sdk.Model +{ + /// + /// - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. + /// + /// - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. + [JsonConverter(typeof(StringEnumConverter))] + public enum GetCollectionRequestView + { + /// + /// Enum VIEWUNSPECIFIED for value: VIEW_UNSPECIFIED + /// + [EnumMember(Value = "VIEW_UNSPECIFIED")] + VIEWUNSPECIFIED = 1, + + /// + /// Enum BASIC for value: BASIC + /// + [EnumMember(Value = "BASIC")] + BASIC = 2, + + /// + /// Enum FULL for value: FULL + /// + [EnumMember(Value = "FULL")] + FULL = 3 + + } + +} diff --git a/src/Com.Sajari.Sdk/Model/ListCollectionsRequestView.cs b/src/Com.Sajari.Sdk/Model/ListCollectionsRequestView.cs new file mode 100644 index 0000000..ac0fb18 --- /dev/null +++ b/src/Com.Sajari.Sdk/Model/ListCollectionsRequestView.cs @@ -0,0 +1,56 @@ +/* + * Search.io API + * + * Search.io offers a search and discovery service with Neuralsearch®, the world's first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence. + * + * The version of the OpenAPI document: v4 + * Contact: support@search.io + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Com.Sajari.Sdk.Client.OpenAPIDateConverter; + +namespace Com.Sajari.Sdk.Model +{ + /// + /// - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. + /// + /// - VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `BASIC` view. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage. + [JsonConverter(typeof(StringEnumConverter))] + public enum ListCollectionsRequestView + { + /// + /// Enum VIEWUNSPECIFIED for value: VIEW_UNSPECIFIED + /// + [EnumMember(Value = "VIEW_UNSPECIFIED")] + VIEWUNSPECIFIED = 1, + + /// + /// Enum BASIC for value: BASIC + /// + [EnumMember(Value = "BASIC")] + BASIC = 2, + + /// + /// Enum FULL for value: FULL + /// + [EnumMember(Value = "FULL")] + FULL = 3 + + } + +} diff --git a/src/Com.Sajari.Sdk/Model/Promotion.cs b/src/Com.Sajari.Sdk/Model/Promotion.cs index 57c8a39..672580b 100644 --- a/src/Com.Sajari.Sdk/Model/Promotion.cs +++ b/src/Com.Sajari.Sdk/Model/Promotion.cs @@ -47,7 +47,7 @@ protected Promotion() { } /// If specified, the promotion is considered disabled after this time.. /// The records to exclude from search results, if the promotion is enabled.. /// The filter boosts to apply to searches, if the promotion is enabled.. - /// The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion.. + /// The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. A filter condition is comprised of a set of filters of the form `field = value` and matches a query if all of those filters are present in the query. For example, a query with the filter `productType = 'shirt' AND size = 'medium'` triggers a promotion with the filter condition `productType = 'shirt'`, but not one with both `productType = 'shirt', and `size = 'small'`.. /// The promotion's ID.. /// The items to fix to specific positions in the search results.. /// The range boosts to apply to searches, if the promotion is enabled.. @@ -156,9 +156,9 @@ public bool ShouldSerializeCreateTime() public List FilterBoosts { get; set; } /// - /// The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. + /// The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. A filter condition is comprised of a set of filters of the form `field = value` and matches a query if all of those filters are present in the query. For example, a query with the filter `productType = 'shirt' AND size = 'medium'` triggers a promotion with the filter condition `productType = 'shirt'`, but not one with both `productType = 'shirt', and `size = 'small'`. /// - /// The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. + /// The conditions applied to the filters passed from the user. A query must match at least one of these in order to trigger the promotion. A filter condition is comprised of a set of filters of the form `field = value` and matches a query if all of those filters are present in the query. For example, a query with the filter `productType = 'shirt' AND size = 'medium'` triggers a promotion with the filter condition `productType = 'shirt'`, but not one with both `productType = 'shirt', and `size = 'small'`. [DataMember(Name = "filter_conditions", EmitDefaultValue = false)] public List FilterConditions { get; set; } diff --git a/src/Com.Sajari.Sdk/Model/PromotionFilterCondition.cs b/src/Com.Sajari.Sdk/Model/PromotionFilterCondition.cs index 14722e2..bb5b4e0 100644 --- a/src/Com.Sajari.Sdk/Model/PromotionFilterCondition.cs +++ b/src/Com.Sajari.Sdk/Model/PromotionFilterCondition.cs @@ -27,7 +27,7 @@ namespace Com.Sajari.Sdk.Model { /// - /// A set of filters of the form `field = 'value'`. Matches a query if the set of filters in the condition matches exactly the set of filters associated with it. + /// A set of filters of the form `field = 'value'`. Matches a query if all filters are present in that query. /// [DataContract(Name = "PromotionFilterCondition")] public partial class PromotionFilterCondition : IEquatable, IValidatableObject @@ -35,16 +35,16 @@ public partial class PromotionFilterCondition : IEquatable /// Initializes a new instance of the class. /// - /// A filter of the form `field = 'value'`.. + /// A filter of the form `field = 'value'`. All of these filters must be present in a query's filter in order for the promotion to be considered active.. public PromotionFilterCondition(List filter = default(List)) { this.Filter = filter; } /// - /// A filter of the form `field = 'value'`. + /// A filter of the form `field = 'value'`. All of these filters must be present in a query's filter in order for the promotion to be considered active. /// - /// A filter of the form `field = 'value'`. + /// A filter of the form `field = 'value'`. All of these filters must be present in a query's filter in order for the promotion to be considered active. [DataMember(Name = "filter", EmitDefaultValue = false)] public List Filter { get; set; } diff --git a/src/Com.Sajari.Sdk/Model/SendEventRequest.cs b/src/Com.Sajari.Sdk/Model/SendEventRequest.cs index 120c0d6..91a9e81 100644 --- a/src/Com.Sajari.Sdk/Model/SendEventRequest.cs +++ b/src/Com.Sajari.Sdk/Model/SendEventRequest.cs @@ -41,7 +41,7 @@ protected SendEventRequest() { } /// Initializes a new instance of the class. /// /// An object made up of field-value pairs that contains additional metadata to record with the event. Every value in the object must be one of the following primitive types: - boolean - number - string. - /// The name of event, e.g. `click`, `purchase`. (required). + /// The name of event, e.g. `click`, `redirect`, `purchase`. (required). /// The token corresponding to the search result that was interacted with, e.g. `eyJ...`. (required). /// The weight assigned to the event. Generally a sensible weight is 1. If you want to weight an event in a certain way you can use a value other than 1. For example, if you want to capture profit in an event, you could set the weight to a value that represents the profit.. public SendEventRequest(Dictionary metadata = default(Dictionary), string name = default(string), string token = default(string), int weight = default(int)) @@ -68,9 +68,9 @@ protected SendEventRequest() { } public Dictionary Metadata { get; set; } /// - /// The name of event, e.g. `click`, `purchase`. + /// The name of event, e.g. `click`, `redirect`, `purchase`. /// - /// The name of event, e.g. `click`, `purchase`. + /// The name of event, e.g. `click`, `redirect`, `purchase`. [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = false)] public string Name { get; set; }