configcatpublicapi

package module

v0.0.0-...-d61984f Latest Latest Go to latest Published: Oct 10, 2020 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/configcat/configcat-publicapi-go-client

README ¶

Go API client for configcatpublicapi

Base API URL: https://api.configcat.com If you prefer the swagger documentation, you can find it here: Swagger UI. The purpose of this API is to access the ConfigCat platform programmatically. You can Create, Read, Update and Delete any entities like Feature Flags, Configs, Environments or Products within ConfigCat. The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON and JSON+HAL format. Do not use this API for accessing and evaluating feature flag values. Use the SDKs instead. # OpenAPI Specification The complete specification is publicly available here: swagger.json. You can use it to generate client libraries in various languages with OpenAPI Generator or Swagger Codegen to interact with this API. # Authentication This API uses the Basic HTTP Authentication Scheme. # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a HTTP 429 - Too many requests status along with a Retry-After HTTP header.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: v1
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://configcat.com

Installation

Put the package under your project folder and add the following in import:

import "./configcatpublicapi"

Documentation for API Endpoints

All URIs are relative to https://api.configcat.com

Class	Method	HTTP request	Description
AuditLogsApi	GetAuditlogs	Get /v1/products/{productId}/auditlogs	List Audit logs
ConfigsApi	GetConfigs	Get /v1/products/{productId}/configs	List Configs
EnvironmentsApi	CreateEnvironment	Post /v1/products/{productId}/environments	Create Environment
EnvironmentsApi	GetEnvironments	Get /v1/products/{productId}/environments	List Environments
EnvironmentsApi	UpdateEnvironment	Put /v1/environments/{environmentId}	Update Environment
FeatureFlagSettingValuesApi	GetSettingValue	Get /v1/environments/{environmentId}/settings/{settingId}/value	Get value
FeatureFlagSettingValuesApi	ReplaceSettingValue	Put /v1/environments/{environmentId}/settings/{settingId}/value	Replace value
FeatureFlagSettingValuesApi	UpdateSettingValue	Patch /v1/environments/{environmentId}/settings/{settingId}/value	Update value
FeatureFlagSettingValuesUsingSDKKeyApi	GetSettingValueBySdkkey	Get /v1/settings/{settingKeyOrId}/value	Get value
FeatureFlagSettingValuesUsingSDKKeyApi	ReplaceSettingValueBySdkkey	Put /v1/settings/{settingKeyOrId}/value	Replace value
FeatureFlagSettingValuesUsingSDKKeyApi	UpdateSettingValueBySdkkey	Patch /v1/settings/{settingKeyOrId}/value	Update value
FeatureFlagsSettingsApi	CreateSetting	Post /v1/configs/{configId}/settings	Create Flag
FeatureFlagsSettingsApi	DeleteSetting	Delete /v1/settings/{settingId}	Delete Flag
FeatureFlagsSettingsApi	GetSetting	Get /v1/settings/{settingId}	Get Flag
FeatureFlagsSettingsApi	GetSettings	Get /v1/configs/{configId}/settings	List Flags
FeatureFlagsSettingsApi	UpdateSetting	Patch /v1/settings/{settingId}	Update Flag
IntegrationLinksApi	AddOrUpdateIntegrationLink	Post /v1/environments/{environmentId}/settings/{settingId}/integrationLinks/{integrationLinkType}/{key}	Add or update Integration link
IntegrationLinksApi	DeleteIntegrationLink	Delete /v1/environments/{environmentId}/settings/{settingId}/integrationLinks/{integrationLinkType}/{key}	Delete Integration link
IntegrationLinksApi	GetIntegrationLinkDetails	Get /v1/integrationLink/{integrationLinkType}/{key}/details	Get Integration link
MeApi	GetMe	Get /v1/me	Get authenticated user details
ProductsApi	GetProducts	Get /v1/products	List Products

Documentation For Models

Documentation For Authorization

Basic

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

support@configcat.com

Documentation ¶

Overview ¶

* ConfigCat Public Management API * * **Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON and JSON+HAL format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available here: [swagger.json](v1/swagger.json). You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication).  # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header. * * API version: v1 * Contact: support@configcat.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AddOrUpdateIntegrationLinkModel
type AuditLogItemModel
type AuditLogType
type AuditLogsApiGetAuditlogsOpts
type AuditLogsApiService
- func (a *AuditLogsApiService) GetAuditlogs(ctx context.Context, productId string, ...) ([]AuditLogItemModel, *http.Response, error)
type BasicAuth
type ConfigModel
type ConfigModelHaljson
type ConfigModelhaljsonLinks
type ConfigsApiService
- func (a *ConfigsApiService) GetConfigs(ctx context.Context, productId string) ([]ConfigModel, *http.Response, error)
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CreateEnvironmentModel
type CreateSettingModel
type DeleteIntegrationLinkModel
type EnvironmentModel
type EnvironmentsApiService
- func (a *EnvironmentsApiService) CreateEnvironment(ctx context.Context, body CreateEnvironmentModel, productId string) (EnvironmentModel, *http.Response, error)
- func (a *EnvironmentsApiService) GetEnvironments(ctx context.Context, productId string) ([]EnvironmentModel, *http.Response, error)
- func (a *EnvironmentsApiService) UpdateEnvironment(ctx context.Context, body UpdateEnvironmentModel, environmentId string) (EnvironmentModel, *http.Response, error)
type FeatureFlagSettingValuesApiReplaceSettingValueOpts
type FeatureFlagSettingValuesApiService
- func (a *FeatureFlagSettingValuesApiService) GetSettingValue(ctx context.Context, environmentId string, settingId int32) (SettingValueModel, *http.Response, error)
- func (a *FeatureFlagSettingValuesApiService) ReplaceSettingValue(ctx context.Context, body UpdateSettingValueModel, environmentId string, ...) (SettingValueModel, *http.Response, error)
- func (a *FeatureFlagSettingValuesApiService) UpdateSettingValue(ctx context.Context, body []Operation, environmentId string, settingId int32, ...) (SettingValueModel, *http.Response, error)
type FeatureFlagSettingValuesApiUpdateSettingValueOpts
type FeatureFlagSettingValuesUsingSDKKeyApiReplaceSettingValueBySdkkeyOpts
type FeatureFlagSettingValuesUsingSDKKeyApiService
- func (a *FeatureFlagSettingValuesUsingSDKKeyApiService) GetSettingValueBySdkkey(ctx context.Context, settingKeyOrId string, xCONFIGCATSDKKEY string) (SettingValueModel, *http.Response, error)
- func (a *FeatureFlagSettingValuesUsingSDKKeyApiService) ReplaceSettingValueBySdkkey(ctx context.Context, body UpdateSettingValueModel, xCONFIGCATSDKKEY string, ...) (SettingValueModel, *http.Response, error)
- func (a *FeatureFlagSettingValuesUsingSDKKeyApiService) UpdateSettingValueBySdkkey(ctx context.Context, body []Operation, xCONFIGCATSDKKEY string, ...) (SettingValueModel, *http.Response, error)
type FeatureFlagSettingValuesUsingSDKKeyApiUpdateSettingValueBySdkkeyOpts
type FeatureFlagsSettingsApiService
- func (a *FeatureFlagsSettingsApiService) CreateSetting(ctx context.Context, body CreateSettingModel, configId string) (SettingModel, *http.Response, error)
- func (a *FeatureFlagsSettingsApiService) DeleteSetting(ctx context.Context, settingId int32) (*http.Response, error)
- func (a *FeatureFlagsSettingsApiService) GetSetting(ctx context.Context, settingId int32) (SettingModel, *http.Response, error)
- func (a *FeatureFlagsSettingsApiService) GetSettings(ctx context.Context, configId string) ([]SettingModel, *http.Response, error)
- func (a *FeatureFlagsSettingsApiService) UpdateSetting(ctx context.Context, body []Operation, settingId int32) (SettingModel, *http.Response, error)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type IntegrationLinkDetail
type IntegrationLinkDetailsModel
type IntegrationLinkModel
type IntegrationLinkType
type IntegrationLinksApiAddOrUpdateIntegrationLinkOpts
type IntegrationLinksApiService
- func (a *IntegrationLinksApiService) AddOrUpdateIntegrationLink(ctx context.Context, environmentId string, settingId int32, ...) (IntegrationLinkModel, *http.Response, error)
- func (a *IntegrationLinksApiService) DeleteIntegrationLink(ctx context.Context, environmentId string, settingId int32, ...) (DeleteIntegrationLinkModel, *http.Response, error)
- func (a *IntegrationLinksApiService) GetIntegrationLinkDetails(ctx context.Context, integrationLinkType IntegrationLinkType, key string) (IntegrationLinkDetailsModel, *http.Response, error)
type MeApiService
- func (a *MeApiService) GetMe(ctx context.Context) (MeModel, *http.Response, error)
type MeModel
type Operation
type OrganizationModel
type ProductModel
type ProductModelHaljson
type ProductModelhaljsonEmbedded
type ProductModelhaljsonEmbeddedOrganization
type ProductModelhaljsonLinks
type ProductsApiService
- func (a *ProductsApiService) GetProducts(ctx context.Context) ([]ProductModel, *http.Response, error)
type RolloutPercentageItemModel
type RolloutRuleComparator
type RolloutRuleModel
type SettingDataModel
type SettingModel
type SettingTagModel
type SettingType
type SettingValueModel
type SettingValueModelHaljson
type SettingValueModelhaljsonEmbedded
type SettingValueModelhaljsonEmbeddedConfig
type SettingValueModelhaljsonEmbeddedEnvironment
type SettingValueModelhaljsonEmbeddedIntegrationLinks
type SettingValueModelhaljsonEmbeddedSetting
type SettingValueModelhaljsonEmbeddedSettingTags
type SettingValueModelhaljsonLinks
type UpdateEnvironmentModel
type UpdateSettingValueModel

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AuditLogsApi *AuditLogsApiService

	ConfigsApi *ConfigsApiService

	EnvironmentsApi *EnvironmentsApiService

	FeatureFlagSettingValuesApi *FeatureFlagSettingValuesApiService

	FeatureFlagSettingValuesUsingSDKKeyApi *FeatureFlagSettingValuesUsingSDKKeyApiService

	FeatureFlagsSettingsApi *FeatureFlagsSettingsApiService

	IntegrationLinksApi *IntegrationLinksApiService

	MeApi *MeApiService

	ProductsApi *ProductsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the ConfigCat Public Management API API vv1 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddOrUpdateIntegrationLinkModel ¶

type AddOrUpdateIntegrationLinkModel struct {
	Description string `json:"description,omitempty"`
	Url         string `json:"url,omitempty"`
}

type AuditLogItemModel ¶

type AuditLogItemModel struct {
	AuditLogId       int64     `json:"auditLogId,omitempty"`
	AuditLogDateTime time.Time `json:"auditLogDateTime,omitempty"`
	AuditLogType     string    `json:"auditLogType,omitempty"`
	UserEmail        string    `json:"userEmail,omitempty"`
	UserName         string    `json:"userName,omitempty"`
	Where            string    `json:"where,omitempty"`
	Why              string    `json:"why,omitempty"`
	ActionTarget     string    `json:"actionTarget,omitempty"`
	Details          string    `json:"details,omitempty"`
}

type AuditLogType ¶

type AuditLogType struct {
}

type AuditLogsApiGetAuditlogsOpts ¶

type AuditLogsApiGetAuditlogsOpts struct {
	ConfigId        optional.Interface
	EnvironmentId   optional.Interface
	AuditLogType    optional.Interface
	FromUtcDateTime optional.Time
	ToUtcDateTime   optional.Time
}

type AuditLogsApiService ¶

type AuditLogsApiService service

func (*AuditLogsApiService) GetAuditlogs ¶

func (a *AuditLogsApiService) GetAuditlogs(ctx context.Context, productId string, localVarOptionals *AuditLogsApiGetAuditlogsOpts) ([]AuditLogItemModel, *http.Response, error)

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ConfigModel ¶

type ConfigModel struct {
	ConfigId string `json:"configId,omitempty"`
	Name     string `json:"name,omitempty"`
}

type ConfigModelHaljson ¶

type ConfigModelHaljson struct {
	ConfigId string                   `json:"configId,omitempty"`
	Name     string                   `json:"name,omitempty"`
	Links    *ConfigModelhaljsonLinks `json:"_links,omitempty"`
}

type ConfigModelhaljsonLinks ¶

type ConfigModelhaljsonLinks struct {
	Settings string `json:"settings,omitempty"`
}

type ConfigsApiService ¶

type ConfigsApiService service

func (*ConfigsApiService) GetConfigs ¶

func (a *ConfigsApiService) GetConfigs(ctx context.Context, productId string) ([]ConfigModel, *http.Response, error)

ConfigsApiService List Configs This endpoint returns the list of the Configs that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param productId The identifier of the Product.

@return []ConfigModel

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateEnvironmentModel ¶

type CreateEnvironmentModel struct {
	Name string `json:"name"`
}

type CreateSettingModel ¶

type CreateSettingModel struct {
	// The key of the setting.
	Key string `json:"key"`
	// The name of the setting, shown on the Dashboard UI.
	Name        string       `json:"name"`
	SettingType *SettingType `json:"settingType"`
	// A short description for the setting, shown on the Dashboard UI.
	Hint string `json:"hint,omitempty"`
}

type DeleteIntegrationLinkModel ¶

type DeleteIntegrationLinkModel struct {
	HasRemainingIntegrationLink bool `json:"hasRemainingIntegrationLink,omitempty"`
}

type EnvironmentModel ¶

type EnvironmentModel struct {
	EnvironmentId string `json:"environmentId,omitempty"`
	Name          string `json:"name,omitempty"`
}

type EnvironmentsApiService ¶

type EnvironmentsApiService service

func (*EnvironmentsApiService) CreateEnvironment ¶

func (a *EnvironmentsApiService) CreateEnvironment(ctx context.Context, body CreateEnvironmentModel, productId string) (EnvironmentModel, *http.Response, error)

EnvironmentsApiService Create Environment This endpoint creates a new Environment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param productId The identifier of the Product.

@return EnvironmentModel

func (*EnvironmentsApiService) GetEnvironments ¶

func (a *EnvironmentsApiService) GetEnvironments(ctx context.Context, productId string) ([]EnvironmentModel, *http.Response, error)

EnvironmentsApiService List Environments This endpoint returns the list of the Environments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param productId The identifier of the Product.

@return []EnvironmentModel

func (*EnvironmentsApiService) UpdateEnvironment ¶

func (a *EnvironmentsApiService) UpdateEnvironment(ctx context.Context, body UpdateEnvironmentModel, environmentId string) (EnvironmentModel, *http.Response, error)

EnvironmentsApiService Update Environment This endpoint updates an Environment identified by the `environmentId` parameter.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param environmentId The identifier of the Product.

@return EnvironmentModel

type FeatureFlagSettingValuesApiReplaceSettingValueOpts ¶

type FeatureFlagSettingValuesApiReplaceSettingValueOpts struct {
	Reason optional.String
}

type FeatureFlagSettingValuesApiService ¶

type FeatureFlagSettingValuesApiService service

func (*FeatureFlagSettingValuesApiService) GetSettingValue ¶

func (a *FeatureFlagSettingValuesApiService) GetSettingValue(ctx context.Context, environmentId string, settingId int32) (SettingValueModel, *http.Response, error)

FeatureFlagSettingValuesApiService Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environmentId The identifier of the Environment.
@param settingId The id of the Setting.

@return SettingValueModel

func (*FeatureFlagSettingValuesApiService) ReplaceSettingValue ¶

func (a *FeatureFlagSettingValuesApiService) ReplaceSettingValue(ctx context.Context, body UpdateSettingValueModel, environmentId string, settingId int32, localVarOptionals *FeatureFlagSettingValuesApiReplaceSettingValueOpts) (SettingValueModel, *http.Response, error)

func (*FeatureFlagSettingValuesApiService) UpdateSettingValue ¶

func (a *FeatureFlagSettingValuesApiService) UpdateSettingValue(ctx context.Context, body []Operation, environmentId string, settingId int32, localVarOptionals *FeatureFlagSettingValuesApiUpdateSettingValueOpts) (SettingValueModel, *http.Response, error)

type FeatureFlagSettingValuesApiUpdateSettingValueOpts ¶

type FeatureFlagSettingValuesApiUpdateSettingValueOpts struct {
	Reason optional.String
}

type FeatureFlagSettingValuesUsingSDKKeyApiReplaceSettingValueBySdkkeyOpts ¶

type FeatureFlagSettingValuesUsingSDKKeyApiReplaceSettingValueBySdkkeyOpts struct {
	Reason optional.String
}

type FeatureFlagSettingValuesUsingSDKKeyApiService ¶

type FeatureFlagSettingValuesUsingSDKKeyApiService service

func (*FeatureFlagSettingValuesUsingSDKKeyApiService) GetSettingValueBySdkkey ¶

func (a *FeatureFlagSettingValuesUsingSDKKeyApiService) GetSettingValueBySdkkey(ctx context.Context, settingKeyOrId string, xCONFIGCATSDKKEY string) (SettingValueModel, *http.Response, error)

FeatureFlagSettingValuesUsingSDKKeyApiService Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param settingKeyOrId The key or id of the Setting.
@param xCONFIGCATSDKKEY The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)

@return SettingValueModel

func (*FeatureFlagSettingValuesUsingSDKKeyApiService) ReplaceSettingValueBySdkkey ¶

func (a *FeatureFlagSettingValuesUsingSDKKeyApiService) ReplaceSettingValueBySdkkey(ctx context.Context, body UpdateSettingValueModel, xCONFIGCATSDKKEY string, settingKeyOrId string, localVarOptionals *FeatureFlagSettingValuesUsingSDKKeyApiReplaceSettingValueBySdkkeyOpts) (SettingValueModel, *http.Response, error)

func (*FeatureFlagSettingValuesUsingSDKKeyApiService) UpdateSettingValueBySdkkey ¶

func (a *FeatureFlagSettingValuesUsingSDKKeyApiService) UpdateSettingValueBySdkkey(ctx context.Context, body []Operation, xCONFIGCATSDKKEY string, settingKeyOrId string, localVarOptionals *FeatureFlagSettingValuesUsingSDKKeyApiUpdateSettingValueBySdkkeyOpts) (SettingValueModel, *http.Response, error)

type FeatureFlagSettingValuesUsingSDKKeyApiUpdateSettingValueBySdkkeyOpts ¶

type FeatureFlagSettingValuesUsingSDKKeyApiUpdateSettingValueBySdkkeyOpts struct {
	Reason optional.String
}

type FeatureFlagsSettingsApiService ¶

type FeatureFlagsSettingsApiService service

func (*FeatureFlagsSettingsApiService) CreateSetting ¶

func (a *FeatureFlagsSettingsApiService) CreateSetting(ctx context.Context, body CreateSettingModel, configId string) (SettingModel, *http.Response, error)

FeatureFlagsSettingsApiService Create Flag This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter. **Important:** The `key` attribute must be unique within the given Config.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param configId The identifier of the Config.

@return SettingModel

func (*FeatureFlagsSettingsApiService) DeleteSetting ¶

func (a *FeatureFlagsSettingsApiService) DeleteSetting(ctx context.Context, settingId int32) (*http.Response, error)

FeatureFlagsSettingsApiService Delete Flag This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param settingId The identifier of the Setting.

func (*FeatureFlagsSettingsApiService) GetSetting ¶

func (a *FeatureFlagsSettingsApiService) GetSetting(ctx context.Context, settingId int32) (SettingModel, *http.Response, error)

FeatureFlagsSettingsApiService Get Flag This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param settingId The identifier of the Setting.

@return SettingModel

func (*FeatureFlagsSettingsApiService) GetSettings ¶

func (a *FeatureFlagsSettingsApiService) GetSettings(ctx context.Context, configId string) ([]SettingModel, *http.Response, error)

FeatureFlagsSettingsApiService List Flags This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param configId The identifier of the Config.

@return []SettingModel

func (*FeatureFlagsSettingsApiService) UpdateSetting ¶

func (a *FeatureFlagsSettingsApiService) UpdateSetting(ctx context.Context, body []Operation, settingId int32) (SettingModel, *http.Response, error)

FeatureFlagsSettingsApiService Update Flag This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](http://jsonpatch.com) operations in a specified Config. Only the `name` and `hint` attributes are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ``` { \"settingId\": 5345, \"key\": \"myAwesomeFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This Flag controls my awesome feature.\", \"settingType\": \"boolean\" } ``` If we send an update request body as below: ``` [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" } ] ``` Only the name is going to be updated and all the other attributes are remaining unchanged. So we get a response like this: ``` { \"settingId\": 5345, \"key\": \"myAwesomeFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This Flag controls my awesome feature.\", \"settingType\": \"boolean\" } ```

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param settingId The identifier of the Setting.

@return SettingModel

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type IntegrationLinkDetail ¶

type IntegrationLinkDetail struct {
	Product     *ProductModel     `json:"product,omitempty"`
	Config      *ConfigModel      `json:"config,omitempty"`
	Environment *EnvironmentModel `json:"environment,omitempty"`
	Setting     *SettingDataModel `json:"setting,omitempty"`
	ReadOnly    bool              `json:"readOnly,omitempty"`
	Status      string            `json:"status,omitempty"`
}

type IntegrationLinkDetailsModel ¶

type IntegrationLinkDetailsModel struct {
	Details                 []IntegrationLinkDetail `json:"details,omitempty"`
	AllIntegrationLinkCount int32                   `json:"allIntegrationLinkCount,omitempty"`
}

type IntegrationLinkModel ¶

type IntegrationLinkModel struct {
	Key                 string               `json:"key,omitempty"`
	Description         string               `json:"description,omitempty"`
	IntegrationLinkType *IntegrationLinkType `json:"integrationLinkType,omitempty"`
	Url                 string               `json:"url,omitempty"`
}

type IntegrationLinkType ¶

type IntegrationLinkType string

const (
	TRELLO_IntegrationLinkType IntegrationLinkType = "trello"
	JIRA_IntegrationLinkType   IntegrationLinkType = "jira"
)

List of IntegrationLinkType

type IntegrationLinksApiAddOrUpdateIntegrationLinkOpts ¶

type IntegrationLinksApiAddOrUpdateIntegrationLinkOpts struct {
	Body optional.Interface
}

type IntegrationLinksApiService ¶

type IntegrationLinksApiService service

func (*IntegrationLinksApiService) AddOrUpdateIntegrationLink ¶

func (a *IntegrationLinksApiService) AddOrUpdateIntegrationLink(ctx context.Context, environmentId string, settingId int32, integrationLinkType IntegrationLinkType, key string, localVarOptionals *IntegrationLinksApiAddOrUpdateIntegrationLinkOpts) (IntegrationLinkModel, *http.Response, error)

func (*IntegrationLinksApiService) DeleteIntegrationLink ¶

func (a *IntegrationLinksApiService) DeleteIntegrationLink(ctx context.Context, environmentId string, settingId int32, integrationLinkType IntegrationLinkType, key string) (DeleteIntegrationLinkModel, *http.Response, error)

IntegrationLinksApiService Delete Integration link

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environmentId The identifier of the Environment.
@param settingId The id of the Setting.
@param integrationLinkType The integration's type.
@param key The key of the integration link.

@return DeleteIntegrationLinkModel

func (*IntegrationLinksApiService) GetIntegrationLinkDetails ¶

func (a *IntegrationLinksApiService) GetIntegrationLinkDetails(ctx context.Context, integrationLinkType IntegrationLinkType, key string) (IntegrationLinkDetailsModel, *http.Response, error)

IntegrationLinksApiService Get Integration link

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param integrationLinkType The integration link's type.
@param key The key of the integration link.

@return IntegrationLinkDetailsModel

type MeApiService ¶

type MeApiService service

func (*MeApiService) GetMe ¶

func (a *MeApiService) GetMe(ctx context.Context) (MeModel, *http.Response, error)

MeApiService Get authenticated user details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return MeModel

type MeModel ¶

type MeModel struct {
	Email    string `json:"email,omitempty"`
	FullName string `json:"fullName,omitempty"`
}

type Operation ¶

type Operation struct {
	Value *interface{} `json:"value,omitempty"`
	Path  string       `json:"path,omitempty"`
	Op    string       `json:"op,omitempty"`
	From  string       `json:"from,omitempty"`
}

type OrganizationModel ¶

type OrganizationModel struct {
	OrganizationId string `json:"organizationId,omitempty"`
	Name           string `json:"name,omitempty"`
}

type ProductModel ¶

type ProductModel struct {
	Organization *OrganizationModel `json:"organization,omitempty"`
	ProductId    string             `json:"productId,omitempty"`
	Name         string             `json:"name,omitempty"`
}

type ProductModelHaljson ¶

type ProductModelHaljson struct {
	Embedded  *ProductModelhaljsonEmbedded `json:"_embedded,omitempty"`
	ProductId string                       `json:"productId,omitempty"`
	Name      string                       `json:"name,omitempty"`
	Links     *ProductModelhaljsonLinks    `json:"_links,omitempty"`
}

type ProductModelhaljsonEmbedded ¶

type ProductModelhaljsonEmbedded struct {
	Organization *ProductModelhaljsonEmbeddedOrganization `json:"organization,omitempty"`
}

type ProductModelhaljsonEmbeddedOrganization ¶

type ProductModelhaljsonEmbeddedOrganization struct {
	OrganizationId string `json:"organizationId,omitempty"`
	Name           string `json:"name,omitempty"`
}

type ProductModelhaljsonLinks ¶

type ProductModelhaljsonLinks struct {
	Configs      string `json:"configs,omitempty"`
	Environments string `json:"environments,omitempty"`
}

type ProductsApiService ¶

type ProductsApiService service

func (*ProductsApiService) GetProducts ¶

func (a *ProductsApiService) GetProducts(ctx context.Context) ([]ProductModel, *http.Response, error)

ProductsApiService List Products This endpoint returns the list of the Products that belongs to the user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []ProductModel

type RolloutPercentageItemModel ¶

type RolloutPercentageItemModel struct {
	// The percentage value for the rule.
	Percentage int64 `json:"percentage"`
	// The value to serve when the user falls in the percentage rule. It must respect the setting type.
	Value *interface{} `json:"value"`
}

type RolloutRuleComparator ¶

type RolloutRuleComparator string

const (
	IS_ONE_OF_RolloutRuleComparator                 RolloutRuleComparator = "isOneOf"
	IS_NOT_ONE_OF_RolloutRuleComparator             RolloutRuleComparator = "isNotOneOf"
	CONTAINS_RolloutRuleComparator                  RolloutRuleComparator = "contains"
	DOES_NOT_CONTAIN_RolloutRuleComparator          RolloutRuleComparator = "doesNotContain"
	SEM_VER_IS_ONE_OF_RolloutRuleComparator         RolloutRuleComparator = "semVerIsOneOf"
	SEM_VER_IS_NOT_ONE_OF_RolloutRuleComparator     RolloutRuleComparator = "semVerIsNotOneOf"
	SEM_VER_LESS_RolloutRuleComparator              RolloutRuleComparator = "semVerLess"
	SEM_VER_LESS_OR_EQUALS_RolloutRuleComparator    RolloutRuleComparator = "semVerLessOrEquals"
	SEM_VER_GREATER_RolloutRuleComparator           RolloutRuleComparator = "semVerGreater"
	SEM_VER_GREATER_OR_EQUALS_RolloutRuleComparator RolloutRuleComparator = "semVerGreaterOrEquals"
	NUMBER_EQUALS_RolloutRuleComparator             RolloutRuleComparator = "numberEquals"
	NUMBER_DOES_NOT_EQUAL_RolloutRuleComparator     RolloutRuleComparator = "numberDoesNotEqual"
	NUMBER_LESS_RolloutRuleComparator               RolloutRuleComparator = "numberLess"
	NUMBER_LESS_OR_EQUALS_RolloutRuleComparator     RolloutRuleComparator = "numberLessOrEquals"
	NUMBER_GREATER_RolloutRuleComparator            RolloutRuleComparator = "numberGreater"
	NUMBER_GREATER_OR_EQUALS_RolloutRuleComparator  RolloutRuleComparator = "numberGreaterOrEquals"
	SENSITIVE_IS_ONE_OF_RolloutRuleComparator       RolloutRuleComparator = "sensitiveIsOneOf"
	SENSITIVE_IS_NOT_ONE_OF_RolloutRuleComparator   RolloutRuleComparator = "sensitiveIsNotOneOf"
)

List of RolloutRuleComparator

type RolloutRuleModel ¶

type RolloutRuleModel struct {
	// The user attribute to compare.
	ComparisonAttribute string                 `json:"comparisonAttribute"`
	Comparator          *RolloutRuleComparator `json:"comparator,omitempty"`
	// The value to compare against.
	ComparisonValue string `json:"comparisonValue"`
	// The value to serve when the comparison matches. It must respect the setting type.
	Value *interface{} `json:"value"`
}

type SettingDataModel ¶

type SettingDataModel struct {
	SettingId           int32        `json:"settingId,omitempty"`
	Key                 string       `json:"key,omitempty"`
	Name                string       `json:"name,omitempty"`
	Hint                string       `json:"hint,omitempty"`
	SettingType         *SettingType `json:"settingType,omitempty"`
	CreatedAt           time.Time    `json:"createdAt,omitempty"`
	CreatorEmail        string       `json:"creatorEmail,omitempty"`
	CreatorFullName     string       `json:"creatorFullName,omitempty"`
	OwnerFullName       string       `json:"ownerFullName,omitempty"`
	OwnerEmail          string       `json:"ownerEmail,omitempty"`
	ExpirationWarningAt time.Time    `json:"expirationWarningAt,omitempty"`
}

type SettingModel ¶

type SettingModel struct {
	SettingId           int32        `json:"settingId,omitempty"`
	Key                 string       `json:"key,omitempty"`
	Name                string       `json:"name,omitempty"`
	Hint                string       `json:"hint,omitempty"`
	SettingType         *SettingType `json:"settingType,omitempty"`
	OwnerUserEmail      string       `json:"ownerUserEmail,omitempty"`
	OwnerUserFullName   string       `json:"ownerUserFullName,omitempty"`
	ExpirationWarningAt time.Time    `json:"expirationWarningAt,omitempty"`
	ConfigId            string       `json:"configId,omitempty"`
	ConfigName          string       `json:"configName,omitempty"`
}

type SettingTagModel ¶

type SettingTagModel struct {
	SettingTagId int64  `json:"settingTagId,omitempty"`
	TagId        int64  `json:"tagId,omitempty"`
	Name         string `json:"name,omitempty"`
	Color        string `json:"color,omitempty"`
}

type SettingType ¶

type SettingType string

const (
	BOOLEAN_SettingType SettingType = "boolean"
	STRING__SettingType SettingType = "string"
	INT__SettingType    SettingType = "int"
	DOUBLE_SettingType  SettingType = "double"
)

List of SettingType

type SettingValueModel ¶

type SettingValueModel struct {
	Config                  *ConfigModel           `json:"config,omitempty"`
	Environment             *EnvironmentModel      `json:"environment,omitempty"`
	ReadOnly                bool                   `json:"readOnly,omitempty"`
	Setting                 *SettingDataModel      `json:"setting,omitempty"`
	UpdatedAt               time.Time              `json:"updatedAt,omitempty"`
	LastUpdaterUserEmail    string                 `json:"lastUpdaterUserEmail,omitempty"`
	LastUpdaterUserFullName string                 `json:"lastUpdaterUserFullName,omitempty"`
	IntegrationLinks        []IntegrationLinkModel `json:"integrationLinks,omitempty"`
	SettingTags             []SettingTagModel      `json:"settingTags,omitempty"`
	// The targeting rule collection.
	RolloutRules []RolloutRuleModel `json:"rolloutRules,omitempty"`
	// The percentage rule collection.
	RolloutPercentageItems []RolloutPercentageItemModel `json:"rolloutPercentageItems,omitempty"`
	// The value to serve. It must respect the setting type.
	Value *interface{} `json:"value,omitempty"`
}

type SettingValueModelHaljson ¶

type SettingValueModelHaljson struct {
	ReadOnly                bool                              `json:"readOnly,omitempty"`
	UpdatedAt               time.Time                         `json:"updatedAt,omitempty"`
	LastUpdaterUserEmail    string                            `json:"lastUpdaterUserEmail,omitempty"`
	LastUpdaterUserFullName string                            `json:"lastUpdaterUserFullName,omitempty"`
	Embedded                *SettingValueModelhaljsonEmbedded `json:"_embedded,omitempty"`
	// The targeting rule collection.
	RolloutRules []RolloutRuleModel `json:"rolloutRules,omitempty"`
	// The percentage rule collection.
	RolloutPercentageItems []RolloutPercentageItemModel `json:"rolloutPercentageItems,omitempty"`
	// The value to serve. It must respect the setting type.
	Value *interface{}                   `json:"value,omitempty"`
	Links *SettingValueModelhaljsonLinks `json:"_links,omitempty"`
}

type SettingValueModelhaljsonEmbedded ¶

type SettingValueModelhaljsonEmbedded struct {
	Setting          *SettingValueModelhaljsonEmbeddedSetting           `json:"setting,omitempty"`
	Config           *SettingValueModelhaljsonEmbeddedConfig            `json:"config,omitempty"`
	Environment      *SettingValueModelhaljsonEmbeddedEnvironment       `json:"environment,omitempty"`
	IntegrationLinks []SettingValueModelhaljsonEmbeddedIntegrationLinks `json:"integrationLinks,omitempty"`
	SettingTags      []SettingValueModelhaljsonEmbeddedSettingTags      `json:"settingTags,omitempty"`
}

type SettingValueModelhaljsonEmbeddedConfig ¶

type SettingValueModelhaljsonEmbeddedConfig struct {
	ConfigId string                   `json:"configId,omitempty"`
	Name     string                   `json:"name,omitempty"`
	Links    *ConfigModelhaljsonLinks `json:"_links,omitempty"`
}

type SettingValueModelhaljsonEmbeddedEnvironment ¶

type SettingValueModelhaljsonEmbeddedEnvironment struct {
	EnvironmentId string `json:"environmentId,omitempty"`
	Name          string `json:"name,omitempty"`
}

type SettingValueModelhaljsonEmbeddedIntegrationLinks ¶

type SettingValueModelhaljsonEmbeddedIntegrationLinks struct {
	Key                 string               `json:"key,omitempty"`
	Description         string               `json:"description,omitempty"`
	IntegrationLinkType *IntegrationLinkType `json:"integrationLinkType,omitempty"`
	Url                 string               `json:"url,omitempty"`
}

type SettingValueModelhaljsonEmbeddedSetting ¶

type SettingValueModelhaljsonEmbeddedSetting struct {
	SettingId           int32        `json:"settingId,omitempty"`
	Key                 string       `json:"key,omitempty"`
	Name                string       `json:"name,omitempty"`
	Hint                string       `json:"hint,omitempty"`
	SettingType         *SettingType `json:"settingType,omitempty"`
	CreatedAt           time.Time    `json:"createdAt,omitempty"`
	CreatorEmail        string       `json:"creatorEmail,omitempty"`
	CreatorFullName     string       `json:"creatorFullName,omitempty"`
	OwnerFullName       string       `json:"ownerFullName,omitempty"`
	OwnerEmail          string       `json:"ownerEmail,omitempty"`
	ExpirationWarningAt time.Time    `json:"expirationWarningAt,omitempty"`
}

type SettingValueModelhaljsonEmbeddedSettingTags ¶

type SettingValueModelhaljsonEmbeddedSettingTags struct {
	SettingTagId int64  `json:"settingTagId,omitempty"`
	TagId        int64  `json:"tagId,omitempty"`
	Name         string `json:"name,omitempty"`
	Color        string `json:"color,omitempty"`
}

type SettingValueModelhaljsonLinks ¶

type SettingValueModelhaljsonLinks struct {
	Self string `json:"self,omitempty"`
}

type UpdateEnvironmentModel ¶

type UpdateEnvironmentModel struct {
	Name string `json:"name,omitempty"`
}

type UpdateSettingValueModel ¶

type UpdateSettingValueModel struct {
	// The targeting rule collection.
	RolloutRules []RolloutRuleModel `json:"rolloutRules,omitempty"`
	// The percentage rule collection.
	RolloutPercentageItems []RolloutPercentageItemModel `json:"rolloutPercentageItems,omitempty"`
	// The value to serve. It must respect the setting type.
	Value *interface{} `json:"value,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL