Skip to content

Latest commit

 

History

History
226 lines (155 loc) · 11.1 KB

README.md

File metadata and controls

226 lines (155 loc) · 11.1 KB

Branding

(branding)

Overview

Available Operations

  • create - Create brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.write scope.

  • upsert - Create or replace brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.write scope.

  • get - Get brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.read scope.

  • update - Updates the brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.write scope.

create

Create brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.write scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.branding.create(account_id="7a621cf0-21cd-49cf-8540-3315211a509a", colors=components.BrandColors(
        dark=components.BrandColor(
            accent="#111111",
        ),
        light=components.BrandColor(
            accent="#111111",
        ),
    ))

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
colors components.BrandColors ✔️ Brand colors for light and dark modes.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateBrandResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.BrandValidationError 422 application/json
errors.APIError 4XX, 5XX */*

upsert

Create or replace brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.write scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.branding.upsert(account_id="87673c22-1b80-4b69-b5bb-e92af8dcce02", colors=components.BrandColors(
        dark=components.BrandColor(
            accent="#111111",
        ),
        light=components.BrandColor(
            accent="#111111",
        ),
    ))

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
colors components.BrandColors ✔️ Brand colors for light and dark modes.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpsertBrandResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.BrandValidationError 422 application/json
errors.APIError 4XX, 5XX */*

get

Get brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.read scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.branding.get(account_id="b888f774-3e7c-4135-a18c-6b985523c4bc")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetBrandResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*

update

Updates the brand properties for the specified account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/branding.write scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.branding.update(account_id="d95fa7f0-e743-42ce-b47c-b60cc78135dd")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
colors Optional[components.UpdateColors] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateBrandResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.BrandValidationError 422 application/json
errors.APIError 4XX, 5XX */*