Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
See: G Suite Vault API Reference for vault.matters.holds.list
.
Synopsis
- type MattersHoldsListResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "view" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListHoldsResponse))))))))))))
- mattersHoldsList :: Text -> MattersHoldsList
- data MattersHoldsList
- mhlXgafv :: Lens' MattersHoldsList (Maybe Xgafv)
- mhlUploadProtocol :: Lens' MattersHoldsList (Maybe Text)
- mhlAccessToken :: Lens' MattersHoldsList (Maybe Text)
- mhlUploadType :: Lens' MattersHoldsList (Maybe Text)
- mhlMatterId :: Lens' MattersHoldsList Text
- mhlView :: Lens' MattersHoldsList (Maybe Text)
- mhlPageToken :: Lens' MattersHoldsList (Maybe Text)
- mhlPageSize :: Lens' MattersHoldsList (Maybe Int32)
- mhlCallback :: Lens' MattersHoldsList (Maybe Text)
REST Resource
type MattersHoldsListResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "view" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListHoldsResponse)))))))))))) Source #
A resource alias for vault.matters.holds.list
method which the
MattersHoldsList
request conforms to.
Creating a Request
Creates a value of MattersHoldsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data MattersHoldsList Source #
Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
See: mattersHoldsList
smart constructor.
Instances
Request Lenses
mhlUploadProtocol :: Lens' MattersHoldsList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
mhlAccessToken :: Lens' MattersHoldsList (Maybe Text) Source #
OAuth access token.
mhlUploadType :: Lens' MattersHoldsList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
mhlMatterId :: Lens' MattersHoldsList Text Source #
The matter ID.
mhlPageToken :: Lens' MattersHoldsList (Maybe Text) Source #
The pagination token as returned in the response. An empty token means start from the beginning.
mhlPageSize :: Lens' MattersHoldsList (Maybe Int32) Source #
The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.
mhlCallback :: Lens' MattersHoldsList (Maybe Text) Source #
JSONP