Skip to content

Latest commit

 

History

History
365 lines (231 loc) · 11.4 KB

IntegrationsBetaApi.md

File metadata and controls

365 lines (231 loc) · 11.4 KB
Raw

\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

IntegrationConfigurationsRep CreateIntegrationConfiguration(ctx, integrationKey).IntegrationConfigurationPost(integrationConfigurationPost).Execute()

Create integration configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    integrationKey := "integrationKey_example" // string | The integration key
    integrationConfigurationPost := *openapiclient.NewIntegrationConfigurationPost("Example integration configuration", map[string]interface{}{"key": interface{}(123)}) // IntegrationConfigurationPost | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IntegrationsBetaApi.CreateIntegrationConfiguration(context.Background(), integrationKey).IntegrationConfigurationPost(integrationConfigurationPost).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IntegrationsBetaApi.CreateIntegrationConfiguration``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateIntegrationConfiguration`: IntegrationConfigurationsRep
    fmt.Fprintf(os.Stdout, "Response from `IntegrationsBetaApi.CreateIntegrationConfiguration`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationKey string The integration key

Other Parameters

Other parameters are passed through a pointer to a apiCreateIntegrationConfigurationRequest struct via the builder pattern

Name Type Description Notes

integrationConfigurationPost | IntegrationConfigurationPost | |

Return type

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(ctx, integrationConfigurationId).Execute()

Delete integration configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    integrationConfigurationId := "integrationConfigurationId_example" // string | The ID of the integration configuration to be deleted

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IntegrationsBetaApi.DeleteIntegrationConfiguration(context.Background(), integrationConfigurationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IntegrationsBetaApi.DeleteIntegrationConfiguration``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationConfigurationId string The ID of the integration configuration to be deleted

Other Parameters

Other parameters are passed through a pointer to a apiDeleteIntegrationConfigurationRequest struct via the builder pattern

Name Type Description Notes

Return type

(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

IntegrationConfigurationCollectionRep GetAllIntegrationConfigurations(ctx, integrationKey).Execute()

Get all configurations for the integration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    integrationKey := "integrationKey_example" // string | Integration key

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IntegrationsBetaApi.GetAllIntegrationConfigurations(context.Background(), integrationKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IntegrationsBetaApi.GetAllIntegrationConfigurations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAllIntegrationConfigurations`: IntegrationConfigurationCollectionRep
    fmt.Fprintf(os.Stdout, "Response from `IntegrationsBetaApi.GetAllIntegrationConfigurations`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationKey string Integration key

Other Parameters

Other parameters are passed through a pointer to a apiGetAllIntegrationConfigurationsRequest struct via the builder pattern

Name Type Description Notes

Return type

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

IntegrationConfigurationsRep GetIntegrationConfiguration(ctx, integrationConfigurationId).Execute()

Get an integration configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    integrationConfigurationId := "integrationConfigurationId_example" // string | Integration configuration ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IntegrationsBetaApi.GetIntegrationConfiguration(context.Background(), integrationConfigurationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IntegrationsBetaApi.GetIntegrationConfiguration``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIntegrationConfiguration`: IntegrationConfigurationsRep
    fmt.Fprintf(os.Stdout, "Response from `IntegrationsBetaApi.GetIntegrationConfiguration`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationConfigurationId string Integration configuration ID

Other Parameters

Other parameters are passed through a pointer to a apiGetIntegrationConfigurationRequest struct via the builder pattern

Name Type Description Notes

Return type

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

IntegrationConfigurationsRep UpdateIntegrationConfiguration(ctx, integrationConfigurationId).PatchOperation(patchOperation).Execute()

Update integration configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    integrationConfigurationId := "integrationConfigurationId_example" // string | The ID of the integration configuration
    patchOperation := []openapiclient.PatchOperation{*openapiclient.NewPatchOperation("replace", "/exampleField")} // []PatchOperation | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IntegrationsBetaApi.UpdateIntegrationConfiguration(context.Background(), integrationConfigurationId).PatchOperation(patchOperation).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IntegrationsBetaApi.UpdateIntegrationConfiguration``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateIntegrationConfiguration`: IntegrationConfigurationsRep
    fmt.Fprintf(os.Stdout, "Response from `IntegrationsBetaApi.UpdateIntegrationConfiguration`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationConfigurationId string The ID of the integration configuration

Other Parameters

Other parameters are passed through a pointer to a apiUpdateIntegrationConfigurationRequest struct via the builder pattern

Name Type Description Notes

patchOperation | []PatchOperation | |

Return type

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]