Skip to content

Latest commit

 

History

History
173 lines (121 loc) · 5.49 KB

SearchApi.md

File metadata and controls

173 lines (121 loc) · 5.49 KB
Raw

swagger_client.SearchApi

All URIs are relative to https://localhost

Method HTTP request Description
post_artist_search POST /v1/artist-search Performs search on active designs by artist
post_v2_dmca_search POST /v2/dmca-search Performs search on publishable designs.
post_v2_search POST /v2/search Returns a list of discoverable designs based on search query.

post_artist_search

SearchResponse post_artist_search(body)

Performs search on active designs by artist

Performs search on designs by artist username or slug which are discoverable and non-affiliate

Example

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.SearchApi(swagger_client.ApiClient(configuration))
body = swagger_client.ArtistSearchRequest() # ArtistSearchRequest | User Search Request

try:
    # Performs search on active designs by artist
    api_response = api_instance.post_artist_search(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchApi->post_artist_search: %s\n" % e)

Parameters

Name Type Description Notes
body ArtistSearchRequest User Search Request

Return type

SearchResponse

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_v2_dmca_search

SearchResponse post_v2_dmca_search(body)

Performs search on publishable designs.

Performs search on publishable designs that have not had a a DMCA takedown. Supports filtering of teepublic approved/unapproved designs.

Example

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.SearchApi(swagger_client.ApiClient(configuration))
body = swagger_client.DmcaSearchRequestV2() # DmcaSearchRequestV2 | User Search Request

try:
    # Performs search on publishable designs.
    api_response = api_instance.post_v2_dmca_search(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchApi->post_v2_dmca_search: %s\n" % e)

Parameters

Name Type Description Notes
body DmcaSearchRequestV2 User Search Request

Return type

SearchResponse

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_v2_search

SearchResponse post_v2_search(body)

Returns a list of discoverable designs based on search query.

Returns a list of discoverable designs based on search query.

Example

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.SearchApi(swagger_client.ApiClient(configuration))
body = swagger_client.SearchRequestV2() # SearchRequestV2 | User Search Request

try:
    # Returns a list of discoverable designs based on search query.
    api_response = api_instance.post_v2_search(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchApi->post_v2_search: %s\n" % e)

Parameters

Name Type Description Notes
body SearchRequestV2 User Search Request

Return type

SearchResponse

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]