Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 3.7 KB

CustomThemeSettingsApi.md

File metadata and controls

107 lines (75 loc) · 3.7 KB

cloudcheckr_cmx_client.CustomThemeSettingsApi

All URIs are relative to //api-us.cloudcheckr.com/

Method HTTP request Description
get_theme_settings GET /customer/v1/customers/theme Retrieves the customer's theme settings.
update_custom_theme_settings PUT /customer/v1/customers/{customerId}/theme Update the custom theme settings such as logo, colors, etc.

get_theme_settings

CustomThemeResponseModel get_theme_settings()

Retrieves the customer's theme settings.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = cloudcheckr_cmx_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = cloudcheckr_cmx_client.CustomThemeSettingsApi(cloudcheckr_cmx_client.ApiClient(configuration))

try:
    # Retrieves the customer's theme settings.
    api_response = api_instance.get_theme_settings()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomThemeSettingsApi->get_theme_settings: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CustomThemeResponseModel

Authorization

oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

update_custom_theme_settings

CustomThemeResponseModel update_custom_theme_settings(customer_id, body=body)

Update the custom theme settings such as logo, colors, etc.

Example

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

# Configure OAuth2 access token for authorization: oauth
configuration = cloudcheckr_cmx_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = cloudcheckr_cmx_client.CustomThemeSettingsApi(cloudcheckr_cmx_client.ApiClient(configuration))
customer_id = 'customer_id_example' # str | 
body = cloudcheckr_cmx_client.UpdateRequestCustomThemeRequestModel() # UpdateRequestCustomThemeRequestModel |  (optional)

try:
    # Update the custom theme settings such as logo, colors, etc.
    api_response = api_instance.update_custom_theme_settings(customer_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomThemeSettingsApi->update_custom_theme_settings: %s\n" % e)

Parameters

Name Type Description Notes
customer_id str
body UpdateRequestCustomThemeRequestModel [optional]

Return type

CustomThemeResponseModel

Authorization

oauth

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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