Skip to content

Latest commit

 

History

History
404 lines (295 loc) · 15.6 KB

BlogPagesApi.md

File metadata and controls

404 lines (295 loc) · 15.6 KB

BlogPagesApi

All URIs are relative to https://api.kinow.com/api

Method HTTP request Description
attach_features_to_blog_page POST /blog-pages/{blog_page_id}/features
attach_product_to_blog_page POST /blog-pages/{blog_page_id}/products
detach_product_from_blog_page DELETE /blog-pages/{blog_page_id}/products/{product_id}
get_blog_page GET /blog-pages/{blog_page_id}
get_blog_page_features GET /blog-pages/{blog_page_id}/features
get_blog_page_products GET /blog-pages/{blog_page_id}/products
get_blog_pages GET /blog-pages

attach_features_to_blog_page

attach_features_to_blog_page(blog_page_id, features)

Attach feature to blog page

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BlogPagesApi()
blog_page_id = 789 # int | 
features = 'features_example' # str |      To attach existing FeatureValue to blog page:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try: 
    api_instance.attach_features_to_blog_page(blog_page_id, features)
except ApiException as e:
    print("Exception when calling BlogPagesApi->attach_features_to_blog_page: %s\n" % e)

Parameters

Name Type Description Notes
blog_page_id int
features str To attach existing FeatureValue to blog page: ``` [{ "id_feature":3, "id_feature_value":5 }] ``` To create a custom FeatureValue: ``` [{ "id_feature":3, "custom_value":[{ "lang": 1, "value": "string" }] }] ```

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

attach_product_to_blog_page

attach_product_to_blog_page(blog_page_id, product_id)

Attach product to blog page

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BlogPagesApi()
blog_page_id = 789 # int | Page ID to fetch
product_id = 789 # int | Product ID to attach

try: 
    api_instance.attach_product_to_blog_page(blog_page_id, product_id)
except ApiException as e:
    print("Exception when calling BlogPagesApi->attach_product_to_blog_page: %s\n" % e)

Parameters

Name Type Description Notes
blog_page_id int Page ID to fetch
product_id int Product ID to attach

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

detach_product_from_blog_page

detach_product_from_blog_page(blog_page_id, product_id)

Detach product from blog page

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BlogPagesApi()
blog_page_id = 789 # int | Page ID to fetch
product_id = 789 # int | Product ID to detach

try: 
    api_instance.detach_product_from_blog_page(blog_page_id, product_id)
except ApiException as e:
    print("Exception when calling BlogPagesApi->detach_product_from_blog_page: %s\n" % e)

Parameters

Name Type Description Notes
blog_page_id int Page ID to fetch
product_id int Product ID to detach

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_blog_page

BlogPageResponse get_blog_page(blog_page_id)

Get blog page

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BlogPagesApi()
blog_page_id = 789 # int | Page ID to fetch

try: 
    api_response = api_instance.get_blog_page(blog_page_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlogPagesApi->get_blog_page: %s\n" % e)

Parameters

Name Type Description Notes
blog_page_id int Page ID to fetch

Return type

BlogPageResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_blog_page_features

FeatureListResponse get_blog_page_features(blog_page_id, page=page, per_page=per_page)

Get blog page features

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BlogPagesApi()
blog_page_id = 789 # int | Blog page ID to fetch
page = 789 # int |  (optional)
per_page = 789 # int |  (optional)

try: 
    api_response = api_instance.get_blog_page_features(blog_page_id, page=page, per_page=per_page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlogPagesApi->get_blog_page_features: %s\n" % e)

Parameters

Name Type Description Notes
blog_page_id int Blog page ID to fetch
page int [optional]
per_page int [optional]

Return type

FeatureListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_blog_page_products

BlogPageProductsResponse get_blog_page_products(blog_page_id, page=page, per_page=per_page, sort_by=sort_by, sort_direction=sort_direction, filters=filters)

Get products linked to a blog page

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BlogPagesApi()
blog_page_id = 789 # int | Page ID to fetch
page = 789 # int |  (optional)
per_page = 789 # int |  (optional)
sort_by = 'sort_by_example' # str | Sort by this attribute (id by default) (optional)
sort_direction = 'sort_direction_example' # str | Sorting direction (asc by default) (optional)
filters = 'filters_example' # str |  ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________  { \"name\": { \"value\": \"string\", \"operator\": \"contains\" }, \"date_add\": { \"value\": \"string\", \"operator\": \"lt\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). (optional)

try: 
    api_response = api_instance.get_blog_page_products(blog_page_id, page=page, per_page=per_page, sort_by=sort_by, sort_direction=sort_direction, filters=filters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlogPagesApi->get_blog_page_products: %s\n" % e)

Parameters

Name Type Description Notes
blog_page_id int Page ID to fetch
page int [optional]
per_page int [optional]
sort_by str Sort by this attribute (id by default) [optional]
sort_direction str Sorting direction (asc by default) [optional]
filters str ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { "name": { "value": "string", "operator": "contains" }, "date_add": { "value": "string", "operator": "lt" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). [optional]

Return type

BlogPageProductsResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_blog_pages

BlogPageListResponse get_blog_pages(page=page, per_page=per_page, sort_by=sort_by, sort_direction=sort_direction, filters=filters)

Get blog pages

Example

from __future__ import print_statement
import time
import kinow_client
from kinow_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiClientId
kinow_client.configuration.api_key['X-Client-Id'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Id'] = 'Bearer'
# Configure API key authorization: ApiClientSecret
kinow_client.configuration.api_key['X-Client-Secret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kinow_client.configuration.api_key_prefix['X-Client-Secret'] = 'Bearer'

# create an instance of the API class
api_instance = kinow_client.BlogPagesApi()
page = 789 # int |  (optional)
per_page = 789 # int |  (optional)
sort_by = 'sort_by_example' # str | Sort by this attribute (id by default) (optional)
sort_direction = 'sort_direction_example' # str | Sorting direction (asc by default) (optional)
filters = 'filters_example' # str |  ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________  { \"name\": { \"value\": \"string\", \"operator\": \"contains\" }, \"date_add\": { \"value\": \"string\", \"operator\": \"lt\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). (optional)

try: 
    api_response = api_instance.get_blog_pages(page=page, per_page=per_page, sort_by=sort_by, sort_direction=sort_direction, filters=filters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlogPagesApi->get_blog_pages: %s\n" % e)

Parameters

Name Type Description Notes
page int [optional]
per_page int [optional]
sort_by str Sort by this attribute (id by default) [optional]
sort_direction str Sorting direction (asc by default) [optional]
filters str ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { "name": { "value": "string", "operator": "contains" }, "date_add": { "value": "string", "operator": "lt" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). [optional]

Return type

BlogPageListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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