growwer 1.0.0

data/docs/PostOrderBriefing.md

@@ -0,0 +1,28 @@
+# Growwer::PostOrderBriefing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  |  |
+| **language** | **String** | The language code of the article. |  |
+| **links** | [**Array<OrderLink>**](OrderLink.md) |  |  |
+| **extra_services** | **Array<String>** |  |  |
+| **additional_info** | **String** |  |  |
+| **has_proposed_draft** | **Boolean** | Whether you attached your own draft; GET /orders/{id}/briefing downloads it. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::PostOrderBriefing.new(
+  title: null,
+  language: null,
+  links: null,
+  extra_services: null,
+  additional_info: null,
+  has_proposed_draft: null
+)
+```
+

data/docs/PostOrderBriefingRequest.md

@@ -0,0 +1,24 @@
+# Growwer::PostOrderBriefingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<OrderLinkRequest>**](OrderLinkRequest.md) | No more links than the offer allows. |  |
+| **extra_services** | **Array<String>** | Extra services the offer has, added to the ones the web selects for your project by default. A project with a sensitive topic always carries `extra_charge_for_sensitive_topic` when the media charges it. | [optional] |
+| **title** | **String** |  | [optional] |
+| **additional_info** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::PostOrderBriefingRequest.new(
+  links: null,
+  extra_services: null,
+  title: null,
+  additional_info: null
+)
+```
+

data/docs/Project.md

@@ -0,0 +1,38 @@
+# Growwer::Project
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** | Your name for the project, or null when it has none. |  |
+| **root_url** | **String** | The website the project promotes. It cannot be changed once the project exists. |  |
+| **website_type** | **String** | What the website is: an online shop (`ecommerce`), a services business (`services`) or anything else (`other`). |  |
+| **topics** | **Array<Integer>** | The website's topic, as a topic id from GET /vocabulary. Exactly one. |  |
+| **language** | **String** | The language of the campaign, as a language code from GET /vocabulary. |  |
+| **country** | **String** | The country the campaign targets, as a country code from GET /vocabulary, or null for worldwide. |  |
+| **promoted_products** | **Array<String>** | The products or services the campaign promotes, 5 to 10. |  |
+| **user_keywords** | **Array<String>** | Keywords you want the campaign to target, at most 100. |  |
+| **state** | **String** | `finished` once Growwer has recommended media for the project, `analyzing` until then. Analysis can take hours, and it never finishes when no medium matches the project. Poll with backoff, and use `createdAt` to decide how long to keep polling.  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::Project.new(
+  id: null,
+  name: null,
+  root_url: null,
+  website_type: null,
+  topics: null,
+  language: es,
+  country: ES,
+  promoted_products: null,
+  user_keywords: null,
+  state: null,
+  created_at: null
+)
+```
+

data/docs/ProjectCatalogueMedia.md

@@ -0,0 +1,48 @@
+# Growwer::ProjectCatalogueMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **domain** | **String** |  |  |
+| **type** | **String** |  |  |
+| **language** | **String** | A language code, as in GET /vocabulary. |  |
+| **country** | **String** | A country code, as in GET /vocabulary, or null for none. |  |
+| **topics** | **Array<Integer>** | Topic ids, as in GET /vocabulary. |  |
+| **metrics** | [**CatalogueMediaMetrics**](CatalogueMediaMetrics.md) |  |  |
+| **positive_traffic_trend** | **Boolean** |  |  |
+| **best_seller** | **Boolean** |  |  |
+| **publication_rate** | **Integer** | The share of the media's orders that were published, in percent, or null without orders. |  |
+| **average_days_to_publication** | **Integer** | The average days from order to publication, or null without published orders. |  |
+| **on_holiday** | **Boolean** | Whether the media is on holiday and will take longer to publish. |  |
+| **flash_offer** | [**CatalogueMediaFlashOffer**](CatalogueMediaFlashOffer.md) |  |  |
+| **post_offer** | [**CataloguePostOffer**](CataloguePostOffer.md) |  |  |
+| **link_addition_offer** | [**CatalogueOfferOrNull**](CatalogueOfferOrNull.md) | Adding a link to an existing article, or null when the media does not offer it. |  |
+| **project** | [**ProjectCatalogueMediaAllOfProject**](ProjectCatalogueMediaAllOfProject.md) |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::ProjectCatalogueMedia.new(
+  id: null,
+  domain: example.com,
+  type: null,
+  language: null,
+  country: null,
+  topics: null,
+  metrics: null,
+  positive_traffic_trend: null,
+  best_seller: null,
+  publication_rate: null,
+  average_days_to_publication: null,
+  on_holiday: null,
+  flash_offer: null,
+  post_offer: null,
+  link_addition_offer: null,
+  project: null
+)
+```
+

data/docs/ProjectCatalogueMediaAllOfProject.md

@@ -0,0 +1,28 @@
+# Growwer::ProjectCatalogueMediaAllOfProject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **favourite** | **Boolean** |  |  |
+| **discarded** | **Boolean** |  |  |
+| **requested** | **Boolean** |  |  |
+| **recommended** | **Boolean** | Growwer recommends the media for the project. |  |
+| **bought** | **Boolean** | You have ordered on the media for the project. |  |
+| **new** | **Boolean** | Growwer matched the media with the project recently. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::ProjectCatalogueMediaAllOfProject.new(
+  favourite: null,
+  discarded: null,
+  requested: null,
+  recommended: null,
+  bought: null,
+  new: null
+)
+```
+

data/docs/ProjectsApi.md

@@ -0,0 +1,368 @@
+# Growwer::ProjectsApi
+
+All URIs are relative to *https://tool.growwer.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_project**](ProjectsApi.md#create_project) | **POST** /api/v1/projects | Create a project |
+| [**delete_project**](ProjectsApi.md#delete_project) | **DELETE** /api/v1/projects/{id} | Delete a project |
+| [**get_project**](ProjectsApi.md#get_project) | **GET** /api/v1/projects/{id} | Get a project |
+| [**list_projects**](ProjectsApi.md#list_projects) | **GET** /api/v1/projects | List your projects |
+| [**update_project**](ProjectsApi.md#update_project) | **PATCH** /api/v1/projects/{id} | Edit a project |
+
+
+## create_project
+
+> <Project> create_project(idempotency_key, create_project_request)
+
+Create a project
+
+Creates a project for a website, as the web's project creation does. Growwer then analyses it in the background to recommend media: the project is answered with `state: analyzing` and turns `finished` when the analysis ends. Analysis can take hours, and it never finishes when no medium matches the project, so poll GET /projects/{id} with backoff and use `createdAt` to decide when to stop.  Every value is validated as on the web: `topics`, `language` and `country` take the identifiers GET /vocabulary publishes.  Creating a project also categorises its website through an external service, as the web does. When that service fails the answer is 500, although the project may already be saved, and a retry under the same Idempotency-Key answers 409 `idempotency_outcome_unknown`. After either, list your projects (GET /projects) before retrying with a new key, or you may create a duplicate.
+
+### 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::ProjectsApi.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`.
+create_project_request = Growwer::CreateProjectRequest.new({root_url: 'https://www.example.com', website_type: 'ecommerce', topics: [37], language: 'es', promoted_products: ['promoted_products_example']}) # CreateProjectRequest | 
+
+begin
+  # Create a project
+  result = api_instance.create_project(idempotency_key, create_project_request)
+  p result
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->create_project: #{e}"
+end
+```
+
+#### Using the create_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Project>, Integer, Hash)> create_project_with_http_info(idempotency_key, create_project_request)
+
+```ruby
+begin
+  # Create a project
+  data, status_code, headers = api_instance.create_project_with_http_info(idempotency_key, create_project_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Project>
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->create_project_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;. |  |
+| **create_project_request** | [**CreateProjectRequest**](CreateProjectRequest.md) |  |  |
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_project
+
+> delete_project(id, idempotency_key)
+
+Delete a project
+
+Deletes one of your projects. A project with an order in progress cannot be deleted until its orders finish.
+
+### 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::ProjectsApi.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`.
+
+begin
+  # Delete a project
+  api_instance.delete_project(id, idempotency_key)
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->delete_project: #{e}"
+end
+```
+
+#### Using the delete_project_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)> delete_project_with_http_info(id, idempotency_key)
+
+```ruby
+begin
+  # Delete a project
+  data, status_code, headers = api_instance.delete_project_with_http_info(id, idempotency_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->delete_project_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;. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_project
+
+> <Project> get_project(id)
+
+Get a project
+
+One of your projects. Poll it to follow `state` after creating the project.
+
+### 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::ProjectsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get a project
+  result = api_instance.get_project(id)
+  p result
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->get_project: #{e}"
+end
+```
+
+#### Using the get_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Project>, Integer, Hash)> get_project_with_http_info(id)
+
+```ruby
+begin
+  # Get a project
+  data, status_code, headers = api_instance.get_project_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Project>
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->get_project_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_projects
+
+> <ListProjects200Response> list_projects(opts)
+
+List your projects
+
+Your projects, newest first.
+
+### 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::ProjectsApi.new
+opts = {
+  limit: 56, # Integer | Projects per page, 1 to 100.
+  offset: 56 # Integer | Projects to skip.
+}
+
+begin
+  # List your projects
+  result = api_instance.list_projects(opts)
+  p result
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->list_projects: #{e}"
+end
+```
+
+#### Using the list_projects_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListProjects200Response>, Integer, Hash)> list_projects_with_http_info(opts)
+
+```ruby
+begin
+  # List your projects
+  data, status_code, headers = api_instance.list_projects_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListProjects200Response>
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->list_projects_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Projects per page, 1 to 100. | [optional][default to 20] |
+| **offset** | **Integer** | Projects to skip. | [optional][default to 0] |
+
+### Return type
+
+[**ListProjects200Response**](ListProjects200Response.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_project
+
+> <Project> update_project(id, idempotency_key, update_project_request)
+
+Edit a project
+
+Changes only the fields you send. `rootUrl` cannot be changed; any field not listed here is refused. Changing `language`, `country`, `promotedProducts` or `topics` makes Growwer categorise the project and work out its target keywords again, in the background.
+
+### 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::ProjectsApi.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`.
+update_project_request = Growwer::UpdateProjectRequest.new # UpdateProjectRequest | 
+
+begin
+  # Edit a project
+  result = api_instance.update_project(id, idempotency_key, update_project_request)
+  p result
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->update_project: #{e}"
+end
+```
+
+#### Using the update_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Project>, Integer, Hash)> update_project_with_http_info(id, idempotency_key, update_project_request)
+
+```ruby
+begin
+  # Edit a project
+  data, status_code, headers = api_instance.update_project_with_http_info(id, idempotency_key, update_project_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Project>
+rescue Growwer::ApiError => e
+  puts "Error when calling ProjectsApi->update_project_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;. |  |
+| **update_project_request** | [**UpdateProjectRequest**](UpdateProjectRequest.md) |  |  |
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PutSellerHoliday200Response.md

@@ -0,0 +1,20 @@
+# Growwer::PutSellerHoliday200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **on_holiday** | **Boolean** |  |  |
+| **end_date** | **Date** | The day the holiday ends, at 00:00 of that day in Growwer's server time, or null for none. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::PutSellerHoliday200Response.new(
+  on_holiday: null,
+  end_date: null
+)
+```
+

data/docs/PutSellerHolidayRequest.md

@@ -0,0 +1,20 @@
+# Growwer::PutSellerHolidayRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **on_holiday** | **Boolean** |  |  |
+| **end_date** | **Date** |  | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::PutSellerHolidayRequest.new(
+  on_holiday: null,
+  end_date: Tue Dec 01 00:00:00 UTC 2026
+)
+```
+

data/docs/RequestMedias201Response.md

@@ -0,0 +1,18 @@
+# Growwer::RequestMedias201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domains** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::RequestMedias201Response.new(
+  domains: null
+)
+```
+

data/docs/RequestMediasRequest.md

@@ -0,0 +1,18 @@
+# Growwer::RequestMediasRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domains** | **Array<String>** | Domains or URLs, 1 to 200 distinct domains. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::RequestMediasRequest.new(
+  domains: null
+)
+```
+

data/docs/SavedFilter.md

@@ -0,0 +1,26 @@
+# Growwer::SavedFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **active_filter_count** | **Integer** | How many filters it applies. |  |
+| **notifications** | [**SavedFilterNotifications**](SavedFilterNotifications.md) |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::SavedFilter.new(
+  id: null,
+  name: null,
+  active_filter_count: null,
+  notifications: null,
+  created_at: null
+)
+```
+

data/docs/SavedFilterNotifications.md

@@ -0,0 +1,20 @@
+# Growwer::SavedFilterNotifications
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  |  |
+| **frequency** | **String** | How often Growwer emails new matching medias, or null when it does not. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::SavedFilterNotifications.new(
+  enabled: null,
+  frequency: null
+)
+```
+