swagger-client

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.45
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AutocompleteApi(swagger_client.ApiClient(configuration))
prefix = 'prefix_example' # str | search prefix
limit = 6 # int | Number of results to return. (optional) (default to 6)
explain = false # bool | Whether to return explanation of results. (optional) (default to false)
bucket = 'default' # str | AB test bucket (optional) (default to default)

try:
    # Returns a list of suggestions based on search prefix.
    api_response = api_instance.get_v1_autocomplete(prefix, limit=limit, explain=explain, bucket=bucket)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutocompleteApi->get_v1_autocomplete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
AutocompleteApi	get_v1_autocomplete	GET /v1/autocomplete	Returns a list of suggestions based on search prefix.
AutocompleteApi	post_v1_autocomplete	POST /v1/autocomplete	Returns a list of suggestions based on search prefix.
DesignsApi	post_v1_similar_designs	POST /v1/similar-designs	Returns a list of discoverable designs based on the query of a design's primary tag.
RelatedApi	get_v1_related_search	GET /v1/related-search	Gets related searches based on given term
SearchApi	post_artist_search	POST /v1/artist-search	Performs search on active designs by artist
SearchApi	post_v2_dmca_search	POST /v2/dmca-search	Performs search on publishable designs.
SearchApi	post_v2_search	POST /v2/search	Returns a list of discoverable designs based on search query.
ServiceApi	healthcheck_get	GET /healthcheck	Check if the service is running
TagApi	get_v1_design_tags	GET /v1/design-tags	Gets tags for a design
TagApi	get_v1_link_graph	GET /v1/link-graph	Retrieves the status of tags considered for our link graph.
TagApi	get_v1_related_tags	GET /v1/related-tags	Gets related tags based on given term(s)
TagApi	get_v1_tag_suggestions	GET /v1/tag-suggestions	Returns a list of tag suggestions based on search prefix.
TagApi	get_v1_tags	GET /v1/tags	Gets tags data based on name(s)
TagApi	post_v1_design_tags	POST /v1/design-tags	Sets taggings for designs
TagApi	post_v1_link_graph	POST /v1/link-graph	Sets the status of tags considered for our link graph.
TagApi	post_v1_tags	POST /v1/tags	Sets tags properties
TrendingApi	get_v1_trending_search	GET /v1/trending-search	Gets trending search results.
TrendingApi	post_v1_trending_search	POST /v1/trending-search	Saves trending search results.

Documentation For Models

• ArtistSearchRequest
• AutocompleteRequest
• AutocompleteResponse
• AutocompleteSuggestion
• Design
• DesignSlim
• DesignTagsResponse
• DmcaSearchRequestV2
• EsAutocompleteSuggest
• EsCompletionSuggest
• EsCompletionSuggestOption
• EsHit
• EsHits
• EsSearchResponse
• Explain
• LinkGraphResponse
• RelatedResponse
• RelatedResult
• RelatedTagObject
• RelatedTagResponse
• RelatedTagResult
• SearchRequest
• SearchRequestV2
• SearchResponse
• SetDesignTaggingsObject
• SetDesignsTaggingsRequest
• SetDesignsTagsResponse
• SetLinkGraphRequest
• SetLinkGraphResponse
• SetTagObject
• SetTagsRequest
• SetTagsResponse
• SimilarDesignsRequestV1
• SimilarDesignsResponse
• TagResult
• TagsResponse
• TrendingRequest
• TrendingResult

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Author