Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetAppsSecrets

Contains the different functions to run the operation getAppsSecrets

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetAppsSecrets.hs

valuegetAppsSecrets

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

GET /v1/apps/secrets

<p>List all secrets stored on the given scope.</p>

datadata GetAppsSecretsParameters

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

Constructors

GetAppsSecretsParameters
- getAppsSecretsParametersQueryEndingBefore :: 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
- getAppsSecretsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getAppsSecretsParametersQueryLimit :: 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.
- getAppsSecretsParametersQueryScope :: GetAppsSecretsParametersQueryScope'
  queryScope: Represents the parameter named 'scope'
  Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
- getAppsSecretsParametersQueryStartingAfter :: 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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAppsSecretsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
Show GetAppsSecretsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
FromJSON GetAppsSecretsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
ToJSON GetAppsSecretsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets

valuemkGetAppsSecretsParameters

:: GetAppsSecretsParametersQueryScope'
getAppsSecretsParametersQueryScope
-> GetAppsSecretsParameters

Create a new GetAppsSecretsParameters with all required fields.

datadata GetAppsSecretsParametersQueryScope'

Defines the object schema located at paths./v1/apps/secrets.GET.parameters.properties.queryScope in the specification.

Represents the parameter named 'scope'

Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Constructors

GetAppsSecretsParametersQueryScope'
- getAppsSecretsParametersQueryScope'Type :: GetAppsSecretsParametersQueryScope'Type'
  type
- getAppsSecretsParametersQueryScope'User :: Maybe Text
  user
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAppsSecretsParametersQueryScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
Show GetAppsSecretsParametersQueryScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
FromJSON GetAppsSecretsParametersQueryScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
ToJSON GetAppsSecretsParametersQueryScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets

valuemkGetAppsSecretsParametersQueryScope'

:: GetAppsSecretsParametersQueryScope'Type'
getAppsSecretsParametersQueryScope'Type
-> GetAppsSecretsParametersQueryScope'

Create a new GetAppsSecretsParametersQueryScope' with all required fields.

datadata GetAppsSecretsParametersQueryScope'Type'

Defines the enum schema located at paths./v1/apps/secrets.GET.parameters.properties.queryScope.properties.type in the specification.

Constructors

GetAppsSecretsParametersQueryScope'Type'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetAppsSecretsParametersQueryScope'Type'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetAppsSecretsParametersQueryScope'Type'EnumAccount
Represents the JSON value "account"
GetAppsSecretsParametersQueryScope'Type'EnumUser
Represents the JSON value "user"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAppsSecretsParametersQueryScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
Show GetAppsSecretsParametersQueryScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
FromJSON GetAppsSecretsParametersQueryScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
ToJSON GetAppsSecretsParametersQueryScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets

datadata GetAppsSecretsResponse

Represents a response of the operation getAppsSecrets.

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

Constructors

GetAppsSecretsResponseError String
Means either no matching case available or a parse error
GetAppsSecretsResponse200 GetAppsSecretsResponseBody200
Successful response.
GetAppsSecretsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetAppsSecretsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
Show GetAppsSecretsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets

datadata GetAppsSecretsResponseBody200

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

Constructors

GetAppsSecretsResponseBody200
- getAppsSecretsResponseBody200Data :: [Apps'secret]
  data
- getAppsSecretsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getAppsSecretsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/apps/secrets'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetAppsSecretsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
Show GetAppsSecretsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
FromJSON GetAppsSecretsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets
ToJSON GetAppsSecretsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetAppsSecrets

valuemkGetAppsSecretsResponseBody200

:: [Apps'secret]
getAppsSecretsResponseBody200Data
-> Bool
getAppsSecretsResponseBody200HasMore
-> Text
getAppsSecretsResponseBody200Url
-> GetAppsSecretsResponseBody200

Create a new GetAppsSecretsResponseBody200 with all required fields.