growwer 1.0.0

data/docs/OrderBriefing.md

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

data/docs/OrderChannel.md

@@ -0,0 +1,18 @@
+# Growwer::OrderChannel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **String** | Whether the order was placed through this API or on the web. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderChannel.new(
+  created: null
+)
+```
+

data/docs/OrderCreateRequest.md

@@ -0,0 +1,32 @@
+# Growwer::OrderCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **project_id** | **String** | One of your projects. |  |
+| **media_id** | **String** | A media you can order for the project (GET /projects/{id}/medias). |  |
+| **briefing** | [**OrderEstimateRequestBriefing**](OrderEstimateRequestBriefing.md) |  |  |
+| **scheduled_publication_date** | **Date** | The day to publish on, at least a few days ahead as the web requires. | [optional] |
+| **draft_reviewable** | **Boolean** | Whether you review the draft before it is published. Defaults to false. | [optional] |
+| **proposed_draft_file_id** | **String** | A file uploaded with POST /files to propose your own draft. The estimate checks it without using it up. | [optional] |
+| **expected_price** | [**Money**](Money.md) | The `price` POST /orders/estimate answered. Only EUR is accepted. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderCreateRequest.new(
+  type: null,
+  project_id: null,
+  media_id: null,
+  briefing: null,
+  scheduled_publication_date: null,
+  draft_reviewable: null,
+  proposed_draft_file_id: null,
+  expected_price: null
+)
+```
+

data/docs/OrderDelivery.md

@@ -0,0 +1,20 @@
+# Growwer::OrderDelivery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The published article, or for a link addition the article the link went into. |  |
+| **published_at** | **Time** | When the post was published; null for a link addition. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderDelivery.new(
+  url: null,
+  published_at: null
+)
+```
+

data/docs/OrderDraft.md

@@ -0,0 +1,22 @@
+# Growwer::OrderDraft
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authored_by_buyer** | **Boolean** | Whether you write the draft. |  |
+| **reviewable** | **Boolean** | Whether you review the draft before it is published. |  |
+| **has_file** | **Boolean** | Whether the current draft has a file; GET /orders/{id}/draft downloads it. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderDraft.new(
+  authored_by_buyer: null,
+  reviewable: null,
+  has_file: null
+)
+```
+

data/docs/OrderEstimate.md

@@ -0,0 +1,24 @@
+# Growwer::OrderEstimate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price** | [**Money**](Money.md) | What the order costs you. Send it as `expectedPrice`. |  |
+| **available_balance** | [**Money**](Money.md) | Your wallet's available balance. |  |
+| **missing** | [**Money**](Money.md) | How much the available balance falls short of the price; zero when it covers it. |  |
+| **sufficient_balance** | **Boolean** | Whether the available balance covers the price. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderEstimate.new(
+  price: null,
+  available_balance: null,
+  missing: null,
+  sufficient_balance: null
+)
+```
+

data/docs/OrderEstimateRequest.md

@@ -0,0 +1,30 @@
+# Growwer::OrderEstimateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **project_id** | **String** | One of your projects. |  |
+| **media_id** | **String** | A media you can order for the project (GET /projects/{id}/medias). |  |
+| **briefing** | [**OrderEstimateRequestBriefing**](OrderEstimateRequestBriefing.md) |  |  |
+| **scheduled_publication_date** | **Date** | The day to publish on, at least a few days ahead as the web requires. | [optional] |
+| **draft_reviewable** | **Boolean** | Whether you review the draft before it is published. Defaults to false. | [optional] |
+| **proposed_draft_file_id** | **String** | A file uploaded with POST /files to propose your own draft. The estimate checks it without using it up. | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderEstimateRequest.new(
+  type: null,
+  project_id: null,
+  media_id: null,
+  briefing: null,
+  scheduled_publication_date: null,
+  draft_reviewable: null,
+  proposed_draft_file_id: null
+)
+```
+

data/docs/OrderEstimateRequestBriefing.md

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

data/docs/OrderLink.md

@@ -0,0 +1,22 @@
+# Growwer::OrderLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target_url** | **String** | Where the link points, or null for a citation. |  |
+| **anchor** | **String** | The anchor text, or null when the media chooses it. A citation always has one. |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderLink.new(
+  target_url: null,
+  anchor: null,
+  type: null
+)
+```
+

data/docs/OrderLinkRequest.md

@@ -0,0 +1,22 @@
+# Growwer::OrderLinkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target_url** | **String** | Where the link points; leave it out for a citation. | [optional] |
+| **anchor** | **String** | The anchor text; leave it out to let the media choose it. A citation needs one. | [optional] |
+| **type** | **String** | A link type the media offers for this type of order (CatalogueOffer `linkTypes`). |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderLinkRequest.new(
+  target_url: null,
+  anchor: null,
+  type: null
+)
+```
+

data/docs/OrderMedia.md

@@ -0,0 +1,20 @@
+# Growwer::OrderMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Null once the media is deleted. |  |
+| **url** | **String** | The media's URL when the order was placed. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderMedia.new(
+  id: null,
+  url: null
+)
+```
+

data/docs/OrderProject.md

@@ -0,0 +1,20 @@
+# Growwer::OrderProject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Null once the project is deleted. |  |
+| **url** | **String** | The project's URL when the order was placed. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderProject.new(
+  id: null,
+  url: null
+)
+```
+

data/docs/OrderStateHistoryInner.md

@@ -0,0 +1,22 @@
+# Growwer::OrderStateHistoryInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | **String** |  |  |
+| **date** | **Time** |  |  |
+| **reason** | [**OrderStateHistoryInnerReason**](OrderStateHistoryInnerReason.md) |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderStateHistoryInner.new(
+  state: null,
+  date: null,
+  reason: null
+)
+```
+

data/docs/OrderStateHistoryInnerReason.md

@@ -0,0 +1,20 @@
+# Growwer::OrderStateHistoryInnerReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **additional_info** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::OrderStateHistoryInnerReason.new(
+  code: null,
+  additional_info: null
+)
+```
+