Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostAppsSecrets

Contains the different functions to run the operation postAppsSecrets

4 types
3 values

Packagestripeapi-3.0.0.0
Exports7
LanguageHaskell2010
LicenceMIT
SourcePostAppsSecrets.hs

valuepostAppsSecrets

:: MonadHTTP m
=> PostAppsSecretsRequestBody
The request body to send
-> ClientT m (Response PostAppsSecretsResponse)
Monadic computation which returns the result of the operation

POST /v1/apps/secrets

<p>Create or replace a secret in the secret store.</p>

datadata PostAppsSecretsRequestBody

Defines the object schema located at paths./v1/apps/secrets.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostAppsSecretsRequestBody
- postAppsSecretsRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postAppsSecretsRequestBodyName :: Text
  name: A name for the secret that's unique within the scope.
  Constraints:
  - Maximum length of 5000
- postAppsSecretsRequestBodyPayload :: Text
  payload: The plaintext secret value to be stored.
  Constraints:
  - Maximum length of 5000
- postAppsSecretsRequestBodyScope :: PostAppsSecretsRequestBodyScope'
  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.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostAppsSecretsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
Show PostAppsSecretsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
FromJSON PostAppsSecretsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
ToJSON PostAppsSecretsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets

valuemkPostAppsSecretsRequestBody

:: Text
postAppsSecretsRequestBodyName
-> Text
postAppsSecretsRequestBodyPayload
-> PostAppsSecretsRequestBodyScope'
postAppsSecretsRequestBodyScope
-> PostAppsSecretsRequestBody

Create a new PostAppsSecretsRequestBody with all required fields.

datadata PostAppsSecretsRequestBodyScope'

Defines the object schema located at paths./v1/apps/secrets.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.scope in the specification.

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

PostAppsSecretsRequestBodyScope'
- postAppsSecretsRequestBodyScope'Type :: PostAppsSecretsRequestBodyScope'Type'
  type
- postAppsSecretsRequestBodyScope'User :: Maybe Text
  user
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostAppsSecretsRequestBodyScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
Show PostAppsSecretsRequestBodyScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
FromJSON PostAppsSecretsRequestBodyScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
ToJSON PostAppsSecretsRequestBodyScope'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets

valuemkPostAppsSecretsRequestBodyScope'

:: PostAppsSecretsRequestBodyScope'Type'
postAppsSecretsRequestBodyScope'Type
-> PostAppsSecretsRequestBodyScope'

Create a new PostAppsSecretsRequestBodyScope' with all required fields.

datadata PostAppsSecretsRequestBodyScope'Type'

Defines the enum schema located at paths./v1/apps/secrets.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.scope.properties.type in the specification.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostAppsSecretsRequestBodyScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
Show PostAppsSecretsRequestBodyScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
FromJSON PostAppsSecretsRequestBodyScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
ToJSON PostAppsSecretsRequestBodyScope'Type'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets

datadata PostAppsSecretsResponse

Represents a response of the operation postAppsSecrets.

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

Constructors

PostAppsSecretsResponseError String
Means either no matching case available or a parse error
PostAppsSecretsResponse200 Apps'secret
Successful response.
PostAppsSecretsResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostAppsSecretsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets
Show PostAppsSecretsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostAppsSecrets