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 |
Returns the description for the list of fields in the request parameters.
Synopsis
- data BatchGetField = BatchGetField' {}
- newBatchGetField :: Text -> NonEmpty FieldIdentifier -> BatchGetField
- batchGetField_domainId :: Lens' BatchGetField Text
- batchGetField_fields :: Lens' BatchGetField (NonEmpty FieldIdentifier)
- data BatchGetFieldResponse = BatchGetFieldResponse' {
- httpStatus :: Int
- errors :: [FieldError]
- fields :: [GetFieldResponse]
- newBatchGetFieldResponse :: Int -> BatchGetFieldResponse
- batchGetFieldResponse_httpStatus :: Lens' BatchGetFieldResponse Int
- batchGetFieldResponse_errors :: Lens' BatchGetFieldResponse [FieldError]
- batchGetFieldResponse_fields :: Lens' BatchGetFieldResponse [GetFieldResponse]
Creating a Request
data BatchGetField Source #
See: newBatchGetField
smart constructor.
BatchGetField' | |
|
Instances
Create a value of BatchGetField
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:
BatchGetField
, batchGetField_domainId
- The unique identifier of the Cases domain.
BatchGetField
, batchGetField_fields
- A list of unique field identifiers.
Request Lenses
batchGetField_domainId :: Lens' BatchGetField Text Source #
The unique identifier of the Cases domain.
batchGetField_fields :: Lens' BatchGetField (NonEmpty FieldIdentifier) Source #
A list of unique field identifiers.
Destructuring the Response
data BatchGetFieldResponse Source #
See: newBatchGetFieldResponse
smart constructor.
BatchGetFieldResponse' | |
|
Instances
newBatchGetFieldResponse Source #
Create a value of BatchGetFieldResponse
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:BatchGetFieldResponse'
, batchGetFieldResponse_httpStatus
- The response's http status code.
$sel:errors:BatchGetFieldResponse'
, batchGetFieldResponse_errors
- A list of field errors.
BatchGetField
, batchGetFieldResponse_fields
- A list of detailed field information.
Response Lenses
batchGetFieldResponse_httpStatus :: Lens' BatchGetFieldResponse Int Source #
The response's http status code.
batchGetFieldResponse_errors :: Lens' BatchGetFieldResponse [FieldError] Source #
A list of field errors.
batchGetFieldResponse_fields :: Lens' BatchGetFieldResponse [GetFieldResponse] Source #
A list of detailed field information.