growwer 2.0.0 → 2.2.0

data/docs/TestHelpersApi.md

@@ -0,0 +1,222 @@
+# Growwer::TestHelpersApi
+
+All URIs are relative to *https://tool.growwer.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**advance_test_order**](TestHelpersApi.md#advance_test_order) | **POST** /api/v1/test-helpers/orders/{id}/advance | Advance a test order |
+| [**reset_test_data**](TestHelpersApi.md#reset_test_data) | **POST** /api/v1/test-helpers/reset | Reset your test data |
+| [**top_up_test_wallet**](TestHelpersApi.md#top_up_test_wallet) | **POST** /api/v1/test-helpers/wallet/top-up | Top up your test wallet |
+
+
+## advance_test_order
+
+> <Order> advance_test_order(id, idempotency_key, advance_test_order_request)
+
+Advance a test order
+
+Test keys only. Moves one of your test orders at once to `to`, without waiting for the simulated seller: `accepted` or `rejected` (by the seller, from `pending_acceptance`), `draft_delivered` (the sample draft, from `pending_draft` or `pending_draft_update`), `draft_update_requested` (as if you sent the draft back, from `pending_draft_review`), `published` (delivered for your review, from `pending_order_delivery`, `scheduled` or `pending_order_delivery_update`), `update_requested` (as if you sent the delivery back, from `pending_order_delivery_review`) or `cancelled_by_growwer` (from any state that is not finished). The order and your test wallet change as that move changes them live, a rejection or a cancellation refunding the price, and the simulated seller carries on from the new state. A post with a future `scheduledPublicationDate` waits in `scheduled` until that date once the simulated seller delivers it; `published` skips the wait. A target its state does not allow answers 409 `invalid_transition` with the targets it allows. A live key gets 403 `test_mode_only`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'growwer'
+# setup authorization
+Growwer.configure do |config|
+  # Configure Bearer authorization: apiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Growwer::TestHelpersApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+idempotency_key = 'idempotency_key_example' # String | A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (`!` to `~`); any other value answers 400 `invalid_idempotency_key`.
+advance_test_order_request = Growwer::AdvanceTestOrderRequest.new({to: 'accepted'}) # AdvanceTestOrderRequest | 
+
+begin
+  # Advance a test order
+  result = api_instance.advance_test_order(id, idempotency_key, advance_test_order_request)
+  p result
+rescue Growwer::ApiError => e
+  puts "Error when calling TestHelpersApi->advance_test_order: #{e}"
+end
+```
+
+#### Using the advance_test_order_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Order>, Integer, Hash)> advance_test_order_with_http_info(id, idempotency_key, advance_test_order_request)
+
+```ruby
+begin
+  # Advance a test order
+  data, status_code, headers = api_instance.advance_test_order_with_http_info(id, idempotency_key, advance_test_order_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Order>
+rescue Growwer::ApiError => e
+  puts "Error when calling TestHelpersApi->advance_test_order_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **idempotency_key** | **String** | A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;. |  |
+| **advance_test_order_request** | [**AdvanceTestOrderRequest**](AdvanceTestOrderRequest.md) |  |  |
+
+### Return type
+
+[**Order**](Order.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## reset_test_data
+
+> reset_test_data(idempotency_key)
+
+Reset your test data
+
+Test keys only. Deletes your test projects, orders and uploaded test files, and returns your test wallet to its opening balance of 1,000.00 EUR with no movements. Your API keys and webhook subscriptions stay, and nothing of your live account changes. It takes no body. A live key gets 403 `test_mode_only`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'growwer'
+# setup authorization
+Growwer.configure do |config|
+  # Configure Bearer authorization: apiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Growwer::TestHelpersApi.new
+idempotency_key = 'idempotency_key_example' # String | A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (`!` to `~`); any other value answers 400 `invalid_idempotency_key`.
+
+begin
+  # Reset your test data
+  api_instance.reset_test_data(idempotency_key)
+rescue Growwer::ApiError => e
+  puts "Error when calling TestHelpersApi->reset_test_data: #{e}"
+end
+```
+
+#### Using the reset_test_data_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> reset_test_data_with_http_info(idempotency_key)
+
+```ruby
+begin
+  # Reset your test data
+  data, status_code, headers = api_instance.reset_test_data_with_http_info(idempotency_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Growwer::ApiError => e
+  puts "Error when calling TestHelpersApi->reset_test_data_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **idempotency_key** | **String** | A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## top_up_test_wallet
+
+> <TopUpTestWallet200Response> top_up_test_wallet(idempotency_key, top_up_test_wallet_request)
+
+Top up your test wallet
+
+Test keys only. Credits your test wallet, the buyer wallet a test key spends from, with fictitious money: more than nothing and at most 10,000.00 EUR per call. It never touches your real wallets, takes no payment and issues no invoice; the movement shows in GET /wallets/buyer/transactions for a test key as a confirmed `deposit`. A live key gets 403 `test_mode_only`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'growwer'
+# setup authorization
+Growwer.configure do |config|
+  # Configure Bearer authorization: apiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Growwer::TestHelpersApi.new
+idempotency_key = 'idempotency_key_example' # String | A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (`!` to `~`); any other value answers 400 `invalid_idempotency_key`.
+top_up_test_wallet_request = Growwer::TopUpTestWalletRequest.new({amount: Growwer::Money.new({amount: 12500, currency: 'EUR'})}) # TopUpTestWalletRequest | 
+
+begin
+  # Top up your test wallet
+  result = api_instance.top_up_test_wallet(idempotency_key, top_up_test_wallet_request)
+  p result
+rescue Growwer::ApiError => e
+  puts "Error when calling TestHelpersApi->top_up_test_wallet: #{e}"
+end
+```
+
+#### Using the top_up_test_wallet_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TopUpTestWallet200Response>, Integer, Hash)> top_up_test_wallet_with_http_info(idempotency_key, top_up_test_wallet_request)
+
+```ruby
+begin
+  # Top up your test wallet
+  data, status_code, headers = api_instance.top_up_test_wallet_with_http_info(idempotency_key, top_up_test_wallet_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TopUpTestWallet200Response>
+rescue Growwer::ApiError => e
+  puts "Error when calling TestHelpersApi->top_up_test_wallet_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **idempotency_key** | **String** | A new key for each write, reused only to retry that same write. 1 to 255 printable ASCII characters without spaces (&#x60;!&#x60; to &#x60;~&#x60;); any other value answers 400 &#x60;invalid_idempotency_key&#x60;. |  |
+| **top_up_test_wallet_request** | [**TopUpTestWalletRequest**](TopUpTestWalletRequest.md) |  |  |
+
+### Return type
+
+[**TopUpTestWallet200Response**](TopUpTestWallet200Response.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/TopUpTestWallet200Response.md

@@ -0,0 +1,20 @@
+# Growwer::TopUpTestWallet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance** | [**Balance**](Balance.md) |  |  |
+| **top_up_url** | **String** | The wallet page where a live buyer tops up, as GET /wallets/buyer gives it. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::TopUpTestWallet200Response.new(
+  balance: null,
+  top_up_url: null
+)
+```
+

data/docs/TopUpTestWalletRequest.md

@@ -0,0 +1,18 @@
+# Growwer::TopUpTestWalletRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | [**Money**](Money.md) | What to credit, in EUR: from 1 to 1000000 cents. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::TopUpTestWalletRequest.new(
+  amount: null
+)
+```
+

data/docs/UpdateWebhookRequest.md

@@ -0,0 +1,26 @@
+# Growwer::UpdateWebhookRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | An HTTPS URL of at most 2048 characters, without a backslash or credentials. Its host is an IP address or a domain name of two labels or more, such as hooks.example.com, with one trailing dot allowed; a single-label host such as localhost is refused (`validation_failed` on `url`). The host is checked, and resolved at each delivery, in lower case and with a Unicode name in punycode, the form a delivery connects to. | [optional] |
+| **events** | [**Array<WebhookEventType>**](WebhookEventType.md) | The events to send, at least one; replaces the list. | [optional] |
+| **low_balance_threshold** | [**MoneyOrNull**](MoneyOrNull.md) | With `balance.low`: the available buyer balance below which the event fires, in EUR. Null removes it. | [optional] |
+| **description** | **String** | A note of yours, at most 255 characters. Null removes it. | [optional] |
+| **enabled** | **Boolean** | Whether the subscription gets events. | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::UpdateWebhookRequest.new(
+  url: null,
+  events: null,
+  low_balance_threshold: null,
+  description: null,
+  enabled: null
+)
+```
+

data/docs/Webhook.md

@@ -0,0 +1,38 @@
+# Growwer::Webhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **url** | **String** |  |  |
+| **events** | [**Array<WebhookEventType>**](WebhookEventType.md) |  |  |
+| **low_balance_threshold** | [**MoneyOrNull**](MoneyOrNull.md) | With `balance.low`, the available buyer balance below which it fires; null otherwise. |  |
+| **description** | **String** |  |  |
+| **enabled** | **Boolean** | Whether the subscription gets events. |  |
+| **disabled_reason** | **String** | Why it is disabled, null while enabled. `by_user`, through PATCH /webhooks/{id}; `endpoint_gone`, its endpoint answered 410; `failing`, every delivery failed for 5 days, and the account owner was emailed. |  |
+| **failing_since** | **Time** | Since when its deliveries have failed without one succeeding, null while they succeed. At 5 days it is disabled. The check runs at each failed attempt, so a subscription whose `failingSince` is already more than 5 days old, say one that had no event for a while, is disabled at its next failed attempt, without the retries that delivery would otherwise get. |  |
+| **previous_secret_expires_at** | **Time** | Until when the secret replaced by the last rotation still signs beside the new one, null when it no longer does. |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::Webhook.new(
+  id: null,
+  url: null,
+  events: null,
+  low_balance_threshold: null,
+  description: null,
+  enabled: null,
+  disabled_reason: null,
+  failing_since: null,
+  previous_secret_expires_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/WebhookDelivery.md

@@ -0,0 +1,32 @@
+# Growwer::WebhookDelivery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **event_id** | **String** | The event's id, sent as `webhook-id` on every attempt and redelivery. |  |
+| **event_type** | **String** |  |  |
+| **status** | **String** | `pending` while it is sent or retried, `succeeded` once an attempt got a 2xx, `failed` once the retries ran out, the endpoint answered 410 or the subscription was disabled. |  |
+| **attempt_count** | **Integer** | How many attempts it took, redeliveries included. |  |
+| **next_attempt_at** | **Time** | When the next retry is due, null when none is. |  |
+| **created_at** | **Time** |  |  |
+| **attempts** | [**Array<WebhookDeliveryAttempt>**](WebhookDeliveryAttempt.md) | The latest 10 attempts, newest first. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::WebhookDelivery.new(
+  id: null,
+  event_id: null,
+  event_type: null,
+  status: null,
+  attempt_count: null,
+  next_attempt_at: null,
+  created_at: null,
+  attempts: null
+)
+```
+

data/docs/WebhookDeliveryAttempt.md

@@ -0,0 +1,26 @@
+# Growwer::WebhookDeliveryAttempt
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attempted_at** | **Time** |  |  |
+| **status_code** | **Integer** | The HTTP status your endpoint answered, null when it did not answer. Only 2xx succeeds; a redirect is not followed and fails. |  |
+| **duration_ms** | **Integer** | How long the attempt took, in milliseconds. It gives up after 15 seconds. |  |
+| **response_body** | **String** | Up to the first 1024 bytes of the response body, null when it did not answer. |  |
+| **error** | **String** | Why there is no status, null when it answered. `address_not_allowed`, its host resolved to, or connected to, an address that is not public. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::WebhookDeliveryAttempt.new(
+  attempted_at: null,
+  status_code: null,
+  duration_ms: null,
+  response_body: null,
+  error: null
+)
+```
+

data/docs/WebhookEvent.md

@@ -0,0 +1,28 @@
+# Growwer::WebhookEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **type** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **api_version** | **String** |  |  |
+| **mode** | **String** | The mode of the subscription it is sent to. |  |
+| **data** | [**WebhookEventData**](WebhookEventData.md) |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::WebhookEvent.new(
+  id: null,
+  type: null,
+  created_at: null,
+  api_version: null,
+  mode: null,
+  data: null
+)
+```
+

data/docs/WebhookEventData.md

@@ -0,0 +1,51 @@
+# Growwer::WebhookEventData
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'growwer'
+
+Growwer::WebhookEventData.openapi_one_of
+# =>
+# [
+#   :'BalanceLowEventData',
+#   :'OrderEventData',
+#   :'WebhookTestEventData'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'growwer'
+
+Growwer::WebhookEventData.build(data)
+# => #<BalanceLowEventData:0x00007fdd4aab02a0>
+
+Growwer::WebhookEventData.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `BalanceLowEventData`
+- `OrderEventData`
+- `WebhookTestEventData`
+- `nil` (if no type matches)
+

data/docs/WebhookEventType.md

@@ -0,0 +1,15 @@
+# Growwer::WebhookEventType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::WebhookEventType.new()
+```
+

data/docs/WebhookTestEventData.md

@@ -0,0 +1,18 @@
+# Growwer::WebhookTestEventData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** | The subscription it was sent to. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::WebhookTestEventData.new(
+  webhook_id: null
+)
+```
+

data/docs/WebhookWithSecret.md

@@ -0,0 +1,40 @@
+# Growwer::WebhookWithSecret
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **url** | **String** |  |  |
+| **events** | [**Array<WebhookEventType>**](WebhookEventType.md) |  |  |
+| **low_balance_threshold** | [**MoneyOrNull**](MoneyOrNull.md) | With `balance.low`, the available buyer balance below which it fires; null otherwise. |  |
+| **description** | **String** |  |  |
+| **enabled** | **Boolean** | Whether the subscription gets events. |  |
+| **disabled_reason** | **String** | Why it is disabled, null while enabled. `by_user`, through PATCH /webhooks/{id}; `endpoint_gone`, its endpoint answered 410; `failing`, every delivery failed for 5 days, and the account owner was emailed. |  |
+| **failing_since** | **Time** | Since when its deliveries have failed without one succeeding, null while they succeed. At 5 days it is disabled. The check runs at each failed attempt, so a subscription whose `failingSince` is already more than 5 days old, say one that had no event for a while, is disabled at its next failed attempt, without the retries that delivery would otherwise get. |  |
+| **previous_secret_expires_at** | **Time** | Until when the secret replaced by the last rotation still signs beside the new one, null when it no longer does. |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **secret** | **String** | The signing secret, `whsec_` and the base64 of 32 random bytes. Shown only in this answer, and absent when the request is replayed under its `Idempotency-Key` (or the MCP tool under its `requestId`), since the secret is never stored. | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::WebhookWithSecret.new(
+  id: null,
+  url: null,
+  events: null,
+  low_balance_threshold: null,
+  description: null,
+  enabled: null,
+  disabled_reason: null,
+  failing_since: null,
+  previous_secret_expires_at: null,
+  created_at: null,
+  updated_at: null,
+  secret: whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw
+)
+```
+