@algolia/n8n-nodes-algolia 0.14.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",p="0.
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("n8n-workflow"),l="@algolia/n8n-nodes-algolia",p="0.15.0",o={name:l,version:p},d=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Search"],operation:["browse"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"options",displayName:"Browse Params",name:"browseParams_options",default:"search_parameters_as_object",options:[{name:"Search Parameters As Object",value:"search_parameters_as_object"},{name:"Search Parameters As Query String",value:"search_parameters_as_query_string_object"}],required:!1},{type:"string",default:"",description:"Search query.",displayName:"Query",name:"query_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"comedy drama crime Macy Buscemi",default:"",description:"Keywords to be used instead of the search query to conduct a more broader search\nUsing the `similarQuery` parameter changes other settings\n- `queryType` is set to `prefixNone`.\n- `removeStopWords` is set to true.\n- `words` is set as the first ranking criterion.\n- All remaining words are treated as `optionalWords`\nSince the `similarQuery` is supposed to do a broad search, they usually return many results.\nCombine it with `filters` to narrow down the list of results.\n",displayName:"Similar Query",name:"similarQuery_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"string",placeholder:"(category:Book OR category:Ebook) AND _tags:published",default:"",description:"Filter expression to only include items that match the filter criteria in the response.\n\nYou can use these filter expressions:\n\n- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.\n- **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).\n- **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.\n- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).\n- **Boolean filters.** `<facet>: true | false`.\n\nYou can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:\n\n- You can only combine filters of the same type with `OR`.\n **Not supported:** `facet:value OR num > 3`.\n- You can't use `NOT` with combinations of filters.\n **Not supported:** `NOT(facet:value OR facet:value)`\n- You can't combine conjunctions (`AND`) with `OR`.\n **Not supported:** `facet:value OR (facet:value AND facet:value)`\n\nUse quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes.\nIf a facet attribute is an array, the filter matches if it matches at least one element of the array.\n\nFor more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).\n",displayName:"Filters",name:"filters_string",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"facetFilters",displayName:"Facet Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"optionalFilters",displayName:"Optional Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"numericFilters",displayName:"Numeric Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"json",name:"tagFilters",displayName:"Tag Filters",default:"",displayOptions:{show:{browseParams_options:["search_parameters_as_object"]}}},{type:"boolean",default:!1,description:`Whether to sum all filter scores
|
|
2
2
|
If true, all filter scores are summed.
|
|
3
3
|
Otherwise, the maximum filter score is kept.
|
|
4
4
|
For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
|
|
@@ -316,7 +316,7 @@ By default, all retrievable attributes are returned.
|
|
|
316
316
|
|
|
317
317
|
Attributes included in \`unretrievableAttributes\`
|
|
318
318
|
won't be retrieved unless the request is authenticated with the admin API key.
|
|
319
|
-
`,required:!1}],routing:{request:{qs:{attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}"}}},displayOptions:{show:{resource:["Records"],operation:["getObject"]}}}],N=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["getObjects"]}}}],x=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["multipleBatch"]}}}],O=[{type:"json",description:"Attributes to update.",required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!0,displayName:"Create If Not Exists",name:"createIfNotExists_boolean",description:"Whether to create a new record if it doesn't exist."}],routing:{request:{qs:{createIfNotExists:"={{ $value.createIfNotExists_boolean }}"}}},displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}}],P=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],A=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add a new record (with auto-generated object ID)",value:"saveObject",action:"Add a new record (with auto-generated object ID)",description:"Adds a record to an index or replaces it.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve a record",value:"getObject",action:"Retrieve a record",description:"Retrieves one record by its object ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Add or replace a record",value:"addOrUpdateObject",action:"Add or replace a record",description:"If a record with the specified object ID exists, the existing record is replaced.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete a record",value:"deleteObject",action:"Delete a record",description:"Deletes a record by its object ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete records matching a filter",value:"deleteBy",action:"Delete records matching a filter",description:"This operation doesn't accept empty filters.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/deleteByQuery"}}},{name:"Delete all records from an index",value:"clearObjects",action:"Delete all records from an index",description:"Deletes only the records from an index while keeping settings, synonyms, and rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/clear"}}},{name:"Add or update attributes",value:"partialUpdateObject",action:"Add or update attributes",description:"Adds new attributes to a record, or updates existing ones.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}/partial"}}},{name:"Batch indexing operations on one index",value:"batch",action:"Batch indexing operations on one index",description:"Adds, updates, or deletes records in one index with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/batch"}}},{name:"Batch indexing operations on multiple indices",value:"multipleBatch",action:"Batch indexing operations on multiple indices",description:"Adds, updates, or deletes records in multiple indices with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/*/batch"}}},{name:"Retrieve records",value:"getObjects",action:"Retrieve records",description:"Retrieves one or more records, potentially from different indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/objects"}}}],displayOptions:{show:{resource:["Records"]}}}],T=[...A,...g,...f,...b,...w,..._,...v,...N,...x,...O,...P],q=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["deleteIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],S=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:1,displayName:"Get Version",name:"getVersion_number",description:"When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility."}],routing:{request:{qs:{getVersion:"={{ $value.getVersion_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}}],j=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}}}],I=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["listIndices"]}}}],$=[{type:"string",placeholder:"products",default:"",description:"Index name (case-sensitive).",routing:{send:{type:"body",value:"={{ $value }}",property:"destination"}},displayName:"Destination",name:"destination_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"options",placeholder:"copy",default:"",description:"Operation to perform on the index.",options:[{name:"move",value:"move"},{name:"copy",value:"copy"}],routing:{send:{type:"body",value:"={{ $value }}",property:"operation"}},displayName:"Operation",name:"operation_options",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Scope",name:"scope_json",default:"[]",description:`**Only for copying.**
|
|
319
|
+
`,required:!1}],routing:{request:{qs:{attributesToRetrieve:"={{ JSON.parse($value.attributesToRetrieve_json) }}"}}},displayOptions:{show:{resource:["Records"],operation:["getObject"]}}}],N=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["getObjects"]}}}],O=[{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:void 0,required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Records"],operation:["multipleBatch"]}}}],x=[{type:"json",description:"Attributes to update.",required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"string",placeholder:"test-record-123",default:"",description:"Unique record identifier.",displayName:"Object ID",name:"objectID_string",required:!0,displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!0,displayName:"Create If Not Exists",name:"createIfNotExists_boolean",description:"Whether to create a new record if it doesn't exist."}],routing:{request:{qs:{createIfNotExists:"={{ $value.createIfNotExists_boolean }}"}}},displayOptions:{show:{resource:["Records"],operation:["partialUpdateObject"]}}}],P=[{type:"json",description:void 0,required:!0,default:"{}",routing:{request:{body:"={{ JSON.parse($value) }}"}},displayName:"Body",name:"body_object",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Records"],operation:["saveObject"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],A=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add a new record (with auto-generated object ID)",value:"saveObject",action:"Add a new record (with auto-generated object ID)",description:"Adds a record to an index or replaces it.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}"}}},{name:"Retrieve a record",value:"getObject",action:"Retrieve a record",description:"Retrieves one record by its object ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Add or replace a record",value:"addOrUpdateObject",action:"Add or replace a record",description:"If a record with the specified object ID exists, the existing record is replaced.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete a record",value:"deleteObject",action:"Delete a record",description:"Deletes a record by its object ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}"}}},{name:"Delete records matching a filter",value:"deleteBy",action:"Delete records matching a filter",description:"This operation doesn't accept empty filters.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/deleteByQuery"}}},{name:"Delete all records from an index",value:"clearObjects",action:"Delete all records from an index",description:"Deletes only the records from an index while keeping settings, synonyms, and rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/clear"}}},{name:"Add or update attributes",value:"partialUpdateObject",action:"Add or update attributes",description:"Adds new attributes to a record, or updates existing ones.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/{{ $parameter.objectID_string }}/partial"}}},{name:"Batch indexing operations on one index",value:"batch",action:"Batch indexing operations on one index",description:"Adds, updates, or deletes records in one index with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/batch"}}},{name:"Batch indexing operations on multiple indices",value:"multipleBatch",action:"Batch indexing operations on multiple indices",description:"Adds, updates, or deletes records in multiple indices with a single API request.",routing:{request:{method:"POST",url:"=/1/indexes/*/batch"}}},{name:"Retrieve records",value:"getObjects",action:"Retrieve records",description:"Retrieves one or more records, potentially from different indices.",routing:{request:{method:"POST",url:"=/1/indexes/*/objects"}}}],displayOptions:{show:{resource:["Records"]}}}],T=[...A,...g,...f,...b,...w,..._,...v,...N,...O,...x,...P],q=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["deleteIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}}],S=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:1,displayName:"Get Version",name:"getVersion_number",description:"When set to 2, the endpoint will not include `synonyms` in the response. This parameter is here for backward compatibility."}],routing:{request:{qs:{getVersion:"={{ $value.getVersion_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["getSettings"]}}}],j=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Indices"],operation:["getTask"]}}}],I=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Indices"],operation:["listIndices"]}}}],$=[{type:"string",placeholder:"products",default:"",description:"Index name (case-sensitive).",routing:{send:{type:"body",value:"={{ $value }}",property:"destination"}},displayName:"Destination",name:"destination_string",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{type:"options",placeholder:"copy",default:"",description:"Operation to perform on the index.",options:[{name:"move",value:"move"},{name:"copy",value:"copy"}],routing:{send:{type:"body",value:"={{ $value }}",property:"operation"}},displayName:"Operation",name:"operation_options",required:!0,displayOptions:{show:{resource:["Indices"],operation:["operationIndex"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"json",displayName:"Scope",name:"scope_json",default:"[]",description:`**Only for copying.**
|
|
320
320
|
|
|
321
321
|
If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged.
|
|
322
322
|
If you omit the \`scope\` parameter, everything is copied: records, settings, synonyms, and rules.
|
|
@@ -634,9 +634,11 @@ For more information, see [Consequences](https://www.algolia.com/doc/guides/mana
|
|
|
634
634
|
|
|
635
635
|
Some consequences require specific conditions or don't require any condition.
|
|
636
636
|
For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
|
|
637
|
-
`,required:!1},{type:"string",placeholder:"Display a promotional banner",default:"",description:"Description of the rule's purpose to help you distinguish between different rules.",displayName:"Description",name:"description_string"},{type:"boolean",default:!0,description:"Whether the rule is active.",displayName:"Enabled",name:"enabled_boolean"},{type:"json",displayName:"Validity",name:"validity_json",default:"[]",description:"Time periods when the rule is active.",required:!1},{type:"json",displayName:"Tags",name:"tags_json",default:"[]",description:void 0,required:!1},{type:"string",default:"",displayName:"Scope",name:"scope_string"}],routing:{request:{body:{conditions:"={{ JSON.parse($value.conditions_json) }}",description:"={{ $value.description_string }}",enabled:"={{ $value.enabled_boolean }}",validity:"={{ JSON.parse($value.validity_json) }}",tags:"={{ JSON.parse($value.tags_json) }}",scope:"={{ $value.scope_string }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}}],te=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Rules to add or replace.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."},{type:"boolean",default:!1,displayName:"Clear Existing Rules",name:"clearExistingRules_boolean",description:"Whether existing rules should be deleted before adding this batch."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}",clearExistingRules:"={{ $value.clearExistingRules_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}}],ae=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",default:"",description:"Search query for rules.",displayName:"Query",name:"query_string"},{type:"options",default:"",description:"Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",options:[{name:"is",value:"is"},{name:"startsWith",value:"startsWith"},{name:"endsWith",value:"endsWith"},{name:"contains",value:"contains"}],displayName:"Anchoring",name:"anchoring_options"},{type:"string",placeholder:"mobile",default:"",description:"Only return rules that match the context (exact match).",displayName:"Context",name:"context_string"},{type:"number",default:"",description:"Requested page of the API response.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Maximum number of hits per page.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"json",name:"enabled",displayName:"Enabled",default:""}],routing:{request:{body:{query:"={{ $value.query_string }}",anchoring:"={{ $value.anchoring_options }}",context:"={{ $value.context_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",enabled:"={{ JSON.parse($value.enabled) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}}}],se=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a rule",value:"getRule",action:"Retrieve a rule",description:"Retrieves a rule by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a rule",value:"saveRule",action:"Create or replace a rule",description:"If a rule with the specified object ID doesn't exist, it's created.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Delete a rule",value:"deleteRule",action:"Delete a rule",description:"Deletes a rule by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or update rules",value:"saveRules",action:"Create or update rules",description:"Create or update multiple rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/batch"}}},{name:"Delete all rules",value:"clearRules",action:"Delete all rules",description:"Deletes all rules from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/clear"}}},{name:"Search for rules",value:"searchRules",action:"Search for rules",description:"Searches for rules in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/search"}}}],displayOptions:{show:{resource:["Rules"]}}}],re=[...se,...Y,...X,...Z,...ee,...te,...ae],ne=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:"List of additions and deletions to your dictionaries.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"boolean",default:!1,description:"Whether to replace all custom entries in the dictionary with the ones sent with this request.",displayName:"Clear Existing Dictionary Entries",name:"clearExistingDictionaryEntries_boolean"}],routing:{request:{body:{clearExistingDictionaryEntries:"={{ $value.clearExistingDictionaryEntries_boolean }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}}],ie=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"options",default:"",description:"ISO code for a supported language.",options:[{name:"af",value:"af"},{name:"ar",value:"ar"},{name:"az",value:"az"},{name:"bg",value:"bg"},{name:"bn",value:"bn"},{name:"ca",value:"ca"},{name:"cs",value:"cs"},{name:"cy",value:"cy"},{name:"da",value:"da"},{name:"de",value:"de"},{name:"el",value:"el"},{name:"en",value:"en"},{name:"eo",value:"eo"},{name:"es",value:"es"},{name:"et",value:"et"},{name:"eu",value:"eu"},{name:"fa",value:"fa"},{name:"fi",value:"fi"},{name:"fo",value:"fo"},{name:"fr",value:"fr"},{name:"ga",value:"ga"},{name:"gl",value:"gl"},{name:"he",value:"he"},{name:"hi",value:"hi"},{name:"hu",value:"hu"},{name:"hy",value:"hy"},{name:"id",value:"id"},{name:"is",value:"is"},{name:"it",value:"it"},{name:"ja",value:"ja"},{name:"ka",value:"ka"},{name:"kk",value:"kk"},{name:"ko",value:"ko"},{name:"ku",value:"ku"},{name:"ky",value:"ky"},{name:"lt",value:"lt"},{name:"lv",value:"lv"},{name:"mi",value:"mi"},{name:"mn",value:"mn"},{name:"mr",value:"mr"},{name:"ms",value:"ms"},{name:"mt",value:"mt"},{name:"nb",value:"nb"},{name:"nl",value:"nl"},{name:"no",value:"no"},{name:"ns",value:"ns"},{name:"pl",value:"pl"},{name:"ps",value:"ps"},{name:"pt",value:"pt"},{name:"pt-br",value:"pt-br"},{name:"qu",value:"qu"},{name:"ro",value:"ro"},{name:"ru",value:"ru"},{name:"sk",value:"sk"},{name:"sq",value:"sq"},{name:"sv",value:"sv"},{name:"sw",value:"sw"},{name:"ta",value:"ta"},{name:"te",value:"te"},{name:"th",value:"th"},{name:"tl",value:"tl"},{name:"tn",value:"tn"},{name:"tr",value:"tr"},{name:"tt",value:"tt"},{name:"uk",value:"uk"},{name:"ur",value:"ur"},{name:"uz",value:"uz"},{name:"zh",value:"zh"}],displayName:"Language",name:"language_options"}],routing:{request:{body:{page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",language:"={{ $value.language_options }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}}],oe=[{type:"json",description:`Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values.
|
|
638
|
-
`,required:!0,default:"{}",routing:{send:{type:"body",property:"disableStandardEntries",value:"={{ JSON.parse($value) }}"}},displayName:"Disable Standard Entries",name:"disable_standard_entries_object",displayOptions:{show:{resource:["Dictionaries"],operation:["setDictionarySettings"]}}}],le=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add or delete dictionary entries",value:"batchDictionaryEntries",action:"Add or delete dictionary entries",description:"Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/batch"}}},{name:"Search dictionary entries",value:"searchDictionaryEntries",action:"Search dictionary entries",description:"Searches for standard and custom dictionary entries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/search"}}},{name:"Retrieve dictionary settings",value:"getDictionarySettings",action:"Retrieve dictionary settings",description:"Retrieves the languages for which standard dictionary entries are turned off.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/settings"}}},{name:"Update dictionary settings",value:"setDictionarySettings",action:"Update dictionary settings",description:"Turns standard stop word dictionary entries on or off for a given language.",routing:{request:{method:"PUT",url:"=/1/dictionaries/*/settings"}}},{name:"List available languages",value:"getDictionaryLanguages",action:"List available languages",description:"Lists supported languages with their supported dictionary types and number of custom entries.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/languages"}}}],displayOptions:{show:{resource:["Dictionaries"]}}}],pe=[...le,...ne,...ie,...oe],de=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}}],ue=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"json",displayName:"Users",name:"users_json",default:"[]",description:"User IDs to assign.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"users"}},displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}}],ce=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["getUserId"]}}}],me=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Get Clusters",name:"getClusters_boolean",description:"Whether to include the cluster's pending mapping state in the response."}],routing:{request:{qs:{getClusters:"={{ $value.getClusters_boolean }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["hasPendingMappings"]}}}],he=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["listUserIds"]}}}],ye=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["removeUserId"]}}}],ge=[{type:"string",default:"",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",displayName:"Cluster Name",name:"clusterName_string"},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"}],routing:{request:{body:{clusterName:"={{ $value.clusterName_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}}],fe=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Assign or move a user ID",value:"assignUserId",action:"Assign or move a user ID",description:"Assigns or moves a user ID to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping"}}},{name:"List user IDs",value:"listUserIds",action:"List user IDs",description:"Lists the userIDs assigned to a multi-cluster application.",routing:{request:{method:"GET",url:"=/1/clusters/mapping"}}},{name:"Assign multiple userIDs",value:"batchAssignUserIds",action:"Assign multiple userIDs",description:"Assigns multiple user IDs to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping/batch"}}},{name:"Get top user IDs",value:"getTopUserIds",action:"Get top user IDs",description:"Get the IDs of the 10 users with the highest number of records per cluster.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/top"}}},{name:"Retrieve user ID",value:"getUserId",action:"Retrieve user ID",description:"Returns the user ID data stored in the mapping.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"Delete user ID",value:"removeUserId",action:"Delete user ID",description:"Deletes a user ID and its associated data from the clusters.",routing:{request:{method:"DELETE",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"List clusters",value:"listClusters",action:"List clusters",description:"Lists the available clusters in a multi-cluster setup.",routing:{request:{method:"GET",url:"=/1/clusters"}}},{name:"Search for user IDs",value:"searchUserIds",action:"Search for user IDs",description:"Since it can take a few seconds to get the data from the different clusters,",routing:{request:{method:"POST",url:"=/1/clusters/mapping/search"}}},{name:"Get migration and user mapping status",value:"hasPendingMappings",action:"Get migration and user mapping status",description:"To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/pending"}}}],displayOptions:{show:{resource:["Clusters"]}}}],be=[...fe,...de,...ue,...ce,...me,...he,...ye,...ge],we=[{type:"string",placeholder:"10.0.0.1/32",default:"",description:"IP address range of the source.",routing:{send:{type:"body",value:"={{ $value }}",property:"source"}},displayName:"Source",name:"source_string",required:!0,displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Server subnet",default:"",description:"Source description.",displayName:"Description",name:"description_string"}],routing:{request:{body:{description:"={{ $value.description_string }}"}}},displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}}],_e=[{type:"string",placeholder:"10.0.0.1/32",default:"",displayName:"Source",name:"source_string",required:!0,description:"IP address range of the source.",displayOptions:{show:{resource:["Vaults"],operation:["deleteSource"]}}}],ve=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Sources.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Vaults"],operation:["replaceSources"]}}}],Ne=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List allowed sources",value:"getSources",action:"List allowed sources",description:"Retrieves all allowed IP addresses with access to your application.",routing:{request:{method:"GET",url:"=/1/security/sources"}}},{name:"Replace allowed sources",value:"replaceSources",action:"Replace allowed sources",description:"Replaces the list of allowed sources.",routing:{request:{method:"PUT",url:"=/1/security/sources"}}},{name:"Add a source",value:"appendSource",action:"Add a source",description:"Adds a source to the list of allowed sources.",routing:{request:{method:"POST",url:"=/1/security/sources/append"}}},{name:"Delete a source",value:"deleteSource",action:"Delete a source",description:"Deletes a source from the list of allowed sources.",routing:{request:{method:"DELETE",url:"=/1/security/sources/{{ $parameter.source_string }}"}}}],displayOptions:{show:{resource:["Vaults"]}}}],xe=[...Ne,...we,..._e,...ve],Oe=[{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Advanced"],operation:["getAppTask"]}}}],Pe=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:"",displayName:"Offset",name:"offset_number",description:"First log entry to retrieve. The most recent entries are listed first."},{type:"number",default:10,typeOptions:{maxValue:1e3},displayName:"Length",name:"length_number",description:"Maximum number of entries to retrieve."},{type:"json",name:"indexName",displayName:"Index Name",default:"",description:`Index for which to retrieve log entries.
|
|
637
|
+
`,required:!1},{type:"string",placeholder:"Display a promotional banner",default:"",description:"Description of the rule's purpose to help you distinguish between different rules.",displayName:"Description",name:"description_string"},{type:"boolean",default:!0,description:"Whether the rule is active.",displayName:"Enabled",name:"enabled_boolean"},{type:"json",displayName:"Validity",name:"validity_json",default:"[]",description:"Time periods when the rule is active.",required:!1},{type:"json",displayName:"Tags",name:"tags_json",default:"[]",description:void 0,required:!1},{type:"string",default:"",displayName:"Scope",name:"scope_string"},{type:"json",description:`Legacy field for a single condition. This field is maintained for backward compatibility
|
|
638
|
+
with older rules but should not be used in new implementations.
|
|
639
|
+
`,required:!1,default:"{}",displayName:"Condition",name:"condition_object"}],routing:{request:{body:{conditions:"={{ JSON.parse($value.conditions_json) }}",description:"={{ $value.description_string }}",enabled:"={{ $value.enabled_boolean }}",validity:"={{ JSON.parse($value.validity_json) }}",tags:"={{ JSON.parse($value.tags_json) }}",scope:"={{ $value.scope_string }}",condition:"={{ JSON.parse($value.condition_object) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRule"]}}}],te=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Rules to add or replace.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}},{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Forward To Replicas",name:"forwardToReplicas_boolean",description:"Whether changes are applied to replica indices."},{type:"boolean",default:!1,displayName:"Clear Existing Rules",name:"clearExistingRules_boolean",description:"Whether existing rules should be deleted before adding this batch."}],routing:{request:{qs:{forwardToReplicas:"={{ $value.forwardToReplicas_boolean }}",clearExistingRules:"={{ $value.clearExistingRules_boolean }}"}}},displayOptions:{show:{resource:["Rules"],operation:["saveRules"]}}}],ae=[{type:"options",placeholder:"ALGOLIA_INDEX_NAME",default:"",displayName:"Index Name",name:"indexName_string",required:!0,description:"Name of the index on which to perform the operation.",displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}},typeOptions:{loadOptions:{routing:{request:{method:"GET",url:"/1/indexes"},output:{postReceive:[{type:"rootProperty",properties:{property:"items"}},{type:"setKeyValue",properties:{name:"={{ $responseItem.name }}",value:"={{ $responseItem.name }}"}}]}}}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",default:"",description:"Search query for rules.",displayName:"Query",name:"query_string"},{type:"options",default:"",description:"Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",options:[{name:"is",value:"is"},{name:"startsWith",value:"startsWith"},{name:"endsWith",value:"endsWith"},{name:"contains",value:"contains"}],displayName:"Anchoring",name:"anchoring_options"},{type:"string",placeholder:"mobile",default:"",description:"Only return rules that match the context (exact match).",displayName:"Context",name:"context_string"},{type:"number",default:"",description:"Requested page of the API response.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Maximum number of hits per page.\n\nAlgolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).\n\n- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.\n- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.\n\nFor example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.\n",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"json",name:"enabled",displayName:"Enabled",default:""}],routing:{request:{body:{query:"={{ $value.query_string }}",anchoring:"={{ $value.anchoring_options }}",context:"={{ $value.context_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",enabled:"={{ JSON.parse($value.enabled) }}"}}},displayOptions:{show:{resource:["Rules"],operation:["searchRules"]}}}],se=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve a rule",value:"getRule",action:"Retrieve a rule",description:"Retrieves a rule by its ID.",routing:{request:{method:"GET",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or replace a rule",value:"saveRule",action:"Create or replace a rule",description:"If a rule with the specified object ID doesn't exist, it's created.",routing:{request:{method:"PUT",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Delete a rule",value:"deleteRule",action:"Delete a rule",description:"Deletes a rule by its ID.",routing:{request:{method:"DELETE",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/{{ $parameter.objectID_string }}"}}},{name:"Create or update rules",value:"saveRules",action:"Create or update rules",description:"Create or update multiple rules.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/batch"}}},{name:"Delete all rules",value:"clearRules",action:"Delete all rules",description:"Deletes all rules from the index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/clear"}}},{name:"Search for rules",value:"searchRules",action:"Search for rules",description:"Searches for rules in your index.",routing:{request:{method:"POST",url:"=/1/indexes/{{ $parameter.indexName_string }}/rules/search"}}}],displayOptions:{show:{resource:["Rules"]}}}],re=[...se,...Y,...X,...Z,...ee,...te,...ae],ne=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{type:"json",displayName:"Requests",name:"requests_json",default:"[]",description:"List of additions and deletions to your dictionaries.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"requests"}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"boolean",default:!1,description:"Whether to replace all custom entries in the dictionary with the ones sent with this request.",displayName:"Clear Existing Dictionary Entries",name:"clearExistingDictionaryEntries_boolean"}],routing:{request:{body:{clearExistingDictionaryEntries:"={{ $value.clearExistingDictionaryEntries_boolean }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["batchDictionaryEntries"]}}}],ie=[{type:"options",default:"",options:[{name:"plurals",value:"plurals"},{name:"stopwords",value:"stopwords"},{name:"compounds",value:"compounds"}],displayName:"Dictionary Name",name:"dictionaryName_options",required:!0,description:"Dictionary type in which to search.",displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{type:"string",default:"",description:"Search query.",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"},{type:"options",default:"",description:"ISO code for a supported language.",options:[{name:"af",value:"af"},{name:"ar",value:"ar"},{name:"az",value:"az"},{name:"bg",value:"bg"},{name:"bn",value:"bn"},{name:"ca",value:"ca"},{name:"cs",value:"cs"},{name:"cy",value:"cy"},{name:"da",value:"da"},{name:"de",value:"de"},{name:"el",value:"el"},{name:"en",value:"en"},{name:"eo",value:"eo"},{name:"es",value:"es"},{name:"et",value:"et"},{name:"eu",value:"eu"},{name:"fa",value:"fa"},{name:"fi",value:"fi"},{name:"fo",value:"fo"},{name:"fr",value:"fr"},{name:"ga",value:"ga"},{name:"gl",value:"gl"},{name:"he",value:"he"},{name:"hi",value:"hi"},{name:"hu",value:"hu"},{name:"hy",value:"hy"},{name:"id",value:"id"},{name:"is",value:"is"},{name:"it",value:"it"},{name:"ja",value:"ja"},{name:"ka",value:"ka"},{name:"kk",value:"kk"},{name:"ko",value:"ko"},{name:"ku",value:"ku"},{name:"ky",value:"ky"},{name:"lt",value:"lt"},{name:"lv",value:"lv"},{name:"mi",value:"mi"},{name:"mn",value:"mn"},{name:"mr",value:"mr"},{name:"ms",value:"ms"},{name:"mt",value:"mt"},{name:"nb",value:"nb"},{name:"nl",value:"nl"},{name:"no",value:"no"},{name:"ns",value:"ns"},{name:"pl",value:"pl"},{name:"ps",value:"ps"},{name:"pt",value:"pt"},{name:"pt-br",value:"pt-br"},{name:"qu",value:"qu"},{name:"ro",value:"ro"},{name:"ru",value:"ru"},{name:"sk",value:"sk"},{name:"sq",value:"sq"},{name:"sv",value:"sv"},{name:"sw",value:"sw"},{name:"ta",value:"ta"},{name:"te",value:"te"},{name:"th",value:"th"},{name:"tl",value:"tl"},{name:"tn",value:"tn"},{name:"tr",value:"tr"},{name:"tt",value:"tt"},{name:"uk",value:"uk"},{name:"ur",value:"ur"},{name:"uz",value:"uz"},{name:"zh",value:"zh"}],displayName:"Language",name:"language_options"}],routing:{request:{body:{page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}",language:"={{ $value.language_options }}"}}},displayOptions:{show:{resource:["Dictionaries"],operation:["searchDictionaryEntries"]}}}],oe=[{type:"json",description:`Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages) and boolean values.
|
|
640
|
+
`,required:!0,default:"{}",routing:{send:{type:"body",property:"disableStandardEntries",value:"={{ JSON.parse($value) }}"}},displayName:"Disable Standard Entries",name:"disable_standard_entries_object",displayOptions:{show:{resource:["Dictionaries"],operation:["setDictionarySettings"]}}}],le=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Add or delete dictionary entries",value:"batchDictionaryEntries",action:"Add or delete dictionary entries",description:"Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/batch"}}},{name:"Search dictionary entries",value:"searchDictionaryEntries",action:"Search dictionary entries",description:"Searches for standard and custom dictionary entries.",routing:{request:{method:"POST",url:"=/1/dictionaries/{{ $parameter.dictionaryName_options }}/search"}}},{name:"Retrieve dictionary settings",value:"getDictionarySettings",action:"Retrieve dictionary settings",description:"Retrieves the languages for which standard dictionary entries are turned off.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/settings"}}},{name:"Update dictionary settings",value:"setDictionarySettings",action:"Update dictionary settings",description:"Turns standard stop word dictionary entries on or off for a given language.",routing:{request:{method:"PUT",url:"=/1/dictionaries/*/settings"}}},{name:"List available languages",value:"getDictionaryLanguages",action:"List available languages",description:"Lists supported languages with their supported dictionary types and number of custom entries.",routing:{request:{method:"GET",url:"=/1/dictionaries/*/languages"}}}],displayOptions:{show:{resource:["Dictionaries"]}}}],pe=[...le,...ne,...ie,...oe],de=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["assignUserId"]}}}],ue=[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",routing:{send:{type:"body",value:"={{ $value }}",property:"cluster"}},displayName:"Cluster",name:"cluster_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"json",displayName:"Users",name:"users_json",default:"[]",description:"User IDs to assign.",required:!0,routing:{send:{type:"body",value:"={{ JSON.parse($value) }}",property:"users"}},displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}},{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},routing:{request:{headers:{"X-Algolia-User-ID":"={{ $value }}"}}},displayName:"X-Algolia-User-ID",name:"X-Algolia-User-ID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["batchAssignUserIds"]}}}],ce=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["getUserId"]}}}],me=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"boolean",default:!1,displayName:"Get Clusters",name:"getClusters_boolean",description:"Whether to include the cluster's pending mapping state in the response."}],routing:{request:{qs:{getClusters:"={{ $value.getClusters_boolean }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["hasPendingMappings"]}}}],he=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"json",name:"page",displayName:"Page",default:"",description:"Requested page of the API response.\nIf `null`, the API response is not paginated.\n"},{type:"number",default:100,displayName:"Hits Per Page",name:"hitsPerPage_number",description:"Number of hits per page."}],routing:{request:{qs:{page:"={{ JSON.parse($value.page) }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["listUserIds"]}}}],ye=[{type:"string",placeholder:"user1",default:"",description:"Unique identifier of the user who makes the search request.",typeOptions:{pattern:"^[a-zA-Z0-9 -*.]+$"},displayName:"User ID",name:"userID_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["removeUserId"]}}}],ge=[{type:"string",default:"",routing:{send:{type:"body",value:"={{ $value }}",property:"query"}},displayName:"Query",name:"query_string",required:!0,displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"c11-test",default:"",description:"Cluster name.",displayName:"Cluster Name",name:"clusterName_string"},{type:"number",default:"",description:"Page of search results to retrieve.",typeOptions:{minValue:0},displayName:"Page",name:"page_number"},{type:"number",default:20,description:"Number of hits per page.",typeOptions:{minValue:1,maxValue:1e3},displayName:"Hits Per Page",name:"hitsPerPage_number"}],routing:{request:{body:{clusterName:"={{ $value.clusterName_string }}",page:"={{ $value.page_number }}",hitsPerPage:"={{ $value.hitsPerPage_number }}"}}},displayOptions:{show:{resource:["Clusters"],operation:["searchUserIds"]}}}],fe=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Assign or move a user ID",value:"assignUserId",action:"Assign or move a user ID",description:"Assigns or moves a user ID to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping"}}},{name:"List user IDs",value:"listUserIds",action:"List user IDs",description:"Lists the userIDs assigned to a multi-cluster application.",routing:{request:{method:"GET",url:"=/1/clusters/mapping"}}},{name:"Assign multiple userIDs",value:"batchAssignUserIds",action:"Assign multiple userIDs",description:"Assigns multiple user IDs to a cluster.",routing:{request:{method:"POST",url:"=/1/clusters/mapping/batch"}}},{name:"Get top user IDs",value:"getTopUserIds",action:"Get top user IDs",description:"Get the IDs of the 10 users with the highest number of records per cluster.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/top"}}},{name:"Retrieve user ID",value:"getUserId",action:"Retrieve user ID",description:"Returns the user ID data stored in the mapping.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"Delete user ID",value:"removeUserId",action:"Delete user ID",description:"Deletes a user ID and its associated data from the clusters.",routing:{request:{method:"DELETE",url:"=/1/clusters/mapping/{{ $parameter.userID_string }}"}}},{name:"List clusters",value:"listClusters",action:"List clusters",description:"Lists the available clusters in a multi-cluster setup.",routing:{request:{method:"GET",url:"=/1/clusters"}}},{name:"Search for user IDs",value:"searchUserIds",action:"Search for user IDs",description:"Since it can take a few seconds to get the data from the different clusters,",routing:{request:{method:"POST",url:"=/1/clusters/mapping/search"}}},{name:"Get migration and user mapping status",value:"hasPendingMappings",action:"Get migration and user mapping status",description:"To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.",routing:{request:{method:"GET",url:"=/1/clusters/mapping/pending"}}}],displayOptions:{show:{resource:["Clusters"]}}}],be=[...fe,...de,...ue,...ce,...me,...he,...ye,...ge],we=[{type:"string",placeholder:"10.0.0.1/32",default:"",description:"IP address range of the source.",routing:{send:{type:"body",value:"={{ $value }}",property:"source"}},displayName:"Source",name:"source_string",required:!0,displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}},{displayName:"Additional Properties",name:"additionalProperties",type:"collection",placeholder:"Add property",default:{},required:!1,options:[{type:"string",placeholder:"Server subnet",default:"",description:"Source description.",displayName:"Description",name:"description_string"}],routing:{request:{body:{description:"={{ $value.description_string }}"}}},displayOptions:{show:{resource:["Vaults"],operation:["appendSource"]}}}],_e=[{type:"string",placeholder:"10.0.0.1/32",default:"",displayName:"Source",name:"source_string",required:!0,description:"IP address range of the source.",displayOptions:{show:{resource:["Vaults"],operation:["deleteSource"]}}}],ve=[{type:"json",displayName:"Body",name:"body",default:"[]",description:"Sources.",required:!0,routing:{request:{body:"={{ $value }}"}},displayOptions:{show:{resource:["Vaults"],operation:["replaceSources"]}}}],Ne=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"List allowed sources",value:"getSources",action:"List allowed sources",description:"Retrieves all allowed IP addresses with access to your application.",routing:{request:{method:"GET",url:"=/1/security/sources"}}},{name:"Replace allowed sources",value:"replaceSources",action:"Replace allowed sources",description:"Replaces the list of allowed sources.",routing:{request:{method:"PUT",url:"=/1/security/sources"}}},{name:"Add a source",value:"appendSource",action:"Add a source",description:"Adds a source to the list of allowed sources.",routing:{request:{method:"POST",url:"=/1/security/sources/append"}}},{name:"Delete a source",value:"deleteSource",action:"Delete a source",description:"Deletes a source from the list of allowed sources.",routing:{request:{method:"DELETE",url:"=/1/security/sources/{{ $parameter.source_string }}"}}}],displayOptions:{show:{resource:["Vaults"]}}}],Oe=[...Ne,...we,..._e,...ve],xe=[{type:"number",placeholder:"1506303845001",default:"",displayName:"Task ID",name:"taskID_number",required:!0,description:"Unique task identifier.",displayOptions:{show:{resource:["Advanced"],operation:["getAppTask"]}}}],Pe=[{displayName:"Options",name:"options",type:"collection",placeholder:"Add option",default:{},required:!1,options:[{type:"number",default:"",displayName:"Offset",name:"offset_number",description:"First log entry to retrieve. The most recent entries are listed first."},{type:"number",default:10,typeOptions:{maxValue:1e3},displayName:"Length",name:"length_number",description:"Maximum number of entries to retrieve."},{type:"json",name:"indexName",displayName:"Index Name",default:"",description:`Index for which to retrieve log entries.
|
|
639
641
|
By default, log entries are retrieved for all indices.
|
|
640
642
|
`},{type:"options",default:"all",options:[{name:"all",value:"all"},{name:"query",value:"query"},{name:"build",value:"build"},{name:"error",value:"error"}],displayName:"Type",name:"type_options",description:`Type of log entries to retrieve.
|
|
641
643
|
By default, all log entries are retrieved.
|
|
642
|
-
`}],routing:{request:{qs:{offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",indexName:"={{ JSON.parse($value.indexName) }}",type:"={{ $value.type_options }}"}}},displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}}],Ae=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve log entries",value:"getLogs",action:"Retrieve log entries",description:"The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).",routing:{request:{method:"GET",url:"=/1/logs"}}},{name:"Check application task status",value:"getAppTask",action:"Check application task status",description:"Checks the status of a given application task.",routing:{request:{method:"GET",url:"=/1/task/{{ $parameter.taskID_number }}"}}}],displayOptions:{show:{resource:["Advanced"]}}}],Te=[...Ae,...
|
|
644
|
+
`}],routing:{request:{qs:{offset:"={{ $value.offset_number }}",length:"={{ $value.length_number }}",indexName:"={{ JSON.parse($value.indexName) }}",type:"={{ $value.type_options }}"}}},displayOptions:{show:{resource:["Advanced"],operation:["getLogs"]}}}],Ae=[{displayName:"Operation",name:"operation",type:"options",default:"",description:"Select the operation to work with",options:[{name:"Retrieve log entries",value:"getLogs",action:"Retrieve log entries",description:"The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).",routing:{request:{method:"GET",url:"=/1/logs"}}},{name:"Check application task status",value:"getAppTask",action:"Check application task status",description:"Checks the status of a given application task.",routing:{request:{method:"GET",url:"=/1/task/{{ $parameter.taskID_number }}"}}}],displayOptions:{show:{resource:["Advanced"]}}}],Te=[...Ae,...xe,...Pe],qe=[{displayName:"Resource",name:"resource",type:"options",default:"",description:"Select the resource to work with",options:[{name:"Advanced",value:"Advanced",description:"Query your logs"},{name:"Api Keys",value:"Api Keys",description:"Manage your API keys"},{name:"Clusters",value:"Clusters",description:"Multi-cluster operations"},{name:"Dictionaries",value:"Dictionaries",description:"Manage your dictionaries"},{name:"Indices",value:"Indices",description:"Manage your indices and index settings"},{name:"Records",value:"Records",description:"Add, update, and delete records from your indices"},{name:"Rules",value:"Rules",description:"Create, update, delete, and search for rules"},{name:"Search",value:"Search",description:"Search one or more indices for matching records or facet values"},{name:"Synonyms",value:"Synonyms",description:"Create, update, delete, and search for synonyms"},{name:"Vaults",value:"Vaults",description:"Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest"}]}],Se=[...qe,...y,...T,...D,...U,...K,...re,...pe,...be,...Oe,...Te];class je{constructor(){this.description={name:"algolia",displayName:"Algolia",description:"Use Algolia in your n8n workflows",subtitle:'={{ $parameter.operation.replace(/([a-z])([A-Z])/g, "$1 $2").toTitleCase() }}',icon:"file:../../algolia.svg",defaults:{name:"Algolia"},credentials:[{name:"algoliaApi",required:!0}],requestDefaults:{baseURL:"=https://{{ $credentials.appId }}.algolia.net",headers:{"User-Agent":`${o.name} (${o.version})`}},version:1,inputs:[i.NodeConnectionTypes.Main],outputs:[i.NodeConnectionTypes.Main],properties:Se,group:[]}}}exports.Algolia=je;
|