StripeAPI.Operations.GetSigmaScheduledQueryRuns

Contains the different functions to run the operation getSigmaScheduledQueryRuns

Documentation

getSigmaScheduledQueryRuns

Arguments

:: forall m. MonadHTTP m

=> GetSigmaScheduledQueryRunsParameters

Contains all available parameters of this operation (query and path parameters)

-> StripeT m (Response GetSigmaScheduledQueryRunsResponse)

Monadic computation which returns the result of the operation

GET /v1/sigma/scheduled_query_runs

<p>Returns a list of scheduled query runs.</p>

data GetSigmaScheduledQueryRunsParameters

Defines the object schema located at paths./v1/sigma/scheduled_query_runs.GET.parameters in the specification.

Constructors

GetSigmaScheduledQueryRunsParameters

Fields

• getSigmaScheduledQueryRunsParametersQueryEndingBefore :: Maybe Text

  queryEnding_before: Represents the parameter named 'ending_before'

  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.

  Constraints:

  • Maximum length of 5000
• getSigmaScheduledQueryRunsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getSigmaScheduledQueryRunsParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

• getSigmaScheduledQueryRunsParametersQueryStartingAfter :: Maybe Text

  queryStarting_after: Represents the parameter named 'starting_after'

  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetSigmaScheduledQueryRunsParameters

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

(==) :: GetSigmaScheduledQueryRunsParameters -> GetSigmaScheduledQueryRunsParameters -> Bool

(/=) :: GetSigmaScheduledQueryRunsParameters -> GetSigmaScheduledQueryRunsParameters -> Bool

Show GetSigmaScheduledQueryRunsParameters

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

showsPrec :: Int -> GetSigmaScheduledQueryRunsParameters -> ShowS

show :: GetSigmaScheduledQueryRunsParameters -> String

showList :: [GetSigmaScheduledQueryRunsParameters] -> ShowS

ToJSON GetSigmaScheduledQueryRunsParameters

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

toJSON :: GetSigmaScheduledQueryRunsParameters -> Value

toEncoding :: GetSigmaScheduledQueryRunsParameters -> Encoding

toJSONList :: [GetSigmaScheduledQueryRunsParameters] -> Value

toEncodingList :: [GetSigmaScheduledQueryRunsParameters] -> Encoding

FromJSON GetSigmaScheduledQueryRunsParameters

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

parseJSON :: Value -> Parser GetSigmaScheduledQueryRunsParameters

parseJSONList :: Value -> Parser [GetSigmaScheduledQueryRunsParameters]

mkGetSigmaScheduledQueryRunsParameters :: GetSigmaScheduledQueryRunsParameters

Create a new GetSigmaScheduledQueryRunsParameters with all required fields.

data GetSigmaScheduledQueryRunsResponse

Represents a response of the operation getSigmaScheduledQueryRuns.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetSigmaScheduledQueryRunsResponseError is used.

Constructors

GetSigmaScheduledQueryRunsResponseError String

Means either no matching case available or a parse error

GetSigmaScheduledQueryRunsResponse200 GetSigmaScheduledQueryRunsResponseBody200

Successful response.

GetSigmaScheduledQueryRunsResponseDefault Error

Error response.

Instances

Eq GetSigmaScheduledQueryRunsResponse

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

(==) :: GetSigmaScheduledQueryRunsResponse -> GetSigmaScheduledQueryRunsResponse -> Bool

(/=) :: GetSigmaScheduledQueryRunsResponse -> GetSigmaScheduledQueryRunsResponse -> Bool

Show GetSigmaScheduledQueryRunsResponse

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

showsPrec :: Int -> GetSigmaScheduledQueryRunsResponse -> ShowS

show :: GetSigmaScheduledQueryRunsResponse -> String

showList :: [GetSigmaScheduledQueryRunsResponse] -> ShowS

data GetSigmaScheduledQueryRunsResponseBody200

Defines the object schema located at paths./v1/sigma/scheduled_query_runs.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetSigmaScheduledQueryRunsResponseBody200

Fields

• getSigmaScheduledQueryRunsResponseBody200Data :: [ScheduledQueryRun]

  data

• getSigmaScheduledQueryRunsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getSigmaScheduledQueryRunsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/sigma/scheduled_query_runs'

Instances

Eq GetSigmaScheduledQueryRunsResponseBody200

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

(==) :: GetSigmaScheduledQueryRunsResponseBody200 -> GetSigmaScheduledQueryRunsResponseBody200 -> Bool

(/=) :: GetSigmaScheduledQueryRunsResponseBody200 -> GetSigmaScheduledQueryRunsResponseBody200 -> Bool

Show GetSigmaScheduledQueryRunsResponseBody200

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

showsPrec :: Int -> GetSigmaScheduledQueryRunsResponseBody200 -> ShowS

show :: GetSigmaScheduledQueryRunsResponseBody200 -> String

showList :: [GetSigmaScheduledQueryRunsResponseBody200] -> ShowS

ToJSON GetSigmaScheduledQueryRunsResponseBody200

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

toJSON :: GetSigmaScheduledQueryRunsResponseBody200 -> Value

toEncoding :: GetSigmaScheduledQueryRunsResponseBody200 -> Encoding

toJSONList :: [GetSigmaScheduledQueryRunsResponseBody200] -> Value

toEncodingList :: [GetSigmaScheduledQueryRunsResponseBody200] -> Encoding

FromJSON GetSigmaScheduledQueryRunsResponseBody200

Defined in StripeAPI.Operations.GetSigmaScheduledQueryRuns

Methods

parseJSON :: Value -> Parser GetSigmaScheduledQueryRunsResponseBody200

parseJSONList :: Value -> Parser [GetSigmaScheduledQueryRunsResponseBody200]

mkGetSigmaScheduledQueryRunsResponseBody200

Arguments

:: [ScheduledQueryRun]

getSigmaScheduledQueryRunsResponseBody200Data

-> Bool

getSigmaScheduledQueryRunsResponseBody200HasMore

-> Text

getSigmaScheduledQueryRunsResponseBody200Url

-> GetSigmaScheduledQueryRunsResponseBody200

Create a new GetSigmaScheduledQueryRunsResponseBody200 with all required fields.