Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation getSubscriptionSchedules
Synopsis
- getSubscriptionSchedules :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe GetSubscriptionSchedulesRequestBody -> m (Either HttpException (Response GetSubscriptionSchedulesResponse))
- getSubscriptionSchedulesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe GetSubscriptionSchedulesRequestBody -> m (Either HttpException (Response ByteString))
- getSubscriptionSchedulesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe GetSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionSchedulesResponse))
- getSubscriptionSchedulesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe GetSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetSubscriptionSchedulesRequestBody = GetSubscriptionSchedulesRequestBody {
- data GetSubscriptionSchedulesResponse
- data GetSubscriptionSchedulesResponseBody200 = GetSubscriptionSchedulesResponseBody200 {}
- data GetSubscriptionSchedulesResponseBody200Object'
Documentation
getSubscriptionSchedules Source #
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> Maybe Text | canceled_at: Only return subscription schedules that were created canceled the given date interval. |
-> Maybe Text | completed_at: Only return subscription schedules that completed during the given date interval. |
-> Maybe Text | created: Only return subscription schedules that were created during the given date interval. |
-> Maybe Text | customer: Only return subscription schedules for the given customer. | Constraints: Maximum length of 5000 |
-> Maybe Text | 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 |
-> Maybe Text | expand: Specifies which fields in the response should be expanded. |
-> Maybe Integer | limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
-> Maybe Text | released_at: Only return subscription schedules that were released during the given date interval. |
-> Maybe Bool | scheduled: Only return subscription schedules that have not started yet. |
-> Maybe Text | 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 |
-> Maybe GetSubscriptionSchedulesRequestBody | The request body to send |
-> m (Either HttpException (Response GetSubscriptionSchedulesResponse)) | Monad containing the result of the operation |
GET /v1/subscription_schedules
<p>Retrieves the list of your subscription schedules.</p>
getSubscriptionSchedulesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe GetSubscriptionSchedulesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/subscription_schedules
The same as getSubscriptionSchedules
but returns the raw ByteString
getSubscriptionSchedulesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe GetSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionSchedulesResponse)) Source #
GET /v1/subscription_schedules
Monadic version of getSubscriptionSchedules
(use with runWithConfiguration
)
getSubscriptionSchedulesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe GetSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/subscription_schedules
Monadic version of getSubscriptionSchedulesRaw
(use with runWithConfiguration
)
data GetSubscriptionSchedulesRequestBody Source #
Defines the data type for the schema getSubscriptionSchedulesRequestBody
data GetSubscriptionSchedulesResponse Source #
Represents a response of the operation getSubscriptionSchedules
.
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), GetSubscriptionSchedulesResponseError
is used.
GetSubscriptionSchedulesResponseError String | Means either no matching case available or a parse error |
GetSubscriptionSchedulesResponse200 GetSubscriptionSchedulesResponseBody200 | Successful response. |
GetSubscriptionSchedulesResponseDefault Error | Error response. |
data GetSubscriptionSchedulesResponseBody200 Source #
Defines the data type for the schema GetSubscriptionSchedulesResponseBody200
GetSubscriptionSchedulesResponseBody200 | |
|
data GetSubscriptionSchedulesResponseBody200Object' Source #
Defines the enum schema GetSubscriptionSchedulesResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
GetSubscriptionSchedulesResponseBody200Object'EnumOther Value | |
GetSubscriptionSchedulesResponseBody200Object'EnumTyped Text | |
GetSubscriptionSchedulesResponseBody200Object'EnumStringList |