Skip to content

Latest commit

 

History

History
325 lines (222 loc) · 11.8 KB

IntegrationsBetaApi.md

File metadata and controls

325 lines (222 loc) · 11.8 KB
Raw

LaunchDarklyApi\IntegrationsBetaApi

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

Method HTTP request Description
createIntegrationConfiguration() POST /api/v2/integration-configurations/keys/{integrationKey} Create integration configuration
deleteIntegrationConfiguration() DELETE /api/v2/integration-configurations/{integrationConfigurationId} Delete integration configuration
getAllIntegrationConfigurations() GET /api/v2/integration-configurations/keys/{integrationKey} Get all configurations for the integration
getIntegrationConfiguration() GET /api/v2/integration-configurations/{integrationConfigurationId} Get an integration configuration
updateIntegrationConfiguration() PATCH /api/v2/integration-configurations/{integrationConfigurationId} Update integration configuration

createIntegrationConfiguration()

createIntegrationConfiguration($integration_key, $integration_configuration_post): \LaunchDarklyApi\Model\IntegrationConfigurationsRep

Create integration configuration

Create a new integration configuration. (Excludes persistent store and flag import configurations.)

Example

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


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


$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
    // 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
);
$integration_key = 'integration_key_example'; // string | The integration key
$integration_configuration_post = new \LaunchDarklyApi\Model\IntegrationConfigurationPost(); // \LaunchDarklyApi\Model\IntegrationConfigurationPost

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

Parameters

Name Type Description Notes
integration_key string The integration key
integration_configuration_post \LaunchDarklyApi\Model\IntegrationConfigurationPost

Return type

\LaunchDarklyApi\Model\IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

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

deleteIntegrationConfiguration()

deleteIntegrationConfiguration($integration_configuration_id)

Delete integration configuration

Delete an integration configuration by ID. (Excludes persistent store and flag import configurations.)

Example

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


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


$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
    // 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
);
$integration_configuration_id = 'integration_configuration_id_example'; // string | The ID of the integration configuration to be deleted

try {
    $apiInstance->deleteIntegrationConfiguration($integration_configuration_id);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationsBetaApi->deleteIntegrationConfiguration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
integration_configuration_id string The ID of the integration configuration to be deleted

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

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

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

getAllIntegrationConfigurations()

getAllIntegrationConfigurations($integration_key): \LaunchDarklyApi\Model\IntegrationConfigurationCollectionRep

Get all configurations for the integration

Get all integration configurations with the specified integration key. (Excludes persistent store and flag import configurations).

Example

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


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


$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
    // 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
);
$integration_key = 'integration_key_example'; // string | Integration key

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

Parameters

Name Type Description Notes
integration_key string Integration key

Return type

\LaunchDarklyApi\Model\IntegrationConfigurationCollectionRep

Authorization

ApiKey

HTTP request headers

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

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

getIntegrationConfiguration()

getIntegrationConfiguration($integration_configuration_id): \LaunchDarklyApi\Model\IntegrationConfigurationsRep

Get an integration configuration

Get integration configuration with the specified ID. (Excludes persistent store and flag import configurations.)

Example

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


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


$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
    // 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
);
$integration_configuration_id = 'integration_configuration_id_example'; // string | Integration configuration ID

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

Parameters

Name Type Description Notes
integration_configuration_id string Integration configuration ID

Return type

\LaunchDarklyApi\Model\IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

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

updateIntegrationConfiguration()

updateIntegrationConfiguration($integration_configuration_id, $patch_operation): \LaunchDarklyApi\Model\IntegrationConfigurationsRep

Update integration configuration

Update an integration configuration. Updating an integration configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.

Example

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


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


$apiInstance = new LaunchDarklyApi\Api\IntegrationsBetaApi(
    // 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
);
$integration_configuration_id = 'integration_configuration_id_example'; // string | The ID of the integration configuration
$patch_operation = [{"op":"replace","path":"/on","value":false}]; // \LaunchDarklyApi\Model\PatchOperation[]

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

Parameters

Name Type Description Notes
integration_configuration_id string The ID of the integration configuration
patch_operation \LaunchDarklyApi\Model\PatchOperation[]

Return type

\LaunchDarklyApi\Model\IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

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