Go API client for schematic

Schematic API

Overview

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

• API version: 0.1
• Package version: 0.0.2
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import schematic "github.com/SchematicHQ/schematic-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), schematic.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), schematic.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), schematic.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), schematic.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountsApi	CountApiKeys	Get /api-keys/count	Count api keys
AccountsApi	CountApiRequests	Get /api-requests/count	Count api requests
AccountsApi	CreateApiKey	Post /api-keys	Create api key
AccountsApi	CreateEnvironment	Post /environments	Create environment
AccountsApi	DeleteApiKey	Delete /api-keys/{api_key_id}	Delete api key
AccountsApi	DeleteEnvironment	Delete /environments/{environment_id}	Delete environment
AccountsApi	GetApiKey	Get /api-keys/{api_key_id}	Get api key
AccountsApi	GetApiRequest	Get /api-requests/{key}	Get api request
AccountsApi	GetEnvironment	Get /environments/{environment_id}	Get environment
AccountsApi	ListApiKeys	Get /api-keys	List api keys
AccountsApi	ListApiRequests	Get /api-requests	List api requests
AccountsApi	UpdateApiKey	Put /api-keys/{api_key_id}	Update api key
AccountsApi	UpdateEnvironment	Put /environments/{environment_id}	Update environment
CompaniesApi	CreateCompany	Post /companies	Create company
CompaniesApi	CreateCompanyMembership	Post /company-memberships	Create company membership
CompaniesApi	CreateCompanyTrait	Post /company-traits	Create company trait
CompaniesApi	CreateUser	Post /users	Create user
CompaniesApi	CreateUserTrait	Post /user-traits	Create user trait
CompaniesApi	DeleteCompany	Delete /companies/{company_id}	Delete company
CompaniesApi	DeleteCompanyMembership	Delete /company-memberships/{company_membership_id}	Delete company membership
CompaniesApi	DeleteUser	Delete /users/{user_id}	Delete user
CompaniesApi	GetCompany	Get /companies/{company_id}	Get company
CompaniesApi	GetUser	Get /users/{user_id}	Get user
CompaniesApi	ListCompanies	Get /companies	List companies
CompaniesApi	ListCompanyMemberships	Get /company-memberships	List company memberships
CompaniesApi	ListCompanyPlans	Get /company-plans	List company plans
CompaniesApi	ListUsers	Get /users	List users
CompaniesApi	LookupCompany	Get /companies/lookup	Lookup company
CompaniesApi	LookupUser	Get /users/lookup	Lookup user
CompaniesApi	UpdateEntityTraitDefinition	Put /entity-trait-definitions/{entity_trait_definition_id}	Update entity trait definition
EntitlementsApi	CreateCompanyOverride	Post /company-overrides	Create company override
EntitlementsApi	CreatePlanEntitlement	Post /plan-entitlements	Create plan entitlement
EntitlementsApi	DeleteCompanyOverride	Delete /company-overrides/{company_override_id}	Delete company override
EntitlementsApi	DeletePlanEntitlement	Delete /plan-entitlements/{plan_entitlement_id}	Delete plan entitlement
EntitlementsApi	GetCompanyOverride	Get /company-overrides/{company_override_id}	Get company override
EntitlementsApi	GetPlanEntitlement	Get /plan-entitlements/{plan_entitlement_id}	Get plan entitlement
EntitlementsApi	ListCompanyOverrides	Get /company-overrides	List company overrides
EntitlementsApi	ListPlanEntitlements	Get /plan-entitlements	List plan entitlements
EntitlementsApi	UpdateCompanyOverride	Put /company-overrides/{company_override_id}	Update company override
EntitlementsApi	UpdatePlanEntitlement	Put /plan-entitlements/{plan_entitlement_id}	Update plan entitlement
EventsApi	CountEventTypes	Get /event-types/count	Count event types
EventsApi	CountEvents	Get /events/count	Count events
EventsApi	CreateEvent	Post /events	Create event
EventsApi	GetEvent	Get /events/{key}	Get event
EventsApi	GetEventType	Get /event-types/{key}	Get event type
EventsApi	ListEventTypes	Get /event-types	List event types
EventsApi	ListEvents	Get /events	List events
EventsApi	ListMetricCounts	Get /metric-counts	List metric counts
EventsApi	ListMetricCountsHourly	Get /metric-counts-hourly	List metric counts hourly
FeaturesApi	CheckFlag	Post /flags/{key}/check	Check flag
FeaturesApi	CheckFlags	Post /flags/check	Check flags
FeaturesApi	CountCompaniesAudience	Post /audience/count-companies	Count Companies audience
FeaturesApi	CountFlagChecks	Get /flag-checks/count	Count flag checks
FeaturesApi	CountUsersAudience	Post /audience/count-users	Count Users audience
FeaturesApi	CreateFeature	Post /features	Create feature
FeaturesApi	CreateFlag	Post /flags	Create flag
FeaturesApi	DeleteFeature	Delete /features/{feature_id}	Delete feature
FeaturesApi	DeleteFlag	Delete /flags/{flag_id}	Delete flag
FeaturesApi	GetCompaniesAudience	Post /audience/get-companies	Get Companies audience
FeaturesApi	GetFeature	Get /features/{feature_id}	Get feature
FeaturesApi	GetFlag	Get /flags/{flag_id}	Get flag
FeaturesApi	GetFlagCheck	Get /flag-checks/{key}	Get flag check
FeaturesApi	GetUsersAudience	Post /audience/get-users	Get Users audience
FeaturesApi	LatestFlagChecks	Get /flag-checks/latest	Latest flag checks
FeaturesApi	ListFeatures	Get /features	List features
FeaturesApi	ListFlagChecks	Get /flag-checks	List flag checks
FeaturesApi	ListFlags	Get /flags	List flags
FeaturesApi	RulesFlag	Put /flags/{flag_id}/rules	Rules flag
FeaturesApi	UpdateFeature	Put /features/{feature_id}	Update feature
FeaturesApi	UpdateFlag	Put /flags/{flag_id}	Update flag
PlansApi	CreatePlan	Post /plans	Create plan
PlansApi	DeletePlan	Delete /plans/{plan_id}	Delete plan
PlansApi	GetPlan	Get /plans/{plan_id}	Get plan
PlansApi	ListPlans	Get /plans	List plans
PlansApi	UpdatePlan	Put /plans/{plan_id}	Update plan
PlansApi	UpdatePlanAudience	Put /plan-audiences/{plan_audience_id}	Update plan audience

Documentation For Models

• ApiError
• ApiKeyCreateResponseData
• ApiKeyRequestListResponseData
• ApiKeyRequestResponseData
• ApiKeyResponseData
• AudienceRequestBody
• CheckFlagOutputWithFlagKey
• CheckFlagRequestBody
• CheckFlagResponse
• CheckFlagResponseData
• CheckFlagsResponse
• CheckFlagsResponseData
• CompanyDetailResponseData
• CompanyMembershipDetailResponseData
• CompanyMembershipResponseData
• CompanyOverrideResponseData
• CompanyPlanResponseData
• CompanyResponseData
• CountApiKeysParams
• CountApiKeysResponse
• CountApiRequestsParams
• CountApiRequestsResponse
• CountCompaniesAudienceResponse
• CountEventTypesParams
• CountEventTypesResponse
• CountEventsParams
• CountEventsResponse
• CountFlagChecksParams
• CountFlagChecksResponse
• CountResponse
• CountUsersAudienceResponse
• CreateApiKeyRequestBody
• CreateApiKeyResponse
• CreateCompanyMembershipResponse
• CreateCompanyOverrideRequestBody
• CreateCompanyOverrideResponse
• CreateCompanyResponse
• CreateCompanyTraitResponse
• CreateEnvironmentRequestBody
• CreateEnvironmentResponse
• CreateEventRequestBody
• CreateEventResponse
• CreateFeatureRequestBody
• CreateFeatureResponse
• CreateFlagRequestBody
• CreateFlagResponse
• CreateOrUpdateConditionGroupRequestBody
• CreateOrUpdateConditionRequestBody
• CreateOrUpdateFlagRequestBody
• CreateOrUpdateRuleRequestBody
• CreatePlanEntitlementRequestBody
• CreatePlanEntitlementResponse
• CreatePlanRequestBody
• CreatePlanResponse
• CreateReqCommon
• CreateUserResponse
• CreateUserTraitResponse
• DeleteApiKeyResponse
• DeleteCompanyMembershipResponse
• DeleteCompanyOverrideResponse
• DeleteCompanyResponse
• DeleteEnvironmentResponse
• DeleteFeatureResponse
• DeleteFlagResponse
• DeletePlanEntitlementResponse
• DeletePlanResponse
• DeleteResponse
• DeleteUserResponse
• EntityKeyResponseData
• EntityTraitDefinitionResponseData
• EnvironmentDetailResponseData
• EnvironmentResponseData
• EventBody
• EventBodyIdentify
• EventBodyIdentifyCompany
• EventBodyTrack
• EventListResponseData
• EventResponseData
• EventSummaryResponseData
• FeatureDetailResponseData
• FeatureResponseData
• FlagCheckLogDetailResponseData
• FlagCheckLogResponseData
• FlagDetailResponseData
• FlagResponseData
• GetApiKeyResponse
• GetApiRequestResponse
• GetCompaniesAudienceResponse
• GetCompanyOverrideResponse
• GetCompanyResponse
• GetEnvironmentResponse
• GetEventResponse
• GetEventTypeResponse
• GetFeatureResponse
• GetFlagCheckResponse
• GetFlagResponse
• GetOrCreateCompanyMembershipRequestBody
• GetPlanEntitlementResponse
• GetPlanResponse
• GetUserResponse
• GetUsersAudienceResponse
• LatestFlagChecksParams
• LatestFlagChecksResponse
• ListApiKeysParams
• ListApiKeysResponse
• ListApiRequestsParams
• ListApiRequestsResponse
• ListCompaniesParams
• ListCompaniesResponse
• ListCompanyMembershipsParams
• ListCompanyMembershipsResponse
• ListCompanyOverridesParams
• ListCompanyOverridesResponse
• ListCompanyPlansParams
• ListCompanyPlansResponse
• ListEventTypesParams
• ListEventTypesResponse
• ListEventsParams
• ListEventsResponse
• ListFeaturesParams
• ListFeaturesResponse
• ListFlagChecksParams
• ListFlagChecksResponse
• ListFlagsParams
• ListFlagsResponse
• ListMetricCountsHourlyParams
• ListMetricCountsHourlyResponse
• ListMetricCountsParams
• ListMetricCountsResponse
• ListPlanEntitlementsParams
• ListPlanEntitlementsResponse
• ListPlansParams
• ListPlansResponse
• ListUsersParams
• ListUsersResponse
• LookupCompanyParams
• LookupCompanyResponse
• LookupUserParams
• LookupUserResponse
• MetricCountsHourlyResponseData
• PaginationFilter
• PlanEntitlementResponseData
• PlanResponseData
• RawEventResponseData
• RuleConditionGroupDetailResponseData
• RuleConditionGroupResponseData
• RuleConditionResponseData
• RuleDetailResponseData
• RuleResponseData
• RulesDetailResponseData
• RulesFlagResponse
• UpdateApiKeyRequestBody
• UpdateApiKeyResponse
• UpdateAudienceRequestBody
• UpdateCompanyOverrideRequestBody
• UpdateCompanyOverrideResponse
• UpdateEntityTraitDefinitionRequestBody
• UpdateEntityTraitDefinitionResponse
• UpdateEnvironmentRequestBody
• UpdateEnvironmentResponse
• UpdateFeatureRequestBody
• UpdateFeatureResponse
• UpdateFlagResponse
• UpdateFlagRulesRequestBody
• UpdatePlanAudienceResponse
• UpdatePlanEntitlementRequestBody
• UpdatePlanEntitlementResponse
• UpdatePlanRequestBody
• UpdatePlanResponse
• UpdateReqCommon
• UpdateRuleRequestBody
• UpsertCompanyRequestBody
• UpsertTraitRequestBody
• UpsertUserRequestBody
• UpsertUserSubRequestBody
• UserDetailResponseData
• UserResponseData

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Schematic-Api-Key
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-Schematic-Api-Key and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author