growwer 1.1.1 → 2.1.0

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
+)
+```
+