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 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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install zincsearch-sdk --save

Finally, you need to build the module:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

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:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

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:

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

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

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 | GET /healthz | Get healthz ZincSearchSDK.Default | version | GET /version | Get version ZincSearchSDK.Document | bulk | POST /api/_bulk | Bulk documents ZincSearchSDK.Document | bulkv2 | POST /api/_bulkv2 | Bulkv2 documents ZincSearchSDK.Document | delete | DELETE /api/{index}/_doc/{id} | Delete document ZincSearchSDK.Document | esBulk | POST /es/_bulk | ES bulk documents ZincSearchSDK.Document | index | POST /api/{index}/_doc | Create or update document ZincSearchSDK.Document | indexWithID | PUT /api/{index}/_doc/{id} | Create or update document with id ZincSearchSDK.Document | multi | POST /api/{index}/_multi | Multi documents ZincSearchSDK.Document | update | POST /api/{index}/_update/{id} | Update document with id ZincSearchSDK.Index | addOrRemoveESAlias | POST /es/_aliases | Add or remove index alias for compatible ES ZincSearchSDK.Index | analyze | POST /api/_analyze | Analyze ZincSearchSDK.Index | analyzeIndex | POST /api/{index}/_analyze | Analyze ZincSearchSDK.Index | delete | DELETE /api/index/{index} | Delete index ZincSearchSDK.Index | create | POST /api/index | Create index ZincSearchSDK.Index | createTemplate | POST /es/_index_template | Create update index template ZincSearchSDK.Index | deleteTemplate | DELETE /es/_index_template/{name} | Delete template ZincSearchSDK.Index | eSCreateIndex | PUT /es/{index} | Create index for compatible ES ZincSearchSDK.Index | eSGetMapping | GET /es/{index}/_mapping | Get index mappings for compatible ES ZincSearchSDK.Index | esExists | HEAD /es/{index} | Checks if the index exists for compatible ES ZincSearchSDK.Index | exists | HEAD /api/index/{index} | Checks if the index exists ZincSearchSDK.Index | getESAliases | GET /es/{target}/_alias/{target_alias} | Get index alias for compatible ES ZincSearchSDK.Index | getIndex | GET /api/index/{index} | Get index metadata ZincSearchSDK.Index | getMapping | GET /api/{index}/_mapping | Get index mappings ZincSearchSDK.Index | getSettings | GET /api/{index}/_settings | Get index settings ZincSearchSDK.Index | getTemplate | GET /es/_index_template/{name} | Get index template ZincSearchSDK.Index | indexNameList | GET /api/index_name | List index Name ZincSearchSDK.Index | list | GET /api/index | List indexes ZincSearchSDK.Index | listTemplates | GET /es/_index_template | List index teplates ZincSearchSDK.Index | refresh | POST /api/index/{index}/refresh | Resfresh index ZincSearchSDK.Index | setMapping | PUT /api/{index}/_mapping | Set index mappings ZincSearchSDK.Index | setSettings | PUT /api/{index}/_settings | Set index Settings ZincSearchSDK.Index | updateTemplate | PUT /es/_index_template/{name} | Create update index template ZincSearchSDK.Search | deleteByQuery | POST /es/{index}/_delete_by_query | Searches the index and deletes all matched documents ZincSearchSDK.Search | mSearch | POST /es/_msearch | Search V2 MultipleSearch for compatible ES ZincSearchSDK.Search | search | POST /es/{index}/_search | Search V2 DSL for compatible ES ZincSearchSDK.Search | searchV1 | POST /api/{index}/_search | Search V1 ZincSearchSDK.User | delete | DELETE /api/user/{id} | Delete user ZincSearchSDK.User | create | POST /api/user | Create user ZincSearchSDK.User | list | GET /api/user | List user ZincSearchSDK.User | login | POST /api/login | Login ZincSearchSDK.User | update | PUT /api/user | Update user

Documentation for Models

• ZincSearchSDK.AggregationHistogramBound
• ZincSearchSDK.AuthLoginRequest
• ZincSearchSDK.AuthLoginResponse
• ZincSearchSDK.AuthLoginUser
• ZincSearchSDK.IndexAnalyzeResponse
• ZincSearchSDK.IndexAnalyzeResponseToken
• ZincSearchSDK.IndexIndexListResponse
• ZincSearchSDK.MetaAggregationAutoDateHistogram
• ZincSearchSDK.MetaAggregationDateHistogram
• ZincSearchSDK.MetaAggregationDateRange
• ZincSearchSDK.MetaAggregationHistogram
• ZincSearchSDK.MetaAggregationIPRange
• ZincSearchSDK.MetaAggregationMetric
• ZincSearchSDK.MetaAggregationRange
• ZincSearchSDK.MetaAggregationResponse
• ZincSearchSDK.MetaAggregations
• ZincSearchSDK.MetaAggregationsTerms
• ZincSearchSDK.MetaAnalyzer
• ZincSearchSDK.MetaBoolQuery
• ZincSearchSDK.MetaDateRange
• ZincSearchSDK.MetaExistsQuery
• ZincSearchSDK.MetaFuzzyQuery
• ZincSearchSDK.MetaHTTPResponse
• ZincSearchSDK.MetaHTTPResponseDeleteByQuery
• ZincSearchSDK.MetaHTTPResponseDocument
• ZincSearchSDK.MetaHTTPResponseError
• ZincSearchSDK.MetaHTTPResponseID
• ZincSearchSDK.MetaHTTPResponseIndex
• ZincSearchSDK.MetaHTTPResponseRecordCount
• ZincSearchSDK.MetaHTTPResponseTemplate
• ZincSearchSDK.MetaHealthzResponse
• ZincSearchSDK.MetaHighlight
• ZincSearchSDK.MetaHit
• ZincSearchSDK.MetaHits
• ZincSearchSDK.MetaHttpRetriesResponse
• ZincSearchSDK.MetaIPRange
• ZincSearchSDK.MetaIdsQuery
• ZincSearchSDK.MetaIndexAnalysis
• ZincSearchSDK.MetaIndexSettings
• ZincSearchSDK.MetaIndexSimple
• ZincSearchSDK.MetaIndexTemplate
• ZincSearchSDK.MetaJSONIngest
• ZincSearchSDK.MetaMappings
• ZincSearchSDK.MetaMatchBoolPrefixQuery
• ZincSearchSDK.MetaMatchPhrasePrefixQuery
• ZincSearchSDK.MetaMatchPhraseQuery
• ZincSearchSDK.MetaMatchQuery
• ZincSearchSDK.MetaMultiMatchQuery
• ZincSearchSDK.MetaPage
• ZincSearchSDK.MetaPrefixQuery
• ZincSearchSDK.MetaProperty
• ZincSearchSDK.MetaQuery
• ZincSearchSDK.MetaQueryStringQuery
• ZincSearchSDK.MetaRange
• ZincSearchSDK.MetaRangeQuery
• ZincSearchSDK.MetaRegexpQuery
• ZincSearchSDK.MetaSearchResponse
• ZincSearchSDK.MetaShards
• ZincSearchSDK.MetaSimpleQueryStringQuery
• ZincSearchSDK.MetaTemplate
• ZincSearchSDK.MetaTemplateTemplate
• ZincSearchSDK.MetaTermQuery
• ZincSearchSDK.MetaTotal
• ZincSearchSDK.MetaUser
• ZincSearchSDK.MetaVersionResponse
• ZincSearchSDK.MetaWildcardQuery
• ZincSearchSDK.MetaZincQuery
• ZincSearchSDK.V1AggregationDateRange
• ZincSearchSDK.V1AggregationNumberRange
• ZincSearchSDK.V1AggregationParams
• ZincSearchSDK.V1QueryParams
• ZincSearchSDK.V1ZincQuery

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication