sbmgmt

package
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package sbmgmt provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.13.4 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "BearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewBackupSpaceRequest added in v0.1.0

func NewBackupSpaceRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewBackupSpaceRequest generates requests for BackupSpace

func NewCompareStoryRequest added in v0.1.0

func NewCompareStoryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewCompareStoryRequest generates requests for CompareStory

func NewCreateAssetFolderRequest added in v0.1.0

func NewCreateAssetFolderRequest(server string, spaceId SpaceIdParam, body CreateAssetFolderJSONRequestBody) (*http.Request, error)

NewCreateAssetFolderRequest calls the generic CreateAssetFolder builder with application/json body

func NewCreateAssetFolderRequestWithBody added in v0.1.0

func NewCreateAssetFolderRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewCreateAssetFolderRequestWithBody generates requests for CreateAssetFolder with any type of body

func NewCreateComponentGroupRequest added in v0.0.3

func NewCreateComponentGroupRequest(server string, spaceId SpaceIdParam, body CreateComponentGroupJSONRequestBody) (*http.Request, error)

NewCreateComponentGroupRequest calls the generic CreateComponentGroup builder with application/json body

func NewCreateComponentGroupRequestWithBody added in v0.0.3

func NewCreateComponentGroupRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewCreateComponentGroupRequestWithBody generates requests for CreateComponentGroup with any type of body

func NewCreateComponentRequest

func NewCreateComponentRequest(server string, spaceId SpaceIdParam, body CreateComponentJSONRequestBody) (*http.Request, error)

NewCreateComponentRequest calls the generic CreateComponent builder with application/json body

func NewCreateComponentRequestWithBody

func NewCreateComponentRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewCreateComponentRequestWithBody generates requests for CreateComponent with any type of body

func NewCreateDatasourceEntryRequest added in v0.1.0

func NewCreateDatasourceEntryRequest(server string, spaceId SpaceIdParam, body CreateDatasourceEntryJSONRequestBody) (*http.Request, error)

NewCreateDatasourceEntryRequest calls the generic CreateDatasourceEntry builder with application/json body

func NewCreateDatasourceEntryRequestWithBody added in v0.1.0

func NewCreateDatasourceEntryRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewCreateDatasourceEntryRequestWithBody generates requests for CreateDatasourceEntry with any type of body

func NewCreateDatasourceRequest added in v0.1.0

func NewCreateDatasourceRequest(server string, spaceId SpaceIdParam, body CreateDatasourceJSONRequestBody) (*http.Request, error)

NewCreateDatasourceRequest calls the generic CreateDatasource builder with application/json body

func NewCreateDatasourceRequestWithBody added in v0.1.0

func NewCreateDatasourceRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewCreateDatasourceRequestWithBody generates requests for CreateDatasource with any type of body

func NewCreateSpaceRequest added in v0.1.0

func NewCreateSpaceRequest(server string, body CreateSpaceJSONRequestBody) (*http.Request, error)

NewCreateSpaceRequest calls the generic CreateSpace builder with application/json body

func NewCreateSpaceRequestWithBody added in v0.1.0

func NewCreateSpaceRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateSpaceRequestWithBody generates requests for CreateSpace with any type of body

func NewCreateSpaceRoleRequest added in v0.1.0

func NewCreateSpaceRoleRequest(server string, spaceId SpaceIdParam, body CreateSpaceRoleJSONRequestBody) (*http.Request, error)

NewCreateSpaceRoleRequest calls the generic CreateSpaceRole builder with application/json body

func NewCreateSpaceRoleRequestWithBody added in v0.1.0

func NewCreateSpaceRoleRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewCreateSpaceRoleRequestWithBody generates requests for CreateSpaceRole with any type of body

func NewCreateStoryRequest added in v0.1.0

func NewCreateStoryRequest(server string, spaceId SpaceIdParam, body CreateStoryJSONRequestBody) (*http.Request, error)

NewCreateStoryRequest calls the generic CreateStory builder with application/json body

func NewCreateStoryRequestWithBody added in v0.1.0

func NewCreateStoryRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewCreateStoryRequestWithBody generates requests for CreateStory with any type of body

func NewDeleteAssetFolderRequest added in v0.1.0

func NewDeleteAssetFolderRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewDeleteAssetFolderRequest generates requests for DeleteAssetFolder

func NewDeleteComponentGroupRequest added in v0.0.3

func NewDeleteComponentGroupRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewDeleteComponentGroupRequest generates requests for DeleteComponentGroup

func NewDeleteComponentRequest

func NewDeleteComponentRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewDeleteComponentRequest generates requests for DeleteComponent

func NewDeleteDatasourceEntryRequest added in v0.1.0

func NewDeleteDatasourceEntryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewDeleteDatasourceEntryRequest generates requests for DeleteDatasourceEntry

func NewDeleteDatasourceRequest added in v0.1.0

func NewDeleteDatasourceRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewDeleteDatasourceRequest generates requests for DeleteDatasource

func NewDeleteSpaceRequest added in v0.1.0

func NewDeleteSpaceRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewDeleteSpaceRequest generates requests for DeleteSpace

func NewDeleteSpaceRoleRequest added in v0.1.0

func NewDeleteSpaceRoleRequest(server string, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam) (*http.Request, error)

NewDeleteSpaceRoleRequest generates requests for DeleteSpaceRole

func NewDeleteStoryRequest added in v0.1.0

func NewDeleteStoryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewDeleteStoryRequest generates requests for DeleteStory

func NewDuplicateSpaceRequest added in v0.1.0

func NewDuplicateSpaceRequest(server string, spaceId SpaceIdParam, body DuplicateSpaceJSONRequestBody) (*http.Request, error)

NewDuplicateSpaceRequest calls the generic DuplicateSpace builder with application/json body

func NewDuplicateSpaceRequestWithBody added in v0.1.0

func NewDuplicateSpaceRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewDuplicateSpaceRequestWithBody generates requests for DuplicateSpace with any type of body

func NewGetAssetFolderRequest added in v0.1.0

func NewGetAssetFolderRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewGetAssetFolderRequest generates requests for GetAssetFolder

func NewGetComponentGroupRequest added in v0.0.3

func NewGetComponentGroupRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewGetComponentGroupRequest generates requests for GetComponentGroup

func NewGetComponentRequest

func NewGetComponentRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewGetComponentRequest generates requests for GetComponent

func NewGetDatasourceEntryRequest added in v0.1.0

func NewGetDatasourceEntryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewGetDatasourceEntryRequest generates requests for GetDatasourceEntry

func NewGetDatasourceRequest added in v0.1.0

func NewGetDatasourceRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewGetDatasourceRequest generates requests for GetDatasource

func NewGetMultipleSpaceRolesRequest added in v0.1.0

func NewGetMultipleSpaceRolesRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewGetMultipleSpaceRolesRequest generates requests for GetMultipleSpaceRoles

func NewGetSpaceRequest

func NewGetSpaceRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewGetSpaceRequest generates requests for GetSpace

func NewGetSpaceRoleRequest added in v0.1.0

func NewGetSpaceRoleRequest(server string, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam) (*http.Request, error)

NewGetSpaceRoleRequest generates requests for GetSpaceRole

func NewGetSpacesSpaceIdWebhooksRequest

func NewGetSpacesSpaceIdWebhooksRequest(server string, spaceId SpaceIdParam, params *GetSpacesSpaceIdWebhooksParams) (*http.Request, error)

NewGetSpacesSpaceIdWebhooksRequest generates requests for GetSpacesSpaceIdWebhooks

func NewGetSpacesSpaceIdWebhooksWebhookIdRequest

func NewGetSpacesSpaceIdWebhooksWebhookIdRequest(server string, spaceId SpaceIdParam, webhookId string, params *GetSpacesSpaceIdWebhooksWebhookIdParams) (*http.Request, error)

NewGetSpacesSpaceIdWebhooksWebhookIdRequest generates requests for GetSpacesSpaceIdWebhooksWebhookId

func NewGetStoryRequest added in v0.1.0

func NewGetStoryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewGetStoryRequest generates requests for GetStory

func NewListAssetFoldersRequest added in v0.1.0

func NewListAssetFoldersRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewListAssetFoldersRequest generates requests for ListAssetFolders

func NewListComponentGroupsRequest added in v0.1.0

func NewListComponentGroupsRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewListComponentGroupsRequest generates requests for ListComponentGroups

func NewListComponentsRequest added in v0.1.0

func NewListComponentsRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewListComponentsRequest generates requests for ListComponents

func NewListDatasourceEntriesRequest added in v0.1.0

func NewListDatasourceEntriesRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewListDatasourceEntriesRequest generates requests for ListDatasourceEntries

func NewListDatasourcesRequest added in v0.1.0

func NewListDatasourcesRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewListDatasourcesRequest generates requests for ListDatasources

func NewListSpacesRequest added in v0.1.0

func NewListSpacesRequest(server string) (*http.Request, error)

NewListSpacesRequest generates requests for ListSpaces

func NewListStoriesRequest added in v0.1.0

func NewListStoriesRequest(server string, spaceId SpaceIdParam) (*http.Request, error)

NewListStoriesRequest generates requests for ListStories

func NewPublishStoryRequest added in v0.1.0

func NewPublishStoryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewPublishStoryRequest generates requests for PublishStory

func NewUnpublishStoryRequest added in v0.1.0

func NewUnpublishStoryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewUnpublishStoryRequest generates requests for UnpublishStory

func NewUpdateAssetFolderRequest added in v0.1.0

func NewUpdateAssetFolderRequest(server string, spaceId SpaceIdParam, id IdParam, body UpdateAssetFolderJSONRequestBody) (*http.Request, error)

NewUpdateAssetFolderRequest calls the generic UpdateAssetFolder builder with application/json body

func NewUpdateAssetFolderRequestWithBody added in v0.1.0

func NewUpdateAssetFolderRequestWithBody(server string, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateAssetFolderRequestWithBody generates requests for UpdateAssetFolder with any type of body

func NewUpdateComponentGroupRequest added in v0.0.3

func NewUpdateComponentGroupRequest(server string, spaceId SpaceIdParam, id IdParam, body UpdateComponentGroupJSONRequestBody) (*http.Request, error)

NewUpdateComponentGroupRequest calls the generic UpdateComponentGroup builder with application/json body

func NewUpdateComponentGroupRequestWithBody added in v0.0.3

func NewUpdateComponentGroupRequestWithBody(server string, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateComponentGroupRequestWithBody generates requests for UpdateComponentGroup with any type of body

func NewUpdateComponentRequest

func NewUpdateComponentRequest(server string, spaceId SpaceIdParam, id IdParam, body UpdateComponentJSONRequestBody) (*http.Request, error)

NewUpdateComponentRequest calls the generic UpdateComponent builder with application/json body

func NewUpdateComponentRequestWithBody

func NewUpdateComponentRequestWithBody(server string, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateComponentRequestWithBody generates requests for UpdateComponent with any type of body

func NewUpdateDatasourceEntryRequest added in v0.1.0

func NewUpdateDatasourceEntryRequest(server string, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceEntryJSONRequestBody) (*http.Request, error)

NewUpdateDatasourceEntryRequest calls the generic UpdateDatasourceEntry builder with application/json body

func NewUpdateDatasourceEntryRequestWithBody added in v0.1.0

func NewUpdateDatasourceEntryRequestWithBody(server string, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDatasourceEntryRequestWithBody generates requests for UpdateDatasourceEntry with any type of body

func NewUpdateDatasourceRequest added in v0.1.0

func NewUpdateDatasourceRequest(server string, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceJSONRequestBody) (*http.Request, error)

NewUpdateDatasourceRequest calls the generic UpdateDatasource builder with application/json body

func NewUpdateDatasourceRequestWithBody added in v0.1.0

func NewUpdateDatasourceRequestWithBody(server string, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDatasourceRequestWithBody generates requests for UpdateDatasource with any type of body

func NewUpdateSpaceRequest added in v0.1.0

func NewUpdateSpaceRequest(server string, spaceId SpaceIdParam, body UpdateSpaceJSONRequestBody) (*http.Request, error)

NewUpdateSpaceRequest calls the generic UpdateSpace builder with application/json body

func NewUpdateSpaceRequestWithBody added in v0.1.0

func NewUpdateSpaceRequestWithBody(server string, spaceId SpaceIdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateSpaceRequestWithBody generates requests for UpdateSpace with any type of body

func NewUpdateSpaceRoleRequest added in v0.1.0

func NewUpdateSpaceRoleRequest(server string, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, body UpdateSpaceRoleJSONRequestBody) (*http.Request, error)

NewUpdateSpaceRoleRequest calls the generic UpdateSpaceRole builder with application/json body

func NewUpdateSpaceRoleRequestWithBody added in v0.1.0

func NewUpdateSpaceRoleRequestWithBody(server string, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateSpaceRoleRequestWithBody generates requests for UpdateSpaceRole with any type of body

func NewUpdateStoryRequest added in v0.1.0

func NewUpdateStoryRequest(server string, spaceId SpaceIdParam, id IdParam, body UpdateStoryJSONRequestBody) (*http.Request, error)

NewUpdateStoryRequest calls the generic UpdateStory builder with application/json body

func NewUpdateStoryRequestWithBody added in v0.1.0

func NewUpdateStoryRequestWithBody(server string, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader) (*http.Request, error)

NewUpdateStoryRequestWithBody generates requests for UpdateStory with any type of body

func NewVersionsStoryRequest added in v0.1.0

func NewVersionsStoryRequest(server string, spaceId SpaceIdParam, id IdParam) (*http.Request, error)

NewVersionsStoryRequest generates requests for VersionsStory

Types

type AssetFolder added in v0.1.0

type AssetFolder struct {
	// Id The ID of the asset folder
	Id int64 `json:"id"`

	// Name The name of the asset folder
	Name string `json:"name"`

	// ParentId The ID of the parent folder
	ParentId *int64 `json:"parent_id,omitempty"`

	// ParentUuid The UUID of the asset folder
	ParentUuid *string `json:"parent_uuid,omitempty"`

	// Uuid The UUID of the asset folder
	Uuid string `json:"uuid"`
}

AssetFolder defines model for AssetFolder.

type AssetFolderBase added in v0.1.0

type AssetFolderBase struct {
	// Name The name of the asset folder
	Name string `json:"name"`

	// ParentId The ID of the parent folder
	ParentId *int64 `json:"parent_id,omitempty"`
}

AssetFolderBase defines model for AssetFolderBase.

type AssetFolderCreateInput added in v0.1.0

type AssetFolderCreateInput struct {
	AssetFolder AssetFolderBase `json:"asset_folder"`
}

AssetFolderCreateInput defines model for AssetFolderCreateInput.

type AssetFolderUpdateInput added in v0.1.0

type AssetFolderUpdateInput = AssetFolderCreateInput

AssetFolderUpdateInput defines model for AssetFolderUpdateInput.

type BackupSpaceResponse added in v0.1.0

type BackupSpaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Space *Space `json:"space,omitempty"`
	}
}

func ParseBackupSpaceResponse added in v0.1.0

func ParseBackupSpaceResponse(rsp *http.Response) (*BackupSpaceResponse, error)

ParseBackupSpaceResponse parses an HTTP response from a BackupSpaceWithResponse call

func (BackupSpaceResponse) Status added in v0.1.0

func (r BackupSpaceResponse) Status() string

Status returns HTTPResponse.Status

func (BackupSpaceResponse) StatusCode added in v0.1.0

func (r BackupSpaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) BackupSpace added in v0.1.0

func (c *Client) BackupSpace(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompareStory added in v0.1.0

func (c *Client) CompareStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAssetFolder added in v0.1.0

func (c *Client) CreateAssetFolder(ctx context.Context, spaceId SpaceIdParam, body CreateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAssetFolderWithBody added in v0.1.0

func (c *Client) CreateAssetFolderWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateComponent

func (c *Client) CreateComponent(ctx context.Context, spaceId SpaceIdParam, body CreateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateComponentGroup added in v0.0.3

func (c *Client) CreateComponentGroup(ctx context.Context, spaceId SpaceIdParam, body CreateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateComponentGroupWithBody added in v0.0.3

func (c *Client) CreateComponentGroupWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateComponentWithBody

func (c *Client) CreateComponentWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDatasource added in v0.1.0

func (c *Client) CreateDatasource(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDatasourceEntry added in v0.1.0

func (c *Client) CreateDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDatasourceEntryWithBody added in v0.1.0

func (c *Client) CreateDatasourceEntryWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateDatasourceWithBody added in v0.1.0

func (c *Client) CreateDatasourceWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSpace added in v0.1.0

func (c *Client) CreateSpace(ctx context.Context, body CreateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSpaceRole added in v0.1.0

func (c *Client) CreateSpaceRole(ctx context.Context, spaceId SpaceIdParam, body CreateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSpaceRoleWithBody added in v0.1.0

func (c *Client) CreateSpaceRoleWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSpaceWithBody added in v0.1.0

func (c *Client) CreateSpaceWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStory added in v0.1.0

func (c *Client) CreateStory(ctx context.Context, spaceId SpaceIdParam, body CreateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateStoryWithBody added in v0.1.0

func (c *Client) CreateStoryWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteAssetFolder added in v0.1.0

func (c *Client) DeleteAssetFolder(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteComponent

func (c *Client) DeleteComponent(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteComponentGroup added in v0.0.3

func (c *Client) DeleteComponentGroup(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteDatasource added in v0.1.0

func (c *Client) DeleteDatasource(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteDatasourceEntry added in v0.1.0

func (c *Client) DeleteDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteSpace added in v0.1.0

func (c *Client) DeleteSpace(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteSpaceRole added in v0.1.0

func (c *Client) DeleteSpaceRole(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteStory added in v0.1.0

func (c *Client) DeleteStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DuplicateSpace added in v0.1.0

func (c *Client) DuplicateSpace(ctx context.Context, spaceId SpaceIdParam, body DuplicateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DuplicateSpaceWithBody added in v0.1.0

func (c *Client) DuplicateSpaceWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAssetFolder added in v0.1.0

func (c *Client) GetAssetFolder(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetComponent

func (c *Client) GetComponent(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetComponentGroup added in v0.0.3

func (c *Client) GetComponentGroup(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDatasource added in v0.1.0

func (c *Client) GetDatasource(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDatasourceEntry added in v0.1.0

func (c *Client) GetDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetMultipleSpaceRoles added in v0.1.0

func (c *Client) GetMultipleSpaceRoles(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSpace

func (c *Client) GetSpace(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSpaceRole added in v0.1.0

func (c *Client) GetSpaceRole(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSpacesSpaceIdWebhooks

func (c *Client) GetSpacesSpaceIdWebhooks(ctx context.Context, spaceId SpaceIdParam, params *GetSpacesSpaceIdWebhooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSpacesSpaceIdWebhooksWebhookId

func (c *Client) GetSpacesSpaceIdWebhooksWebhookId(ctx context.Context, spaceId SpaceIdParam, webhookId string, params *GetSpacesSpaceIdWebhooksWebhookIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStory added in v0.1.0

func (c *Client) GetStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListAssetFolders added in v0.1.0

func (c *Client) ListAssetFolders(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListComponentGroups added in v0.1.0

func (c *Client) ListComponentGroups(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListComponents added in v0.1.0

func (c *Client) ListComponents(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListDatasourceEntries added in v0.1.0

func (c *Client) ListDatasourceEntries(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListDatasources added in v0.1.0

func (c *Client) ListDatasources(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListSpaces added in v0.1.0

func (c *Client) ListSpaces(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListStories added in v0.1.0

func (c *Client) ListStories(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PublishStory added in v0.1.0

func (c *Client) PublishStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UnpublishStory added in v0.1.0

func (c *Client) UnpublishStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAssetFolder added in v0.1.0

func (c *Client) UpdateAssetFolder(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateAssetFolderWithBody added in v0.1.0

func (c *Client) UpdateAssetFolderWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateComponent

func (c *Client) UpdateComponent(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateComponentGroup added in v0.0.3

func (c *Client) UpdateComponentGroup(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateComponentGroupWithBody added in v0.0.3

func (c *Client) UpdateComponentGroupWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateComponentWithBody

func (c *Client) UpdateComponentWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDatasource added in v0.1.0

func (c *Client) UpdateDatasource(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDatasourceEntry added in v0.1.0

func (c *Client) UpdateDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDatasourceEntryWithBody added in v0.1.0

func (c *Client) UpdateDatasourceEntryWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateDatasourceWithBody added in v0.1.0

func (c *Client) UpdateDatasourceWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSpace added in v0.1.0

func (c *Client) UpdateSpace(ctx context.Context, spaceId SpaceIdParam, body UpdateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSpaceRole added in v0.1.0

func (c *Client) UpdateSpaceRole(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, body UpdateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSpaceRoleWithBody added in v0.1.0

func (c *Client) UpdateSpaceRoleWithBody(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSpaceWithBody added in v0.1.0

func (c *Client) UpdateSpaceWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateStory added in v0.1.0

func (c *Client) UpdateStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateStoryWithBody added in v0.1.0

func (c *Client) UpdateStoryWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) VersionsStory added in v0.1.0

func (c *Client) VersionsStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// CompareStory request
	CompareStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PublishStory request
	PublishStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnpublishStory request
	UnpublishStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// VersionsStory request
	VersionsStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSpacesSpaceIdWebhooks request
	GetSpacesSpaceIdWebhooks(ctx context.Context, spaceId SpaceIdParam, params *GetSpacesSpaceIdWebhooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSpacesSpaceIdWebhooksWebhookId request
	GetSpacesSpaceIdWebhooksWebhookId(ctx context.Context, spaceId SpaceIdParam, webhookId string, params *GetSpacesSpaceIdWebhooksWebhookIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSpaces request
	ListSpaces(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSpaceWithBody request with any body
	CreateSpaceWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateSpace(ctx context.Context, body CreateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSpace request
	DeleteSpace(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSpace request
	GetSpace(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DuplicateSpaceWithBody request with any body
	DuplicateSpaceWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	DuplicateSpace(ctx context.Context, spaceId SpaceIdParam, body DuplicateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateSpaceWithBody request with any body
	UpdateSpaceWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateSpace(ctx context.Context, spaceId SpaceIdParam, body UpdateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAssetFolders request
	ListAssetFolders(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateAssetFolderWithBody request with any body
	CreateAssetFolderWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateAssetFolder(ctx context.Context, spaceId SpaceIdParam, body CreateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteAssetFolder request
	DeleteAssetFolder(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAssetFolder request
	GetAssetFolder(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateAssetFolderWithBody request with any body
	UpdateAssetFolderWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateAssetFolder(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BackupSpace request
	BackupSpace(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListComponentGroups request
	ListComponentGroups(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateComponentGroupWithBody request with any body
	CreateComponentGroupWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateComponentGroup(ctx context.Context, spaceId SpaceIdParam, body CreateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteComponentGroup request
	DeleteComponentGroup(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetComponentGroup request
	GetComponentGroup(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateComponentGroupWithBody request with any body
	UpdateComponentGroupWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateComponentGroup(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListComponents request
	ListComponents(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateComponentWithBody request with any body
	CreateComponentWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateComponent(ctx context.Context, spaceId SpaceIdParam, body CreateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteComponent request
	DeleteComponent(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetComponent request
	GetComponent(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateComponentWithBody request with any body
	UpdateComponentWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateComponent(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDatasourceEntries request
	ListDatasourceEntries(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDatasourceEntryWithBody request with any body
	CreateDatasourceEntryWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteDatasourceEntry request
	DeleteDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDatasourceEntry request
	GetDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDatasourceEntryWithBody request with any body
	UpdateDatasourceEntryWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateDatasourceEntry(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDatasources request
	ListDatasources(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDatasourceWithBody request with any body
	CreateDatasourceWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateDatasource(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteDatasource request
	DeleteDatasource(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDatasource request
	GetDatasource(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDatasourceWithBody request with any body
	UpdateDatasourceWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateDatasource(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMultipleSpaceRoles request
	GetMultipleSpaceRoles(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSpaceRoleWithBody request with any body
	CreateSpaceRoleWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateSpaceRole(ctx context.Context, spaceId SpaceIdParam, body CreateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSpaceRole request
	DeleteSpaceRole(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSpaceRole request
	GetSpaceRole(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateSpaceRoleWithBody request with any body
	UpdateSpaceRoleWithBody(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateSpaceRole(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, body UpdateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListStories request
	ListStories(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateStoryWithBody request with any body
	CreateStoryWithBody(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateStory(ctx context.Context, spaceId SpaceIdParam, body CreateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteStory request
	DeleteStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStory request
	GetStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateStoryWithBody request with any body
	UpdateStoryWithBody(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateStory(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) BackupSpaceWithResponse added in v0.1.0

func (c *ClientWithResponses) BackupSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*BackupSpaceResponse, error)

BackupSpaceWithResponse request returning *BackupSpaceResponse

func (*ClientWithResponses) CompareStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) CompareStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*CompareStoryResponse, error)

CompareStoryWithResponse request returning *CompareStoryResponse

func (*ClientWithResponses) CreateAssetFolderWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateAssetFolderWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAssetFolderResponse, error)

CreateAssetFolderWithBodyWithResponse request with arbitrary body returning *CreateAssetFolderResponse

func (*ClientWithResponses) CreateAssetFolderWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAssetFolderResponse, error)

func (*ClientWithResponses) CreateComponentGroupWithBodyWithResponse added in v0.0.3

func (c *ClientWithResponses) CreateComponentGroupWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateComponentGroupResponse, error)

CreateComponentGroupWithBodyWithResponse request with arbitrary body returning *CreateComponentGroupResponse

func (*ClientWithResponses) CreateComponentGroupWithResponse added in v0.0.3

func (c *ClientWithResponses) CreateComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateComponentGroupResponse, error)

func (*ClientWithResponses) CreateComponentWithBodyWithResponse

func (c *ClientWithResponses) CreateComponentWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateComponentResponse, error)

CreateComponentWithBodyWithResponse request with arbitrary body returning *CreateComponentResponse

func (*ClientWithResponses) CreateComponentWithResponse

func (c *ClientWithResponses) CreateComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateComponentResponse, error)

func (*ClientWithResponses) CreateDatasourceEntryWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateDatasourceEntryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDatasourceEntryResponse, error)

CreateDatasourceEntryWithBodyWithResponse request with arbitrary body returning *CreateDatasourceEntryResponse

func (*ClientWithResponses) CreateDatasourceEntryWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDatasourceEntryResponse, error)

func (*ClientWithResponses) CreateDatasourceWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateDatasourceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDatasourceResponse, error)

CreateDatasourceWithBodyWithResponse request with arbitrary body returning *CreateDatasourceResponse

func (*ClientWithResponses) CreateDatasourceWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDatasourceResponse, error)

func (*ClientWithResponses) CreateSpaceRoleWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateSpaceRoleWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSpaceRoleResponse, error)

CreateSpaceRoleWithBodyWithResponse request with arbitrary body returning *CreateSpaceRoleResponse

func (*ClientWithResponses) CreateSpaceRoleWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSpaceRoleResponse, error)

func (*ClientWithResponses) CreateSpaceWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateSpaceWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSpaceResponse, error)

CreateSpaceWithBodyWithResponse request with arbitrary body returning *CreateSpaceResponse

func (*ClientWithResponses) CreateSpaceWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateSpaceWithResponse(ctx context.Context, body CreateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSpaceResponse, error)

func (*ClientWithResponses) CreateStoryWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateStoryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStoryResponse, error)

CreateStoryWithBodyWithResponse request with arbitrary body returning *CreateStoryResponse

func (*ClientWithResponses) CreateStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) CreateStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStoryResponse, error)

func (*ClientWithResponses) DeleteAssetFolderWithResponse added in v0.1.0

func (c *ClientWithResponses) DeleteAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteAssetFolderResponse, error)

DeleteAssetFolderWithResponse request returning *DeleteAssetFolderResponse

func (*ClientWithResponses) DeleteComponentGroupWithResponse added in v0.0.3

func (c *ClientWithResponses) DeleteComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteComponentGroupResponse, error)

DeleteComponentGroupWithResponse request returning *DeleteComponentGroupResponse

func (*ClientWithResponses) DeleteComponentWithResponse

func (c *ClientWithResponses) DeleteComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteComponentResponse, error)

DeleteComponentWithResponse request returning *DeleteComponentResponse

func (*ClientWithResponses) DeleteDatasourceEntryWithResponse added in v0.1.0

func (c *ClientWithResponses) DeleteDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteDatasourceEntryResponse, error)

DeleteDatasourceEntryWithResponse request returning *DeleteDatasourceEntryResponse

func (*ClientWithResponses) DeleteDatasourceWithResponse added in v0.1.0

func (c *ClientWithResponses) DeleteDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteDatasourceResponse, error)

DeleteDatasourceWithResponse request returning *DeleteDatasourceResponse

func (*ClientWithResponses) DeleteSpaceRoleWithResponse added in v0.1.0

func (c *ClientWithResponses) DeleteSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*DeleteSpaceRoleResponse, error)

DeleteSpaceRoleWithResponse request returning *DeleteSpaceRoleResponse

func (*ClientWithResponses) DeleteSpaceWithResponse added in v0.1.0

func (c *ClientWithResponses) DeleteSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*DeleteSpaceResponse, error)

DeleteSpaceWithResponse request returning *DeleteSpaceResponse

func (*ClientWithResponses) DeleteStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) DeleteStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteStoryResponse, error)

DeleteStoryWithResponse request returning *DeleteStoryResponse

func (*ClientWithResponses) DuplicateSpaceWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) DuplicateSpaceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DuplicateSpaceResponse, error)

DuplicateSpaceWithBodyWithResponse request with arbitrary body returning *DuplicateSpaceResponse

func (*ClientWithResponses) DuplicateSpaceWithResponse added in v0.1.0

func (c *ClientWithResponses) DuplicateSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, body DuplicateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*DuplicateSpaceResponse, error)

func (*ClientWithResponses) GetAssetFolderWithResponse added in v0.1.0

func (c *ClientWithResponses) GetAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetAssetFolderResponse, error)

GetAssetFolderWithResponse request returning *GetAssetFolderResponse

func (*ClientWithResponses) GetComponentGroupWithResponse added in v0.0.3

func (c *ClientWithResponses) GetComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetComponentGroupResponse, error)

GetComponentGroupWithResponse request returning *GetComponentGroupResponse

func (*ClientWithResponses) GetComponentWithResponse

func (c *ClientWithResponses) GetComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetComponentResponse, error)

GetComponentWithResponse request returning *GetComponentResponse

func (*ClientWithResponses) GetDatasourceEntryWithResponse added in v0.1.0

func (c *ClientWithResponses) GetDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetDatasourceEntryResponse, error)

GetDatasourceEntryWithResponse request returning *GetDatasourceEntryResponse

func (*ClientWithResponses) GetDatasourceWithResponse added in v0.1.0

func (c *ClientWithResponses) GetDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetDatasourceResponse, error)

GetDatasourceWithResponse request returning *GetDatasourceResponse

func (*ClientWithResponses) GetMultipleSpaceRolesWithResponse added in v0.1.0

func (c *ClientWithResponses) GetMultipleSpaceRolesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*GetMultipleSpaceRolesResponse, error)

GetMultipleSpaceRolesWithResponse request returning *GetMultipleSpaceRolesResponse

func (*ClientWithResponses) GetSpaceRoleWithResponse added in v0.1.0

func (c *ClientWithResponses) GetSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*GetSpaceRoleResponse, error)

GetSpaceRoleWithResponse request returning *GetSpaceRoleResponse

func (*ClientWithResponses) GetSpaceWithResponse

func (c *ClientWithResponses) GetSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*GetSpaceResponse, error)

GetSpaceWithResponse request returning *GetSpaceResponse

func (*ClientWithResponses) GetSpacesSpaceIdWebhooksWebhookIdWithResponse

func (c *ClientWithResponses) GetSpacesSpaceIdWebhooksWebhookIdWithResponse(ctx context.Context, spaceId SpaceIdParam, webhookId string, params *GetSpacesSpaceIdWebhooksWebhookIdParams, reqEditors ...RequestEditorFn) (*GetSpacesSpaceIdWebhooksWebhookIdResponse, error)

GetSpacesSpaceIdWebhooksWebhookIdWithResponse request returning *GetSpacesSpaceIdWebhooksWebhookIdResponse

func (*ClientWithResponses) GetSpacesSpaceIdWebhooksWithResponse

func (c *ClientWithResponses) GetSpacesSpaceIdWebhooksWithResponse(ctx context.Context, spaceId SpaceIdParam, params *GetSpacesSpaceIdWebhooksParams, reqEditors ...RequestEditorFn) (*GetSpacesSpaceIdWebhooksResponse, error)

GetSpacesSpaceIdWebhooksWithResponse request returning *GetSpacesSpaceIdWebhooksResponse

func (*ClientWithResponses) GetStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) GetStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetStoryResponse, error)

GetStoryWithResponse request returning *GetStoryResponse

func (*ClientWithResponses) ListAssetFoldersWithResponse added in v0.1.0

func (c *ClientWithResponses) ListAssetFoldersWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListAssetFoldersResponse, error)

ListAssetFoldersWithResponse request returning *ListAssetFoldersResponse

func (*ClientWithResponses) ListComponentGroupsWithResponse added in v0.1.0

func (c *ClientWithResponses) ListComponentGroupsWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListComponentGroupsResponse, error)

ListComponentGroupsWithResponse request returning *ListComponentGroupsResponse

func (*ClientWithResponses) ListComponentsWithResponse added in v0.1.0

func (c *ClientWithResponses) ListComponentsWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListComponentsResponse, error)

ListComponentsWithResponse request returning *ListComponentsResponse

func (*ClientWithResponses) ListDatasourceEntriesWithResponse added in v0.1.0

func (c *ClientWithResponses) ListDatasourceEntriesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListDatasourceEntriesResponse, error)

ListDatasourceEntriesWithResponse request returning *ListDatasourceEntriesResponse

func (*ClientWithResponses) ListDatasourcesWithResponse added in v0.1.0

func (c *ClientWithResponses) ListDatasourcesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListDatasourcesResponse, error)

ListDatasourcesWithResponse request returning *ListDatasourcesResponse

func (*ClientWithResponses) ListSpacesWithResponse added in v0.1.0

func (c *ClientWithResponses) ListSpacesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListSpacesResponse, error)

ListSpacesWithResponse request returning *ListSpacesResponse

func (*ClientWithResponses) ListStoriesWithResponse added in v0.1.0

func (c *ClientWithResponses) ListStoriesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListStoriesResponse, error)

ListStoriesWithResponse request returning *ListStoriesResponse

func (*ClientWithResponses) PublishStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) PublishStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*PublishStoryResponse, error)

PublishStoryWithResponse request returning *PublishStoryResponse

func (*ClientWithResponses) UnpublishStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) UnpublishStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*UnpublishStoryResponse, error)

UnpublishStoryWithResponse request returning *UnpublishStoryResponse

func (*ClientWithResponses) UpdateAssetFolderWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateAssetFolderWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAssetFolderResponse, error)

UpdateAssetFolderWithBodyWithResponse request with arbitrary body returning *UpdateAssetFolderResponse

func (*ClientWithResponses) UpdateAssetFolderWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAssetFolderResponse, error)

func (*ClientWithResponses) UpdateComponentGroupWithBodyWithResponse added in v0.0.3

func (c *ClientWithResponses) UpdateComponentGroupWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateComponentGroupResponse, error)

UpdateComponentGroupWithBodyWithResponse request with arbitrary body returning *UpdateComponentGroupResponse

func (*ClientWithResponses) UpdateComponentGroupWithResponse added in v0.0.3

func (c *ClientWithResponses) UpdateComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateComponentGroupResponse, error)

func (*ClientWithResponses) UpdateComponentWithBodyWithResponse

func (c *ClientWithResponses) UpdateComponentWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateComponentResponse, error)

UpdateComponentWithBodyWithResponse request with arbitrary body returning *UpdateComponentResponse

func (*ClientWithResponses) UpdateComponentWithResponse

func (c *ClientWithResponses) UpdateComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateComponentResponse, error)

func (*ClientWithResponses) UpdateDatasourceEntryWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateDatasourceEntryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDatasourceEntryResponse, error)

UpdateDatasourceEntryWithBodyWithResponse request with arbitrary body returning *UpdateDatasourceEntryResponse

func (*ClientWithResponses) UpdateDatasourceEntryWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDatasourceEntryResponse, error)

func (*ClientWithResponses) UpdateDatasourceWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateDatasourceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDatasourceResponse, error)

UpdateDatasourceWithBodyWithResponse request with arbitrary body returning *UpdateDatasourceResponse

func (*ClientWithResponses) UpdateDatasourceWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDatasourceResponse, error)

func (*ClientWithResponses) UpdateSpaceRoleWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateSpaceRoleWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSpaceRoleResponse, error)

UpdateSpaceRoleWithBodyWithResponse request with arbitrary body returning *UpdateSpaceRoleResponse

func (*ClientWithResponses) UpdateSpaceRoleWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, body UpdateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSpaceRoleResponse, error)

func (*ClientWithResponses) UpdateSpaceWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateSpaceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSpaceResponse, error)

UpdateSpaceWithBodyWithResponse request with arbitrary body returning *UpdateSpaceResponse

func (*ClientWithResponses) UpdateSpaceWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, body UpdateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSpaceResponse, error)

func (*ClientWithResponses) UpdateStoryWithBodyWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateStoryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStoryResponse, error)

UpdateStoryWithBodyWithResponse request with arbitrary body returning *UpdateStoryResponse

func (*ClientWithResponses) UpdateStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) UpdateStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStoryResponse, error)

func (*ClientWithResponses) VersionsStoryWithResponse added in v0.1.0

func (c *ClientWithResponses) VersionsStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*VersionsStoryResponse, error)

VersionsStoryWithResponse request returning *VersionsStoryResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// CompareStoryWithResponse request
	CompareStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*CompareStoryResponse, error)

	// PublishStoryWithResponse request
	PublishStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*PublishStoryResponse, error)

	// UnpublishStoryWithResponse request
	UnpublishStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*UnpublishStoryResponse, error)

	// VersionsStoryWithResponse request
	VersionsStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*VersionsStoryResponse, error)

	// GetSpacesSpaceIdWebhooksWithResponse request
	GetSpacesSpaceIdWebhooksWithResponse(ctx context.Context, spaceId SpaceIdParam, params *GetSpacesSpaceIdWebhooksParams, reqEditors ...RequestEditorFn) (*GetSpacesSpaceIdWebhooksResponse, error)

	// GetSpacesSpaceIdWebhooksWebhookIdWithResponse request
	GetSpacesSpaceIdWebhooksWebhookIdWithResponse(ctx context.Context, spaceId SpaceIdParam, webhookId string, params *GetSpacesSpaceIdWebhooksWebhookIdParams, reqEditors ...RequestEditorFn) (*GetSpacesSpaceIdWebhooksWebhookIdResponse, error)

	// ListSpacesWithResponse request
	ListSpacesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListSpacesResponse, error)

	// CreateSpaceWithBodyWithResponse request with any body
	CreateSpaceWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSpaceResponse, error)

	CreateSpaceWithResponse(ctx context.Context, body CreateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSpaceResponse, error)

	// DeleteSpaceWithResponse request
	DeleteSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*DeleteSpaceResponse, error)

	// GetSpaceWithResponse request
	GetSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*GetSpaceResponse, error)

	// DuplicateSpaceWithBodyWithResponse request with any body
	DuplicateSpaceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DuplicateSpaceResponse, error)

	DuplicateSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, body DuplicateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*DuplicateSpaceResponse, error)

	// UpdateSpaceWithBodyWithResponse request with any body
	UpdateSpaceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSpaceResponse, error)

	UpdateSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, body UpdateSpaceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSpaceResponse, error)

	// ListAssetFoldersWithResponse request
	ListAssetFoldersWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListAssetFoldersResponse, error)

	// CreateAssetFolderWithBodyWithResponse request with any body
	CreateAssetFolderWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAssetFolderResponse, error)

	CreateAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAssetFolderResponse, error)

	// DeleteAssetFolderWithResponse request
	DeleteAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteAssetFolderResponse, error)

	// GetAssetFolderWithResponse request
	GetAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetAssetFolderResponse, error)

	// UpdateAssetFolderWithBodyWithResponse request with any body
	UpdateAssetFolderWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateAssetFolderResponse, error)

	UpdateAssetFolderWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateAssetFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateAssetFolderResponse, error)

	// BackupSpaceWithResponse request
	BackupSpaceWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*BackupSpaceResponse, error)

	// ListComponentGroupsWithResponse request
	ListComponentGroupsWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListComponentGroupsResponse, error)

	// CreateComponentGroupWithBodyWithResponse request with any body
	CreateComponentGroupWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateComponentGroupResponse, error)

	CreateComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateComponentGroupResponse, error)

	// DeleteComponentGroupWithResponse request
	DeleteComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteComponentGroupResponse, error)

	// GetComponentGroupWithResponse request
	GetComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetComponentGroupResponse, error)

	// UpdateComponentGroupWithBodyWithResponse request with any body
	UpdateComponentGroupWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateComponentGroupResponse, error)

	UpdateComponentGroupWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateComponentGroupResponse, error)

	// ListComponentsWithResponse request
	ListComponentsWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListComponentsResponse, error)

	// CreateComponentWithBodyWithResponse request with any body
	CreateComponentWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateComponentResponse, error)

	CreateComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateComponentResponse, error)

	// DeleteComponentWithResponse request
	DeleteComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteComponentResponse, error)

	// GetComponentWithResponse request
	GetComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetComponentResponse, error)

	// UpdateComponentWithBodyWithResponse request with any body
	UpdateComponentWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateComponentResponse, error)

	UpdateComponentWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateComponentJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateComponentResponse, error)

	// ListDatasourceEntriesWithResponse request
	ListDatasourceEntriesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListDatasourceEntriesResponse, error)

	// CreateDatasourceEntryWithBodyWithResponse request with any body
	CreateDatasourceEntryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDatasourceEntryResponse, error)

	CreateDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDatasourceEntryResponse, error)

	// DeleteDatasourceEntryWithResponse request
	DeleteDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteDatasourceEntryResponse, error)

	// GetDatasourceEntryWithResponse request
	GetDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetDatasourceEntryResponse, error)

	// UpdateDatasourceEntryWithBodyWithResponse request with any body
	UpdateDatasourceEntryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDatasourceEntryResponse, error)

	UpdateDatasourceEntryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceEntryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDatasourceEntryResponse, error)

	// ListDatasourcesWithResponse request
	ListDatasourcesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListDatasourcesResponse, error)

	// CreateDatasourceWithBodyWithResponse request with any body
	CreateDatasourceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDatasourceResponse, error)

	CreateDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDatasourceResponse, error)

	// DeleteDatasourceWithResponse request
	DeleteDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteDatasourceResponse, error)

	// GetDatasourceWithResponse request
	GetDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetDatasourceResponse, error)

	// UpdateDatasourceWithBodyWithResponse request with any body
	UpdateDatasourceWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDatasourceResponse, error)

	UpdateDatasourceWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateDatasourceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDatasourceResponse, error)

	// GetMultipleSpaceRolesWithResponse request
	GetMultipleSpaceRolesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*GetMultipleSpaceRolesResponse, error)

	// CreateSpaceRoleWithBodyWithResponse request with any body
	CreateSpaceRoleWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSpaceRoleResponse, error)

	CreateSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSpaceRoleResponse, error)

	// DeleteSpaceRoleWithResponse request
	DeleteSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*DeleteSpaceRoleResponse, error)

	// GetSpaceRoleWithResponse request
	GetSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, reqEditors ...RequestEditorFn) (*GetSpaceRoleResponse, error)

	// UpdateSpaceRoleWithBodyWithResponse request with any body
	UpdateSpaceRoleWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSpaceRoleResponse, error)

	UpdateSpaceRoleWithResponse(ctx context.Context, spaceId SpaceIdParam, spaceRoleId SpaceRoleIdParam, body UpdateSpaceRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSpaceRoleResponse, error)

	// ListStoriesWithResponse request
	ListStoriesWithResponse(ctx context.Context, spaceId SpaceIdParam, reqEditors ...RequestEditorFn) (*ListStoriesResponse, error)

	// CreateStoryWithBodyWithResponse request with any body
	CreateStoryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateStoryResponse, error)

	CreateStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, body CreateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateStoryResponse, error)

	// DeleteStoryWithResponse request
	DeleteStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*DeleteStoryResponse, error)

	// GetStoryWithResponse request
	GetStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, reqEditors ...RequestEditorFn) (*GetStoryResponse, error)

	// UpdateStoryWithBodyWithResponse request with any body
	UpdateStoryWithBodyWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateStoryResponse, error)

	UpdateStoryWithResponse(ctx context.Context, spaceId SpaceIdParam, id IdParam, body UpdateStoryJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateStoryResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CompareStoryResponse added in v0.1.0

type CompareStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[][]string
}

func ParseCompareStoryResponse added in v0.1.0

func ParseCompareStoryResponse(rsp *http.Response) (*CompareStoryResponse, error)

ParseCompareStoryResponse parses an HTTP response from a CompareStoryWithResponse call

func (CompareStoryResponse) Status added in v0.1.0

func (r CompareStoryResponse) Status() string

Status returns HTTPResponse.Status

func (CompareStoryResponse) StatusCode added in v0.1.0

func (r CompareStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Component

type Component struct {
	// Color Css color used as background for the icon
	Color *string `json:"color,omitempty"`

	// ComponentGroupUuid The component group uuid of the component
	ComponentGroupUuid *uuid.UUID `json:"component_group_uuid,omitempty"`

	// CreatedAt The creation timestamp of the component
	CreatedAt time.Time `json:"created_at"`

	// DisplayName The display name of the component
	DisplayName *string `json:"display_name,omitempty"`

	// Icon An optional icon for the component to identify this component type in the interface
	Icon *ComponentIcon `json:"icon,omitempty"`

	// Id The ID of the component
	Id int64 `json:"id"`

	// Image URL to the preview image, if uploaded
	Image *string `json:"image,omitempty"`

	// IsNestable Component should be insertable in blocks field type fields
	IsNestable *bool `json:"is_nestable,omitempty"`

	// IsRoot Component should be usable as a Content Type
	IsRoot *bool `json:"is_root,omitempty"`

	// Name Technical name used for component property in entries
	Name string `json:"name"`

	// PresetId The ID of the preset associated with the component (null if not set)
	PresetId *string `json:"preset_id,omitempty"`

	// PreviewField Define the field that should be used for preview in the interface
	PreviewField *string `json:"preview_field,omitempty"`

	// PreviewTmpl Define the template that should be used for preview in the interface
	PreviewTmpl *string `json:"preview_tmpl"`

	// RealName The real name of the component
	RealName *string `json:"real_name,omitempty"`

	// Schema The definition of fields (schema) for this component
	Schema *orderedmap.OrderedMap[string, FieldInput] `json:"schema,omitempty"`

	// UpdatedAt The update timestamp of the component
	UpdatedAt time.Time `json:"updated_at"`
}

Component defines model for Component.

type ComponentBase added in v0.1.0

type ComponentBase struct {
	// Color Css color used as background for the icon
	Color *string `json:"color,omitempty"`

	// ComponentGroupUuid The component group uuid of the component
	ComponentGroupUuid *uuid.UUID `json:"component_group_uuid,omitempty"`

	// DisplayName The display name of the component
	DisplayName *string `json:"display_name,omitempty"`

	// Icon An optional icon for the component to identify this component type in the interface
	Icon *ComponentBaseIcon `json:"icon,omitempty"`

	// Image URL to the preview image, if uploaded
	Image *string `json:"image,omitempty"`

	// IsNestable Component should be insertable in blocks field type fields
	IsNestable *bool `json:"is_nestable,omitempty"`

	// IsRoot Component should be usable as a Content Type
	IsRoot *bool `json:"is_root,omitempty"`

	// Name Technical name used for component property in entries
	Name string `json:"name"`

	// PreviewField Define the field that should be used for preview in the interface
	PreviewField *string `json:"preview_field,omitempty"`

	// PreviewTmpl Define the template that should be used for preview in the interface
	PreviewTmpl *string `json:"preview_tmpl"`

	// Schema The definition of fields (schema) for this component
	Schema *orderedmap.OrderedMap[string, FieldInput] `json:"schema,omitempty"`
}

ComponentBase defines model for ComponentBase.

type ComponentBaseIcon added in v0.1.0

type ComponentBaseIcon string

ComponentBaseIcon An optional icon for the component to identify this component type in the interface

const (
	ComponentBaseIconBlock             ComponentBaseIcon = "block-@"
	ComponentBaseIconBlock12block      ComponentBaseIcon = "block-1-2block"
	ComponentBaseIconBlockAdd          ComponentBaseIcon = "block-add"
	ComponentBaseIconBlockArrowPointer ComponentBaseIcon = "block-arrow-pointer"
	ComponentBaseIconBlockBlock        ComponentBaseIcon = "block-block"
	ComponentBaseIconBlockBuildin      ComponentBaseIcon = "block-buildin"
	ComponentBaseIconBlockCart         ComponentBaseIcon = "block-cart"
	ComponentBaseIconBlockCenterM      ComponentBaseIcon = "block-center-m"
	ComponentBaseIconBlockComment      ComponentBaseIcon = "block-comment"
	ComponentBaseIconBlockDoc          ComponentBaseIcon = "block-doc"
	ComponentBaseIconBlockDollarSign   ComponentBaseIcon = "block-dollar-sign"
	ComponentBaseIconBlockEmail        ComponentBaseIcon = "block-email"
	ComponentBaseIconBlockImage        ComponentBaseIcon = "block-image"
	ComponentBaseIconBlockKeyboard     ComponentBaseIcon = "block-keyboard"
	ComponentBaseIconBlockLocked       ComponentBaseIcon = "block-locked"
	ComponentBaseIconBlockMapPin       ComponentBaseIcon = "block-map-pin"
	ComponentBaseIconBlockMobile       ComponentBaseIcon = "block-mobile"
	ComponentBaseIconBlockMonitor      ComponentBaseIcon = "block-monitor"
	ComponentBaseIconBlockPaycard      ComponentBaseIcon = "block-paycard"
	ComponentBaseIconBlockResizeFc     ComponentBaseIcon = "block-resize-fc"
	ComponentBaseIconBlockShare        ComponentBaseIcon = "block-share"
	ComponentBaseIconBlockShield       ComponentBaseIcon = "block-shield"
	ComponentBaseIconBlockShield2      ComponentBaseIcon = "block-shield-2"
	ComponentBaseIconBlockSticker      ComponentBaseIcon = "block-sticker"
	ComponentBaseIconBlockSuitcase     ComponentBaseIcon = "block-suitcase"
	ComponentBaseIconBlockTable        ComponentBaseIcon = "block-table"
	ComponentBaseIconBlockTable2       ComponentBaseIcon = "block-table-2"
	ComponentBaseIconBlockTag          ComponentBaseIcon = "block-tag"
	ComponentBaseIconBlockTextC        ComponentBaseIcon = "block-text-c"
	ComponentBaseIconBlockTextImgC     ComponentBaseIcon = "block-text-img-c"
	ComponentBaseIconBlockTextImgL     ComponentBaseIcon = "block-text-img-l"
	ComponentBaseIconBlockTextImgR     ComponentBaseIcon = "block-text-img-r"
	ComponentBaseIconBlockTextImgRL    ComponentBaseIcon = "block-text-img-r-l"
	ComponentBaseIconBlockTextImgTL    ComponentBaseIcon = "block-text-img-t-l"
	ComponentBaseIconBlockTextImgTR    ComponentBaseIcon = "block-text-img-t-r"
	ComponentBaseIconBlockTextL        ComponentBaseIcon = "block-text-l"
	ComponentBaseIconBlockTextR        ComponentBaseIcon = "block-text-r"
	ComponentBaseIconBlockUnlocked     ComponentBaseIcon = "block-unlocked"
	ComponentBaseIconBlockWallet       ComponentBaseIcon = "block-wallet"
)

Defines values for ComponentBaseIcon.

type ComponentCreateInput added in v0.1.0

type ComponentCreateInput struct {
	Component ComponentBase `json:"component"`
}

ComponentCreateInput defines model for ComponentCreateInput.

type ComponentGroup

type ComponentGroup struct {
	// Id The ID of the component group
	Id int64 `json:"id"`

	// Name The name of the component group
	Name string `json:"name"`

	// Uuid The UUID of the component group
	Uuid uuid.UUID `json:"uuid"`
}

ComponentGroup defines model for ComponentGroup.

type ComponentGroupBase added in v0.1.0

type ComponentGroupBase struct {
	// Name The name of the component group
	Name string `json:"name"`
}

ComponentGroupBase defines model for ComponentGroupBase.

type ComponentGroupCreateInput added in v0.1.0

type ComponentGroupCreateInput struct {
	ComponentGroup ComponentGroupBase `json:"component_group"`
}

ComponentGroupCreateInput defines model for ComponentGroupCreateInput.

type ComponentGroupUpdateInput added in v0.1.0

type ComponentGroupUpdateInput = ComponentGroupCreateInput

ComponentGroupUpdateInput defines model for ComponentGroupUpdateInput.

type ComponentIcon added in v0.1.0

type ComponentIcon string

ComponentIcon An optional icon for the component to identify this component type in the interface

const (
	ComponentIconBlock             ComponentIcon = "block-@"
	ComponentIconBlock12block      ComponentIcon = "block-1-2block"
	ComponentIconBlockAdd          ComponentIcon = "block-add"
	ComponentIconBlockArrowPointer ComponentIcon = "block-arrow-pointer"
	ComponentIconBlockBlock        ComponentIcon = "block-block"
	ComponentIconBlockBuildin      ComponentIcon = "block-buildin"
	ComponentIconBlockCart         ComponentIcon = "block-cart"
	ComponentIconBlockCenterM      ComponentIcon = "block-center-m"
	ComponentIconBlockComment      ComponentIcon = "block-comment"
	ComponentIconBlockDoc          ComponentIcon = "block-doc"
	ComponentIconBlockDollarSign   ComponentIcon = "block-dollar-sign"
	ComponentIconBlockEmail        ComponentIcon = "block-email"
	ComponentIconBlockImage        ComponentIcon = "block-image"
	ComponentIconBlockKeyboard     ComponentIcon = "block-keyboard"
	ComponentIconBlockLocked       ComponentIcon = "block-locked"
	ComponentIconBlockMapPin       ComponentIcon = "block-map-pin"
	ComponentIconBlockMobile       ComponentIcon = "block-mobile"
	ComponentIconBlockMonitor      ComponentIcon = "block-monitor"
	ComponentIconBlockPaycard      ComponentIcon = "block-paycard"
	ComponentIconBlockResizeFc     ComponentIcon = "block-resize-fc"
	ComponentIconBlockShare        ComponentIcon = "block-share"
	ComponentIconBlockShield       ComponentIcon = "block-shield"
	ComponentIconBlockShield2      ComponentIcon = "block-shield-2"
	ComponentIconBlockSticker      ComponentIcon = "block-sticker"
	ComponentIconBlockSuitcase     ComponentIcon = "block-suitcase"
	ComponentIconBlockTable        ComponentIcon = "block-table"
	ComponentIconBlockTable2       ComponentIcon = "block-table-2"
	ComponentIconBlockTag          ComponentIcon = "block-tag"
	ComponentIconBlockTextC        ComponentIcon = "block-text-c"
	ComponentIconBlockTextImgC     ComponentIcon = "block-text-img-c"
	ComponentIconBlockTextImgL     ComponentIcon = "block-text-img-l"
	ComponentIconBlockTextImgR     ComponentIcon = "block-text-img-r"
	ComponentIconBlockTextImgRL    ComponentIcon = "block-text-img-r-l"
	ComponentIconBlockTextImgTL    ComponentIcon = "block-text-img-t-l"
	ComponentIconBlockTextImgTR    ComponentIcon = "block-text-img-t-r"
	ComponentIconBlockTextL        ComponentIcon = "block-text-l"
	ComponentIconBlockTextR        ComponentIcon = "block-text-r"
	ComponentIconBlockUnlocked     ComponentIcon = "block-unlocked"
	ComponentIconBlockWallet       ComponentIcon = "block-wallet"
)

Defines values for ComponentIcon.

type ComponentUpdateInput added in v0.1.0

type ComponentUpdateInput = ComponentCreateInput

ComponentUpdateInput defines model for ComponentUpdateInput.

type CreateAssetFolderJSONRequestBody added in v0.1.0

type CreateAssetFolderJSONRequestBody = AssetFolderCreateInput

CreateAssetFolderJSONRequestBody defines body for CreateAssetFolder for application/json ContentType.

type CreateAssetFolderResponse added in v0.1.0

type CreateAssetFolderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// AssetFolder A asset folder can be used to group components together. Each component can have only one asset folder.
		AssetFolder *AssetFolder `json:"asset_folder,omitempty"`
	}
}

func ParseCreateAssetFolderResponse added in v0.1.0

func ParseCreateAssetFolderResponse(rsp *http.Response) (*CreateAssetFolderResponse, error)

ParseCreateAssetFolderResponse parses an HTTP response from a CreateAssetFolderWithResponse call

func (CreateAssetFolderResponse) Status added in v0.1.0

func (r CreateAssetFolderResponse) Status() string

Status returns HTTPResponse.Status

func (CreateAssetFolderResponse) StatusCode added in v0.1.0

func (r CreateAssetFolderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateComponentGroupJSONRequestBody added in v0.0.3

type CreateComponentGroupJSONRequestBody = ComponentGroupCreateInput

CreateComponentGroupJSONRequestBody defines body for CreateComponentGroup for application/json ContentType.

type CreateComponentGroupResponse added in v0.0.3

type CreateComponentGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// ComponentGroup A component group can be used to group components together. Each component can have only one component group.
		ComponentGroup *ComponentGroup `json:"component_group,omitempty"`
	}
}

func ParseCreateComponentGroupResponse added in v0.0.3

func ParseCreateComponentGroupResponse(rsp *http.Response) (*CreateComponentGroupResponse, error)

ParseCreateComponentGroupResponse parses an HTTP response from a CreateComponentGroupWithResponse call

func (CreateComponentGroupResponse) Status added in v0.0.3

Status returns HTTPResponse.Status

func (CreateComponentGroupResponse) StatusCode added in v0.0.3

func (r CreateComponentGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateComponentJSONRequestBody

type CreateComponentJSONRequestBody = ComponentCreateInput

CreateComponentJSONRequestBody defines body for CreateComponent for application/json ContentType.

type CreateComponentResponse

type CreateComponentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Component A component is a standalone entity that is meaningful in its own right. While components (or bloks) can be nested in each other, semantically they remain equal. Each component is a small piece of your data structure which can be filled with content or nested by your content editor. One component can consist of as many field types as required.
		Component *Component `json:"component,omitempty"`
	}
}

func ParseCreateComponentResponse

func ParseCreateComponentResponse(rsp *http.Response) (*CreateComponentResponse, error)

ParseCreateComponentResponse parses an HTTP response from a CreateComponentWithResponse call

func (CreateComponentResponse) Status

func (r CreateComponentResponse) Status() string

Status returns HTTPResponse.Status

func (CreateComponentResponse) StatusCode

func (r CreateComponentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDatasourceEntryJSONRequestBody added in v0.1.0

type CreateDatasourceEntryJSONRequestBody = DatasourceEntryCreateInput

CreateDatasourceEntryJSONRequestBody defines body for CreateDatasourceEntry for application/json ContentType.

type CreateDatasourceEntryResponse added in v0.1.0

type CreateDatasourceEntryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// DatasourceEntry The actual KEY/VALUE pair object a datasource consists of. One specific datasource entry is a set of two linked data items: a key, which is a unique identifier for the item of data scoped in the data source, and the value, which is the data that is identified.
		DatasourceEntry *DatasourceEntry `json:"datasource_entry,omitempty"`
	}
}

func ParseCreateDatasourceEntryResponse added in v0.1.0

func ParseCreateDatasourceEntryResponse(rsp *http.Response) (*CreateDatasourceEntryResponse, error)

ParseCreateDatasourceEntryResponse parses an HTTP response from a CreateDatasourceEntryWithResponse call

func (CreateDatasourceEntryResponse) Status added in v0.1.0

Status returns HTTPResponse.Status

func (CreateDatasourceEntryResponse) StatusCode added in v0.1.0

func (r CreateDatasourceEntryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDatasourceJSONRequestBody added in v0.1.0

type CreateDatasourceJSONRequestBody = DatasourceCreateInput

CreateDatasourceJSONRequestBody defines body for CreateDatasource for application/json ContentType.

type CreateDatasourceResponse added in v0.1.0

type CreateDatasourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Datasource
}

func ParseCreateDatasourceResponse added in v0.1.0

func ParseCreateDatasourceResponse(rsp *http.Response) (*CreateDatasourceResponse, error)

ParseCreateDatasourceResponse parses an HTTP response from a CreateDatasourceWithResponse call

func (CreateDatasourceResponse) Status added in v0.1.0

func (r CreateDatasourceResponse) Status() string

Status returns HTTPResponse.Status

func (CreateDatasourceResponse) StatusCode added in v0.1.0

func (r CreateDatasourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSpaceJSONRequestBody added in v0.1.0

type CreateSpaceJSONRequestBody = SpaceCreateInput

CreateSpaceJSONRequestBody defines body for CreateSpace for application/json ContentType.

type CreateSpaceResponse added in v0.1.0

type CreateSpaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		Space *Space `json:"space,omitempty"`
	}
}

func ParseCreateSpaceResponse added in v0.1.0

func ParseCreateSpaceResponse(rsp *http.Response) (*CreateSpaceResponse, error)

ParseCreateSpaceResponse parses an HTTP response from a CreateSpaceWithResponse call

func (CreateSpaceResponse) Status added in v0.1.0

func (r CreateSpaceResponse) Status() string

Status returns HTTPResponse.Status

func (CreateSpaceResponse) StatusCode added in v0.1.0

func (r CreateSpaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSpaceRoleJSONRequestBody added in v0.1.0

type CreateSpaceRoleJSONRequestBody = SpaceRoleCreateInput

CreateSpaceRoleJSONRequestBody defines body for CreateSpaceRole for application/json ContentType.

type CreateSpaceRoleResponse added in v0.1.0

type CreateSpaceRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		SpaceRole *SpaceRole `json:"space_role,omitempty"`
	}
}

func ParseCreateSpaceRoleResponse added in v0.1.0

func ParseCreateSpaceRoleResponse(rsp *http.Response) (*CreateSpaceRoleResponse, error)

ParseCreateSpaceRoleResponse parses an HTTP response from a CreateSpaceRoleWithResponse call

func (CreateSpaceRoleResponse) Status added in v0.1.0

func (r CreateSpaceRoleResponse) Status() string

Status returns HTTPResponse.Status

func (CreateSpaceRoleResponse) StatusCode added in v0.1.0

func (r CreateSpaceRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateStoryJSONRequestBody added in v0.1.0

type CreateStoryJSONRequestBody = StoryCreateInput

CreateStoryJSONRequestBody defines body for CreateStory for application/json ContentType.

type CreateStoryResponse added in v0.1.0

type CreateStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Story This is an object representing your content entry. One Story object can be of a specific type, so called content types and is able to contain components. You define the fields and nestability of your content types to achieve your content structure. You can use this object to build up your entities when migrating or importing content. You can set alternate versions of a story with Management API using the group_id of the story.
		Story *Story `json:"story,omitempty"`
	}
}

func ParseCreateStoryResponse added in v0.1.0

func ParseCreateStoryResponse(rsp *http.Response) (*CreateStoryResponse, error)

ParseCreateStoryResponse parses an HTTP response from a CreateStoryWithResponse call

func (CreateStoryResponse) Status added in v0.1.0

func (r CreateStoryResponse) Status() string

Status returns HTTPResponse.Status

func (CreateStoryResponse) StatusCode added in v0.1.0

func (r CreateStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Datasource added in v0.1.0

type Datasource struct {
	// CreatedAt The creation timestamp of the datasource
	CreatedAt time.Time `json:"created_at"`

	// Id The ID of the datasource
	Id int64 `json:"id"`

	// Name The name of the data source
	Name string `json:"name"`

	// Slug The slug of the data source
	Slug string `json:"slug"`

	// UpdatedAt The update timestamp of the datasource
	UpdatedAt time.Time `json:"updated_at"`
}

Datasource defines model for Datasource.

type DatasourceBase added in v0.1.0

type DatasourceBase struct {
	// Name The name of the data source
	Name string `json:"name"`

	// Slug The slug of the data source
	Slug string `json:"slug"`
}

DatasourceBase defines model for DatasourceBase.

type DatasourceCreateInput added in v0.1.0

type DatasourceCreateInput struct {
	Datasource DatasourceBase `json:"datasource"`
}

DatasourceCreateInput defines model for DatasourceCreateInput.

type DatasourceEntry added in v0.1.0

type DatasourceEntry struct {
	// DatasourceId The ID of the datasource containing the entry
	DatasourceId *int64 `json:"datasource_id,omitempty"`

	// Id The ID of the datasource entry
	Id int64 `json:"id"`

	// Name The name of the datasource entry
	Name string `json:"name"`

	// Value The value of the datasource entry
	Value *string `json:"value,omitempty"`
}

DatasourceEntry defines model for DatasourceEntry.

type DatasourceEntryBase added in v0.1.0

type DatasourceEntryBase struct {
	// DatasourceId The ID of the datasource containing the entry
	DatasourceId *int64 `json:"datasource_id,omitempty"`

	// Name The name of the datasource entry
	Name string `json:"name"`

	// Value The value of the datasource entry
	Value *string `json:"value,omitempty"`
}

DatasourceEntryBase defines model for DatasourceEntryBase.

type DatasourceEntryCreateInput added in v0.1.0

type DatasourceEntryCreateInput struct {
	DatasourceEntry DatasourceEntryBase `json:"datasource_entry"`
}

DatasourceEntryCreateInput defines model for DatasourceEntryCreateInput.

type DatasourceEntryUpdateInput added in v0.1.0

type DatasourceEntryUpdateInput = DatasourceEntryCreateInput

DatasourceEntryUpdateInput defines model for DatasourceEntryUpdateInput.

type DatasourceUpdateInput added in v0.1.0

type DatasourceUpdateInput = DatasourceCreateInput

DatasourceUpdateInput defines model for DatasourceUpdateInput.

type DeleteAssetFolderResponse added in v0.1.0

type DeleteAssetFolderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// AssetFolder A asset folder can be used to group components together. Each component can have only one asset folder.
		AssetFolder *AssetFolder `json:"asset_folder,omitempty"`
	}
}

func ParseDeleteAssetFolderResponse added in v0.1.0

func ParseDeleteAssetFolderResponse(rsp *http.Response) (*DeleteAssetFolderResponse, error)

ParseDeleteAssetFolderResponse parses an HTTP response from a DeleteAssetFolderWithResponse call

func (DeleteAssetFolderResponse) Status added in v0.1.0

func (r DeleteAssetFolderResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteAssetFolderResponse) StatusCode added in v0.1.0

func (r DeleteAssetFolderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteComponentGroupResponse added in v0.0.3

type DeleteComponentGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// ComponentGroup A component group can be used to group components together. Each component can have only one component group.
		ComponentGroup *ComponentGroup `json:"component_group,omitempty"`
	}
}

func ParseDeleteComponentGroupResponse added in v0.0.3

func ParseDeleteComponentGroupResponse(rsp *http.Response) (*DeleteComponentGroupResponse, error)

ParseDeleteComponentGroupResponse parses an HTTP response from a DeleteComponentGroupWithResponse call

func (DeleteComponentGroupResponse) Status added in v0.0.3

Status returns HTTPResponse.Status

func (DeleteComponentGroupResponse) StatusCode added in v0.0.3

func (r DeleteComponentGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteComponentResponse

type DeleteComponentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Component A component is a standalone entity that is meaningful in its own right. While components (or bloks) can be nested in each other, semantically they remain equal. Each component is a small piece of your data structure which can be filled with content or nested by your content editor. One component can consist of as many field types as required.
		Component *Component `json:"component,omitempty"`
	}
}

func ParseDeleteComponentResponse

func ParseDeleteComponentResponse(rsp *http.Response) (*DeleteComponentResponse, error)

ParseDeleteComponentResponse parses an HTTP response from a DeleteComponentWithResponse call

func (DeleteComponentResponse) Status

func (r DeleteComponentResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteComponentResponse) StatusCode

func (r DeleteComponentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteDatasourceEntryResponse added in v0.1.0

type DeleteDatasourceEntryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// DatasourceEntry The actual KEY/VALUE pair object a datasource consists of. One specific datasource entry is a set of two linked data items: a key, which is a unique identifier for the item of data scoped in the data source, and the value, which is the data that is identified.
		DatasourceEntry *DatasourceEntry `json:"datasource_entry,omitempty"`
	}
}

func ParseDeleteDatasourceEntryResponse added in v0.1.0

func ParseDeleteDatasourceEntryResponse(rsp *http.Response) (*DeleteDatasourceEntryResponse, error)

ParseDeleteDatasourceEntryResponse parses an HTTP response from a DeleteDatasourceEntryWithResponse call

func (DeleteDatasourceEntryResponse) Status added in v0.1.0

Status returns HTTPResponse.Status

func (DeleteDatasourceEntryResponse) StatusCode added in v0.1.0

func (r DeleteDatasourceEntryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteDatasourceResponse added in v0.1.0

type DeleteDatasourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Datasource A datasource is a collection of datasource entries with a specific name and slug. Each datasource entry is a collection of key-value pairs (KVP), so called datasource entries. Those key-value pairs can be used for a single choice, multiple choice options and as well directly through our API to use them for multi-language labels, categories, or anything similar.
		Datasource *Datasource `json:"datasource,omitempty"`
	}
}

func ParseDeleteDatasourceResponse added in v0.1.0

func ParseDeleteDatasourceResponse(rsp *http.Response) (*DeleteDatasourceResponse, error)

ParseDeleteDatasourceResponse parses an HTTP response from a DeleteDatasourceWithResponse call

func (DeleteDatasourceResponse) Status added in v0.1.0

func (r DeleteDatasourceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteDatasourceResponse) StatusCode added in v0.1.0

func (r DeleteDatasourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSpaceResponse added in v0.1.0

type DeleteSpaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Space *Space `json:"space,omitempty"`
	}
}

func ParseDeleteSpaceResponse added in v0.1.0

func ParseDeleteSpaceResponse(rsp *http.Response) (*DeleteSpaceResponse, error)

ParseDeleteSpaceResponse parses an HTTP response from a DeleteSpaceWithResponse call

func (DeleteSpaceResponse) Status added in v0.1.0

func (r DeleteSpaceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteSpaceResponse) StatusCode added in v0.1.0

func (r DeleteSpaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSpaceRoleResponse added in v0.1.0

type DeleteSpaceRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		SpaceRole *SpaceRole `json:"space_role,omitempty"`
	}
}

func ParseDeleteSpaceRoleResponse added in v0.1.0

func ParseDeleteSpaceRoleResponse(rsp *http.Response) (*DeleteSpaceRoleResponse, error)

ParseDeleteSpaceRoleResponse parses an HTTP response from a DeleteSpaceRoleWithResponse call

func (DeleteSpaceRoleResponse) Status added in v0.1.0

func (r DeleteSpaceRoleResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteSpaceRoleResponse) StatusCode added in v0.1.0

func (r DeleteSpaceRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteStoryResponse added in v0.1.0

type DeleteStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Story This is an object representing your content entry. One Story object can be of a specific type, so called content types and is able to contain components. You define the fields and nestability of your content types to achieve your content structure. You can use this object to build up your entities when migrating or importing content. You can set alternate versions of a story with Management API using the group_id of the story.
		Story *Story `json:"story,omitempty"`
	}
}

func ParseDeleteStoryResponse added in v0.1.0

func ParseDeleteStoryResponse(rsp *http.Response) (*DeleteStoryResponse, error)

ParseDeleteStoryResponse parses an HTTP response from a DeleteStoryWithResponse call

func (DeleteStoryResponse) Status added in v0.1.0

func (r DeleteStoryResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteStoryResponse) StatusCode added in v0.1.0

func (r DeleteStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DuplicateSpaceJSONRequestBody added in v0.1.0

type DuplicateSpaceJSONRequestBody = SpaceDuplicateInput

DuplicateSpaceJSONRequestBody defines body for DuplicateSpace for application/json ContentType.

type DuplicateSpaceResponse added in v0.1.0

type DuplicateSpaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Space *Space `json:"space,omitempty"`
	}
}

func ParseDuplicateSpaceResponse added in v0.1.0

func ParseDuplicateSpaceResponse(rsp *http.Response) (*DuplicateSpaceResponse, error)

ParseDuplicateSpaceResponse parses an HTTP response from a DuplicateSpaceWithResponse call

func (DuplicateSpaceResponse) Status added in v0.1.0

func (r DuplicateSpaceResponse) Status() string

Status returns HTTPResponse.Status

func (DuplicateSpaceResponse) StatusCode added in v0.1.0

func (r DuplicateSpaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FieldInput

type FieldInput struct {
	// AddHttps Prepends https: to stop usage of relative protocol
	AddHttps *bool `json:"add_https,omitempty"`

	// AllowTargetBlank Allow target blank for links in richtext
	AllowTargetBlank *bool `json:"allow_target_blank,omitempty"`

	// AssetFolderId Default asset folder numeric id to store uploaded image of that field
	AssetFolderId *int64 `json:"asset_folder_id,omitempty"`

	// CanSync Advanced usage to sync with field in preview
	CanSync *bool `json:"can_sync,omitempty"`

	// ComponentWhitelist Array of component/content type names: ["post","page","product"]
	ComponentWhitelist *[]string `json:"component_whitelist,omitempty"`

	// CustomizeToolbar Customize toolbar in richtext or markdown
	CustomizeToolbar *bool `json:"customize_toolbar,omitempty"`

	// DatasourceSlug Define selectable datasources string; Effects editor only if source=internal
	DatasourceSlug *string `json:"datasource_slug,omitempty"`

	// DefaultValue Default value for the field; Can be an escaped JSON object
	DefaultValue *string `json:"default_value,omitempty"`

	// Description Description shown in the editor interface
	Description *string `json:"description,omitempty"`

	// DisableTime Disables time selection from date picker; Default: false
	DisableTime *bool `json:"disable_time,omitempty"`

	// DisplayName Name of the field for the editor interface
	DisplayName *string `json:"display_name,omitempty"`

	// ExternalDatasource Define external datasource JSON Url; Effects editor only if source=external
	ExternalDatasource *string `json:"external_datasource,omitempty"`

	// FieldType Name of the custom field type plugin
	FieldType *string `json:"field_type,omitempty"`

	// Filetypes Array of file type names: ["images", "videos", "audios", "texts"]
	Filetypes *[]string `json:"filetypes,omitempty"`

	// FolderSlug Filter on selectable stories path; Effects editor only if source=internal_stories; In case you have a multi-language folder structure you can add the '{0}' placeholder and the path will be adapted dynamically. Examples: "{0}/categories/", {0}/{1}/categories/
	FolderSlug *string `json:"folder_slug,omitempty"`

	// ForceLinkScope Force link scope to be internal or external
	ForceLinkScope *bool `json:"force_link_scope,omitempty"`

	// ImageCrop Activate force crop for images: (true/false)
	ImageCrop *bool `json:"image_crop,omitempty"`

	// ImageHeight Define height in px or height ratio if keep_image_size is enabled
	ImageHeight *string `json:"image_height,omitempty"`

	// ImageWidth Define width in px or width ratio if keep_image_size is enabled
	ImageWidth *string `json:"image_width,omitempty"`

	// KeepImageSize Keep original size: (true/false)
	KeepImageSize *bool `json:"keep_image_size,omitempty"`

	// Keys Array of field keys to include in this section
	Keys *[]string `json:"keys,omitempty"`

	// LinkScope Filter on selectable stories path; In case you have a multi-language folder structure you can add the '{0}' placeholder and the path will be adapted dynamically. Examples: "{0}/categories/", {0}/{1}/categories/
	LinkScope *string `json:"link_scope,omitempty"`

	// MaxLength Set the max length of the input string
	MaxLength *int64 `json:"max_length,omitempty"`

	// Maximum Maximum amount of options or bloks in this field
	Maximum *int64 `json:"maximum,omitempty"`

	// Minimum Minimum amount of options or bloks in this field
	Minimum *int64 `json:"minimum,omitempty"`

	// NoTranslate Should be excluded in translation export
	NoTranslate *bool `json:"no_translate,omitempty"`

	// Options Array of datasource entries [{name:"", value:""}]; Effects editor only if source=undefined
	Options *[]FieldOption `json:"options,omitempty"`

	// Pos The position of the field
	Pos int64 `json:"pos"`

	// Regex Client Regex validation for the field
	Regex *string `json:"regex,omitempty"`

	// Required Is field required; Default: false
	Required *bool `json:"required,omitempty"`

	// RestrictComponents Activate restriction nestable component option; Default: false
	RestrictComponents *bool `json:"restrict_components,omitempty"`

	// RestrictContentTypes Activate restriction content type option
	RestrictContentTypes *bool `json:"restrict_content_types,omitempty"`

	// RichMarkdown Enable rich markdown view by default (true/false)
	RichMarkdown *bool `json:"rich_markdown,omitempty"`

	// Rtl Enable global RTL for this field
	Rtl *bool `json:"rtl,omitempty"`

	// Source Possible values: undefined: Self; internal_stories: Stories; internal: Datasource; external: API Endpoint in Datasource Entries Array Format
	Source *string `json:"source,omitempty"`

	// Toolbar Array of toolbar options
	Toolbar *[]string `json:"toolbar,omitempty"`

	// Tooltip Show the description as a tooltip
	Tooltip *bool `json:"tooltip,omitempty"`

	// Translatable Can field be translated; Default: false
	Translatable *bool `json:"translatable,omitempty"`

	// Type The type of the field
	Type string `json:"type"`

	// UseUuid Default: true; available in option and source=internal_stories
	UseUuid *bool `json:"use_uuid,omitempty"`
}

FieldInput defines model for FieldInput.

type FieldOption added in v0.1.0

type FieldOption struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

FieldOption defines model for FieldOption.

type GetAssetFolderResponse added in v0.1.0

type GetAssetFolderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// AssetFolder A asset folder can be used to group components together. Each component can have only one asset folder.
		AssetFolder *AssetFolder `json:"asset_folder,omitempty"`
	}
}

func ParseGetAssetFolderResponse added in v0.1.0

func ParseGetAssetFolderResponse(rsp *http.Response) (*GetAssetFolderResponse, error)

ParseGetAssetFolderResponse parses an HTTP response from a GetAssetFolderWithResponse call

func (GetAssetFolderResponse) Status added in v0.1.0

func (r GetAssetFolderResponse) Status() string

Status returns HTTPResponse.Status

func (GetAssetFolderResponse) StatusCode added in v0.1.0

func (r GetAssetFolderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetComponentGroupResponse added in v0.0.3

type GetComponentGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// ComponentGroup A component group can be used to group components together. Each component can have only one component group.
		ComponentGroup *ComponentGroup `json:"component_group,omitempty"`
	}
}

func ParseGetComponentGroupResponse added in v0.0.3

func ParseGetComponentGroupResponse(rsp *http.Response) (*GetComponentGroupResponse, error)

ParseGetComponentGroupResponse parses an HTTP response from a GetComponentGroupWithResponse call

func (GetComponentGroupResponse) Status added in v0.0.3

func (r GetComponentGroupResponse) Status() string

Status returns HTTPResponse.Status

func (GetComponentGroupResponse) StatusCode added in v0.0.3

func (r GetComponentGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetComponentResponse

type GetComponentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Component A component is a standalone entity that is meaningful in its own right. While components (or bloks) can be nested in each other, semantically they remain equal. Each component is a small piece of your data structure which can be filled with content or nested by your content editor. One component can consist of as many field types as required.
		Component *Component `json:"component,omitempty"`
	}
}

func ParseGetComponentResponse

func ParseGetComponentResponse(rsp *http.Response) (*GetComponentResponse, error)

ParseGetComponentResponse parses an HTTP response from a GetComponentWithResponse call

func (GetComponentResponse) Status

func (r GetComponentResponse) Status() string

Status returns HTTPResponse.Status

func (GetComponentResponse) StatusCode

func (r GetComponentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDatasourceEntryResponse added in v0.1.0

type GetDatasourceEntryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// DatasourceEntry The actual KEY/VALUE pair object a datasource consists of. One specific datasource entry is a set of two linked data items: a key, which is a unique identifier for the item of data scoped in the data source, and the value, which is the data that is identified.
		DatasourceEntry *DatasourceEntry `json:"datasource_entry,omitempty"`
	}
}

func ParseGetDatasourceEntryResponse added in v0.1.0

func ParseGetDatasourceEntryResponse(rsp *http.Response) (*GetDatasourceEntryResponse, error)

ParseGetDatasourceEntryResponse parses an HTTP response from a GetDatasourceEntryWithResponse call

func (GetDatasourceEntryResponse) Status added in v0.1.0

Status returns HTTPResponse.Status

func (GetDatasourceEntryResponse) StatusCode added in v0.1.0

func (r GetDatasourceEntryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDatasourceResponse added in v0.1.0

type GetDatasourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Datasource A datasource is a collection of datasource entries with a specific name and slug. Each datasource entry is a collection of key-value pairs (KVP), so called datasource entries. Those key-value pairs can be used for a single choice, multiple choice options and as well directly through our API to use them for multi-language labels, categories, or anything similar.
		Datasource *Datasource `json:"datasource,omitempty"`
	}
}

func ParseGetDatasourceResponse added in v0.1.0

func ParseGetDatasourceResponse(rsp *http.Response) (*GetDatasourceResponse, error)

ParseGetDatasourceResponse parses an HTTP response from a GetDatasourceWithResponse call

func (GetDatasourceResponse) Status added in v0.1.0

func (r GetDatasourceResponse) Status() string

Status returns HTTPResponse.Status

func (GetDatasourceResponse) StatusCode added in v0.1.0

func (r GetDatasourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMultipleSpaceRolesResponse added in v0.1.0

type GetMultipleSpaceRolesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]struct {
		SpaceRole *SpaceRole `json:"space_role,omitempty"`
	}
}

func ParseGetMultipleSpaceRolesResponse added in v0.1.0

func ParseGetMultipleSpaceRolesResponse(rsp *http.Response) (*GetMultipleSpaceRolesResponse, error)

ParseGetMultipleSpaceRolesResponse parses an HTTP response from a GetMultipleSpaceRolesWithResponse call

func (GetMultipleSpaceRolesResponse) Status added in v0.1.0

Status returns HTTPResponse.Status

func (GetMultipleSpaceRolesResponse) StatusCode added in v0.1.0

func (r GetMultipleSpaceRolesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSpaceResponse

type GetSpaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Space *Space `json:"space,omitempty"`
	}
}

func ParseGetSpaceResponse

func ParseGetSpaceResponse(rsp *http.Response) (*GetSpaceResponse, error)

ParseGetSpaceResponse parses an HTTP response from a GetSpaceWithResponse call

func (GetSpaceResponse) Status

func (r GetSpaceResponse) Status() string

Status returns HTTPResponse.Status

func (GetSpaceResponse) StatusCode

func (r GetSpaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSpaceRoleResponse added in v0.1.0

type GetSpaceRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		SpaceRole *SpaceRole `json:"space_role,omitempty"`
	}
}

func ParseGetSpaceRoleResponse added in v0.1.0

func ParseGetSpaceRoleResponse(rsp *http.Response) (*GetSpaceRoleResponse, error)

ParseGetSpaceRoleResponse parses an HTTP response from a GetSpaceRoleWithResponse call

func (GetSpaceRoleResponse) Status added in v0.1.0

func (r GetSpaceRoleResponse) Status() string

Status returns HTTPResponse.Status

func (GetSpaceRoleResponse) StatusCode added in v0.1.0

func (r GetSpaceRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSpacesSpaceIdWebhooksParams

type GetSpacesSpaceIdWebhooksParams struct {
	// Token The API access token
	Token string `form:"token" json:"token"`
}

GetSpacesSpaceIdWebhooksParams defines parameters for GetSpacesSpaceIdWebhooks.

type GetSpacesSpaceIdWebhooksResponse

type GetSpacesSpaceIdWebhooksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Total    *int       `json:"total,omitempty"`
		Webhooks *[]Webhook `json:"webhooks,omitempty"`
	}
}

func ParseGetSpacesSpaceIdWebhooksResponse

func ParseGetSpacesSpaceIdWebhooksResponse(rsp *http.Response) (*GetSpacesSpaceIdWebhooksResponse, error)

ParseGetSpacesSpaceIdWebhooksResponse parses an HTTP response from a GetSpacesSpaceIdWebhooksWithResponse call

func (GetSpacesSpaceIdWebhooksResponse) Status

Status returns HTTPResponse.Status

func (GetSpacesSpaceIdWebhooksResponse) StatusCode

func (r GetSpacesSpaceIdWebhooksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSpacesSpaceIdWebhooksWebhookIdParams

type GetSpacesSpaceIdWebhooksWebhookIdParams struct {
	// Token The API access token
	Token string `form:"token" json:"token"`
}

GetSpacesSpaceIdWebhooksWebhookIdParams defines parameters for GetSpacesSpaceIdWebhooksWebhookId.

type GetSpacesSpaceIdWebhooksWebhookIdResponse

type GetSpacesSpaceIdWebhooksWebhookIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Webhook
}

func ParseGetSpacesSpaceIdWebhooksWebhookIdResponse

func ParseGetSpacesSpaceIdWebhooksWebhookIdResponse(rsp *http.Response) (*GetSpacesSpaceIdWebhooksWebhookIdResponse, error)

ParseGetSpacesSpaceIdWebhooksWebhookIdResponse parses an HTTP response from a GetSpacesSpaceIdWebhooksWebhookIdWithResponse call

func (GetSpacesSpaceIdWebhooksWebhookIdResponse) Status

Status returns HTTPResponse.Status

func (GetSpacesSpaceIdWebhooksWebhookIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetStoryResponse added in v0.1.0

type GetStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Story This is an object representing your content entry. One Story object can be of a specific type, so called content types and is able to contain components. You define the fields and nestability of your content types to achieve your content structure. You can use this object to build up your entities when migrating or importing content. You can set alternate versions of a story with Management API using the group_id of the story.
		Story *Story `json:"story,omitempty"`
	}
}

func ParseGetStoryResponse added in v0.1.0

func ParseGetStoryResponse(rsp *http.Response) (*GetStoryResponse, error)

ParseGetStoryResponse parses an HTTP response from a GetStoryWithResponse call

func (GetStoryResponse) Status added in v0.1.0

func (r GetStoryResponse) Status() string

Status returns HTTPResponse.Status

func (GetStoryResponse) StatusCode added in v0.1.0

func (r GetStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IdParam added in v0.1.0

type IdParam = int64

IdParam defines model for idParam.

type ListAssetFoldersResponse added in v0.1.0

type ListAssetFoldersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		AssetFolders *[]AssetFolder `json:"asset_folders,omitempty"`
	}
}

func ParseListAssetFoldersResponse added in v0.1.0

func ParseListAssetFoldersResponse(rsp *http.Response) (*ListAssetFoldersResponse, error)

ParseListAssetFoldersResponse parses an HTTP response from a ListAssetFoldersWithResponse call

func (ListAssetFoldersResponse) Status added in v0.1.0

func (r ListAssetFoldersResponse) Status() string

Status returns HTTPResponse.Status

func (ListAssetFoldersResponse) StatusCode added in v0.1.0

func (r ListAssetFoldersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListComponentGroupsResponse added in v0.1.0

type ListComponentGroupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		ComponentGroups *[]ComponentGroup `json:"component_groups,omitempty"`
	}
}

func ParseListComponentGroupsResponse added in v0.1.0

func ParseListComponentGroupsResponse(rsp *http.Response) (*ListComponentGroupsResponse, error)

ParseListComponentGroupsResponse parses an HTTP response from a ListComponentGroupsWithResponse call

func (ListComponentGroupsResponse) Status added in v0.1.0

Status returns HTTPResponse.Status

func (ListComponentGroupsResponse) StatusCode added in v0.1.0

func (r ListComponentGroupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListComponentsResponse added in v0.1.0

type ListComponentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Components *[]Component `json:"components,omitempty"`
	}
}

func ParseListComponentsResponse added in v0.1.0

func ParseListComponentsResponse(rsp *http.Response) (*ListComponentsResponse, error)

ParseListComponentsResponse parses an HTTP response from a ListComponentsWithResponse call

func (ListComponentsResponse) Status added in v0.1.0

func (r ListComponentsResponse) Status() string

Status returns HTTPResponse.Status

func (ListComponentsResponse) StatusCode added in v0.1.0

func (r ListComponentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListDatasourceEntriesResponse added in v0.1.0

type ListDatasourceEntriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		DatasourceEntries *[]DatasourceEntry `json:"datasource_entries,omitempty"`
	}
}

func ParseListDatasourceEntriesResponse added in v0.1.0

func ParseListDatasourceEntriesResponse(rsp *http.Response) (*ListDatasourceEntriesResponse, error)

ParseListDatasourceEntriesResponse parses an HTTP response from a ListDatasourceEntriesWithResponse call

func (ListDatasourceEntriesResponse) Status added in v0.1.0

Status returns HTTPResponse.Status

func (ListDatasourceEntriesResponse) StatusCode added in v0.1.0

func (r ListDatasourceEntriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListDatasourcesResponse added in v0.1.0

type ListDatasourcesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Datasources *[]Datasource `json:"datasources,omitempty"`
	}
}

func ParseListDatasourcesResponse added in v0.1.0

func ParseListDatasourcesResponse(rsp *http.Response) (*ListDatasourcesResponse, error)

ParseListDatasourcesResponse parses an HTTP response from a ListDatasourcesWithResponse call

func (ListDatasourcesResponse) Status added in v0.1.0

func (r ListDatasourcesResponse) Status() string

Status returns HTTPResponse.Status

func (ListDatasourcesResponse) StatusCode added in v0.1.0

func (r ListDatasourcesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSpacesResponse added in v0.1.0

type ListSpacesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Spaces *[]Space `json:"spaces,omitempty"`
	}
}

func ParseListSpacesResponse added in v0.1.0

func ParseListSpacesResponse(rsp *http.Response) (*ListSpacesResponse, error)

ParseListSpacesResponse parses an HTTP response from a ListSpacesWithResponse call

func (ListSpacesResponse) Status added in v0.1.0

func (r ListSpacesResponse) Status() string

Status returns HTTPResponse.Status

func (ListSpacesResponse) StatusCode added in v0.1.0

func (r ListSpacesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListStoriesResponse added in v0.1.0

type ListStoriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Stories *[]Story `json:"stories,omitempty"`
	}
}

func ParseListStoriesResponse added in v0.1.0

func ParseListStoriesResponse(rsp *http.Response) (*ListStoriesResponse, error)

ParseListStoriesResponse parses an HTTP response from a ListStoriesWithResponse call

func (ListStoriesResponse) Status added in v0.1.0

func (r ListStoriesResponse) Status() string

Status returns HTTPResponse.Status

func (ListStoriesResponse) StatusCode added in v0.1.0

func (r ListStoriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PublishStoryResponse added in v0.1.0

type PublishStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Story This is an object representing your content entry. One Story object can be of a specific type, so called content types and is able to contain components. You define the fields and nestability of your content types to achieve your content structure. You can use this object to build up your entities when migrating or importing content. You can set alternate versions of a story with Management API using the group_id of the story.
		Story *Story `json:"story,omitempty"`
	}
}

func ParsePublishStoryResponse added in v0.1.0

func ParsePublishStoryResponse(rsp *http.Response) (*PublishStoryResponse, error)

ParsePublishStoryResponse parses an HTTP response from a PublishStoryWithResponse call

func (PublishStoryResponse) Status added in v0.1.0

func (r PublishStoryResponse) Status() string

Status returns HTTPResponse.Status

func (PublishStoryResponse) StatusCode added in v0.1.0

func (r PublishStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Space

type Space struct {
	// ApiLogsPerMonth An array of API logs per month
	ApiLogsPerMonth []interface{} `json:"api_logs_per_month"`

	// ApiRequests The total number of API requests allowed
	ApiRequests int `json:"api_requests"`

	// AssetsCount The count of assets in the space
	AssetsCount int `json:"assets_count"`

	// Collaborators An array of collaborators
	Collaborators []interface{} `json:"collaborators"`

	// CreatedAt The creation timestamp of the space
	CreatedAt time.Time `json:"created_at"`

	// Domain The domain of the space
	Domain string `json:"domain"`

	// Environments The environments of the space (null if not set)
	Environments *string `json:"environments,omitempty"`

	// Euid The EUID of the space (null if not set)
	Euid *string `json:"euid,omitempty"`

	// ExceededRequests The count of exceeded API requests
	ExceededRequests int `json:"exceeded_requests"`

	// FirstToken The first token of the space
	FirstToken string `json:"first_token"`

	// HasPendingTasks Indicates whether the space has pending tasks
	HasPendingTasks bool `json:"has_pending_tasks"`

	// HasSlackWebhook Indicates whether the space has a Slack webhook
	HasSlackWebhook bool `json:"has_slack_webhook"`

	// Limits The limits of the space
	Limits *map[string]interface{} `json:"limits,omitempty"`

	// Name The name of the space
	Name string `json:"name"`

	// Options The options of the space
	Options map[string]interface{} `json:"options"`

	// Owner The owner of the space
	Owner map[string]interface{} `json:"owner"`

	// Plan The plan of the space
	Plan string `json:"plan"`

	// PlanLevel The plan level of the space
	PlanLevel int `json:"plan_level"`

	// RequestCountToday The count of requests made today
	RequestCountToday int `json:"request_count_today"`

	// Role The role of the user in the space
	Role string `json:"role"`

	// SearchblokId The Searchblok ID of the space (null if not set)
	SearchblokId *string `json:"searchblok_id,omitempty"`

	// Settings An array of settings
	Settings []interface{} `json:"settings"`

	// StoriesCount The count of stories in the space
	StoriesCount int `json:"stories_count"`

	// StoryPublishedHook The story published hook of the space (null if not set)
	StoryPublishedHook *string `json:"story_published_hook,omitempty"`

	// Trial Indicates whether the space is in trial mode
	Trial bool `json:"trial"`

	// UpdatedAt The update timestamp of the space
	UpdatedAt time.Time `json:"updated_at"`
}

Space defines model for Space.

type SpaceBase added in v0.1.0

type SpaceBase struct {
	// Domain The domain of the space
	Domain *string `json:"domain,omitempty"`

	// Environments The environments of the space (null if not set)
	Environments *string `json:"environments,omitempty"`

	// Name The name of the space
	Name string `json:"name"`

	// SearchblokId The Searchblok ID of the space (null if not set)
	SearchblokId *string `json:"searchblok_id,omitempty"`

	// StoryPublishedHook The story published hook of the space (null if not set)
	StoryPublishedHook *string `json:"story_published_hook,omitempty"`
}

SpaceBase defines model for SpaceBase.

type SpaceCreateInput added in v0.1.0

type SpaceCreateInput struct {
	Space SpaceBase `json:"space"`
}

SpaceCreateInput defines model for SpaceCreateInput.

type SpaceDuplicateInput added in v0.1.0

type SpaceDuplicateInput struct {
	// DupId The numeric id of the original space
	DupId *int      `json:"dup_id,omitempty"`
	Space SpaceBase `json:"space"`
}

SpaceDuplicateInput defines model for SpaceDuplicateInput.

type SpaceIdParam

type SpaceIdParam = int64

SpaceIdParam defines model for spaceIdParam.

type SpaceRole added in v0.1.0

type SpaceRole struct {
	AllowedLanguages *[]string `json:"allowed_languages,omitempty"`
	AllowedPaths     *[]string `json:"allowed_paths,omitempty"`
	BranchIds        *[]int    `json:"branch_ids,omitempty"`
	ComponentIds     *[]int    `json:"component_ids,omitempty"`
	DatasourceIds    *[]int    `json:"datasource_ids,omitempty"`
	ExtId            *string   `json:"ext_id,omitempty"`
	FieldPermissions *[]string `json:"field_permissions,omitempty"`

	// Id Numeric Unique ID
	Id                       int       `json:"id"`
	Permissions              *[]string `json:"permissions,omitempty"`
	ReadonlyFieldPermissions *[]string `json:"readonly_field_permissions,omitempty"`
	ResolvedAllowedPaths     *[]string `json:"resolved_allowed_paths,omitempty"`
	Role                     string    `json:"role"`
	Subtitle                 *string   `json:"subtitle,omitempty"`
}

SpaceRole defines model for SpaceRole.

type SpaceRoleBase added in v0.1.0

type SpaceRoleBase struct {
	AllowedLanguages         *[]string `json:"allowed_languages,omitempty"`
	AllowedPaths             *[]string `json:"allowed_paths,omitempty"`
	BranchIds                *[]int    `json:"branch_ids,omitempty"`
	ComponentIds             *[]int    `json:"component_ids,omitempty"`
	DatasourceIds            *[]int    `json:"datasource_ids,omitempty"`
	ExtId                    *string   `json:"ext_id,omitempty"`
	FieldPermissions         *[]string `json:"field_permissions,omitempty"`
	Permissions              *[]string `json:"permissions,omitempty"`
	ReadonlyFieldPermissions *[]string `json:"readonly_field_permissions,omitempty"`
	ResolvedAllowedPaths     *[]string `json:"resolved_allowed_paths,omitempty"`
	Role                     string    `json:"role"`
	Subtitle                 *string   `json:"subtitle,omitempty"`
}

SpaceRoleBase defines model for SpaceRoleBase.

type SpaceRoleCreateInput added in v0.1.0

type SpaceRoleCreateInput struct {
	SpaceRole *SpaceRoleBase `json:"space_role,omitempty"`
}

SpaceRoleCreateInput defines model for SpaceRoleCreateInput.

type SpaceRoleIdParam added in v0.1.0

type SpaceRoleIdParam = int64

SpaceRoleIdParam defines model for spaceRoleIdParam.

type SpaceRoleUpdateInput added in v0.1.0

type SpaceRoleUpdateInput struct {
	SpaceRole *SpaceRoleBase `json:"space_role,omitempty"`
}

SpaceRoleUpdateInput defines model for SpaceRoleUpdateInput.

type SpaceUpdateInput added in v0.1.0

type SpaceUpdateInput struct {
	// BillingAddress The billing address of the space
	BillingAddress *map[string]interface{} `json:"billing_address,omitempty"`

	// DefaultRoot The default root of the space
	DefaultRoot *string `json:"default_root,omitempty"`

	// Duplicatable Indicates whether the space is duplicatable (null if not set)
	Duplicatable *string `json:"duplicatable,omitempty"`

	// Id The ID of the space
	Id *int64 `json:"id,omitempty"`

	// Options The options of the space
	Options *map[string]interface{} `json:"options,omitempty"`

	// OwnerId The ID of the owner of the space
	OwnerId *int `json:"owner_id,omitempty"`

	// ParentId The ID of the parent space (null if not set)
	ParentId *int `json:"parent_id,omitempty"`

	// Routes An array of routes
	Routes *[]interface{} `json:"routes,omitempty"`
	Space  SpaceBase      `json:"space"`

	// UniqDomain The unique domain of the space (null if not set)
	UniqDomain *string `json:"uniq_domain,omitempty"`
}

SpaceUpdateInput defines model for SpaceUpdateInput.

type Story added in v0.1.0

type Story struct {
	Alternates []map[string]interface{} `json:"alternates"`
	CanNotView bool                     `json:"can_not_view"`

	// Content The content of the story
	Content *map[string]interface{} `json:"content,omitempty"`

	// CreatedAt The creation timestamp of the story
	CreatedAt time.Time `json:"created_at"`

	// DefaultRoot Default content type/root component. (*Required if is_folder is true)
	DefaultRoot *bool `json:"default_root,omitempty"`

	// DeletedAt The deletion timestamp of the story
	DeletedAt *time.Time `json:"deleted_at,omitempty"`

	// DisableFeEditor Is side by side editor disabled for all entries in folder (true/false)
	DisableFeEditor *bool `json:"disable_fe_editor,omitempty"`

	// ExpireAt The expire timestamp of the story
	ExpireAt *time.Time `json:"expire_at,omitempty"`

	// FirstPublishedAt First publishing date (Format: YYYY-mm-dd HH:MM)
	FirstPublishedAt *string `json:"first_published_at,omitempty"`
	FullSlug         *string `json:"full_slug,omitempty"`

	// Id The ID of the story
	Id int64 `json:"id"`

	// IsFolder Flag indicating whether the story is a folder
	IsFolder    *bool `json:"is_folder,omitempty"`
	IsScheduled *bool `json:"is_scheduled,omitempty"`

	// IsStartpage Flag indicating whether the story is the start page
	IsStartpage *bool `json:"is_startpage,omitempty"`
	LastAuthor  struct {
		FriendlyName *string `json:"friendly_name,omitempty"`
		Id           *int    `json:"id,omitempty"`
		Userid       *string `json:"userid,omitempty"`
	} `json:"last_author"`
	LocalizedPaths []map[string]interface{} `json:"localized_paths"`
	MetaData       *map[string]interface{}  `json:"meta_data,omitempty"`

	// Name The name of the story
	Name   string                  `json:"name"`
	Parent *map[string]interface{} `json:"parent,omitempty"`

	// ParentId The ID of the parent story/folder
	ParentId *int `json:"parent_id,omitempty"`

	// ParentUuid The UUID of the story
	ParentUuid *string `json:"parent_uuid,omitempty"`

	// Path Given real path, used in the preview editor
	Path   *string `json:"path,omitempty"`
	Pinned bool    `json:"pinned"`

	// Position The position of the story/folder within its parent
	Position     int `json:"position"`
	PreviewToken struct {
		Timestamp *string `json:"timestamp,omitempty"`
		Token     *string `json:"token,omitempty"`
	} `json:"preview_token"`

	// PublishAt The publish timestamp of the story
	PublishAt *time.Time `json:"publish_at,omitempty"`

	// Slug The slug of the story
	Slug                      string                   `json:"slug"`
	SortByDate                *string                  `json:"sort_by_date,omitempty"`
	SpaceRoleIds              []int                    `json:"space_role_ids"`
	TagList                   *[]string                `json:"tag_list,omitempty"`
	TranslatedSlugs           []map[string]interface{} `json:"translated_slugs"`
	TranslatedSlugsAttributes *[]struct {
		Lang *string `json:"lang,omitempty"`
		Name *string `json:"name,omitempty"`
		Slug *string `json:"slug,omitempty"`
	} `json:"translated_slugs_attributes,omitempty"`
	TranslatedStories  []interface{} `json:"translated_stories"`
	UnpublishedChanges *bool         `json:"unpublished_changes,omitempty"`

	// UpdatedAt The update timestamp of the story
	UpdatedAt time.Time `json:"updated_at"`
	UserIds   []int     `json:"user_ids"`

	// Uuid The UUID of the story
	Uuid string `json:"uuid"`
}

Story defines model for Story.

type StoryBase added in v0.1.0

type StoryBase struct {
	// Content The content of the story
	Content *map[string]interface{} `json:"content,omitempty"`

	// DefaultRoot Default content type/root component. (*Required if is_folder is true)
	DefaultRoot *bool `json:"default_root,omitempty"`

	// DisableFeEditor Is side by side editor disabled for all entries in folder (true/false)
	DisableFeEditor *bool `json:"disable_fe_editor,omitempty"`

	// FirstPublishedAt First publishing date (Format: YYYY-mm-dd HH:MM)
	FirstPublishedAt *string `json:"first_published_at,omitempty"`

	// IsFolder Flag indicating whether the story is a folder
	IsFolder *bool `json:"is_folder,omitempty"`

	// IsStartpage Flag indicating whether the story is the start page
	IsStartpage *bool `json:"is_startpage,omitempty"`

	// Name The name of the story
	Name string `json:"name"`

	// ParentId The ID of the parent story/folder
	ParentId *int `json:"parent_id,omitempty"`

	// Path Given real path, used in the preview editor
	Path *string `json:"path,omitempty"`

	// Position The position of the story/folder within its parent
	Position *int `json:"position,omitempty"`

	// Slug The slug of the story
	Slug                      string `json:"slug"`
	TranslatedSlugsAttributes *[]struct {
		Lang *string `json:"lang,omitempty"`
		Name *string `json:"name,omitempty"`
		Slug *string `json:"slug,omitempty"`
	} `json:"translated_slugs_attributes,omitempty"`
}

StoryBase defines model for StoryBase.

type StoryCreateInput added in v0.1.0

type StoryCreateInput struct {
	// Publish If '1' it will publish the story, 'publish' must be omitted if publication is not desired
	Publish   *int64    `json:"publish,omitempty"`
	ReleaseId *int64    `json:"release_id,omitempty"`
	Story     StoryBase `json:"story"`
}

StoryCreateInput defines model for StoryCreateInput.

type StoryUpdateInput added in v0.1.0

type StoryUpdateInput struct {
	// ForceUpdate If '1' it will overwrite a locked story
	ForceUpdate *int    `json:"force_update,omitempty"`
	GroupId     *int    `json:"group_id,omitempty"`
	Lang        *string `json:"lang,omitempty"`

	// Publish If '1' it will publish the story, 'publish' must be omitted if publication is not desired
	Publish   *int64    `json:"publish,omitempty"`
	ReleaseId *int64    `json:"release_id,omitempty"`
	Story     StoryBase `json:"story"`
}

StoryUpdateInput defines model for StoryUpdateInput.

type UnpublishStoryResponse added in v0.1.0

type UnpublishStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Story This is an object representing your content entry. One Story object can be of a specific type, so called content types and is able to contain components. You define the fields and nestability of your content types to achieve your content structure. You can use this object to build up your entities when migrating or importing content. You can set alternate versions of a story with Management API using the group_id of the story.
		Story *Story `json:"story,omitempty"`
	}
}

func ParseUnpublishStoryResponse added in v0.1.0

func ParseUnpublishStoryResponse(rsp *http.Response) (*UnpublishStoryResponse, error)

ParseUnpublishStoryResponse parses an HTTP response from a UnpublishStoryWithResponse call

func (UnpublishStoryResponse) Status added in v0.1.0

func (r UnpublishStoryResponse) Status() string

Status returns HTTPResponse.Status

func (UnpublishStoryResponse) StatusCode added in v0.1.0

func (r UnpublishStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAssetFolderJSONRequestBody added in v0.1.0

type UpdateAssetFolderJSONRequestBody = AssetFolderUpdateInput

UpdateAssetFolderJSONRequestBody defines body for UpdateAssetFolder for application/json ContentType.

type UpdateAssetFolderResponse added in v0.1.0

type UpdateAssetFolderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// AssetFolder A asset folder can be used to group components together. Each component can have only one asset folder.
		AssetFolder *AssetFolder `json:"asset_folder,omitempty"`
	}
}

func ParseUpdateAssetFolderResponse added in v0.1.0

func ParseUpdateAssetFolderResponse(rsp *http.Response) (*UpdateAssetFolderResponse, error)

ParseUpdateAssetFolderResponse parses an HTTP response from a UpdateAssetFolderWithResponse call

func (UpdateAssetFolderResponse) Status added in v0.1.0

func (r UpdateAssetFolderResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateAssetFolderResponse) StatusCode added in v0.1.0

func (r UpdateAssetFolderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateComponentGroupJSONRequestBody added in v0.0.3

type UpdateComponentGroupJSONRequestBody = ComponentGroupUpdateInput

UpdateComponentGroupJSONRequestBody defines body for UpdateComponentGroup for application/json ContentType.

type UpdateComponentGroupResponse added in v0.0.3

type UpdateComponentGroupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// ComponentGroup A component group can be used to group components together. Each component can have only one component group.
		ComponentGroup *ComponentGroup `json:"component_group,omitempty"`
	}
}

func ParseUpdateComponentGroupResponse added in v0.0.3

func ParseUpdateComponentGroupResponse(rsp *http.Response) (*UpdateComponentGroupResponse, error)

ParseUpdateComponentGroupResponse parses an HTTP response from a UpdateComponentGroupWithResponse call

func (UpdateComponentGroupResponse) Status added in v0.0.3

Status returns HTTPResponse.Status

func (UpdateComponentGroupResponse) StatusCode added in v0.0.3

func (r UpdateComponentGroupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateComponentJSONRequestBody

type UpdateComponentJSONRequestBody = ComponentUpdateInput

UpdateComponentJSONRequestBody defines body for UpdateComponent for application/json ContentType.

type UpdateComponentResponse

type UpdateComponentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Component A component is a standalone entity that is meaningful in its own right. While components (or bloks) can be nested in each other, semantically they remain equal. Each component is a small piece of your data structure which can be filled with content or nested by your content editor. One component can consist of as many field types as required.
		Component *Component `json:"component,omitempty"`
	}
}

func ParseUpdateComponentResponse

func ParseUpdateComponentResponse(rsp *http.Response) (*UpdateComponentResponse, error)

ParseUpdateComponentResponse parses an HTTP response from a UpdateComponentWithResponse call

func (UpdateComponentResponse) Status

func (r UpdateComponentResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateComponentResponse) StatusCode

func (r UpdateComponentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDatasourceEntryJSONRequestBody added in v0.1.0

type UpdateDatasourceEntryJSONRequestBody = DatasourceEntryUpdateInput

UpdateDatasourceEntryJSONRequestBody defines body for UpdateDatasourceEntry for application/json ContentType.

type UpdateDatasourceEntryResponse added in v0.1.0

type UpdateDatasourceEntryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// DatasourceEntry The actual KEY/VALUE pair object a datasource consists of. One specific datasource entry is a set of two linked data items: a key, which is a unique identifier for the item of data scoped in the data source, and the value, which is the data that is identified.
		DatasourceEntry *DatasourceEntry `json:"datasource_entry,omitempty"`
	}
}

func ParseUpdateDatasourceEntryResponse added in v0.1.0

func ParseUpdateDatasourceEntryResponse(rsp *http.Response) (*UpdateDatasourceEntryResponse, error)

ParseUpdateDatasourceEntryResponse parses an HTTP response from a UpdateDatasourceEntryWithResponse call

func (UpdateDatasourceEntryResponse) Status added in v0.1.0

Status returns HTTPResponse.Status

func (UpdateDatasourceEntryResponse) StatusCode added in v0.1.0

func (r UpdateDatasourceEntryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDatasourceJSONBody added in v0.1.0

type UpdateDatasourceJSONBody struct {
	Datasource *DatasourceUpdateInput `json:"datasource,omitempty"`
}

UpdateDatasourceJSONBody defines parameters for UpdateDatasource.

type UpdateDatasourceJSONRequestBody added in v0.1.0

type UpdateDatasourceJSONRequestBody UpdateDatasourceJSONBody

UpdateDatasourceJSONRequestBody defines body for UpdateDatasource for application/json ContentType.

type UpdateDatasourceResponse added in v0.1.0

type UpdateDatasourceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Datasource A datasource is a collection of datasource entries with a specific name and slug. Each datasource entry is a collection of key-value pairs (KVP), so called datasource entries. Those key-value pairs can be used for a single choice, multiple choice options and as well directly through our API to use them for multi-language labels, categories, or anything similar.
		Datasource *Datasource `json:"datasource,omitempty"`
	}
}

func ParseUpdateDatasourceResponse added in v0.1.0

func ParseUpdateDatasourceResponse(rsp *http.Response) (*UpdateDatasourceResponse, error)

ParseUpdateDatasourceResponse parses an HTTP response from a UpdateDatasourceWithResponse call

func (UpdateDatasourceResponse) Status added in v0.1.0

func (r UpdateDatasourceResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateDatasourceResponse) StatusCode added in v0.1.0

func (r UpdateDatasourceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateSpaceJSONRequestBody added in v0.1.0

type UpdateSpaceJSONRequestBody = SpaceUpdateInput

UpdateSpaceJSONRequestBody defines body for UpdateSpace for application/json ContentType.

type UpdateSpaceResponse added in v0.1.0

type UpdateSpaceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Space *Space `json:"space,omitempty"`
	}
}

func ParseUpdateSpaceResponse added in v0.1.0

func ParseUpdateSpaceResponse(rsp *http.Response) (*UpdateSpaceResponse, error)

ParseUpdateSpaceResponse parses an HTTP response from a UpdateSpaceWithResponse call

func (UpdateSpaceResponse) Status added in v0.1.0

func (r UpdateSpaceResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateSpaceResponse) StatusCode added in v0.1.0

func (r UpdateSpaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateSpaceRoleJSONRequestBody added in v0.1.0

type UpdateSpaceRoleJSONRequestBody = SpaceRoleUpdateInput

UpdateSpaceRoleJSONRequestBody defines body for UpdateSpaceRole for application/json ContentType.

type UpdateSpaceRoleResponse added in v0.1.0

type UpdateSpaceRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		SpaceRole *SpaceRole `json:"space_role,omitempty"`
	}
}

func ParseUpdateSpaceRoleResponse added in v0.1.0

func ParseUpdateSpaceRoleResponse(rsp *http.Response) (*UpdateSpaceRoleResponse, error)

ParseUpdateSpaceRoleResponse parses an HTTP response from a UpdateSpaceRoleWithResponse call

func (UpdateSpaceRoleResponse) Status added in v0.1.0

func (r UpdateSpaceRoleResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateSpaceRoleResponse) StatusCode added in v0.1.0

func (r UpdateSpaceRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateStoryJSONRequestBody added in v0.1.0

type UpdateStoryJSONRequestBody = StoryUpdateInput

UpdateStoryJSONRequestBody defines body for UpdateStory for application/json ContentType.

type UpdateStoryResponse added in v0.1.0

type UpdateStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Story This is an object representing your content entry. One Story object can be of a specific type, so called content types and is able to contain components. You define the fields and nestability of your content types to achieve your content structure. You can use this object to build up your entities when migrating or importing content. You can set alternate versions of a story with Management API using the group_id of the story.
		Story *Story `json:"story,omitempty"`
	}
}

func ParseUpdateStoryResponse added in v0.1.0

func ParseUpdateStoryResponse(rsp *http.Response) (*UpdateStoryResponse, error)

ParseUpdateStoryResponse parses an HTTP response from a UpdateStoryWithResponse call

func (UpdateStoryResponse) Status added in v0.1.0

func (r UpdateStoryResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateStoryResponse) StatusCode added in v0.1.0

func (r UpdateStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Version added in v0.1.0

type Version struct {
	Author    *string    `json:"author,omitempty"`
	AuthorId  *int       `json:"author_id,omitempty"`
	CreatedAt *time.Time `json:"created_at,omitempty"`
	Event     *string    `json:"event,omitempty"`
	Id        *int       `json:"id,omitempty"`
	IsDraft   *bool      `json:"is_draft,omitempty"`
	ItemId    *int       `json:"item_id,omitempty"`
}

Version defines model for Version.

type VersionsStoryResponse added in v0.1.0

type VersionsStoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Versions *[]Version `json:"versions,omitempty"`
	}
}

func ParseVersionsStoryResponse added in v0.1.0

func ParseVersionsStoryResponse(rsp *http.Response) (*VersionsStoryResponse, error)

ParseVersionsStoryResponse parses an HTTP response from a VersionsStoryWithResponse call

func (VersionsStoryResponse) Status added in v0.1.0

func (r VersionsStoryResponse) Status() string

Status returns HTTPResponse.Status

func (VersionsStoryResponse) StatusCode added in v0.1.0

func (r VersionsStoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Webhook

type Webhook struct {
	CreatedAt *time.Time `json:"created_at,omitempty"`
	Events    *[]string  `json:"events,omitempty"`
	Id        *string    `json:"id,omitempty"`
	Name      *string    `json:"name,omitempty"`
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	Url       *string    `json:"url,omitempty"`
}

Webhook defines model for Webhook.

Jump to

Keyboard shortcuts

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