StripeAPI.Operations.GetWebhookEndpoints

Contains the different functions to run the operation getWebhookEndpoints

Documentation

getWebhookEndpoints

Arguments

:: forall m. MonadHTTP m

=> GetWebhookEndpointsParameters

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

-> ClientT m (Response GetWebhookEndpointsResponse)

Monadic computation which returns the result of the operation

GET /v1/webhook_endpoints

<p>Returns a list of your webhook endpoints.</p>

data GetWebhookEndpointsParameters

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

Constructors

GetWebhookEndpointsParameters

Fields

• getWebhookEndpointsParametersQueryEndingBefore :: 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
• getWebhookEndpointsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getWebhookEndpointsParametersQueryLimit :: 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.

• getWebhookEndpointsParametersQueryStartingAfter :: 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 GetWebhookEndpointsParameters

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

(==) :: GetWebhookEndpointsParameters -> GetWebhookEndpointsParameters -> Bool

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

Show GetWebhookEndpointsParameters

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

showsPrec :: Int -> GetWebhookEndpointsParameters -> ShowS

show :: GetWebhookEndpointsParameters -> String

showList :: [GetWebhookEndpointsParameters] -> ShowS

ToJSON GetWebhookEndpointsParameters

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

toJSON :: GetWebhookEndpointsParameters -> Value

toEncoding :: GetWebhookEndpointsParameters -> Encoding

toJSONList :: [GetWebhookEndpointsParameters] -> Value

toEncodingList :: [GetWebhookEndpointsParameters] -> Encoding

FromJSON GetWebhookEndpointsParameters

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

parseJSON :: Value -> Parser GetWebhookEndpointsParameters

parseJSONList :: Value -> Parser [GetWebhookEndpointsParameters]

mkGetWebhookEndpointsParameters :: GetWebhookEndpointsParameters

Create a new GetWebhookEndpointsParameters with all required fields.

data GetWebhookEndpointsResponse

Represents a response of the operation getWebhookEndpoints.

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), GetWebhookEndpointsResponseError is used.

Constructors

GetWebhookEndpointsResponseError String

Means either no matching case available or a parse error

GetWebhookEndpointsResponse200 GetWebhookEndpointsResponseBody200

Successful response.

GetWebhookEndpointsResponseDefault Error

Error response.

Instances

Eq GetWebhookEndpointsResponse

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

(==) :: GetWebhookEndpointsResponse -> GetWebhookEndpointsResponse -> Bool

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

Show GetWebhookEndpointsResponse

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

showsPrec :: Int -> GetWebhookEndpointsResponse -> ShowS

show :: GetWebhookEndpointsResponse -> String

showList :: [GetWebhookEndpointsResponse] -> ShowS

data GetWebhookEndpointsResponseBody200

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

Constructors

GetWebhookEndpointsResponseBody200

Fields

• getWebhookEndpointsResponseBody200Data :: [WebhookEndpoint]

  data

• getWebhookEndpointsResponseBody200HasMore :: Bool

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

• getWebhookEndpointsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetWebhookEndpointsResponseBody200

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

(==) :: GetWebhookEndpointsResponseBody200 -> GetWebhookEndpointsResponseBody200 -> Bool

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

Show GetWebhookEndpointsResponseBody200

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

showsPrec :: Int -> GetWebhookEndpointsResponseBody200 -> ShowS

show :: GetWebhookEndpointsResponseBody200 -> String

showList :: [GetWebhookEndpointsResponseBody200] -> ShowS

ToJSON GetWebhookEndpointsResponseBody200

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

toJSON :: GetWebhookEndpointsResponseBody200 -> Value

toEncoding :: GetWebhookEndpointsResponseBody200 -> Encoding

toJSONList :: [GetWebhookEndpointsResponseBody200] -> Value

toEncodingList :: [GetWebhookEndpointsResponseBody200] -> Encoding

FromJSON GetWebhookEndpointsResponseBody200

Defined in StripeAPI.Operations.GetWebhookEndpoints

Methods

parseJSON :: Value -> Parser GetWebhookEndpointsResponseBody200

parseJSONList :: Value -> Parser [GetWebhookEndpointsResponseBody200]

mkGetWebhookEndpointsResponseBody200

Arguments

:: [WebhookEndpoint]

getWebhookEndpointsResponseBody200Data

-> Bool

getWebhookEndpointsResponseBody200HasMore

-> Text

getWebhookEndpointsResponseBody200Url

-> GetWebhookEndpointsResponseBody200

Create a new GetWebhookEndpointsResponseBody200 with all required fields.