Safe Haskell	None
Language	Haskell2010

Neptune.Backend.Core

Contents

NeptuneBackendConfig
NeptuneBackendRequest
HasBodyParam
HasOptionalParam
- NeptuneBackendRequest Utils
- Params Utils
  - OpenAPI CollectionFormat Utils
AuthMethods
Utils
DateTime Formatting
Date Formatting
Byte/Binary Formatting
Lens Type Aliases

Description

Synopsis

data NeptuneBackendConfig = NeptuneBackendConfig {
- configHost :: ByteString
- configUserAgent :: Text
- configLogExecWithContext :: LogExecWithContext
- configLogContext :: LogContext
- configAuthMethods :: [AnyAuthMethod]
- configValidateAuthMethods :: Bool
}
newConfig :: IO NeptuneBackendConfig
addAuthMethod :: AuthMethod auth => NeptuneBackendConfig -> auth -> NeptuneBackendConfig
withStdoutLogging :: NeptuneBackendConfig -> IO NeptuneBackendConfig
withStderrLogging :: NeptuneBackendConfig -> IO NeptuneBackendConfig
withNoLogging :: NeptuneBackendConfig -> NeptuneBackendConfig
data NeptuneBackendRequest req contentType res accept = NeptuneBackendRequest {
- rMethod :: Method
- rUrlPath :: [ByteString]
- rParams :: Params
- rAuthTypes :: [TypeRep]
}
rMethodL :: Lens_' (NeptuneBackendRequest req contentType res accept) Method
rUrlPathL :: Lens_' (NeptuneBackendRequest req contentType res accept) [ByteString]
rParamsL :: Lens_' (NeptuneBackendRequest req contentType res accept) Params
rAuthTypesL :: Lens_' (NeptuneBackendRequest req contentType res accept) [TypeRep]
class HasBodyParam req param where
- setBodyParam :: forall contentType res accept. (Consumes req contentType, MimeRender contentType param) => NeptuneBackendRequest req contentType res accept -> param -> NeptuneBackendRequest req contentType res accept
class HasOptionalParam req param where
- applyOptionalParam :: NeptuneBackendRequest req contentType res accept -> param -> NeptuneBackendRequest req contentType res accept
- (-&-) :: NeptuneBackendRequest req contentType res accept -> param -> NeptuneBackendRequest req contentType res accept
data Params = Params {
- paramsQuery :: Query
- paramsHeaders :: RequestHeaders
- paramsBody :: ParamBody
}
paramsQueryL :: Lens_' Params Query
paramsHeadersL :: Lens_' Params RequestHeaders
paramsBodyL :: Lens_' Params ParamBody
data ParamBody
- = ParamBodyNone
- | ParamBodyB ByteString
- | ParamBodyBL ByteString
- | ParamBodyFormUrlEncoded Form
- | ParamBodyMultipartFormData [Part]
_mkRequest :: Method -> [ByteString] -> NeptuneBackendRequest req contentType res accept
_mkParams :: Params
setHeader :: NeptuneBackendRequest req contentType res accept -> [Header] -> NeptuneBackendRequest req contentType res accept
addHeader :: NeptuneBackendRequest req contentType res accept -> [Header] -> NeptuneBackendRequest req contentType res accept
removeHeader :: NeptuneBackendRequest req contentType res accept -> [HeaderName] -> NeptuneBackendRequest req contentType res accept
_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => NeptuneBackendRequest req contentType res accept -> NeptuneBackendRequest req contentType res accept
_setAcceptHeader :: forall req contentType res accept. MimeType accept => NeptuneBackendRequest req contentType res accept -> NeptuneBackendRequest req contentType res accept
setQuery :: NeptuneBackendRequest req contentType res accept -> [QueryItem] -> NeptuneBackendRequest req contentType res accept
addQuery :: NeptuneBackendRequest req contentType res accept -> [QueryItem] -> NeptuneBackendRequest req contentType res accept
addForm :: NeptuneBackendRequest req contentType res accept -> Form -> NeptuneBackendRequest req contentType res accept
_addMultiFormPart :: NeptuneBackendRequest req contentType res accept -> Part -> NeptuneBackendRequest req contentType res accept
_setBodyBS :: NeptuneBackendRequest req contentType res accept -> ByteString -> NeptuneBackendRequest req contentType res accept
_setBodyLBS :: NeptuneBackendRequest req contentType res accept -> ByteString -> NeptuneBackendRequest req contentType res accept
_hasAuthType :: AuthMethod authMethod => NeptuneBackendRequest req contentType res accept -> Proxy authMethod -> NeptuneBackendRequest req contentType res accept
toPath :: ToHttpApiData a => a -> ByteString
toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header]
toForm :: ToHttpApiData v => (ByteString, v) -> Form
toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem]
data CollectionFormat
- = CommaSeparated
- | SpaceSeparated
- | TabSeparated
- | PipeSeparated
- | MultiParamArray
toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header]
toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form
toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query
_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)]
_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)]
_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)]
class Typeable a => AuthMethod a where
- applyAuthMethod :: NeptuneBackendConfig -> a -> NeptuneBackendRequest req contentType res accept -> IO (NeptuneBackendRequest req contentType res accept)
data AnyAuthMethod = forall a.AuthMethod a => AnyAuthMethod a
data AuthMethodException = AuthMethodException String
_applyAuthMethods :: NeptuneBackendRequest req contentType res accept -> NeptuneBackendConfig -> IO (NeptuneBackendRequest req contentType res accept)
_omitNulls :: [(Text, Value)] -> Value
_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text])
_emptyToNothing :: Maybe String -> Maybe String
_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a
newtype DateTime = DateTime {
- unDateTime :: UTCTime
}
_readDateTime :: (MonadFail m, Alternative m) => String -> m DateTime
_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String
_parseISO8601 :: (ParseTime t, MonadFail m, Alternative m) => String -> m t
newtype Date = Date {
- unDate :: Day
}
_readDate :: MonadFail m => String -> m Date
_showDate :: FormatTime t => t -> String
newtype ByteArray = ByteArray {
- unByteArray :: ByteString
}
_readByteArray :: MonadFail m => Text -> m ByteArray
_showByteArray :: ByteArray -> Text
newtype Binary = Binary {
- unBinary :: ByteString
}
_readBinaryBase64 :: MonadFail m => Text -> m Binary
_showBinaryBase64 :: Binary -> Text
type Lens_' s a = Lens_ s s a a
type Lens_ s t a b = forall (f :: * -> *). Functor f => (a -> f b) -> s -> f t

NeptuneBackendConfig

data NeptuneBackendConfig Source #

Constructors

Fields

configHost :: ByteString
host supplied in the Request
configUserAgent :: Text
user-agent supplied in the Request
configLogExecWithContext :: LogExecWithContext
Run a block using a Logger instance
configLogContext :: LogContext
Configures the logger
configAuthMethods :: [AnyAuthMethod]
List of configured auth methods
configValidateAuthMethods :: Bool
throw exceptions if auth methods are not configured

Instances

Instances details

Show NeptuneBackendConfig Source #	display the config
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> NeptuneBackendConfig -> ShowS # show :: NeptuneBackendConfig -> String # showList :: [NeptuneBackendConfig] -> ShowS #

newConfig :: IO NeptuneBackendConfig Source #

constructs a default NeptuneBackendConfig

configHost:

http://localhost

configUserAgent:

"neptune-backend/0.1.0.0"

addAuthMethod :: AuthMethod auth => NeptuneBackendConfig -> auth -> NeptuneBackendConfig Source #

updates config use AuthMethod on matching requests

withStdoutLogging :: NeptuneBackendConfig -> IO NeptuneBackendConfig Source #

updates the config to use stdout logging

withStderrLogging :: NeptuneBackendConfig -> IO NeptuneBackendConfig Source #

updates the config to use stderr logging

withNoLogging :: NeptuneBackendConfig -> NeptuneBackendConfig Source #

updates the config to disable logging

NeptuneBackendRequest

data NeptuneBackendRequest req contentType res accept Source #

Represents a request.

Type Variables:

req - request operation
contentType - MimeType associated with request body
res - response model
accept - MimeType associated with response body

Constructors

NeptuneBackendRequest
Fields rMethod :: Method Method of NeptuneBackendRequest rUrlPath :: [ByteString] Endpoint of NeptuneBackendRequest rParams :: Params params of NeptuneBackendRequest rAuthTypes :: [TypeRep] types of auth methods

Instances

Instances details

Show (NeptuneBackendRequest req contentType res accept) Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> NeptuneBackendRequest req contentType res accept -> ShowS # show :: NeptuneBackendRequest req contentType res accept -> String # showList :: [NeptuneBackendRequest req contentType res accept] -> ShowS #

rMethodL :: Lens_' (NeptuneBackendRequest req contentType res accept) Method Source #

rMethod Lens

rUrlPathL :: Lens_' (NeptuneBackendRequest req contentType res accept) [ByteString] Source #

rUrlPath Lens

rParamsL :: Lens_' (NeptuneBackendRequest req contentType res accept) Params Source #

rParams Lens

rAuthTypesL :: Lens_' (NeptuneBackendRequest req contentType res accept) [TypeRep] Source #

rParams Lens

HasBodyParam

class HasBodyParam req param where Source #

Designates the body parameter of a request

Minimal complete definition

Nothing

Methods

setBodyParam :: forall contentType res accept. (Consumes req contentType, MimeRender contentType param) => NeptuneBackendRequest req contentType res accept -> param -> NeptuneBackendRequest req contentType res accept Source #

Instances

Instances details

HasBodyParam UpdateUserProfile UserProfileUpdateDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateUserProfile contentType, MimeRender contentType UserProfileUpdateDTO) => NeptuneBackendRequest UpdateUserProfile contentType res accept -> UserProfileUpdateDTO -> NeptuneBackendRequest UpdateUserProfile contentType res accept Source #
HasBodyParam UpdateTags UpdateTagsParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateTags contentType, MimeRender contentType UpdateTagsParams) => NeptuneBackendRequest UpdateTags contentType res accept -> UpdateTagsParams -> NeptuneBackendRequest UpdateTags contentType res accept Source #
HasBodyParam UpdateProjectMember ProjectMemberUpdateDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateProjectMember contentType, MimeRender contentType ProjectMemberUpdateDTO) => NeptuneBackendRequest UpdateProjectMember contentType res accept -> ProjectMemberUpdateDTO -> NeptuneBackendRequest UpdateProjectMember contentType res accept Source #
HasBodyParam UpdateProjectInvitation ProjectInvitationUpdateDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateProjectInvitation contentType, MimeRender contentType ProjectInvitationUpdateDTO) => NeptuneBackendRequest UpdateProjectInvitation contentType res accept -> ProjectInvitationUpdateDTO -> NeptuneBackendRequest UpdateProjectInvitation contentType res accept Source #
HasBodyParam UpdateProject ProjectUpdateDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateProject contentType, MimeRender contentType ProjectUpdateDTO) => NeptuneBackendRequest UpdateProject contentType res accept -> ProjectUpdateDTO -> NeptuneBackendRequest UpdateProject contentType res accept Source #
HasBodyParam UpdateOrganizationMember OrganizationMemberUpdateDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateOrganizationMember contentType, MimeRender contentType OrganizationMemberUpdateDTO) => NeptuneBackendRequest UpdateOrganizationMember contentType res accept -> OrganizationMemberUpdateDTO -> NeptuneBackendRequest UpdateOrganizationMember contentType res accept Source #
HasBodyParam UpdateOrganizationInvitation OrganizationInvitationUpdateDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateOrganizationInvitation contentType, MimeRender contentType OrganizationInvitationUpdateDTO) => NeptuneBackendRequest UpdateOrganizationInvitation contentType res accept -> OrganizationInvitationUpdateDTO -> NeptuneBackendRequest UpdateOrganizationInvitation contentType res accept Source #
HasBodyParam UpdateOrganization OrganizationUpdateDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateOrganization contentType, MimeRender contentType OrganizationUpdateDTO) => NeptuneBackendRequest UpdateOrganization contentType res accept -> OrganizationUpdateDTO -> NeptuneBackendRequest UpdateOrganization contentType res accept Source #
HasBodyParam UpdateExperiment EditExperimentParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateExperiment contentType, MimeRender contentType EditExperimentParams) => NeptuneBackendRequest UpdateExperiment contentType res accept -> EditExperimentParams -> NeptuneBackendRequest UpdateExperiment contentType res accept Source #
HasBodyParam UpdateChartSet ChartSetParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateChartSet contentType, MimeRender contentType ChartSetParams) => NeptuneBackendRequest UpdateChartSet contentType res accept -> ChartSetParams -> NeptuneBackendRequest UpdateChartSet contentType res accept Source #
HasBodyParam UpdateChart ChartDefinition Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes UpdateChart contentType, MimeRender contentType ChartDefinition) => NeptuneBackendRequest UpdateChart contentType res accept -> ChartDefinition -> NeptuneBackendRequest UpdateChart contentType res accept Source #
HasBodyParam TrashExperiments ExperimentIds Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes TrashExperiments contentType, MimeRender contentType ExperimentIds) => NeptuneBackendRequest TrashExperiments contentType res accept -> ExperimentIds -> NeptuneBackendRequest TrashExperiments contentType res accept Source #
HasBodyParam SendRegistrationSurvey RegistrationSurveyDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes SendRegistrationSurvey contentType, MimeRender contentType RegistrationSurveyDTO) => NeptuneBackendRequest SendRegistrationSurvey contentType res accept -> RegistrationSurveyDTO -> NeptuneBackendRequest SendRegistrationSurvey contentType res accept Source #
HasBodyParam SendQuestionnaire QuestionnaireDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes SendQuestionnaire contentType, MimeRender contentType QuestionnaireDTO) => NeptuneBackendRequest SendQuestionnaire contentType res accept -> QuestionnaireDTO -> NeptuneBackendRequest SendQuestionnaire contentType res accept Source #
HasBodyParam RestoreExperiments ExperimentIds Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes RestoreExperiments contentType, MimeRender contentType ExperimentIds) => NeptuneBackendRequest RestoreExperiments contentType res accept -> ExperimentIds -> NeptuneBackendRequest RestoreExperiments contentType res accept Source #
HasBodyParam PostSystemMetricValues MetricValues Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes PostSystemMetricValues contentType, MimeRender contentType MetricValues) => NeptuneBackendRequest PostSystemMetricValues contentType res accept -> MetricValues -> NeptuneBackendRequest PostSystemMetricValues contentType res accept Source #
HasBodyParam PostChannelValues ChannelsValues Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes PostChannelValues contentType, MimeRender contentType ChannelsValues) => NeptuneBackendRequest PostChannelValues contentType res accept -> ChannelsValues -> NeptuneBackendRequest PostChannelValues contentType res accept Source #
HasBodyParam MarkExperimentCompleted CompletedExperimentParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes MarkExperimentCompleted contentType, MimeRender contentType CompletedExperimentParams) => NeptuneBackendRequest MarkExperimentCompleted contentType res accept -> CompletedExperimentParams -> NeptuneBackendRequest MarkExperimentCompleted contentType res accept Source #
HasBodyParam EmptyExperimentsTrash ExperimentIds Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes EmptyExperimentsTrash contentType, MimeRender contentType ExperimentIds) => NeptuneBackendRequest EmptyExperimentsTrash contentType res accept -> ExperimentIds -> NeptuneBackendRequest EmptyExperimentsTrash contentType res accept Source #
HasBodyParam DeleteUserProfileLink LinkDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes DeleteUserProfileLink contentType, MimeRender contentType LinkDTO) => NeptuneBackendRequest DeleteUserProfileLink contentType res accept -> LinkDTO -> NeptuneBackendRequest DeleteUserProfileLink contentType res accept Source #
HasBodyParam CreateSystemMetric SystemMetricParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateSystemMetric contentType, MimeRender contentType SystemMetricParams) => NeptuneBackendRequest CreateSystemMetric contentType res accept -> SystemMetricParams -> NeptuneBackendRequest CreateSystemMetric contentType res accept Source #
HasBodyParam CreateSystemChannel ChannelParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateSystemChannel contentType, MimeRender contentType ChannelParams) => NeptuneBackendRequest CreateSystemChannel contentType res accept -> ChannelParams -> NeptuneBackendRequest CreateSystemChannel contentType res accept Source #
HasBodyParam CreateReservation NewReservationDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateReservation contentType, MimeRender contentType NewReservationDTO) => NeptuneBackendRequest CreateReservation contentType res accept -> NewReservationDTO -> NeptuneBackendRequest CreateReservation contentType res accept Source #
HasBodyParam CreateProjectInvitation NewProjectInvitationDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateProjectInvitation contentType, MimeRender contentType NewProjectInvitationDTO) => NeptuneBackendRequest CreateProjectInvitation contentType res accept -> NewProjectInvitationDTO -> NeptuneBackendRequest CreateProjectInvitation contentType res accept Source #
HasBodyParam CreateProject NewProjectDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateProject contentType, MimeRender contentType NewProjectDTO) => NeptuneBackendRequest CreateProject contentType res accept -> NewProjectDTO -> NeptuneBackendRequest CreateProject contentType res accept Source #
HasBodyParam CreateOrganizationInvitation NewOrganizationInvitationDTO Source #	Body Param "newOrganizationInvitation" - addToAllProjects flag is ignored when roleGrant value is admin
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateOrganizationInvitation contentType, MimeRender contentType NewOrganizationInvitationDTO) => NeptuneBackendRequest CreateOrganizationInvitation contentType res accept -> NewOrganizationInvitationDTO -> NeptuneBackendRequest CreateOrganizationInvitation contentType res accept Source #
HasBodyParam CreateOrganization OrganizationCreationParamsDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateOrganization contentType, MimeRender contentType OrganizationCreationParamsDTO) => NeptuneBackendRequest CreateOrganization contentType res accept -> OrganizationCreationParamsDTO -> NeptuneBackendRequest CreateOrganization contentType res accept Source #
HasBodyParam CreateExperiment ExperimentCreationParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateExperiment contentType, MimeRender contentType ExperimentCreationParams) => NeptuneBackendRequest CreateExperiment contentType res accept -> ExperimentCreationParams -> NeptuneBackendRequest CreateExperiment contentType res accept Source #
HasBodyParam CreateCheckoutSession CreateSessionParamsDTO Source #	Body Param "createSessionParams" - Stripe Checkout Session details
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateCheckoutSession contentType, MimeRender contentType CreateSessionParamsDTO) => NeptuneBackendRequest CreateCheckoutSession contentType res accept -> CreateSessionParamsDTO -> NeptuneBackendRequest CreateCheckoutSession contentType res accept Source #
HasBodyParam CreateChartSet ChartSetParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateChartSet contentType, MimeRender contentType ChartSetParams) => NeptuneBackendRequest CreateChartSet contentType res accept -> ChartSetParams -> NeptuneBackendRequest CreateChartSet contentType res accept Source #
HasBodyParam CreateChart ChartDefinition Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateChart contentType, MimeRender contentType ChartDefinition) => NeptuneBackendRequest CreateChart contentType res accept -> ChartDefinition -> NeptuneBackendRequest CreateChart contentType res accept Source #
HasBodyParam CreateChannel ChannelParams Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateChannel contentType, MimeRender contentType ChannelParams) => NeptuneBackendRequest CreateChannel contentType res accept -> ChannelParams -> NeptuneBackendRequest CreateChannel contentType res accept Source #
HasBodyParam CreateCardUpdateSession CreateSessionParamsDTO Source #	Body Param "createSessionParams" - Stripe Checkout Session details
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CreateCardUpdateSession contentType, MimeRender contentType CreateSessionParamsDTO) => NeptuneBackendRequest CreateCardUpdateSession contentType res accept -> CreateSessionParamsDTO -> NeptuneBackendRequest CreateCardUpdateSession contentType res accept Source #
HasBodyParam ChangePassword PasswordChangeDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes ChangePassword contentType, MimeRender contentType PasswordChangeDTO) => NeptuneBackendRequest ChangePassword contentType res accept -> PasswordChangeDTO -> NeptuneBackendRequest ChangePassword contentType res accept Source #
HasBodyParam CancelSubscription SubscriptionCancelInfoDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes CancelSubscription contentType, MimeRender contentType SubscriptionCancelInfoDTO) => NeptuneBackendRequest CancelSubscription contentType res accept -> SubscriptionCancelInfoDTO -> NeptuneBackendRequest CancelSubscription contentType res accept Source #
HasBodyParam AddUserProfileLink UserProfileLinkDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes AddUserProfileLink contentType, MimeRender contentType UserProfileLinkDTO) => NeptuneBackendRequest AddUserProfileLink contentType res accept -> UserProfileLinkDTO -> NeptuneBackendRequest AddUserProfileLink contentType res accept Source #
HasBodyParam AddProjectMember NewProjectMemberDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes AddProjectMember contentType, MimeRender contentType NewProjectMemberDTO) => NeptuneBackendRequest AddProjectMember contentType res accept -> NewProjectMemberDTO -> NeptuneBackendRequest AddProjectMember contentType res accept Source #
HasBodyParam AddOrganizationMember NewOrganizationMemberDTO Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes AddOrganizationMember contentType, MimeRender contentType NewOrganizationMemberDTO) => NeptuneBackendRequest AddOrganizationMember contentType res accept -> NewOrganizationMemberDTO -> NeptuneBackendRequest AddOrganizationMember contentType res accept Source #
HasBodyParam AbortExperiments ExperimentIds Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods setBodyParam :: (Consumes AbortExperiments contentType, MimeRender contentType ExperimentIds) => NeptuneBackendRequest AbortExperiments contentType res accept -> ExperimentIds -> NeptuneBackendRequest AbortExperiments contentType res accept Source #

HasOptionalParam

class HasOptionalParam req param where Source #

Designates the optional parameters of a request

Minimal complete definition

applyOptionalParam | (-&-)

Methods

applyOptionalParam :: NeptuneBackendRequest req contentType res accept -> param -> NeptuneBackendRequest req contentType res accept Source #

Apply an optional parameter to a request

(-&-) :: NeptuneBackendRequest req contentType res accept -> param -> NeptuneBackendRequest req contentType res accept infixl 2 Source #

infix operator / alias for addOptionalParam

Instances

Instances details

HasOptionalParam StorageUsage0 ProjectIdentifier Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest StorageUsage0 contentType res accept -> ProjectIdentifier -> NeptuneBackendRequest StorageUsage0 contentType res accept Source # (-&-) :: NeptuneBackendRequest StorageUsage0 contentType res accept -> ProjectIdentifier -> NeptuneBackendRequest StorageUsage0 contentType res accept Source #
HasOptionalParam StorageUsage0 OrganizationIdentifier Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest StorageUsage0 contentType res accept -> OrganizationIdentifier -> NeptuneBackendRequest StorageUsage0 contentType res accept Source # (-&-) :: NeptuneBackendRequest StorageUsage0 contentType res accept -> OrganizationIdentifier -> NeptuneBackendRequest StorageUsage0 contentType res accept Source #
HasOptionalParam ListProjectsMembers IncludeInvitations Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjectsMembers contentType res accept -> IncludeInvitations -> NeptuneBackendRequest ListProjectsMembers contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjectsMembers contentType res accept -> IncludeInvitations -> NeptuneBackendRequest ListProjectsMembers contentType res accept Source #
HasOptionalParam ListProjects Visibility Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> Visibility -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> Visibility -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects ViewedUsername Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> ViewedUsername -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> ViewedUsername -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects UserRelation Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> UserRelation -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> UserRelation -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects SortDirection Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> SortDirection -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> SortDirection -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects SortBy Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> SortBy -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> SortBy -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects SearchTerm Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> SearchTerm -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> SearchTerm -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects ProjectKey Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> ProjectKey -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> ProjectKey -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects OrganizationIdentifier Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> OrganizationIdentifier -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> OrganizationIdentifier -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects OrgRelation Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> OrgRelation -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> OrgRelation -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects Offset Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> Offset -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> Offset -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListProjects Limit Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListProjects contentType res accept -> Limit -> NeptuneBackendRequest ListProjects contentType res accept Source # (-&-) :: NeptuneBackendRequest ListProjects contentType res accept -> Limit -> NeptuneBackendRequest ListProjects contentType res accept Source #
HasOptionalParam ListMembers UsernamePrefix Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListMembers contentType res accept -> UsernamePrefix -> NeptuneBackendRequest ListMembers contentType res accept Source # (-&-) :: NeptuneBackendRequest ListMembers contentType res accept -> UsernamePrefix -> NeptuneBackendRequest ListMembers contentType res accept Source #
HasOptionalParam ListMembers ProjectIdentifier Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListMembers contentType res accept -> ProjectIdentifier -> NeptuneBackendRequest ListMembers contentType res accept Source # (-&-) :: NeptuneBackendRequest ListMembers contentType res accept -> ProjectIdentifier -> NeptuneBackendRequest ListMembers contentType res accept Source #
HasOptionalParam ListMembers OrganizationIdentifier Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListMembers contentType res accept -> OrganizationIdentifier -> NeptuneBackendRequest ListMembers contentType res accept Source # (-&-) :: NeptuneBackendRequest ListMembers contentType res accept -> OrganizationIdentifier -> NeptuneBackendRequest ListMembers contentType res accept Source #
HasOptionalParam ListMembers Offset Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListMembers contentType res accept -> Offset -> NeptuneBackendRequest ListMembers contentType res accept Source # (-&-) :: NeptuneBackendRequest ListMembers contentType res accept -> Offset -> NeptuneBackendRequest ListMembers contentType res accept Source #
HasOptionalParam ListMembers Limit Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest ListMembers contentType res accept -> Limit -> NeptuneBackendRequest ListMembers contentType res accept Source # (-&-) :: NeptuneBackendRequest ListMembers contentType res accept -> Limit -> NeptuneBackendRequest ListMembers contentType res accept Source #
HasOptionalParam GetSystemMetricsCSV Gzipped Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetSystemMetricsCSV contentType res accept -> Gzipped -> NeptuneBackendRequest GetSystemMetricsCSV contentType res accept Source # (-&-) :: NeptuneBackendRequest GetSystemMetricsCSV contentType res accept -> Gzipped -> NeptuneBackendRequest GetSystemMetricsCSV contentType res accept Source #
HasOptionalParam GetSystemMetricValues StartPoint Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetSystemMetricValues contentType res accept -> StartPoint -> NeptuneBackendRequest GetSystemMetricValues contentType res accept Source # (-&-) :: NeptuneBackendRequest GetSystemMetricValues contentType res accept -> StartPoint -> NeptuneBackendRequest GetSystemMetricValues contentType res accept Source #
HasOptionalParam GetSystemMetricValues ItemCount Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetSystemMetricValues contentType res accept -> ItemCount -> NeptuneBackendRequest GetSystemMetricValues contentType res accept Source # (-&-) :: NeptuneBackendRequest GetSystemMetricValues contentType res accept -> ItemCount -> NeptuneBackendRequest GetSystemMetricValues contentType res accept Source #
HasOptionalParam GetSystemMetricValues EndPoint Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetSystemMetricValues contentType res accept -> EndPoint -> NeptuneBackendRequest GetSystemMetricValues contentType res accept Source # (-&-) :: NeptuneBackendRequest GetSystemMetricValues contentType res accept -> EndPoint -> NeptuneBackendRequest GetSystemMetricValues contentType res accept Source #
HasOptionalParam GetChannelValuesCSV Gzipped Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetChannelValuesCSV contentType res accept -> Gzipped -> NeptuneBackendRequest GetChannelValuesCSV contentType res accept Source # (-&-) :: NeptuneBackendRequest GetChannelValuesCSV contentType res accept -> Gzipped -> NeptuneBackendRequest GetChannelValuesCSV contentType res accept Source #
HasOptionalParam GetChannelValuesCSV ExperimentId Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetChannelValuesCSV contentType res accept -> ExperimentId -> NeptuneBackendRequest GetChannelValuesCSV contentType res accept Source # (-&-) :: NeptuneBackendRequest GetChannelValuesCSV contentType res accept -> ExperimentId -> NeptuneBackendRequest GetChannelValuesCSV contentType res accept Source #
HasOptionalParam GetChannelValues Offset Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetChannelValues contentType res accept -> Offset -> NeptuneBackendRequest GetChannelValues contentType res accept Source # (-&-) :: NeptuneBackendRequest GetChannelValues contentType res accept -> Offset -> NeptuneBackendRequest GetChannelValues contentType res accept Source #
HasOptionalParam GetChannelValues Limit Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest GetChannelValues contentType res accept -> Limit -> NeptuneBackendRequest GetChannelValues contentType res accept Source # (-&-) :: NeptuneBackendRequest GetChannelValues contentType res accept -> Limit -> NeptuneBackendRequest GetChannelValues contentType res accept Source #
HasOptionalParam DeprecatedGetChannelValuesCSV Gzipped Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept -> Gzipped -> NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept Source # (-&-) :: NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept -> Gzipped -> NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept Source #
HasOptionalParam DeprecatedGetChannelValuesCSV ExperimentId Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept -> ExperimentId -> NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept Source # (-&-) :: NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept -> ExperimentId -> NeptuneBackendRequest DeprecatedGetChannelValuesCSV contentType res accept Source #
HasOptionalParam DeprecatedGetChannelValues Offset Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept -> Offset -> NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept Source # (-&-) :: NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept -> Offset -> NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept Source #
HasOptionalParam DeprecatedGetChannelValues Limit Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept -> Limit -> NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept Source # (-&-) :: NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept -> Limit -> NeptuneBackendRequest DeprecatedGetChannelValues contentType res accept Source #
HasOptionalParam CreateExperiment XNeptuneCliVersion Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest CreateExperiment contentType res accept -> XNeptuneCliVersion -> NeptuneBackendRequest CreateExperiment contentType res accept Source # (-&-) :: NeptuneBackendRequest CreateExperiment contentType res accept -> XNeptuneCliVersion -> NeptuneBackendRequest CreateExperiment contentType res accept Source #
HasOptionalParam AbortExperiments MarkOnly Source #
Instance details Defined in Neptune.Backend.API.ApiDefault Methods applyOptionalParam :: NeptuneBackendRequest AbortExperiments contentType res accept -> MarkOnly -> NeptuneBackendRequest AbortExperiments contentType res accept Source # (-&-) :: NeptuneBackendRequest AbortExperiments contentType res accept -> MarkOnly -> NeptuneBackendRequest AbortExperiments contentType res accept Source #

data Params Source #

Request Params

Constructors

Params
Fields paramsQuery :: Query paramsHeaders :: RequestHeaders paramsBody :: ParamBody

Instances

Instances details

Show Params Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> Params -> ShowS # show :: Params -> String # showList :: [Params] -> ShowS #

paramsQueryL :: Lens_' Params Query Source #

paramsQuery Lens

paramsHeadersL :: Lens_' Params RequestHeaders Source #

paramsHeaders Lens

paramsBodyL :: Lens_' Params ParamBody Source #

paramsBody Lens

data ParamBody Source #

Request Body

Constructors

ParamBodyNone
ParamBodyB ByteString
ParamBodyBL ByteString
ParamBodyFormUrlEncoded Form
ParamBodyMultipartFormData [Part]

Instances

Instances details

Show ParamBody Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> ParamBody -> ShowS # show :: ParamBody -> String # showList :: [ParamBody] -> ShowS #

NeptuneBackendRequest Utils

_mkRequest Source #

Arguments

:: Method	Method
-> [ByteString]	Endpoint
-> NeptuneBackendRequest req contentType res accept	req: Request Type, res: Response Type

_mkParams :: Params Source #

setHeader :: NeptuneBackendRequest req contentType res accept -> [Header] -> NeptuneBackendRequest req contentType res accept Source #

addHeader :: NeptuneBackendRequest req contentType res accept -> [Header] -> NeptuneBackendRequest req contentType res accept Source #

removeHeader :: NeptuneBackendRequest req contentType res accept -> [HeaderName] -> NeptuneBackendRequest req contentType res accept Source #

_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => NeptuneBackendRequest req contentType res accept -> NeptuneBackendRequest req contentType res accept Source #

_setAcceptHeader :: forall req contentType res accept. MimeType accept => NeptuneBackendRequest req contentType res accept -> NeptuneBackendRequest req contentType res accept Source #

setQuery :: NeptuneBackendRequest req contentType res accept -> [QueryItem] -> NeptuneBackendRequest req contentType res accept Source #

addQuery :: NeptuneBackendRequest req contentType res accept -> [QueryItem] -> NeptuneBackendRequest req contentType res accept Source #

addForm :: NeptuneBackendRequest req contentType res accept -> Form -> NeptuneBackendRequest req contentType res accept Source #

_addMultiFormPart :: NeptuneBackendRequest req contentType res accept -> Part -> NeptuneBackendRequest req contentType res accept Source #

_setBodyBS :: NeptuneBackendRequest req contentType res accept -> ByteString -> NeptuneBackendRequest req contentType res accept Source #

_setBodyLBS :: NeptuneBackendRequest req contentType res accept -> ByteString -> NeptuneBackendRequest req contentType res accept Source #

_hasAuthType :: AuthMethod authMethod => NeptuneBackendRequest req contentType res accept -> Proxy authMethod -> NeptuneBackendRequest req contentType res accept Source #

Params Utils

toPath :: ToHttpApiData a => a -> ByteString Source #

toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header] Source #

toForm :: ToHttpApiData v => (ByteString, v) -> Form Source #

toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem] Source #

OpenAPI `CollectionFormat` Utils

data CollectionFormat Source #

Determines the format of the array if type array is used.

Constructors

CommaSeparated	CSV format for multiple parameters.
SpaceSeparated	Also called SSV
TabSeparated	Also called TSV
PipeSeparated	`value1\|value2\|value2`
MultiParamArray	Using multiple GET parameters, e.g. `foo=bar&foo=baz`. This is valid only for parameters in "query" (`Query`) or "formData" (`Form`)

toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header] Source #

toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form Source #

toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query Source #

_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)] Source #

_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)] Source #

_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)] Source #

AuthMethods

class Typeable a => AuthMethod a where Source #

Provides a method to apply auth methods to requests

Methods

applyAuthMethod :: NeptuneBackendConfig -> a -> NeptuneBackendRequest req contentType res accept -> IO (NeptuneBackendRequest req contentType res accept) Source #

Instances

Instances details

AuthMethod AnyAuthMethod Source #
Instance details Defined in Neptune.Backend.Core Methods applyAuthMethod :: NeptuneBackendConfig -> AnyAuthMethod -> NeptuneBackendRequest req contentType res accept -> IO (NeptuneBackendRequest req contentType res accept) Source #
AuthMethod AuthOAuthOauth2 Source #
Instance details Defined in Neptune.Backend.Model Methods applyAuthMethod :: NeptuneBackendConfig -> AuthOAuthOauth2 -> NeptuneBackendRequest req contentType res accept -> IO (NeptuneBackendRequest req contentType res accept) Source #

data AnyAuthMethod Source #

An existential wrapper for any AuthMethod

Constructors

forall a.AuthMethod a => AnyAuthMethod a

Instances

Instances details

AuthMethod AnyAuthMethod Source #
Instance details Defined in Neptune.Backend.Core Methods applyAuthMethod :: NeptuneBackendConfig -> AnyAuthMethod -> NeptuneBackendRequest req contentType res accept -> IO (NeptuneBackendRequest req contentType res accept) Source #

data AuthMethodException Source #

indicates exceptions related to AuthMethods

Constructors

AuthMethodException String

Instances

Instances details

Show AuthMethodException Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> AuthMethodException -> ShowS # show :: AuthMethodException -> String # showList :: [AuthMethodException] -> ShowS #
Exception AuthMethodException Source #
Instance details Defined in Neptune.Backend.Core Methods toException :: AuthMethodException -> SomeException # fromException :: SomeException -> Maybe AuthMethodException # displayException :: AuthMethodException -> String #

_applyAuthMethods :: NeptuneBackendRequest req contentType res accept -> NeptuneBackendConfig -> IO (NeptuneBackendRequest req contentType res accept) Source #

apply all matching AuthMethods in config to request

Utils

_omitNulls :: [(Text, Value)] -> Value Source #

Removes Null fields. (OpenAPI-Specification 2.0 does not allow Null in JSON)

_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text]) Source #

Encodes fields using WH.toQueryParam

_emptyToNothing :: Maybe String -> Maybe String Source #

Collapse (Just "") to Nothing

_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a Source #

Collapse (Just mempty) to Nothing

DateTime Formatting

newtype DateTime Source #

Constructors

DateTime
Fields unDateTime :: UTCTime

Instances

Instances details

Eq DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods (==) :: DateTime -> DateTime -> Bool # (/=) :: DateTime -> DateTime -> Bool #
Data DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DateTime -> c DateTime # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DateTime # toConstr :: DateTime -> Constr # dataTypeOf :: DateTime -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DateTime) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DateTime) # gmapT :: (forall b. Data b => b -> b) -> DateTime -> DateTime # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r # gmapQ :: (forall d. Data d => d -> u) -> DateTime -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DateTime -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime #
Ord DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods compare :: DateTime -> DateTime -> Ordering # (<) :: DateTime -> DateTime -> Bool # (<=) :: DateTime -> DateTime -> Bool # (>) :: DateTime -> DateTime -> Bool # (>=) :: DateTime -> DateTime -> Bool # max :: DateTime -> DateTime -> DateTime # min :: DateTime -> DateTime -> DateTime #
Show DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> DateTime -> ShowS # show :: DateTime -> String # showList :: [DateTime] -> ShowS #
ToJSON DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods toJSON :: DateTime -> Value # toEncoding :: DateTime -> Encoding # toJSONList :: [DateTime] -> Value # toEncodingList :: [DateTime] -> Encoding #
FromJSON DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods parseJSON :: Value -> Parser DateTime # parseJSONList :: Value -> Parser [DateTime] #
NFData DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods rnf :: DateTime -> () #
ToHttpApiData DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods toUrlPiece :: DateTime -> Text # toEncodedUrlPiece :: DateTime -> Builder # toHeader :: DateTime -> ByteString # toQueryParam :: DateTime -> Text #
FromHttpApiData DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods parseUrlPiece :: Text -> Either Text DateTime # parseHeader :: ByteString -> Either Text DateTime # parseQueryParam :: Text -> Either Text DateTime #
MimeRender MimeMultipartFormData DateTime Source #
Instance details Defined in Neptune.Backend.Core Methods mimeRender :: Proxy MimeMultipartFormData -> DateTime -> ByteString Source # mimeRender' :: MimeMultipartFormData -> DateTime -> ByteString Source #

_readDateTime :: (MonadFail m, Alternative m) => String -> m DateTime Source #

_parseISO8601

_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String Source #

TI.formatISO8601Millis

_parseISO8601 :: (ParseTime t, MonadFail m, Alternative m) => String -> m t Source #

parse an ISO8601 date-time string

Date Formatting

newtype Date Source #

Constructors

Date
Fields unDate :: Day

Instances

Instances details

Enum Date Source #
Instance details Defined in Neptune.Backend.Core Methods succ :: Date -> Date # pred :: Date -> Date # toEnum :: Int -> Date # fromEnum :: Date -> Int # enumFrom :: Date -> [Date] # enumFromThen :: Date -> Date -> [Date] # enumFromTo :: Date -> Date -> [Date] # enumFromThenTo :: Date -> Date -> Date -> [Date] #
Eq Date Source #
Instance details Defined in Neptune.Backend.Core Methods (==) :: Date -> Date -> Bool # (/=) :: Date -> Date -> Bool #
Data Date Source #
Instance details Defined in Neptune.Backend.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date # toConstr :: Date -> Constr # dataTypeOf :: Date -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date) # gmapT :: (forall b. Data b => b -> b) -> Date -> Date # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQ :: (forall d. Data d => d -> u) -> Date -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date #
Ord Date Source #
Instance details Defined in Neptune.Backend.Core Methods compare :: Date -> Date -> Ordering # (<) :: Date -> Date -> Bool # (<=) :: Date -> Date -> Bool # (>) :: Date -> Date -> Bool # (>=) :: Date -> Date -> Bool # max :: Date -> Date -> Date # min :: Date -> Date -> Date #
Show Date Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #
Ix Date Source #
Instance details Defined in Neptune.Backend.Core Methods range :: (Date, Date) -> [Date] # index :: (Date, Date) -> Date -> Int # unsafeIndex :: (Date, Date) -> Date -> Int # inRange :: (Date, Date) -> Date -> Bool # rangeSize :: (Date, Date) -> Int # unsafeRangeSize :: (Date, Date) -> Int #
ToJSON Date Source #
Instance details Defined in Neptune.Backend.Core Methods toJSON :: Date -> Value # toEncoding :: Date -> Encoding # toJSONList :: [Date] -> Value # toEncodingList :: [Date] -> Encoding #
FromJSON Date Source #
Instance details Defined in Neptune.Backend.Core Methods parseJSON :: Value -> Parser Date # parseJSONList :: Value -> Parser [Date] #
NFData Date Source #
Instance details Defined in Neptune.Backend.Core Methods rnf :: Date -> () #
ToHttpApiData Date Source #
Instance details Defined in Neptune.Backend.Core Methods toUrlPiece :: Date -> Text # toEncodedUrlPiece :: Date -> Builder # toHeader :: Date -> ByteString # toQueryParam :: Date -> Text #
FromHttpApiData Date Source #
Instance details Defined in Neptune.Backend.Core Methods parseUrlPiece :: Text -> Either Text Date # parseHeader :: ByteString -> Either Text Date # parseQueryParam :: Text -> Either Text Date #
MimeRender MimeMultipartFormData Date Source #
Instance details Defined in Neptune.Backend.Core Methods mimeRender :: Proxy MimeMultipartFormData -> Date -> ByteString Source # mimeRender' :: MimeMultipartFormData -> Date -> ByteString Source #

_readDate :: MonadFail m => String -> m Date Source #

TI.parseTimeM True TI.defaultTimeLocale "%Y-%m-%d"

_showDate :: FormatTime t => t -> String Source #

TI.formatTime TI.defaultTimeLocale "%Y-%m-%d"

Byte/Binary Formatting

newtype ByteArray Source #

base64 encoded characters

Constructors

ByteArray
Fields unByteArray :: ByteString

Instances

Instances details

Eq ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods (==) :: ByteArray -> ByteArray -> Bool # (/=) :: ByteArray -> ByteArray -> Bool #
Data ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteArray -> c ByteArray # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteArray # toConstr :: ByteArray -> Constr # dataTypeOf :: ByteArray -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteArray) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteArray) # gmapT :: (forall b. Data b => b -> b) -> ByteArray -> ByteArray # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r # gmapQ :: (forall d. Data d => d -> u) -> ByteArray -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteArray -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray #
Ord ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods compare :: ByteArray -> ByteArray -> Ordering # (<) :: ByteArray -> ByteArray -> Bool # (<=) :: ByteArray -> ByteArray -> Bool # (>) :: ByteArray -> ByteArray -> Bool # (>=) :: ByteArray -> ByteArray -> Bool # max :: ByteArray -> ByteArray -> ByteArray # min :: ByteArray -> ByteArray -> ByteArray #
Show ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> ByteArray -> ShowS # show :: ByteArray -> String # showList :: [ByteArray] -> ShowS #
ToJSON ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods toJSON :: ByteArray -> Value # toEncoding :: ByteArray -> Encoding # toJSONList :: [ByteArray] -> Value # toEncodingList :: [ByteArray] -> Encoding #
FromJSON ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods parseJSON :: Value -> Parser ByteArray # parseJSONList :: Value -> Parser [ByteArray] #
NFData ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods rnf :: ByteArray -> () #
ToHttpApiData ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods toUrlPiece :: ByteArray -> Text # toEncodedUrlPiece :: ByteArray -> Builder # toHeader :: ByteArray -> ByteString # toQueryParam :: ByteArray -> Text #
FromHttpApiData ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods parseUrlPiece :: Text -> Either Text ByteArray # parseHeader :: ByteString -> Either Text ByteArray # parseQueryParam :: Text -> Either Text ByteArray #
MimeRender MimeMultipartFormData ByteArray Source #
Instance details Defined in Neptune.Backend.Core Methods mimeRender :: Proxy MimeMultipartFormData -> ByteArray -> ByteString Source # mimeRender' :: MimeMultipartFormData -> ByteArray -> ByteString Source #

_readByteArray :: MonadFail m => Text -> m ByteArray Source #

read base64 encoded characters

_showByteArray :: ByteArray -> Text Source #

show base64 encoded characters

newtype Binary Source #

any sequence of octets

Constructors

Binary
Fields unBinary :: ByteString

Instances

Instances details

Eq Binary Source #
Instance details Defined in Neptune.Backend.Core Methods (==) :: Binary -> Binary -> Bool # (/=) :: Binary -> Binary -> Bool #
Data Binary Source #
Instance details Defined in Neptune.Backend.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binary -> c Binary # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binary # toConstr :: Binary -> Constr # dataTypeOf :: Binary -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binary) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binary) # gmapT :: (forall b. Data b => b -> b) -> Binary -> Binary # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r # gmapQ :: (forall d. Data d => d -> u) -> Binary -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Binary -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binary -> m Binary # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary #
Ord Binary Source #
Instance details Defined in Neptune.Backend.Core Methods compare :: Binary -> Binary -> Ordering # (<) :: Binary -> Binary -> Bool # (<=) :: Binary -> Binary -> Bool # (>) :: Binary -> Binary -> Bool # (>=) :: Binary -> Binary -> Bool # max :: Binary -> Binary -> Binary # min :: Binary -> Binary -> Binary #
Show Binary Source #
Instance details Defined in Neptune.Backend.Core Methods showsPrec :: Int -> Binary -> ShowS # show :: Binary -> String # showList :: [Binary] -> ShowS #
ToJSON Binary Source #
Instance details Defined in Neptune.Backend.Core Methods toJSON :: Binary -> Value # toEncoding :: Binary -> Encoding # toJSONList :: [Binary] -> Value # toEncodingList :: [Binary] -> Encoding #
FromJSON Binary Source #
Instance details Defined in Neptune.Backend.Core Methods parseJSON :: Value -> Parser Binary # parseJSONList :: Value -> Parser [Binary] #
NFData Binary Source #
Instance details Defined in Neptune.Backend.Core Methods rnf :: Binary -> () #
ToHttpApiData Binary Source #
Instance details Defined in Neptune.Backend.Core Methods toUrlPiece :: Binary -> Text # toEncodedUrlPiece :: Binary -> Builder # toHeader :: Binary -> ByteString # toQueryParam :: Binary -> Text #
FromHttpApiData Binary Source #
Instance details Defined in Neptune.Backend.Core Methods parseUrlPiece :: Text -> Either Text Binary # parseHeader :: ByteString -> Either Text Binary # parseQueryParam :: Text -> Either Text Binary #
MimeRender MimeMultipartFormData Binary Source #
Instance details Defined in Neptune.Backend.Core Methods mimeRender :: Proxy MimeMultipartFormData -> Binary -> ByteString Source # mimeRender' :: MimeMultipartFormData -> Binary -> ByteString Source #

_readBinaryBase64 :: MonadFail m => Text -> m Binary Source #

_showBinaryBase64 :: Binary -> Text Source #

Lens Type Aliases

type Lens_' s a = Lens_ s s a a Source #

type Lens_ s t a b = forall (f :: * -> *). Functor f => (a -> f b) -> s -> f t Source #

NeptuneBackendConfig

Instances

NeptuneBackendRequest

Instances

HasBodyParam

Instances

HasOptionalParam

Instances

Instances

Instances

NeptuneBackendRequest Utils

Params Utils

OpenAPI CollectionFormat Utils

AuthMethods

Instances

Instances

Instances

Utils

DateTime Formatting

Instances

Date Formatting

Instances

Byte/Binary Formatting

Instances

Instances

Lens Type Aliases

OpenAPI `CollectionFormat` Utils