Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates the attributes of an existing template. The template attributes
that can be modified include name
, description
,
layoutConfiguration
, requiredFields
, and status
. At least one of
these attributes must not be null. If a null value is provided for a
given attribute, that attribute is ignored and its current value is
preserved.
Synopsis
- data UpdateTemplate = UpdateTemplate' {}
- newUpdateTemplate :: Text -> Text -> UpdateTemplate
- updateTemplate_description :: Lens' UpdateTemplate (Maybe Text)
- updateTemplate_layoutConfiguration :: Lens' UpdateTemplate (Maybe LayoutConfiguration)
- updateTemplate_name :: Lens' UpdateTemplate (Maybe Text)
- updateTemplate_requiredFields :: Lens' UpdateTemplate (Maybe [RequiredField])
- updateTemplate_status :: Lens' UpdateTemplate (Maybe TemplateStatus)
- updateTemplate_domainId :: Lens' UpdateTemplate Text
- updateTemplate_templateId :: Lens' UpdateTemplate Text
- data UpdateTemplateResponse = UpdateTemplateResponse' {
- httpStatus :: Int
- newUpdateTemplateResponse :: Int -> UpdateTemplateResponse
- updateTemplateResponse_httpStatus :: Lens' UpdateTemplateResponse Int
Creating a Request
data UpdateTemplate Source #
See: newUpdateTemplate
smart constructor.
UpdateTemplate' | |
|
Instances
Create a value of UpdateTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTemplate
, updateTemplate_description
- A brief description of the template.
$sel:layoutConfiguration:UpdateTemplate'
, updateTemplate_layoutConfiguration
- Configuration of layouts associated to the template.
UpdateTemplate
, updateTemplate_name
- The name of the template. It must be unique per domain.
$sel:requiredFields:UpdateTemplate'
, updateTemplate_requiredFields
- A list of fields that must contain a value for a case to be successfully
created with this template.
UpdateTemplate
, updateTemplate_status
- The status of the template.
UpdateTemplate
, updateTemplate_domainId
- The unique identifier of the Cases domain.
UpdateTemplate
, updateTemplate_templateId
- A unique identifier for the template.
Request Lenses
updateTemplate_description :: Lens' UpdateTemplate (Maybe Text) Source #
A brief description of the template.
updateTemplate_layoutConfiguration :: Lens' UpdateTemplate (Maybe LayoutConfiguration) Source #
Configuration of layouts associated to the template.
updateTemplate_name :: Lens' UpdateTemplate (Maybe Text) Source #
The name of the template. It must be unique per domain.
updateTemplate_requiredFields :: Lens' UpdateTemplate (Maybe [RequiredField]) Source #
A list of fields that must contain a value for a case to be successfully created with this template.
updateTemplate_status :: Lens' UpdateTemplate (Maybe TemplateStatus) Source #
The status of the template.
updateTemplate_domainId :: Lens' UpdateTemplate Text Source #
The unique identifier of the Cases domain.
updateTemplate_templateId :: Lens' UpdateTemplate Text Source #
A unique identifier for the template.
Destructuring the Response
data UpdateTemplateResponse Source #
See: newUpdateTemplateResponse
smart constructor.
UpdateTemplateResponse' | |
|
Instances
newUpdateTemplateResponse Source #
Create a value of UpdateTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateTemplateResponse'
, updateTemplateResponse_httpStatus
- The response's http status code.
Response Lenses
updateTemplateResponse_httpStatus :: Lens' UpdateTemplateResponse Int Source #
The response's http status code.