Go API client for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: 5.3.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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

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

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://squidex.dev.embracecloud.io/api

Class	Method	HTTP request	Description
AppsApi	AppClientsDeleteClient	Delete /apps/{app}/clients/{id}	Revoke an app client.
AppsApi	AppClientsGetClients	Get /apps/{app}/clients	Get app clients.
AppsApi	AppClientsPostClient	Post /apps/{app}/clients	Create a new app client.
AppsApi	AppClientsPutClient	Put /apps/{app}/clients/{id}	Updates an app client.
AppsApi	AppContributorsDeleteContributor	Delete /apps/{app}/contributors/{id}	Remove contributor.
AppsApi	AppContributorsDeleteMyself	Delete /apps/{app}/contributors/me	Remove yourself.
AppsApi	AppContributorsGetContributors	Get /apps/{app}/contributors	Get app contributors.
AppsApi	AppContributorsPostContributor	Post /apps/{app}/contributors	Assign contributor to app.
AppsApi	AppLanguagesDeleteLanguage	Delete /apps/{app}/languages/{language}	Deletes an app language.
AppsApi	AppLanguagesGetLanguages	Get /apps/{app}/languages	Get app languages.
AppsApi	AppLanguagesPostLanguage	Post /apps/{app}/languages	Attaches an app language.
AppsApi	AppLanguagesPutLanguage	Put /apps/{app}/languages/{language}	Updates an app language.
AppsApi	AppPatternsDeletePattern	Delete /apps/{app}/patterns/{id}	Delete an app pattern.
AppsApi	AppPatternsGetPatterns	Get /apps/{app}/patterns	Get app patterns.
AppsApi	AppPatternsPostPattern	Post /apps/{app}/patterns	Create a new app pattern.
AppsApi	AppPatternsPutPattern	Put /apps/{app}/patterns/{id}	Update an app pattern.
AppsApi	AppRolesDeleteRole	Delete /apps/{app}/roles/{roleName}	Remove role from app.
AppsApi	AppRolesGetPermissions	Get /apps/{app}/roles/permissions	Get app permissions.
AppsApi	AppRolesGetRoles	Get /apps/{app}/roles	Get app roles.
AppsApi	AppRolesPostRole	Post /apps/{app}/roles	Add role to app.
AppsApi	AppRolesPutRole	Put /apps/{app}/roles/{roleName}	Update an app role.
AppsApi	AppWorkflowsDeleteWorkflow	Delete /apps/{app}/workflows/{id}	Delete a workflow.
AppsApi	AppWorkflowsGetWorkflows	Get /apps/{app}/workflows	Get app workflow.
AppsApi	AppWorkflowsPostWorkflow	Post /apps/{app}/workflows	Create a workflow.
AppsApi	AppWorkflowsPutWorkflow	Put /apps/{app}/workflows/{id}	Update a workflow.
AppsApi	AppsDeleteApp	Delete /apps/{app}	Archive the app.
AppsApi	AppsDeleteImage	Delete /apps/{app}/image	Remove the app image.
AppsApi	AppsGetApp	Get /apps/{app}	Get an app by name.
AppsApi	AppsGetApps	Get /apps	Get your apps.
AppsApi	AppsGetImage	Get /apps/{app}/image	Get the app image.
AppsApi	AppsPostApp	Post /apps	Create a new app.
AppsApi	AppsUpdateApp	Put /apps/{app}	Update the app.
AppsApi	AppsUploadImage	Post /apps/{app}/image	Upload the app image.
AssetsApi	AssetContentGetAssetContent	Get /assets/{id}	Get the asset content.
AssetsApi	AssetContentGetAssetContentBySlug	Get /assets/{app}/{idOrSlug}/{more}	Get the asset content.
AssetsApi	AssetFoldersDeleteAssetFolder	Delete /apps/{app}/assets/folders/{id}	Delete an asset folder.
AssetsApi	AssetFoldersGetAssetFolders	Get /apps/{app}/assets/folders	Get asset folders.
AssetsApi	AssetFoldersPostAssetFolder	Post /apps/{app}/assets/folders	Upload a new asset.
AssetsApi	AssetFoldersPutAssetFolder	Put /apps/{app}/assets/folders/{id}	Updates the asset folder.
AssetsApi	AssetFoldersPutAssetFolderParent	Put /apps/{app}/assets/folders/{id}/parent	Moves the asset folder.
AssetsApi	AssetsDeleteAsset	Delete /apps/{app}/assets/{id}	Delete an asset.
AssetsApi	AssetsGetAsset	Get /apps/{app}/assets/{id}	Get an asset by id.
AssetsApi	AssetsGetAssets	Get /apps/{app}/assets	Get assets.
AssetsApi	AssetsGetAssetsPost	Post /apps/{app}/assets/query	Get assets.
AssetsApi	AssetsGetTags	Get /apps/{app}/assets/tags	Get assets tags.
AssetsApi	AssetsPostAsset	Post /apps/{app}/assets	Upload a new asset.
AssetsApi	AssetsPutAsset	Put /apps/{app}/assets/{id}	Updates the asset.
AssetsApi	AssetsPutAssetContent	Put /apps/{app}/assets/{id}/content	Replace asset content.
AssetsApi	AssetsPutAssetParent	Put /apps/{app}/assets/{id}/parent	Moves the asset.
BackupsApi	BackupContentGetBackupContent	Get /apps/{app}/backups/{id}	Get the backup content.
BackupsApi	BackupsDeleteBackup	Delete /apps/{app}/backups/{id}	Delete a backup.
BackupsApi	BackupsGetBackups	Get /apps/{app}/backups	Get all backup jobs.
BackupsApi	BackupsPostBackup	Post /apps/{app}/backups	Start a new backup.
BackupsApi	RestoreGetRestoreJob	Get /apps/restore	Get current restore status.
BackupsApi	RestorePostRestoreJob	Post /apps/restore	Restore a backup.
CommentsApi	CommentsDeleteComment	Delete /apps/{app}/comments/{commentsId}/{commentId}	Deletes the comment.
CommentsApi	CommentsGetComments	Get /apps/{app}/comments/{commentsId}	Get all comments.
CommentsApi	CommentsPostComment	Post /apps/{app}/comments/{commentsId}	Create a new comment.
CommentsApi	CommentsPutComment	Put /apps/{app}/comments/{commentsId}/{commentId}	Updates the comment.
HistoryApi	HistoryGetHistory	Get /apps/{app}/history	Get historical events.
LanguagesApi	LanguagesGetLanguages	Get /languages	Get supported languages.
NewsApi	NewsGetNews	Get /news/features	Get features since version.
NotificationsApi	UserNotificationsDeleteComment	Delete /users/{userId}/notifications/{commentId}	Deletes the notification.
NotificationsApi	UserNotificationsGetNotifications	Get /users/{userId}/notifications	Get all notifications.
PingApi	PingGetAppPing	Get /ping/{app}	Get ping status.
PingApi	PingGetInfo	Get /info	Get API information.
PingApi	PingGetPing	Get /ping	Get ping status of the API.
PlansApi	AppPlansGetPlans	Get /apps/{app}/plans	Get app plan information.
PlansApi	AppPlansPutPlan	Put /apps/{app}/plan	Change the app plan.
RulesApi	RulesDeleteEvent	Delete /apps/{app}/rules/events/{id}	Cancels an event.
RulesApi	RulesDeleteRule	Delete /apps/{app}/rules/{id}	Delete a rule.
RulesApi	RulesDeleteRuleRun	Delete /apps/{app}/rules/run	Cancel the current run.
RulesApi	RulesDisableRule	Put /apps/{app}/rules/{id}/disable	Disable a rule.
RulesApi	RulesEnableRule	Put /apps/{app}/rules/{id}/enable	Enable a rule.
RulesApi	RulesGetActions	Get /rules/actions	Get supported rule actions.
RulesApi	RulesGetEvents	Get /apps/{app}/rules/events	Get rule events.
RulesApi	RulesGetRules	Get /apps/{app}/rules	Get rules.
RulesApi	RulesPostRule	Post /apps/{app}/rules	Create a new rule.
RulesApi	RulesPutEvent	Put /apps/{app}/rules/events/{id}	Retry the event immediately.
RulesApi	RulesPutRule	Put /apps/{app}/rules/{id}	Update a rule.
RulesApi	RulesPutRuleRun	Put /apps/{app}/rules/{id}/run	Run a rule.
RulesApi	RulesTriggerRule	Put /apps/{app}/rules/{id}/trigger	Trigger a rule.
SchemasApi	SchemaFieldsDeleteField	Delete /apps/{app}/schemas/{name}/fields/{id}	Delete a schema field.
SchemasApi	SchemaFieldsDeleteNestedField	Delete /apps/{app}/schemas/{name}/fields/{parentId}/nested/{id}	Delete a nested field.
SchemasApi	SchemaFieldsDisableField	Put /apps/{app}/schemas/{name}/fields/{id}/disable	Disable a schema field.
SchemasApi	SchemaFieldsDisableNestedField	Put /apps/{app}/schemas/{name}/fields/{parentId}/nested/{id}/disable	Disable a nested field.
SchemasApi	SchemaFieldsEnableField	Put /apps/{app}/schemas/{name}/fields/{id}/enable	Enable a schema field.
SchemasApi	SchemaFieldsEnableNestedField	Put /apps/{app}/schemas/{name}/fields/{parentId}/nested/{id}/enable	Enable a nested field.
SchemasApi	SchemaFieldsHideField	Put /apps/{app}/schemas/{name}/fields/{id}/hide	Hide a schema field.
SchemasApi	SchemaFieldsHideNestedField	Put /apps/{app}/schemas/{name}/fields/{parentId}/nested/{id}/hide	Hide a nested field.
SchemasApi	SchemaFieldsLockField	Put /apps/{app}/schemas/{name}/fields/{id}/lock	Lock a schema field.
SchemasApi	SchemaFieldsLockNestedField	Put /apps/{app}/schemas/{name}/fields/{parentId}/nested/{id}/lock	Lock a nested field.
SchemasApi	SchemaFieldsPostField	Post /apps/{app}/schemas/{name}/fields	Add a schema field.
SchemasApi	SchemaFieldsPostNestedField	Post /apps/{app}/schemas/{name}/fields/{parentId}/nested	Add a nested field.
SchemasApi	SchemaFieldsPutField	Put /apps/{app}/schemas/{name}/fields/{id}	Update a schema field.
SchemasApi	SchemaFieldsPutNestedField	Put /apps/{app}/schemas/{name}/fields/{parentId}/nested/{id}	Update a nested field.
SchemasApi	SchemaFieldsPutNestedFieldOrdering	Put /apps/{app}/schemas/{name}/fields/{parentId}/nested/ordering	Reorders the nested fields.
SchemasApi	SchemaFieldsPutSchemaFieldOrdering	Put /apps/{app}/schemas/{name}/fields/ordering	Reorders the fields.
SchemasApi	SchemaFieldsPutSchemaUIFields	Put /apps/{app}/schemas/{name}/fields/ui	Configure UI fields.
SchemasApi	SchemaFieldsShowField	Put /apps/{app}/schemas/{name}/fields/{id}/show	Show a schema field.
SchemasApi	SchemaFieldsShowNestedField	Put /apps/{app}/schemas/{name}/fields/{parentId}/nested/{id}/show	Show a nested field.
SchemasApi	SchemasDeleteSchema	Delete /apps/{app}/schemas/{name}	Delete a schema.
SchemasApi	SchemasGetSchema	Get /apps/{app}/schemas/{name}	Get a schema by name.
SchemasApi	SchemasGetSchemas	Get /apps/{app}/schemas	Get schemas.
SchemasApi	SchemasPostSchema	Post /apps/{app}/schemas	Create a new schema.
SchemasApi	SchemasPublishSchema	Put /apps/{app}/schemas/{name}/publish	Publish a schema.
SchemasApi	SchemasPutCategory	Put /apps/{app}/schemas/{name}/category	Update a schema category.
SchemasApi	SchemasPutPreviewUrls	Put /apps/{app}/schemas/{name}/preview-urls	Update the preview urls.
SchemasApi	SchemasPutRules	Put /apps/{app}/schemas/{name}/rules	Update the rules.
SchemasApi	SchemasPutSchema	Put /apps/{app}/schemas/{name}	Update a schema.
SchemasApi	SchemasPutSchemaSync	Put /apps/{app}/schemas/{name}/sync	Synchronize a schema.
SchemasApi	SchemasPutScripts	Put /apps/{app}/schemas/{name}/scripts	Update the scripts.
SchemasApi	SchemasUnpublishSchema	Put /apps/{app}/schemas/{name}/unpublish	Unpublish a schema.
SearchApi	SearchGetSearchResults	Get /apps/{app}/search	Get search results.
StatisticsApi	UsagesGetCurrentStorageSize	Get /apps/{app}/usages/storage/today	Get total asset size.
StatisticsApi	UsagesGetLog	Get /apps/{app}/usages/log	Get api calls as log file.
StatisticsApi	UsagesGetStorageSizes	Get /apps/{app}/usages/storage/{fromDate}/{toDate}	Get asset usage by date.
StatisticsApi	UsagesGetUsages	Get /apps/{app}/usages/calls/{fromDate}/{toDate}	Get api calls in date range.
TranslationsApi	TranslationsPostTranslation	Post /apps/{app}/translations	Translate a text.
UsersApi	UsersGetUser	Get /users/{id}	Get user by id.
UsersApi	UsersGetUserPicture	Get /users/{id}/picture	Get user picture by id.
UsersApi	UsersGetUserResources	Get /	Get the user resources.
UsersApi	UsersGetUsers	Get /users	Get users by query.

Documentation For Models

• AddFieldDto
• AddLanguageDto
• AddRoleDto
• AddWorkflowDto
• AlgoliaRuleActionDto
• AlgoliaRuleActionDtoAllOf
• AnnotateAssetDto
• AppDto
• AppDtoAllOf
• AppLanguageDto
• AppLanguageDtoAllOf
• AppLanguagesDto
• AppLanguagesDtoAllOf
• AppPlansDto
• ArrayFieldPropertiesDto
• ArrayFieldPropertiesDtoAllOf
• AssetChangedRuleTriggerDto
• AssetChangedRuleTriggerDtoAllOf
• AssetDto
• AssetDtoAllOf
• AssetMeta
• AssetPreviewMode
• AssetType
• AssetsDto
• AssetsDtoAllOf
• AssetsFieldPropertiesDto
• AssetsFieldPropertiesDtoAllOf
• AssignContributorDto
• AzureQueueRuleActionDto
• AzureQueueRuleActionDtoAllOf
• BackupJobDto
• BackupJobDtoAllOf
• BackupJobsDto
• BackupJobsDtoAllOf
• BooleanFieldEditor
• BooleanFieldPropertiesDto
• BooleanFieldPropertiesDtoAllOf
• BulkResultDto
• BulkUpdateDto
• BulkUpdateJobDto
• BulkUpdateType
• CallsUsageDtoDto
• CallsUsagePerDateDto
• ChangeCategoryDto
• ChangePlanDto
• ChangeStatusDto
• ClientDto
• ClientDtoAllOf
• ClientsDto
• ClientsDtoAllOf
• CommentDto
• CommentRuleActionDto
• CommentRuleActionDtoAllOf
• CommentRuleTriggerDto
• CommentsDto
• ConfigureFieldRulesDto
• ConfigureUiFieldsDto
• ContentChangedRuleTriggerDto
• ContentChangedRuleTriggerDtoAllOf
• ContentChangedRuleTriggerSchemaDto
• ContentDataOfString
• ContentDataOfStringAllOf
• ContentDto
• ContentDtoAllOf
• ContentsDto
• ContentsDtoAllOf
• ContentsIdsQueryDto
• ContributorDto
• ContributorDtoAllOf
• ContributorsDto
• ContributorsDtoAllOf
• ContributorsMetadata
• CreateAppDto
• CreateAssetFolderDto
• CreateClientDto
• CreateContentRuleActionDto
• CreateContentRuleActionDtoAllOf
• CreateRuleDto
• CreateSchemaDto
• CreateSchemaDtoAllOf
• CreateUserDto
• CurrentStorageDto
• DateTimeCalculatedDefaultValue
• DateTimeFieldEditor
• DateTimeFieldPropertiesDto
• DateTimeFieldPropertiesDtoAllOf
• DiscourseRuleActionDto
• DiscourseRuleActionDtoAllOf
• ElasticSearchRuleActionDto
• ElasticSearchRuleActionDtoAllOf
• EmailRuleActionDto
• EmailRuleActionDtoAllOf
• ErrorDto
• EventConsumerDto
• EventConsumerDtoAllOf
• EventConsumersDto
• EventConsumersDtoAllOf
• FastlyRuleActionDto
• FastlyRuleActionDtoAllOf
• FeatureDto
• FeaturesDto
• FieldDto
• FieldDtoAllOf
• FieldPropertiesDto
• FieldRuleAction
• FieldRuleDto
• GeolocationFieldEditor
• GeolocationFieldPropertiesDto
• GeolocationFieldPropertiesDtoAllOf
• GraphQlPostDto
• HistoryEventDto
• IJsonValue
• ImageFormat
• ImportContentsDto
• InlineObject
• InlineObject1
• InlineObject2
• JobStatus
• JsonFieldPropertiesDto
• JsonValueType
• KeyValuePairOfStringAndContentFieldData
• LanguageDto
• LogDownloadDto
• ManualRuleTriggerDto
• MediumRuleActionDto
• MediumRuleActionDtoAllOf
• MoveAssetItemDto
• NamedContentData
• NestedFieldDto
• NestedFieldDtoAllOf
• NotificationRuleActionDto
• NotificationRuleActionDtoAllOf
• NumberFieldEditor
• NumberFieldPropertiesDto
• NumberFieldPropertiesDtoAllOf
• PatternDto
• PatternDtoAllOf
• PatternsDto
• PatternsDtoAllOf
• PlanChangedDto
• PlanDto
• PrerenderRuleActionDto
• PrerenderRuleActionDtoAllOf
• QueryDto
• QueryOfIJsonValue
• ReferencesFieldEditor
• ReferencesFieldPropertiesDto
• ReferencesFieldPropertiesDtoAllOf
• RenameAssetFolderDto
• ReorderFieldsDto
• ResizeMode
• Resource
• ResourceLink
• ResourcesDto
• RestoreJobDto
• RestoreRequestDto
• RoleDto
• RoleDtoAllOf
• RolesDto
• RolesDtoAllOf
• RuleAction
• RuleActionPropertyEditor
• RuleDto
• RuleDtoAllOf
• RuleElementDto
• RuleElementPropertyDto
• RuleEventDto
• RuleEventDtoAllOf
• RuleEventsDto
• RuleEventsDtoAllOf
• RuleJobResult
• RuleResult
• RuleTriggerDto
• RulesDto
• RulesDtoAllOf
• ScheduleJobDto
• SchemaChangedRuleTriggerDto
• SchemaDetailsDto
• SchemaDetailsDtoAllOf
• SchemaDto
• SchemaDtoAllOf
• SchemaPropertiesDto
• SchemaScriptsDto
• SchemasDto
• SchemasDtoAllOf
• SearchResultDto
• SearchResultDtoAllOf
• SearchResultType
• SlackRuleActionDto
• SlackRuleActionDtoAllOf
• SortNode
• SortOrder
• StatusInfoDto
• StorageUsagePerDateDto
• StringContentType
• StringFieldEditor
• StringFieldPropertiesDto
• StringFieldPropertiesDtoAllOf
• SynchronizeSchemaDto
• SynchronizeSchemaDtoAllOf
• TagsFieldEditor
• TagsFieldPropertiesDto
• TagsFieldPropertiesDtoAllOf
• TranslateDto
• TranslationDto
• TranslationResult
• TweetRuleActionDto
• TweetRuleActionDtoAllOf
• UiFieldEditor
• UiFieldPropertiesDto
• UiFieldPropertiesDtoAllOf
• UiSettingsDto
• UpdateAppDto
• UpdateClientDto
• UpdateFieldDto
• UpdateLanguageDto
• UpdatePatternDto
• UpdateRoleDto
• UpdateRuleDto
• UpdateSchemaDto
• UpdateSettingDto
• UpdateUserDto
• UpdateWorkflowDto
• UpsertCommentDto
• UpsertSchemaDto
• UpsertSchemaFieldDto
• UpsertSchemaNestedFieldDto
• UsageRuleTriggerDto
• UsageRuleTriggerDtoAllOf
• UserDto
• UserDtoAllOf
• UserProperty
• UsersDto
• UsersDtoAllOf
• WebhookMethod
• WebhookRuleActionDto
• WebhookRuleActionDtoAllOf
• WorkflowDto
• WorkflowDtoAllOf
• WorkflowStepDto
• WorkflowTransitionDto
• WorkflowsDto
• WorkflowsDtoAllOf

Documentation For Authorization

squidex-oauth-auth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• squidex-api: Read and write access to the API

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Author