https://github.com/simontreanor/funstripe
An F# library to connect to the Stripe API, including code generators to update the model and requests.
https://github.com/simontreanor/funstripe
code-generation fsharp stripe-api
Last synced: 13 days ago
JSON representation
An F# library to connect to the Stripe API, including code generators to update the model and requests.
- Host: GitHub
- URL: https://github.com/simontreanor/funstripe
- Owner: simontreanor
- Created: 2020-10-29T18:59:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-25T10:57:25.000Z (2 months ago)
- Last Synced: 2025-03-29T06:43:26.957Z (about 1 month ago)
- Topics: code-generation, fsharp, stripe-api
- Language: F#
- Homepage:
- Size: 2.81 MB
- Stars: 38
- Watchers: 2
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FunStripe
An F# library to connect to the Stripe API, including code generators to update the model and requests. Targets .NET Standard 2.0 and .NET Standard 2.1.
## Latest updates
2025-02-24: version 0.11.2 implements changes to the order of generated types to reduce the need for recursive type declarations (thank [Thorium](https://github.com/Thorium) for that!). [FunStripeLite](https://github.com/simontreanor/FunStripeLite) has been added as a subproject and will be maintained here from now on.
2025-01-21: version 0.11.0 changes the target frameworks to .NET Standard 2.0 and .NET Standard 2.1 and updates FSharp.Core to version 9.0.101 and FSharp.Data to 6.4.1.
2023-11-13: version 0.10.2 makes some minor performance enhancements.
2023-10-13: version 0.10.1 makes some minor tweaks to normalise the folder structure.
2023-10-11: version 0.10.0 fixes an issue with form serialisation that meant that JsonField names were only applied to the top level elements. It also tidies the code up a little.
2023-08-29: version 0.9.3 updates the Stripe API from version 2022-11-15 to 2023-08-16, which contains some breaking changes. See the [Stripe API changelog](https://stripe.com/docs/upgrades#api-changelog) for details. It also updates the package dependencies for FSharp.Core and FSharp.Data to 6.0.7 and 6.2.0 respectively.
2022-11-22: version 0.9.2 updates the Stripe API from version 2022-08-01 to 2022-11-15, which contains some breaking changes. See the [Stripe API changelog](https://stripe.com/docs/upgrades#api-changelog) for details. As .NET 5 is out-of-support, this has been removed from the target frameworks.
2022-10-04: version 0.9.0 updates the Stripe API from version 2020-08-27 to 2022-08-01, which contains some breaking changes. See the [Stripe API changelog](https://stripe.com/docs/upgrades#api-changelog) for details.
2022-04-22: a lightweight version of this library without the code generators is now available as [FunStripeLite](https://github.com/simontreanor/FunStripeLite).
2021-07-18: version 0.8.0 updates the Stripe API from version 2020-03-02 to 2020-08-27, which contains some breaking changes. See the [Stripe API changelog](https://stripe.com/docs/upgrades#api-changelog) for details.
## Installation
Get the latest version of FunStripe (which includes the model builders) from [Nuget](https://www.nuget.org/packages/FunStripe/) or the lite version, which just contains the models, from [Nuget](https://www.nuget.org/packages/FunStripeLite/).
## Usage
Open the StripeModel and StripeRequest modules.
Here's an example of how to create a new payment method:
```F#
let settings = RestApi.StripeApiSettings.New(apiKey = Config.StripeTestApiKey)
let getNewPaymentMethod () =
asyncResult {
return!
PaymentMethods.CreateOptions.New(
card = Choice2Of2 (PaymentMethods.Create'CardTokenParams.New("tok_visa")),
type' = PaymentMethods.Create'Type.Card
)
|> PaymentMethods.Create settings
}
```
The result value is an `AsyncResult`, giving you the requested object in case of success or a detailed error response if not.
The general format of API requests is ``.`` `settings` `options`.
To instantiate the `settings` you need to pass in your Stripe API key. Having local rather than global settings allows you to use different keys for different Stripe accounts if you need to.
If you don't specify the API key in the settings record, it will look for a default test API key to use, and to keep the keys out of source code, it uses [UserSecrets](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-9.0&tabs=windows). It is recommended to use `UserSecrets` during development and web-server configuration settings in production, but if your source code will not be made public you can simply specify the API key as a string, at least for testing purposes. `Config.fs` contains some notes to help you.
The `options` can be provided using record notation or if there are many uninitialised properties you can use the static `New` method to instantiate the record more effiently.
## Code Generation
By cloning the source repository, as a developer you can use `ModelBuilder.fs` and `RequestBuilder.fs` to generate the code in `StripeModel.fs` and `StripeRequest.fs` respectively.
Using Visual Studio Code, you simply select all the text in each document and hit `Alt + Enter` to send the code to F# Interactive. This will overwrite the contents of the target modules.
The Stripe OpenAPI specification is stored locally as `/res/spec3.sdk.json`. See the references below for the link to the latest online version.
By replacing the local copy with the latest one from online, you can regenerate the source code and build it to get the latest changes.
You could also customise how the source code is represented by editing the builder code files.
## References
[Stripe Documentation](https://stripe.com/docs)
[Developer Tools](https://stripe.com/docs/development)
[API Reference](https://stripe.com/docs/api)
[Official Stripe .NET Library](https://github.com/stripe/stripe-dotnet)
[Stripe OpenAPI Specification](https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.sdk.json)