Skip to content

Latest commit

 

History

History
285 lines (198 loc) · 11.5 KB

DependencyApi.md

File metadata and controls

285 lines (198 loc) · 11.5 KB
Raw

GeminiCommerce\ProductConfigurator\DependencyApi

All URIs are relative to https://product-configurator.api.gogemini.io, except if the operation defines another base path.

Method HTTP request Description
productConfiguratorCreateDependency() POST /v1/{tenantId}/step/{stepId}/dependency/create Create Dependency
productConfiguratorDeleteDependency() DELETE /v1/{tenantId}/dependency/{dependencyId} Delete Dependency
productConfiguratorListDependencies() POST /v1/{tenantId}/page-size/{pageSize}/dependencies List Dependencies
productConfiguratorUpdateDependency() PUT /v1/{tenantId}/dependency/{dependencyId} Update Dependency

productConfiguratorCreateDependency()

productConfiguratorCreateDependency($tenant_id, $step_id, $body): \GeminiCommerce\ProductConfigurator\Model\ProductconfiguratordependencyEntity

Create Dependency

Establish a new dependency for an existing step by specifying the tenant and step IDs. Utilize a POST request with the required dependency details in the body to seamlessly enhance the configuration logic of your product.

Example

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


// Configure OAuth2 access token for authorization: standardAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: APIAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new GeminiCommerce\ProductConfigurator\Api\DependencyApi(
    // 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
);
$tenant_id = 'tenant_id_example'; // string
$step_id = 'step_id_example'; // string
$body = new \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorCreateDependencyRequest(); // \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorCreateDependencyRequest

try {
    $result = $apiInstance->productConfiguratorCreateDependency($tenant_id, $step_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DependencyApi->productConfiguratorCreateDependency: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tenant_id string
step_id string
body \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorCreateDependencyRequest

Return type

\GeminiCommerce\ProductConfigurator\Model\ProductconfiguratordependencyEntity

Authorization

standardAuthorization, APIAuthorization

HTTP request headers

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

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

productConfiguratorDeleteDependency()

productConfiguratorDeleteDependency($tenant_id, $dependency_id): object

Delete Dependency

Remove a specific dependency by specifying the tenant and dependency IDs. Ensure precision in dependency management with a straightforward DELETE request, simplifying the elimination of unwanted configuration logic.

Example

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


// Configure OAuth2 access token for authorization: standardAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: APIAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new GeminiCommerce\ProductConfigurator\Api\DependencyApi(
    // 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
);
$tenant_id = 'tenant_id_example'; // string
$dependency_id = 'dependency_id_example'; // string

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

Parameters

Name Type Description Notes
tenant_id string
dependency_id string

Return type

object

Authorization

standardAuthorization, APIAuthorization

HTTP request headers

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

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

productConfiguratorListDependencies()

productConfiguratorListDependencies($tenant_id, $page_size, $body): \GeminiCommerce\ProductConfigurator\Model\DependencyListDependenciesResponse

List Dependencies

Retrieve a list of dependencies based on the specified tenant ID. Customize results by specifying page size for efficient pagination. Submit an empty body to get all dependencies associated with the configurations.

Example

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


// Configure OAuth2 access token for authorization: standardAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: APIAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new GeminiCommerce\ProductConfigurator\Api\DependencyApi(
    // 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
);
$tenant_id = 'tenant_id_example'; // string
$page_size = 56; // int
$body = new \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorListDependenciesRequest(); // \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorListDependenciesRequest

try {
    $result = $apiInstance->productConfiguratorListDependencies($tenant_id, $page_size, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DependencyApi->productConfiguratorListDependencies: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tenant_id string
page_size int
body \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorListDependenciesRequest

Return type

\GeminiCommerce\ProductConfigurator\Model\DependencyListDependenciesResponse

Authorization

standardAuthorization, APIAuthorization

HTTP request headers

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

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

productConfiguratorUpdateDependency()

productConfiguratorUpdateDependency($tenant_id, $dependency_id, $body): \GeminiCommerce\ProductConfigurator\Model\ProductconfiguratordependencyEntity

Update Dependency

Modify an existing dependency by specifying the tenant and dependency IDs. Utilize a PUT request with updated dependency details in the body for seamless customization and fine-tuning of your product configurations.

Example

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


// Configure OAuth2 access token for authorization: standardAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: APIAuthorization
$config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = GeminiCommerce\ProductConfigurator\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new GeminiCommerce\ProductConfigurator\Api\DependencyApi(
    // 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
);
$tenant_id = 'tenant_id_example'; // string
$dependency_id = 'dependency_id_example'; // string
$body = new \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorUpdateDependencyRequest(); // \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorUpdateDependencyRequest

try {
    $result = $apiInstance->productConfiguratorUpdateDependency($tenant_id, $dependency_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DependencyApi->productConfiguratorUpdateDependency: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tenant_id string
dependency_id string
body \GeminiCommerce\ProductConfigurator\Model\ProductConfiguratorUpdateDependencyRequest

Return type

\GeminiCommerce\ProductConfigurator\Model\ProductconfiguratordependencyEntity

Authorization

standardAuthorization, APIAuthorization

HTTP request headers

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

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