{"id":20464076,"url":"https://github.com/fullstack-development/haskell-equifax-generated","last_synced_at":"2026-04-21T13:31:56.877Z","repository":{"id":42972416,"uuid":"360004883","full_name":"fullstack-development/haskell-equifax-generated","owner":"fullstack-development","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-15T17:29:54.000Z","size":506,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-05T12:18:46.274Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fullstack-development.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-21T02:07:05.000Z","updated_at":"2024-11-15T17:29:59.000Z","dependencies_parsed_at":"2025-01-16T00:49:12.913Z","dependency_job_id":"db3f9916-c5e4-4dbc-a576-6ff842413ebf","html_url":"https://github.com/fullstack-development/haskell-equifax-generated","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fullstack-development/haskell-equifax-generated","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullstack-development%2Fhaskell-equifax-generated","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullstack-development%2Fhaskell-equifax-generated/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullstack-development%2Fhaskell-equifax-generated/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullstack-development%2Fhaskell-equifax-generated/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fullstack-development","download_url":"https://codeload.github.com/fullstack-development/haskell-equifax-generated/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fullstack-development%2Fhaskell-equifax-generated/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32094364,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T11:25:29.218Z","status":"ssl_error","status_checked_at":"2026-04-21T11:25:28.499Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T13:13:56.995Z","updated_at":"2026-04-21T13:31:56.853Z","avatar_url":"https://github.com/fullstack-development.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"## OpenAPI Auto-Generated [http-client](https://www.stackage.org/lts-10.0/package/http-client-0.5.7.1) Bindings to `Consumer Credit Report`\n\nThe library in `lib` provides auto-generated-from-OpenAPI [http-client](https://www.stackage.org/lts-10.0/package/http-client-0.5.7.1) bindings to the Consumer Credit Report API.\n\nOpenApi Version: 3.0.0\n\n## Installation\n\nInstallation follows the standard approach to installing Stack-based projects.\n\n1. Install the [Haskell `stack` tool](http://docs.haskellstack.org/en/stable/README).\n2. To build the package, and generate the documentation (recommended):\n```\nstack haddock\n```\nwhich will generate docs for this lib in the `docs` folder.\n\nTo generate the docs in the normal location (to enable hyperlinks to external libs), remove \n```\nbuild:\n  haddock-arguments:\n    haddock-args:\n    - \"--odir=./docs\"\n```\nfrom the stack.yaml file and run `stack haddock` again.\n\n3. To run unit tests:\n```\nstack test\n```\n\n## OpenAPI-Generator\n\nThe code generator that produced this library, and which explains how\nto obtain and use the openapi-generator cli tool lives at\n\nhttps://openapi-generator.tech\n\nThe _generator-name_ argument (`--generator-name`) passed to the cli tool used should be\n\n```\nhaskell-http-client\n```\n\n### Unsupported OpenAPI Features\n\n* Model Inheritance\n\nThis is beta software; other cases may not be supported.\n\n### Codegen \"additional properties\" parameters\n\nThese options allow some customization of the code generation process.\n\n**haskell-http-client additional properties:**\n\n| OPTION                          | DESCRIPTION                                                                                                                   | DEFAULT  | ACTUAL                                |\n| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------- |\n| allowFromJsonNulls              | allow JSON Null during model decoding from JSON                                                                               | true     | true              |\n| allowNonUniqueOperationIds      | allow *different* API modules to contain the same operationId. Each API must be imported qualified                            | false    | false    |\n| allowToJsonNulls                | allow emitting JSON Null during model encoding to JSON                                                                        | false    | false                |\n| baseModule                      | Set the base module namespace                                                                                                 |          | ConsumerCreditReport                      |\n| cabalPackage                    | Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens                             |          | consumer-credit-report                    |\n| cabalVersion                    | Set the cabal version number, consisting of a sequence of one or more integers separated by dots                              | 0.1.0.0  | 0.1.0.0                    |\n| customTestInstanceModule        | test module used to provide typeclass instances for types not known by the generator                                          |          |         |\n| configType                      | Set the name of the type used for configuration                                                                               |          | ConsumerCreditReportConfig                      |\n| dateFormat                      | format string used to parse/render a date                                                                                     | %Y-%m-%d | %Y-%m-%d                      |\n| dateTimeFormat                  | format string used to parse/render a datetime. (Defaults to [formatISO8601Millis][1] when not provided)                       |          |                   |\n| dateTimeParseFormat             | overrides the format string used to parse a datetime                                                                          |          |              |\n| generateEnums                   | Generate specific datatypes for OpenAPI enums                                                                                 | true     | true                   |\n| generateFormUrlEncodedInstances | Generate FromForm/ToForm instances for models used by x-www-form-urlencoded operations (model fields must be primitive types) | true     | true |\n| generateLenses                  | Generate Lens optics for Models                                                                                               | true     | true                  |\n| generateModelConstructors       | Generate smart constructors (only supply required fields) for models                                                          | true     | true       |\n| inlineMimeTypes                 | Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option                           | true     | true                 |\n| modelDeriving                   | Additional classes to include in the deriving() clause of Models                                                              |          |                    |\n| requestType                     | Set the name of the type used to generate requests                                                                            |          | ConsumerCreditReportRequest                     |\n| strictFields                    | Add strictness annotations to all model fields                                                                                | true     | true                  |\n| useKatip                        | Sets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-logger       | true     | true                      |\n\n[1]: https://www.stackage.org/haddock/lts-9.0/iso8601-time-0.1.4/Data-Time-ISO8601.html#v:formatISO8601Millis\n\nAn example setting _dateTimeFormat_ and _strictFields_:\n\n```\njava -jar openapi-generator-cli.jar generate -i petstore.yaml -g haskell-http-client -o output/haskell-http-client --additional-properties=dateTimeFormat=\"%Y-%m-%dT%H:%M:%S%Q%z\" --additional-properties=strictFields=false \n```\n\nView the full list of Codegen \"config option\" parameters with the command:\n\n```\njava -jar openapi-generator-cli.jar config-help -g haskell-http-client\n```\n\n## Usage Notes\n\n### Example Petstore Haddock documentation\n\nAn example of the generated haddock documentation targeting the server http://petstore.swagger.io/ (Petstore) can be found [here][2]\n\n[2]: https://hackage.haskell.org/package/swagger-petstore\n\n### Example Petstore App\n\nAn example application using the auto-generated haskell-http-client bindings for the server http://petstore.swagger.io/ can be found [here][3]\n\n[3]: https://github.com/openapitools/openapi-generator/tree/master/samples/client/petstore/haskell-http-client/example-app\n\nThis library is intended to be imported qualified.\n\n### Modules\n\n| MODULE              | NOTES                                               |\n| ------------------- | --------------------------------------------------- |\n| ConsumerCreditReport.Client    | use the \"dispatch\" functions to send requests       |\n| ConsumerCreditReport.Core      | core funcions, config and request types             |\n| ConsumerCreditReport.API       | construct api requests                              |\n| ConsumerCreditReport.Model     | describes api models                                |\n| ConsumerCreditReport.MimeTypes | encoding/decoding MIME types (content-types/accept) |\n| ConsumerCreditReport.ModelLens | lenses for model fields                             |\n| ConsumerCreditReport.Logging   | logging functions and utils                         |\n\n\n### MimeTypes\n\nThis library adds type safety around what OpenAPI specifies as\nProduces and Consumes for each Operation (e.g. the list of MIME types an\nOperation can Produce (using 'accept' headers) and Consume (using 'content-type' headers).\n\nFor example, if there is an Operation named _addFoo_, there will be a\ndata type generated named _AddFoo_ (note the capitalization), which\ndescribes additional constraints and actions on the _addFoo_ operation\nvia its typeclass instances. These typeclass instances can be viewed\nin GHCi or via the Haddocks.\n\n* required parameters are included as function arguments to _addFoo_\n* optional non-body parameters are included by using  `applyOptionalParam`\n* optional body parameters are set by using  `setBodyParam`\n\nExample code generated for pretend _addFoo_ operation: \n\n```haskell\ndata AddFoo \t\ninstance Consumes AddFoo MimeJSON\ninstance Produces AddFoo MimeJSON\ninstance Produces AddFoo MimeXML\ninstance HasBodyParam AddFoo FooModel\ninstance HasOptionalParam AddFoo FooName\ninstance HasOptionalParam AddFoo FooId\n```\n\nthis would indicate that:\n\n* the _addFoo_ operation can consume JSON\n* the _addFoo_ operation produces JSON or XML, depending on the argument passed to the dispatch function\n* the _addFoo_ operation can set it's body param of _FooModel_ via `setBodyParam`\n* the _addFoo_ operation can set 2 different optional parameters via `applyOptionalParam`\n\nIf the OpenAPI spec doesn't declare it can accept or produce a certain\nMIME type for a given Operation, you should either add a Produces or\nConsumes instance for the desired MIME types (assuming the server\nsupports it), use `dispatchLbsUnsafe` or modify the OpenAPI spec and\nrun the generator again.\n\nNew MIME type instances can be added via MimeType/MimeRender/MimeUnrender\n\nOnly JSON instances are generated by default, and in some case\nx-www-form-urlencoded instances (FromFrom, ToForm) will also be\ngenerated if the model fields are primitive types, and there are\nOperations using x-www-form-urlencoded which use those models.\n\n### Authentication\n\nA haskell data type will be generated for each OpenAPI authentication type.\n\nIf for example the AuthMethod `AuthOAuthFoo` is generated for OAuth operations, then\n`addAuthMethod` should be used to add the AuthMethod config.\n\nWhen a request is dispatched, if a matching auth method is found in\nthe config, it will be applied to the request.\n\n### Example\n\n```haskell\nmgr \u003c- newManager defaultManagerSettings\nconfig0 \u003c- withStdoutLogging =\u003c\u003c newConfig \nlet config = config0\n    `addAuthMethod` AuthOAuthFoo \"secret-key\"\n\nlet addFooRequest = \n  addFoo \n    (ContentType MimeJSON) \n    (Accept MimeXML) \n    (ParamBar paramBar)\n    (ParamQux paramQux)\n    modelBaz\n  `applyOptionalParam` FooId 1\n  `applyOptionalParam` FooName \"name\"\n  `setHeader` [(\"qux_header\",\"xxyy\")]\naddFooResult \u003c- dispatchMime mgr config addFooRequest\n```\n\nSee the example app and the haddocks for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffullstack-development%2Fhaskell-equifax-generated","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffullstack-development%2Fhaskell-equifax-generated","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffullstack-development%2Fhaskell-equifax-generated/lists"}