Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetProductsSearch

Contains the different functions to run the operation getProductsSearch

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetProductsSearch.hs

valuegetProductsSearch

:: MonadHTTP m
=> GetProductsSearchParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetProductsSearchResponse)
Monadic computation which returns the result of the operation

GET /v1/products/search

<p>Search for products you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p>

datadata GetProductsSearchParameters

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

Constructors

GetProductsSearchParameters
- getProductsSearchParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getProductsSearchParametersQueryLimit :: 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.
- getProductsSearchParametersQueryPage :: Maybe Text
  queryPage: Represents the parameter named 'page'
  A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
  Constraints:
  - Maximum length of 5000
- getProductsSearchParametersQueryQuery :: Text
  queryQuery: Represents the parameter named 'query'
  The search query string. See search query language and the list of supported query fields for products.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetProductsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch
Show GetProductsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch
FromJSON GetProductsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch
ToJSON GetProductsSearchParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch

valuemkGetProductsSearchParameters

:: Text
getProductsSearchParametersQueryQuery
-> GetProductsSearchParameters

Create a new GetProductsSearchParameters with all required fields.

datadata GetProductsSearchResponse

Represents a response of the operation getProductsSearch.

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

Constructors

GetProductsSearchResponseError String
Means either no matching case available or a parse error
GetProductsSearchResponse200 GetProductsSearchResponseBody200
Successful response.
GetProductsSearchResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetProductsSearchResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch
Show GetProductsSearchResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch

datadata GetProductsSearchResponseBody200

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

Constructors

GetProductsSearchResponseBody200
- getProductsSearchResponseBody200Data :: [Product]
  data
- getProductsSearchResponseBody200HasMore :: Bool
  has_more
- getProductsSearchResponseBody200NextPage :: Maybe (Nullable Text)
  next_page
  Constraints:
  - Maximum length of 5000
- getProductsSearchResponseBody200TotalCount :: Maybe Int
  total_count: The total number of objects that match the query, only accurate up to 10,000.
- getProductsSearchResponseBody200Url :: Text
  url
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetProductsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch
Show GetProductsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch
FromJSON GetProductsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch
ToJSON GetProductsSearchResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProductsSearch

valuemkGetProductsSearchResponseBody200

:: [Product]
getProductsSearchResponseBody200Data
-> Bool
getProductsSearchResponseBody200HasMore
-> Text
getProductsSearchResponseBody200Url
-> GetProductsSearchResponseBody200

Create a new GetProductsSearchResponseBody200 with all required fields.