models

type AuthenticateUserRequest struct {

	// Password
	// Required: true
	Password *string `json:"Password"`

	// Username
	// Required: true
	Username *string `json:"Username"`
}

type AuthenticateUserResponse struct {

	// JWT token used to authenticate against the API
	Jwt string `json:"jwt,omitempty"`
}

type AzureCredentials struct {

	// Azure application ID
	ApplicationID string `json:"ApplicationID,omitempty"`

	// Azure authentication key
	AuthenticationKey string `json:"AuthenticationKey,omitempty"`

	// Azure tenant ID
	TenantID string `json:"TenantID,omitempty"`
}

type DockerHub struct {

	// Is authentication against DockerHub enabled
	Authentication bool `json:"Authentication,omitempty"`

	// Password used to authenticate against the DockerHub
	Password string `json:"Password,omitempty"`

	// Username used to authenticate against the DockerHub
	Username string `json:"Username,omitempty"`
}

type DockerHubSubset struct {

	// Is authentication against DockerHub enabled
	Authentication bool `json:"Authentication,omitempty"`

	// Username used to authenticate against the DockerHub
	Username string `json:"Username,omitempty"`
}

type DockerHubUpdateRequest struct {

	// Enable authentication against DockerHub
	// Required: true
	Authentication *bool `json:"Authentication"`

	// Password used to authenticate against the DockerHub
	// Required: true
	Password *string `json:"Password"`

	// Username used to authenticate against the DockerHub
	// Required: true
	Username *string `json:"Username"`
}

type Endpoint struct {

	// List of team identifiers authorized to connect to this endpoint
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to connect to this endpoint
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`

	// azure credentials
	AzureCredentials *AzureCredentials `json:"AzureCredentials,omitempty"`

	// Endpoint group identifier
	GroupID int64 `json:"GroupID,omitempty"`

	// Endpoint identifier
	ID int64 `json:"Id,omitempty"`

	// Endpoint name
	Name string `json:"Name,omitempty"`

	// URL or IP address where exposed containers will be reachable
	PublicURL string `json:"PublicURL,omitempty"`

	// TLS config
	TLSConfig *TLSConfiguration `json:"TLSConfig,omitempty"`

	// Endpoint environment type. 1 for a Docker environment, 2 for an agent on Docker environment or 3 for an Azure environment.
	Type int64 `json:"Type,omitempty"`

	// URL or IP address of the Docker host associated to this endpoint
	URL string `json:"URL,omitempty"`
}

type EndpointAccessUpdateRequest struct {

	// List of team identifiers authorized to connect to this endpoint
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to connect to this endpoint
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`
}

type EndpointGroup struct {

	// List of team identifiers authorized to connect to this endpoint. Will be inherited by endpoints that are part of the group
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to connect to this endpoint group. Will be inherited by endpoints that are part of the group
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`

	// Endpoint group description
	Description string `json:"Description,omitempty"`

	// Endpoint group identifier
	ID int64 `json:"Id,omitempty"`

	// labels
	Labels []*Pair `json:"Labels"`

	// Endpoint group name
	Name string `json:"Name,omitempty"`
}

type EndpointGroupAccessUpdateRequest struct {

	// List of team identifiers authorized to connect to this endpoint
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to connect to this endpoint
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`
}

type EndpointGroupCreateRequest struct {

	// List of endpoint identifiers that will be part of this group
	AssociatedEndpoints []int64 `json:"AssociatedEndpoints"`

	// Endpoint group description
	Description string `json:"Description,omitempty"`

	// labels
	Labels []*Pair `json:"Labels"`

	// Endpoint group name
	// Required: true
	Name *string `json:"Name"`
}

type EndpointGroupListResponse []*EndpointGroup

type EndpointGroupUpdateRequest struct {

	// List of endpoint identifiers that will be part of this group
	AssociatedEndpoints []int64 `json:"AssociatedEndpoints"`

	// Endpoint group description
	Description string `json:"Description,omitempty"`

	// labels
	Labels []*Pair `json:"Labels"`

	// Endpoint group name
	Name string `json:"Name,omitempty"`
}

type EndpointJobRequest struct {

	// Content of the job script
	// Required: true
	FileContent *string `json:"FileContent"`

	// Container image which will be used to execute the job
	// Required: true
	Image *string `json:"Image"`
}

type EndpointListResponse []*EndpointSubset

type EndpointSubset struct {

	// List of team identifiers authorized to connect to this endpoint
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to connect to this endpoint
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`

	// Endpoint group identifier
	GroupID int64 `json:"GroupID,omitempty"`

	// Endpoint identifier
	ID int64 `json:"Id,omitempty"`

	// Endpoint name
	Name string `json:"Name,omitempty"`

	// URL or IP address where exposed containers will be reachable
	PublicURL string `json:"PublicURL,omitempty"`

	// TLS config
	TLSConfig *TLSConfiguration `json:"TLSConfig,omitempty"`

	// Endpoint environment type. 1 for a Docker environment, 2 for an agent on Docker environment, 3 for an Azure environment.
	Type int64 `json:"Type,omitempty"`

	// URL or IP address of the Docker host associated to this endpoint
	URL string `json:"URL,omitempty"`
}

type EndpointUpdateRequest struct {

	// Azure application ID
	ApplicationID string `json:"ApplicationID,omitempty"`

	// Azure authentication key
	AuthenticationKey string `json:"AuthenticationKey,omitempty"`

	// Group identifier
	GroupID int64 `json:"GroupID,omitempty"`

	// Name that will be used to identify this endpoint
	Name string `json:"Name,omitempty"`

	// URL or IP address where exposed containers will be reachable. Defaults to URL if not specified
	PublicURL string `json:"PublicURL,omitempty"`

	// Require TLS to connect against this endpoint
	TLS bool `json:"TLS,omitempty"`

	// Skip client verification when using TLS
	TLSSkipClientVerify bool `json:"TLSSkipClientVerify,omitempty"`

	// Skip server verification when using TLS
	TLSSkipVerify bool `json:"TLSSkipVerify,omitempty"`

	// Azure tenant ID
	TenantID string `json:"TenantID,omitempty"`

	// URL or IP address of a Docker host
	URL string `json:"URL,omitempty"`
}

type GenericError struct {

	// Error message
	Err string `json:"err,omitempty"`
}

type LDAPGroupSearchSettings struct {

	// LDAP attribute which denotes the group membership.
	GroupAttribute string `json:"GroupAttribute,omitempty"`

	// The distinguished name of the element from which the LDAP server will search for groups.
	GroupBaseDN string `json:"GroupBaseDN,omitempty"`

	// The LDAP search filter used to select group elements, optional.
	GroupFilter string `json:"GroupFilter,omitempty"`
}

type LDAPSearchSettings struct {

	// The distinguished name of the element from which the LDAP server will search for users
	BaseDN string `json:"BaseDN,omitempty"`

	// Optional LDAP search filter used to select user elements
	Filter string `json:"Filter,omitempty"`

	// LDAP attribute which denotes the username
	UserNameAttribute string `json:"UserNameAttribute,omitempty"`
}

type LDAPSettings struct {

	// Automatically provision users and assign them to matching LDAP group names
	AutoCreateUsers bool `json:"AutoCreateUsers,omitempty"`

	// group search settings
	GroupSearchSettings []*LDAPGroupSearchSettings `json:"GroupSearchSettings"`

	// Password of the account that will be used to search users
	Password string `json:"Password,omitempty"`

	// Account that will be used to search for users
	ReaderDN string `json:"ReaderDN,omitempty"`

	// search settings
	SearchSettings []*LDAPSearchSettings `json:"SearchSettings"`

	// Whether LDAP connection should use StartTLS
	StartTLS bool `json:"StartTLS,omitempty"`

	// TLS config
	TLSConfig *TLSConfiguration `json:"TLSConfig,omitempty"`

	// URL or IP address of the LDAP server
	URL string `json:"URL,omitempty"`
}

type Pair struct {

	// name
	Name string `json:"name,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

type PublicSettingsInspectResponse struct {

	// Whether non-administrator should be able to use bind mounts when creating containers
	AllowBindMountsForRegularUsers bool `json:"AllowBindMountsForRegularUsers,omitempty"`

	// Whether non-administrator should be able to use privileged mode when creating containers
	AllowPrivilegedModeForRegularUsers bool `json:"AllowPrivilegedModeForRegularUsers,omitempty"`

	// Active authentication method for the Portainer instance. Valid values are: 1 for managed or 2 for LDAP.
	AuthenticationMethod int64 `json:"AuthenticationMethod,omitempty"`

	// Whether to display or not external templates contributions as sub-menus in the UI.
	DisplayExternalContributors bool `json:"DisplayExternalContributors,omitempty"`

	// URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string
	LogoURL string `json:"LogoURL,omitempty"`
}

type Registry struct {

	// Is authentication against this registry enabled
	Authentication bool `json:"Authentication,omitempty"`

	// List of team identifiers authorized to use this registry
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to use this registry
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`

	// Registry identifier
	ID int64 `json:"Id,omitempty"`

	// Registry name
	Name string `json:"Name,omitempty"`

	// Password used to authenticate against this registry
	Password string `json:"Password,omitempty"`

	// URL or IP address of the Docker registry
	URL string `json:"URL,omitempty"`

	// Username used to authenticate against this registry
	Username string `json:"Username,omitempty"`
}

type RegistryAccessUpdateRequest struct {

	// List of team identifiers authorized to use thi registry
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to use thi registry
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`
}

type RegistryCreateRequest struct {

	// Is authentication against this registry enabled
	// Required: true
	Authentication *bool `json:"Authentication"`

	// Name that will be used to identify this registry
	// Required: true
	Name *string `json:"Name"`

	// Password used to authenticate against this registry
	// Required: true
	Password *string `json:"Password"`

	// Registry Type. Valid values are: 1 (Quay.io), 2 (Azure container registry) or 3 (custom registry)
	// Required: true
	Type *int64 `json:"Type"`

	// URL or IP address of the Docker registry
	// Required: true
	URL *string `json:"URL"`

	// Username used to authenticate against this registry
	// Required: true
	Username *string `json:"Username"`
}

type RegistryListResponse []*RegistrySubset

type RegistrySubset struct {

	// Is authentication against this registry enabled
	Authentication bool `json:"Authentication,omitempty"`

	// List of team identifiers authorized to use this registry
	AuthorizedTeams []int64 `json:"AuthorizedTeams"`

	// List of user identifiers authorized to use this registry
	AuthorizedUsers []int64 `json:"AuthorizedUsers"`

	// Registry identifier
	ID int64 `json:"Id,omitempty"`

	// Registry name
	Name string `json:"Name,omitempty"`

	// URL or IP address of the Docker registry
	URL string `json:"URL,omitempty"`

	// Username used to authenticate against this registry
	Username string `json:"Username,omitempty"`
}

type RegistryUpdateRequest struct {

	// Is authentication against this registry enabled
	Authentication bool `json:"Authentication,omitempty"`

	// Name that will be used to identify this registry
	// Required: true
	Name *string `json:"Name"`

	// Password used to authenticate against this registry
	Password string `json:"Password,omitempty"`

	// URL or IP address of the Docker registry
	// Required: true
	URL *string `json:"URL"`

	// Username used to authenticate against this registry
	Username string `json:"Username,omitempty"`
}

type ResourceControl struct {

	// Permit access to the associated resource to any user
	Public bool `json:"Public,omitempty"`

	// Docker resource identifier on which access control will be applied. In the case of a resource control applied to a stack, use the stack name as identifier
	ResourceID string `json:"ResourceID,omitempty"`

	// List of Docker resources that will inherit this access control
	SubResourceIds []string `json:"SubResourceIDs"`

	// List of team identifiers with access to the associated resource
	Teams []int64 `json:"Teams"`

	// Type of Docker resource. Valid values are: container, volume service, secret, config or stack
	Type string `json:"Type,omitempty"`

	// List of user identifiers with access to the associated resource
	Users []int64 `json:"Users"`
}

type ResourceControlCreateRequest struct {

	// Permit access to the associated resource to any user
	Public bool `json:"Public,omitempty"`

	// Docker resource identifier on which access control will be applied. In the case of a resource control applied to a stack, use the stack name as identifier
	// Required: true
	ResourceID *string `json:"ResourceID"`

	// List of Docker resources that will inherit this access control
	SubResourceIds []string `json:"SubResourceIDs"`

	// List of team identifiers with access to the associated resource
	Teams []int64 `json:"Teams"`

	// Type of Docker resource. Valid values are: container, volume service, secret, config or stack
	// Required: true
	Type *string `json:"Type"`

	// List of user identifiers with access to the associated resource
	Users []int64 `json:"Users"`
}

type ResourceControlUpdateRequest struct {

	// Permit access to the associated resource to any user
	Public bool `json:"Public,omitempty"`

	// List of team identifiers with access to the associated resource
	Teams []int64 `json:"Teams"`

	// List of user identifiers with access to the associated resource
	Users []int64 `json:"Users"`
}

type Settings struct {

	// Whether non-administrator should be able to use bind mounts when creating containers
	AllowBindMountsForRegularUsers bool `json:"AllowBindMountsForRegularUsers,omitempty"`

	// Whether non-administrator should be able to use privileged mode when creating containers
	AllowPrivilegedModeForRegularUsers bool `json:"AllowPrivilegedModeForRegularUsers,omitempty"`

	// Active authentication method for the Portainer instance. Valid values are: 1 for managed or 2 for LDAP.
	AuthenticationMethod int64 `json:"AuthenticationMethod,omitempty"`

	// A list of label name & value that will be used to hide containers when querying containers
	BlackListedLabels []*SettingsBlackListedLabels `json:"BlackListedLabels"`

	// Whether to display or not external templates contributions as sub-menus in the UI.
	DisplayExternalContributors bool `json:"DisplayExternalContributors,omitempty"`

	// l d a p settings
	LDAPSettings *LDAPSettings `json:"LDAPSettings,omitempty"`

	// URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string
	LogoURL string `json:"LogoURL,omitempty"`

	// URL to the templates that will be displayed in the UI when navigating to App Templates
	TemplatesURL string `json:"TemplatesURL,omitempty"`
}

type SettingsBlackListedLabels struct {

	// name
	Name string `json:"name,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

type SettingsLDAPCheckRequest struct {

	// l d a p settings
	LDAPSettings *LDAPSettings `json:"LDAPSettings,omitempty"`
}

type SettingsUpdateRequest struct {

	// Whether non-administrator users should be able to use bind mounts when creating containers
	AllowBindMountsForRegularUsers bool `json:"AllowBindMountsForRegularUsers,omitempty"`

	// Whether non-administrator users should be able to use privileged mode when creating containers
	AllowPrivilegedModeForRegularUsers bool `json:"AllowPrivilegedModeForRegularUsers,omitempty"`

	// Active authentication method for the Portainer instance. Valid values are: 1 for managed or 2 for LDAP.
	// Required: true
	AuthenticationMethod *int64 `json:"AuthenticationMethod"`

	// A list of label name & value that will be used to hide containers when querying containers
	BlackListedLabels []*SettingsBlackListedLabels `json:"BlackListedLabels"`

	// Whether to display or not external templates contributions as sub-menus in the UI.
	DisplayExternalContributors bool `json:"DisplayExternalContributors,omitempty"`

	// l d a p settings
	LDAPSettings *LDAPSettings `json:"LDAPSettings,omitempty"`

	// URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string
	LogoURL string `json:"LogoURL,omitempty"`

	// URL to the templates that will be displayed in the UI when navigating to App Templates
	// Required: true
	TemplatesURL *string `json:"TemplatesURL"`
}

type Stack struct {

	// Endpoint identifier. Reference the endpoint that will be used for deployment
	EndpointID int64 `json:"EndpointID,omitempty"`

	// Path to the Stack file
	EntryPoint string `json:"EntryPoint,omitempty"`

	// A list of environment variables used during stack deployment
	Env []*StackEnv `json:"Env"`

	// Stack identifier
	ID int64 `json:"Id,omitempty"`

	// Stack name
	Name string `json:"Name,omitempty"`

	// Path on disk to the repository hosting the Stack file
	ProjectPath string `json:"ProjectPath,omitempty"`

	// Cluster identifier of the Swarm cluster where the stack is deployed
	SwarmID string `json:"SwarmID,omitempty"`

	// Stack type. 1 for a Swarm stack, 2 for a Compose stack
	Type int64 `json:"Type,omitempty"`
}

type StackCreateRequest struct {

	// Path to the Stack file inside the Git repository. Will default to 'docker-compose.yml' if not specified.
	ComposeFilePathInRepository string `json:"ComposeFilePathInRepository,omitempty"`

	// A list of environment variables used during stack deployment
	Env []*StackEnv `json:"Env"`

	// Name of the stack
	// Required: true
	Name *string `json:"Name"`

	// Use basic authentication to clone the Git repository.
	RepositoryAuthentication bool `json:"RepositoryAuthentication,omitempty"`

	// Password used in basic authentication. Required when RepositoryAuthentication is true.
	RepositoryPassword string `json:"RepositoryPassword,omitempty"`

	// Reference name of a Git repository hosting the Stack file. Used in 'repository' deployment method.
	RepositoryReferenceName string `json:"RepositoryReferenceName,omitempty"`

	// URL of a Git repository hosting the Stack file. Required when using the 'repository' deployment method.
	RepositoryURL string `json:"RepositoryURL,omitempty"`

	// Username used in basic authentication. Required when RepositoryAuthentication is true.
	RepositoryUsername string `json:"RepositoryUsername,omitempty"`

	// Content of the Stack file. Required when using the 'string' deployment method.
	StackFileContent string `json:"StackFileContent,omitempty"`

	// Swarm cluster identifier. Required when creating a Swarm stack (type 1).
	SwarmID string `json:"SwarmID,omitempty"`
}

type StackEnv struct {

	// name
	Name string `json:"name,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

type StackFileInspectResponse struct {

	// Content of the Stack file.
	StackFileContent string `json:"StackFileContent,omitempty"`
}

type StackListResponse []*Stack

type StackMigrateRequest struct {

	// Endpoint identifier of the target endpoint where the stack will be relocated
	// Required: true
	EndpointID *int64 `json:"EndpointID"`

	// If provided will rename the migrated stack
	Name string `json:"Name,omitempty"`

	// Swarm cluster identifier, must match the identifier of the cluster where the stack will be relocated
	SwarmID string `json:"SwarmID,omitempty"`
}

type StackUpdateRequest struct {

	// A list of environment variables used during stack deployment
	Env []*StackEnv `json:"Env"`

	// Prune services that are no longer referenced (only available for Swarm stacks)
	Prune bool `json:"Prune,omitempty"`

	// New content of the Stack file.
	StackFileContent string `json:"StackFileContent,omitempty"`
}

type Status struct {

	// Is analytics enabled
	Analytics bool `json:"Analytics,omitempty"`

	// Is authentication enabled
	Authentication bool `json:"Authentication,omitempty"`

	// Is endpoint management enabled
	EndpointManagement bool `json:"EndpointManagement,omitempty"`

	// Portainer API version
	Version string `json:"Version,omitempty"`
}

type TLSConfiguration struct {

	// Use TLS
	TLS bool `json:"TLS,omitempty"`

	// Path to the TLS CA certificate file
	TLSCACertPath string `json:"TLSCACertPath,omitempty"`

	// Path to the TLS client certificate file
	TLSCertPath string `json:"TLSCertPath,omitempty"`

	// Path to the TLS client key file
	TLSKeyPath string `json:"TLSKeyPath,omitempty"`

	// Skip the verification of the server TLS certificate
	TLSSkipVerify bool `json:"TLSSkipVerify,omitempty"`
}

type Tag struct {

	// Tag identifier
	ID int64 `json:"Id,omitempty"`

	// Tag name
	Name string `json:"Name,omitempty"`
}

type TagCreateRequest struct {

	// Name
	// Required: true
	Name *string `json:"Name"`
}

type TagListResponse []*Tag

type Team struct {

	// Team identifier
	ID int64 `json:"Id,omitempty"`

	// Team name
	Name string `json:"Name,omitempty"`
}

type TeamCreateRequest struct {

	// Name
	// Required: true
	Name *string `json:"Name"`
}

type TeamListResponse []*Team

type TeamMembership struct {

	// Membership identifier
	ID int64 `json:"Id,omitempty"`

	// Team role (1 for team leader and 2 for team member)
	Role int64 `json:"Role,omitempty"`

	// Team identifier
	TeamID int64 `json:"TeamID,omitempty"`

	// User identifier
	UserID int64 `json:"UserID,omitempty"`
}

type TeamMembershipCreateRequest struct {

	// Role for the user inside the team (1 for leader and 2 for regular member)
	// Required: true
	Role *int64 `json:"Role"`

	// Team identifier
	// Required: true
	TeamID *int64 `json:"TeamID"`

	// User identifier
	// Required: true
	UserID *int64 `json:"UserID"`
}

type TeamMembershipListResponse []*TeamMembership

type TeamMembershipUpdateRequest struct {

	// Role for the user inside the team (1 for leader and 2 for regular member)
	// Required: true
	Role *int64 `json:"Role"`

	// Team identifier
	// Required: true
	TeamID *int64 `json:"TeamID"`

	// User identifier
	// Required: true
	UserID *int64 `json:"UserID"`
}

type TeamMembershipsResponse []*TeamMembership

type TeamUpdateRequest struct {

	// Name
	// Required: true
	Name *string `json:"Name"`
}

type Template struct {

	// Whether the template should be available to administrators only
	AdministratorOnly bool `json:"administrator_only,omitempty"`

	// A list of categories associated to the template
	Categories []string `json:"categories"`

	// The command that will be executed in a container template
	Command string `json:"command,omitempty"`

	// Description of the template
	Description string `json:"description,omitempty"`

	// A list of environment variables used during the template deployment
	Env []*TemplateEnv `json:"env"`

	// Container hostname
	Hostname string `json:"hostname,omitempty"`

	// Template identifier
	ID int64 `json:"id,omitempty"`

	// Image associated to a container template. Mandatory for a container template
	Image string `json:"image,omitempty"`

	// Whether the container should be started in interactive mode (-i -t equivalent on the CLI)
	Interactive bool `json:"interactive,omitempty"`

	// Container labels
	Labels []*Pair `json:"labels"`

	// URL of the template's logo
	Logo string `json:"logo,omitempty"`

	// Default name for the stack/container to be used on deployment
	Name string `json:"name,omitempty"`

	// Name of a network that will be used on container deployment if it exists inside the environment
	Network string `json:"network,omitempty"`

	// A note that will be displayed in the UI. Supports HTML content
	Note string `json:"note,omitempty"`

	// Platform associated to the template. Valid values are: 'linux', 'windows' or leave empty for multi-platform
	Platform string `json:"platform,omitempty"`

	// A list of ports exposed by the container
	Ports []string `json:"ports"`

	// Whether the container should be started in privileged mode
	Privileged bool `json:"privileged,omitempty"`

	// The URL of a registry associated to the image for a container template
	Registry string `json:"registry,omitempty"`

	// repository
	Repository *TemplateRepository `json:"repository,omitempty"`

	// Container restart policy
	RestartPolicy string `json:"restart_policy,omitempty"`

	// Title of the template
	Title string `json:"title,omitempty"`

	// Template type. Valid values are: 1 (container), 2 (Swarm stack) or 3 (Compose stack)
	Type int64 `json:"type,omitempty"`

	// A list of volumes used during the container template deployment
	Volumes []*TemplateVolume `json:"volumes"`
}

type TemplateCreateRequest struct {

	// Whether the template should be available to administrators only
	AdministratorOnly bool `json:"administrator_only,omitempty"`

	// A list of categories associated to the template
	Categories []string `json:"categories"`

	// The command that will be executed in a container template
	Command string `json:"command,omitempty"`

	// Description of the template
	// Required: true
	Description *string `json:"description"`

	// A list of environment variables used during the template deployment
	Env []*TemplateEnv `json:"env"`

	// Container hostname
	Hostname string `json:"hostname,omitempty"`

	// Image associated to a container template. Mandatory for a container template
	Image string `json:"image,omitempty"`

	// Whether the container should be started in interactive mode (-i -t equivalent on the CLI)
	Interactive bool `json:"interactive,omitempty"`

	// Container labels
	Labels []*Pair `json:"labels"`

	// URL of the template's logo
	Logo string `json:"logo,omitempty"`

	// Default name for the stack/container to be used on deployment
	Name string `json:"name,omitempty"`

	// Name of a network that will be used on container deployment if it exists inside the environment
	Network string `json:"network,omitempty"`

	// A note that will be displayed in the UI. Supports HTML content
	Note string `json:"note,omitempty"`

	// Platform associated to the template. Valid values are: 'linux', 'windows' or leave empty for multi-platform
	Platform string `json:"platform,omitempty"`

	// A list of ports exposed by the container
	Ports []string `json:"ports"`

	// Whether the container should be started in privileged mode
	Privileged bool `json:"privileged,omitempty"`

	// The URL of a registry associated to the image for a container template
	Registry string `json:"registry,omitempty"`

	// repository
	Repository *TemplateRepository `json:"repository,omitempty"`

	// Container restart policy
	RestartPolicy string `json:"restart_policy,omitempty"`

	// Title of the template
	// Required: true
	Title *string `json:"title"`

	// Template type. Valid values are: 1 (container), 2 (Swarm stack) or 3 (Compose stack)
	// Required: true
	Type *int64 `json:"type"`

	// A list of volumes used during the container template deployment
	Volumes []*TemplateVolume `json:"volumes"`
}

type TemplateEnv struct {

	// Default value that will be set for the variable
	Default string `json:"default,omitempty"`

	// Content of the tooltip that will be generated in the UI
	Description string `json:"description,omitempty"`

	// Text for the label that will be generated in the UI
	Label string `json:"label,omitempty"`

	// name of the environment variable
	Name string `json:"name,omitempty"`

	// If set to true, will not generate any input for this variable in the UI
	Preset bool `json:"preset,omitempty"`

	// A list of name/value that will be used to generate a dropdown in the UI
	Select []*TemplateEnvSelect `json:"select"`
}

type TemplateEnvSelect struct {

	// Will set this choice as the default choice
	Default bool `json:"default,omitempty"`

	// Some text that will displayed as a choice
	Text string `json:"text,omitempty"`

	// A value that will be associated to the choice
	Value string `json:"value,omitempty"`
}

type TemplateListResponse []*Template

type TemplateRepository struct {

	// URL of a git repository used to deploy a stack template. Mandatory for a Swarm/Compose stack template
	// Required: true
	URL *string `json:"URL"`

	// Path to the stack file inside the git repository
	Stackfile string `json:"stackfile,omitempty"`
}

type TemplateUpdateRequest struct {

	// Whether the template should be available to administrators only
	AdministratorOnly bool `json:"administrator_only,omitempty"`

	// A list of categories associated to the template
	Categories []string `json:"categories"`

	// The command that will be executed in a container template
	Command string `json:"command,omitempty"`

	// Description of the template
	Description string `json:"description,omitempty"`

	// A list of environment variables used during the template deployment
	Env []*TemplateEnv `json:"env"`

	// Container hostname
	Hostname string `json:"hostname,omitempty"`

	// Image associated to a container template. Mandatory for a container template
	Image string `json:"image,omitempty"`

	// Whether the container should be started in interactive mode (-i -t equivalent on the CLI)
	Interactive bool `json:"interactive,omitempty"`

	// Container labels
	Labels []*Pair `json:"labels"`

	// URL of the template's logo
	Logo string `json:"logo,omitempty"`

	// Default name for the stack/container to be used on deployment
	Name string `json:"name,omitempty"`

	// Name of a network that will be used on container deployment if it exists inside the environment
	Network string `json:"network,omitempty"`

	// A note that will be displayed in the UI. Supports HTML content
	Note string `json:"note,omitempty"`

	// Platform associated to the template. Valid values are: 'linux', 'windows' or leave empty for multi-platform
	Platform string `json:"platform,omitempty"`

	// A list of ports exposed by the container
	Ports []string `json:"ports"`

	// Whether the container should be started in privileged mode
	Privileged bool `json:"privileged,omitempty"`

	// The URL of a registry associated to the image for a container template
	Registry string `json:"registry,omitempty"`

	// repository
	Repository *TemplateRepository `json:"repository,omitempty"`

	// Container restart policy
	RestartPolicy string `json:"restart_policy,omitempty"`

	// Title of the template
	Title string `json:"title,omitempty"`

	// Template type. Valid values are: 1 (container), 2 (Swarm stack) or 3 (Compose stack)
	Type int64 `json:"type,omitempty"`

	// A list of volumes used during the container template deployment
	Volumes []*TemplateVolume `json:"volumes"`
}

type TemplateVolume struct {

	// Path on the host
	Bind string `json:"bind,omitempty"`

	// Path inside the container
	Container string `json:"container,omitempty"`

	// Whether the volume used should be readonly
	Readonly bool `json:"readonly,omitempty"`
}

type User struct {

	// User identifier
	ID int64 `json:"Id,omitempty"`

	// Password
	Password string `json:"Password,omitempty"`

	// User role (1 for administrator account and 2 for regular account)
	Role int64 `json:"Role,omitempty"`

	// Username
	Username string `json:"Username,omitempty"`
}

type UserAdminInitRequest struct {

	// Password for the admin user
	Password string `json:"Password,omitempty"`

	// Username for the admin user
	Username string `json:"Username,omitempty"`
}

type UserCreateRequest struct {

	// Password
	// Required: true
	Password *string `json:"Password"`

	// User role (1 for administrator account and 2 for regular account)
	// Required: true
	Role *int64 `json:"Role"`

	// Username
	// Required: true
	Username *string `json:"Username"`
}

type UserListResponse []*UserSubset

type UserMembershipsResponse []*TeamMembership

type UserPasswordCheckRequest struct {

	// Password
	// Required: true
	Password *string `json:"Password"`
}

type UserPasswordCheckResponse struct {

	// Is the password valid
	Valid bool `json:"valid,omitempty"`
}

type UserSubset struct {

	// User identifier
	ID int64 `json:"Id,omitempty"`

	// User role (1 for administrator account and 2 for regular account)
	Role int64 `json:"Role,omitempty"`

	// Username
	Username string `json:"Username,omitempty"`
}

type UserUpdateRequest struct {

	// Password
	Password string `json:"Password,omitempty"`

	// User role (1 for administrator account and 2 for regular account)
	Role int64 `json:"Role,omitempty"`
}