Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/zincsearch/sdk-nodejs-zincsearch

NodeJS SDK Client for ZincSearch
https://github.com/zincsearch/sdk-nodejs-zincsearch
zinc zincsearch
Last synced: about 2 months ago
JSON representation
NodeJS SDK Client for ZincSearch
Host: GitHub
URL: https://github.com/zincsearch/sdk-nodejs-zincsearch
Owner: zincsearch
License: apache-2.0
Created: 2022-06-23T12:51:39.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-09-21T10:48:37.000Z (over 2 years ago)
Last Synced: 2023-03-30T09:44:22.405Z (over 1 year ago)
Topics: zinc, zincsearch
Language: JavaScript
Homepage: https://docs.zincsearch.com
Size: 145 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # zincsearch-sdk

ZincSearchSDK - JavaScript client for zincsearch-sdk

Zinc Search engine API documents https://docs.zincsearch.com

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.3.3

- Package version: 0.3.3

- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

For more information, please visit [https://www.zincsearch.com](https://www.zincsearch.com)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell

npm install zincsearch-sdk --save

```

Finally, you need to build the module:

```shell

npm run build

```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell

npm install

```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell

npm link

```

To use the link you just defined in your project, switch to the directory you want to use your zincsearch-sdk from, and run:

```shell

npm link /path/to/

```

Finally, you need to build the module:

```shell

npm run build

```

#### git

If the library is hosted at a git repository, e.g.https://github.com/zinclabs/sdk-nodejs-zincsearch

then install it via:

```shell

    npm install zinclabs/sdk-nodejs-zincsearch --save

```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following

the above steps with Node.js and installing browserify with `npm install -g browserify`,

perform the following (assuming *main.js* is your entry file):

```shell

browserify main.js > bundle.js

```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:

Cannot resolve module", most certainly you should disable AMD loader. Add/merge

the following section to your webpack config:

```javascript

module: {

  rules: [

    {

      parser: {

        amd: false

      }

    }

  ]

}

```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript

var ZincSearchSDK = require('zincsearch-sdk');

var defaultClient = ZincSearchSDK.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth

var basicAuth = defaultClient.authentications['basicAuth'];

basicAuth.username = 'YOUR USERNAME'

basicAuth.password = 'YOUR PASSWORD'

var api = new ZincSearchSDK.Default()

var callback = function(error, data, response) {

  if (error) {

    console.error(error);

  } else {

    console.log('API called successfully. Returned data: ' + data);

  }

};

api.healthz(callback);

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:4080*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*ZincSearchSDK.Default* | [**healthz**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Default.md#healthz) | **GET** /healthz | Get healthz

*ZincSearchSDK.Default* | [**version**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Default.md#version) | **GET** /version | Get version

*ZincSearchSDK.Document* | [**bulk**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#bulk) | **POST** /api/_bulk | Bulk documents

*ZincSearchSDK.Document* | [**bulkv2**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#bulkv2) | **POST** /api/_bulkv2 | Bulkv2 documents

*ZincSearchSDK.Document* | [**delete**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#delete) | **DELETE** /api/{index}/_doc/{id} | Delete document

*ZincSearchSDK.Document* | [**esBulk**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#esBulk) | **POST** /es/_bulk | ES bulk documents

*ZincSearchSDK.Document* | [**index**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#index) | **POST** /api/{index}/_doc | Create or update document

*ZincSearchSDK.Document* | [**indexWithID**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#indexWithID) | **PUT** /api/{index}/_doc/{id} | Create or update document with id

*ZincSearchSDK.Document* | [**multi**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#multi) | **POST** /api/{index}/_multi | Multi documents

*ZincSearchSDK.Document* | [**update**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Document.md#update) | **POST** /api/{index}/_update/{id} | Update document with id

*ZincSearchSDK.Index* | [**addOrRemoveESAlias**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#addOrRemoveESAlias) | **POST** /es/_aliases | Add or remove index alias for compatible ES

*ZincSearchSDK.Index* | [**analyze**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#analyze) | **POST** /api/_analyze | Analyze

*ZincSearchSDK.Index* | [**analyzeIndex**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#analyzeIndex) | **POST** /api/{index}/_analyze | Analyze

*ZincSearchSDK.Index* | [**delete**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#delete) | **DELETE** /api/index/{index} | Delete index

*ZincSearchSDK.Index* | [**create**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#create) | **POST** /api/index | Create index

*ZincSearchSDK.Index* | [**createTemplate**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#createTemplate) | **POST** /es/_index_template | Create update index template

*ZincSearchSDK.Index* | [**deleteTemplate**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#deleteTemplate) | **DELETE** /es/_index_template/{name} | Delete template

*ZincSearchSDK.Index* | [**eSCreateIndex**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#eSCreateIndex) | **PUT** /es/{index} | Create index for compatible ES

*ZincSearchSDK.Index* | [**eSGetMapping**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#eSGetMapping) | **GET** /es/{index}/_mapping | Get index mappings for compatible ES

*ZincSearchSDK.Index* | [**esExists**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#esExists) | **HEAD** /es/{index} | Checks if the index exists for compatible ES

*ZincSearchSDK.Index* | [**exists**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#exists) | **HEAD** /api/index/{index} | Checks if the index exists

*ZincSearchSDK.Index* | [**getESAliases**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#getESAliases) | **GET** /es/{target}/_alias/{target_alias} | Get index alias for compatible ES

*ZincSearchSDK.Index* | [**getIndex**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#getIndex) | **GET** /api/index/{index} | Get index metadata

*ZincSearchSDK.Index* | [**getMapping**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#getMapping) | **GET** /api/{index}/_mapping | Get index mappings

*ZincSearchSDK.Index* | [**getSettings**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#getSettings) | **GET** /api/{index}/_settings | Get index settings

*ZincSearchSDK.Index* | [**getTemplate**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#getTemplate) | **GET** /es/_index_template/{name} | Get index template

*ZincSearchSDK.Index* | [**indexNameList**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#indexNameList) | **GET** /api/index_name | List index Name

*ZincSearchSDK.Index* | [**list**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#list) | **GET** /api/index | List indexes

*ZincSearchSDK.Index* | [**listTemplates**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#listTemplates) | **GET** /es/_index_template | List index teplates

*ZincSearchSDK.Index* | [**refresh**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#refresh) | **POST** /api/index/{index}/refresh | Resfresh index

*ZincSearchSDK.Index* | [**setMapping**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#setMapping) | **PUT** /api/{index}/_mapping | Set index mappings

*ZincSearchSDK.Index* | [**setSettings**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#setSettings) | **PUT** /api/{index}/_settings | Set index Settings

*ZincSearchSDK.Index* | [**updateTemplate**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Index.md#updateTemplate) | **PUT** /es/_index_template/{name} | Create update index template

*ZincSearchSDK.Search* | [**deleteByQuery**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Search.md#deleteByQuery) | **POST** /es/{index}/_delete_by_query | Searches the index and deletes all matched documents

*ZincSearchSDK.Search* | [**mSearch**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Search.md#mSearch) | **POST** /es/_msearch | Search V2 MultipleSearch for compatible ES

*ZincSearchSDK.Search* | [**search**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Search.md#search) | **POST** /es/{index}/_search | Search V2 DSL for compatible ES

*ZincSearchSDK.Search* | [**searchV1**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/Search.md#searchV1) | **POST** /api/{index}/_search | Search V1

*ZincSearchSDK.User* | [**delete**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/User.md#delete) | **DELETE** /api/user/{id} | Delete user

*ZincSearchSDK.User* | [**create**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/User.md#create) | **POST** /api/user | Create user

*ZincSearchSDK.User* | [**list**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/User.md#list) | **GET** /api/user | List user

*ZincSearchSDK.User* | [**login**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/User.md#login) | **POST** /api/login | Login

*ZincSearchSDK.User* | [**update**](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/User.md#update) | **PUT** /api/user | Update user

## Documentation for Models

 - [ZincSearchSDK.AggregationHistogramBound](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/AggregationHistogramBound.md)

 - [ZincSearchSDK.AuthLoginRequest](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/AuthLoginRequest.md)

 - [ZincSearchSDK.AuthLoginResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/AuthLoginResponse.md)

 - [ZincSearchSDK.AuthLoginUser](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/AuthLoginUser.md)

 - [ZincSearchSDK.IndexAnalyzeResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/IndexAnalyzeResponse.md)

 - [ZincSearchSDK.IndexAnalyzeResponseToken](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/IndexAnalyzeResponseToken.md)

 - [ZincSearchSDK.IndexIndexListResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/IndexIndexListResponse.md)

 - [ZincSearchSDK.MetaAggregationAutoDateHistogram](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationAutoDateHistogram.md)

 - [ZincSearchSDK.MetaAggregationDateHistogram](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationDateHistogram.md)

 - [ZincSearchSDK.MetaAggregationDateRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationDateRange.md)

 - [ZincSearchSDK.MetaAggregationHistogram](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationHistogram.md)

 - [ZincSearchSDK.MetaAggregationIPRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationIPRange.md)

 - [ZincSearchSDK.MetaAggregationMetric](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationMetric.md)

 - [ZincSearchSDK.MetaAggregationRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationRange.md)

 - [ZincSearchSDK.MetaAggregationResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationResponse.md)

 - [ZincSearchSDK.MetaAggregations](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregations.md)

 - [ZincSearchSDK.MetaAggregationsTerms](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAggregationsTerms.md)

 - [ZincSearchSDK.MetaAnalyzer](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaAnalyzer.md)

 - [ZincSearchSDK.MetaBoolQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaBoolQuery.md)

 - [ZincSearchSDK.MetaDateRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaDateRange.md)

 - [ZincSearchSDK.MetaExistsQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaExistsQuery.md)

 - [ZincSearchSDK.MetaFuzzyQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaFuzzyQuery.md)

 - [ZincSearchSDK.MetaHTTPResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponse.md)

 - [ZincSearchSDK.MetaHTTPResponseDeleteByQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponseDeleteByQuery.md)

 - [ZincSearchSDK.MetaHTTPResponseDocument](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponseDocument.md)

 - [ZincSearchSDK.MetaHTTPResponseError](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponseError.md)

 - [ZincSearchSDK.MetaHTTPResponseID](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponseID.md)

 - [ZincSearchSDK.MetaHTTPResponseIndex](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponseIndex.md)

 - [ZincSearchSDK.MetaHTTPResponseRecordCount](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponseRecordCount.md)

 - [ZincSearchSDK.MetaHTTPResponseTemplate](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHTTPResponseTemplate.md)

 - [ZincSearchSDK.MetaHealthzResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHealthzResponse.md)

 - [ZincSearchSDK.MetaHighlight](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHighlight.md)

 - [ZincSearchSDK.MetaHit](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHit.md)

 - [ZincSearchSDK.MetaHits](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHits.md)

 - [ZincSearchSDK.MetaHttpRetriesResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaHttpRetriesResponse.md)

 - [ZincSearchSDK.MetaIPRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaIPRange.md)

 - [ZincSearchSDK.MetaIdsQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaIdsQuery.md)

 - [ZincSearchSDK.MetaIndexAnalysis](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaIndexAnalysis.md)

 - [ZincSearchSDK.MetaIndexSettings](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaIndexSettings.md)

 - [ZincSearchSDK.MetaIndexSimple](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaIndexSimple.md)

 - [ZincSearchSDK.MetaIndexTemplate](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaIndexTemplate.md)

 - [ZincSearchSDK.MetaJSONIngest](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaJSONIngest.md)

 - [ZincSearchSDK.MetaMappings](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaMappings.md)

 - [ZincSearchSDK.MetaMatchBoolPrefixQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaMatchBoolPrefixQuery.md)

 - [ZincSearchSDK.MetaMatchPhrasePrefixQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaMatchPhrasePrefixQuery.md)

 - [ZincSearchSDK.MetaMatchPhraseQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaMatchPhraseQuery.md)

 - [ZincSearchSDK.MetaMatchQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaMatchQuery.md)

 - [ZincSearchSDK.MetaMultiMatchQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaMultiMatchQuery.md)

 - [ZincSearchSDK.MetaPage](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaPage.md)

 - [ZincSearchSDK.MetaPrefixQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaPrefixQuery.md)

 - [ZincSearchSDK.MetaProperty](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaProperty.md)

 - [ZincSearchSDK.MetaQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaQuery.md)

 - [ZincSearchSDK.MetaQueryStringQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaQueryStringQuery.md)

 - [ZincSearchSDK.MetaRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaRange.md)

 - [ZincSearchSDK.MetaRangeQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaRangeQuery.md)

 - [ZincSearchSDK.MetaRegexpQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaRegexpQuery.md)

 - [ZincSearchSDK.MetaSearchResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaSearchResponse.md)

 - [ZincSearchSDK.MetaShards](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaShards.md)

 - [ZincSearchSDK.MetaSimpleQueryStringQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaSimpleQueryStringQuery.md)

 - [ZincSearchSDK.MetaTemplate](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaTemplate.md)

 - [ZincSearchSDK.MetaTemplateTemplate](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaTemplateTemplate.md)

 - [ZincSearchSDK.MetaTermQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaTermQuery.md)

 - [ZincSearchSDK.MetaTotal](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaTotal.md)

 - [ZincSearchSDK.MetaUser](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaUser.md)

 - [ZincSearchSDK.MetaVersionResponse](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaVersionResponse.md)

 - [ZincSearchSDK.MetaWildcardQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaWildcardQuery.md)

 - [ZincSearchSDK.MetaZincQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/MetaZincQuery.md)

 - [ZincSearchSDK.V1AggregationDateRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/V1AggregationDateRange.md)

 - [ZincSearchSDK.V1AggregationNumberRange](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/V1AggregationNumberRange.md)

 - [ZincSearchSDK.V1AggregationParams](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/V1AggregationParams.md)

 - [ZincSearchSDK.V1QueryParams](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/V1QueryParams.md)

 - [ZincSearchSDK.V1ZincQuery](https://github.com/zinclabs/sdk-nodejs-zincsearch/tree/main/docs/V1ZincQuery.md)

## Documentation for Authorization

### basicAuth

- **Type**: HTTP basic authentication