Skip to content

Latest commit

 

History

History
250 lines (167 loc) · 7.54 KB

BrandTemplateApi.md

File metadata and controls

250 lines (167 loc) · 7.54 KB

AkeneoPresales\DescrbAPI\BrandTemplateApi

All URIs are relative to https://app.descrb.com.

Method HTTP request Description
createTemplateApiV1BrandTemplatePost() POST /api/v1/brand-template/ Create Template
deleteTemplateApiV1BrandTemplateTemplateTemplateIdDelete() DELETE /api/v1/brand-template/template/{template_id} Delete Template
editTemplateApiV1BrandTemplateTemplateTemplateIdPatch() PATCH /api/v1/brand-template/template/{template_id} Edit Template
readUserTemplatesApiV1BrandTemplateMyTemplatesGet() GET /api/v1/brand-template/my-templates Read User Templates

createTemplateApiV1BrandTemplatePost()

createTemplateApiV1BrandTemplatePost($brand_template_create): mixed

Create Template

Create new brand template

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\BrandTemplateApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand_template_create = new \AkeneoPresales\DescrbAPI\Model\BrandTemplateCreate(); // \AkeneoPresales\DescrbAPI\Model\BrandTemplateCreate

try {
    $result = $apiInstance->createTemplateApiV1BrandTemplatePost($brand_template_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandTemplateApi->createTemplateApiV1BrandTemplatePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
brand_template_create \AkeneoPresales\DescrbAPI\Model\BrandTemplateCreate

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

deleteTemplateApiV1BrandTemplateTemplateTemplateIdDelete()

deleteTemplateApiV1BrandTemplateTemplateTemplateIdDelete($template_id): mixed

Delete Template

Get description by ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\BrandTemplateApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$template_id = 'template_id_example'; // string

try {
    $result = $apiInstance->deleteTemplateApiV1BrandTemplateTemplateTemplateIdDelete($template_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandTemplateApi->deleteTemplateApiV1BrandTemplateTemplateTemplateIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
template_id string

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

editTemplateApiV1BrandTemplateTemplateTemplateIdPatch()

editTemplateApiV1BrandTemplateTemplateTemplateIdPatch($template_id, $brand_template_update): \AkeneoPresales\DescrbAPI\Model\BrandTemplate

Edit Template

Get description by ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\BrandTemplateApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$template_id = 'template_id_example'; // string
$brand_template_update = new \AkeneoPresales\DescrbAPI\Model\BrandTemplateUpdate(); // \AkeneoPresales\DescrbAPI\Model\BrandTemplateUpdate

try {
    $result = $apiInstance->editTemplateApiV1BrandTemplateTemplateTemplateIdPatch($template_id, $brand_template_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandTemplateApi->editTemplateApiV1BrandTemplateTemplateTemplateIdPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
template_id string
brand_template_update \AkeneoPresales\DescrbAPI\Model\BrandTemplateUpdate

Return type

\AkeneoPresales\DescrbAPI\Model\BrandTemplate

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

readUserTemplatesApiV1BrandTemplateMyTemplatesGet()

readUserTemplatesApiV1BrandTemplateMyTemplatesGet(): mixed

Read User Templates

Retrieve user Brand descriptions.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\BrandTemplateApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->readUserTemplatesApiV1BrandTemplateMyTemplatesGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandTemplateApi->readUserTemplatesApiV1BrandTemplateMyTemplatesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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