nordlet 0.0.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ea1ee383c311c7ebce9d4c81b29fa76238cc108a4029db8bf0c2eede3de8f2c
-  data.tar.gz: 3972c8ff7f1318b916a859894a8f0029e0e09032f4965fd368385c32cfc4747c
+  metadata.gz: 78636e2e2280ec7c8b78bcae6e5bbfda775e1b1acd1db0e66b14ede60d5ab89b
+  data.tar.gz: 3bebf64821bf5d204b54324e032de88db99ed25694db721c8e4a6902d2e81e71
 SHA512:
-  metadata.gz: 7078b21592adb0992a0b99bb5ca913ad7fded9fa909b30eec07ad88d401baf0fe5170c72130e926200739f35fd5f9c298f1b2aa3f36c2ba74418b89812918c68
-  data.tar.gz: '098e7b2cc8a410e5a0885d931d62bf0318513e0d5e7d4ccf2e3a0240be3cd3d9fbb9a2de03805cc3ea077b5bbd271979387d7724cd206d5bc35904c4749e18aa'
+  metadata.gz: 9c94c06be4b9be05ed2cf68da4b22099dd1f3f9c5fe4c7b025a604f17a13fb1bbd0d320672cafd76dd9c981664c25fa251b0e80c8756eaf7a78150459ab2a423
+  data.tar.gz: 3c58e1b9291822ef95d6acc23a76001aea470cd124344337242bcd082fa3908dd3bb2aaaca7fcee8c4ed1dc7ae4495a97424c6d308fd34e8894c4d91d9247a6b

data/README.md

@@ -0,0 +1,167 @@
+# Nordlet Ruby Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Nordlet%2FRuby)
+
+The Nordlet Ruby library provides convenient access to the Nordlet APIs from Ruby.
+
+## Table of Contents
+
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Errors](#errors)
+- [Advanced](#advanced)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Additional Headers](#additional-headers)
+  - [Additional Query Parameters](#additional-query-parameters)
+- [Contributing](#contributing)
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```ruby
+require "nordlet"
+
+client = Nordlet::Client.new(token: "<token>")
+
+client.reference.post_v1reference_exchange_rates_sync
+```
+
+## Environments
+
+This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.
+### Environments
+```ruby
+require "nordlet"
+
+nordlet = Nordlet::Client.new(
+    base_url: Nordlet::Environment::PRODUCTION
+)
+```
+
+### Custom URL
+```ruby
+require "nordlet"
+
+client = Nordlet::Client.new(
+    base_url: "https://example.com"
+)
+```
+
+## Errors
+
+Failed API calls will raise errors that can be rescued from granularly.
+
+```ruby
+require "nordlet"
+
+client = Nordlet::Client.new(
+    base_url: "https://example.com"
+)
+
+begin
+    result = client.reference.post_v1reference_exchange_rates_sync
+rescue Nordlet::Errors::TimeoutError
+    puts "API didn't respond before our timeout elapsed"
+rescue Nordlet::Errors::ServiceUnavailableError
+    puts "API returned status 503, is probably overloaded, try again later"
+rescue Nordlet::Errors::ServerError
+    puts "API returned some other 5xx status, this is probably a bug"
+rescue Nordlet::Errors::ResponseError => e
+    puts "API returned an unexpected status other than 5xx: #{e.code} #{e.message}"
+rescue Nordlet::Errors::ApiError => e
+    puts "Some other error occurred when calling the API: #{e.message}"
+end
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries. A request will be retried as long as the request is deemed
+retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (Internal Server Error)
+
+The `retryStatusCodes` configuration controls which [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) status codes are retried:
+
+- `legacy` (default): Retries `408`, `429`, `500`, `502`, `503`, `504`, `521`, `522`, `524`
+- `recommended`: Retries `408`, `429`, `502`, `503`, `504` only (excludes `500 Internal Server Error` to avoid retrying non-idempotent failures)
+
+Use the `max_retries` option to configure this behavior.
+
+```ruby
+require "nordlet"
+
+client = Nordlet::Client.new(
+    base_url: "https://example.com",
+    max_retries: 3  # Configure max retries (default is 2)
+)
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeout` option to configure this behavior.
+
+```ruby
+require "nordlet"
+
+response = client.reference.post_v1reference_exchange_rates_sync(
+    ...,
+    timeout: 30  # 30 second timeout
+)
+```
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `additional_headers` request option.
+
+```ruby
+require "nordlet"
+
+response = client.reference.post_v1reference_exchange_rates_sync(
+    ...,
+    request_options: {
+        additional_headers: {
+            "X-Custom-Header" => "custom-value"
+        }
+    }
+)
+```
+
+### Additional Query Parameters
+
+If you would like to send additional query parameters as part of the request, use the `additional_query_parameters` request option.
+
+```ruby
+require "nordlet"
+
+response = client.reference.post_v1reference_exchange_rates_sync(
+    ...,
+    request_options: {
+        additional_query_parameters: {
+            "custom_param" => "custom-value"
+        }
+    }
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!