growwer 1.0.0

data/docs/CatalogueMedia.md

@@ -0,0 +1,46 @@
+# Growwer::CatalogueMedia
+
+## 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. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CatalogueMedia.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
+)
+```
+

data/docs/CatalogueMediaFlashOffer.md

@@ -0,0 +1,20 @@
+# Growwer::CatalogueMediaFlashOffer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount_percent** | **Integer** |  |  |
+| **ends_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CatalogueMediaFlashOffer.new(
+  discount_percent: null,
+  ends_at: null
+)
+```
+

data/docs/CatalogueMediaMetrics.md

@@ -0,0 +1,26 @@
+# Growwer::CatalogueMediaMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organic_traffic** | **Float** | Monthly organic traffic. |  |
+| **domain_rating** | **Float** |  |  |
+| **referring_domains** | **Float** |  |  |
+| **linked_domains** | **Float** |  |  |
+| **linked_to_referring_ratio** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CatalogueMediaMetrics.new(
+  organic_traffic: null,
+  domain_rating: null,
+  referring_domains: null,
+  linked_domains: null,
+  linked_to_referring_ratio: null
+)
+```
+

data/docs/CatalogueOffer.md

@@ -0,0 +1,24 @@
+# Growwer::CatalogueOffer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price** | [**Money**](Money.md) | What you pay for the offer with its dearest link type, flash offer discount included. |  |
+| **link_type** | **String** | The link type `price` is for. |  |
+| **prices** | [**Hash<String, Money>**](Money.md) | What you pay for each link type the offer gives, by link type. |  |
+| **previous_price** | [**MoneyOrNull**](MoneyOrNull.md) | The highest price the offer has had, when `price` is more than 5% below it; otherwise null. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CatalogueOffer.new(
+  price: null,
+  link_type: null,
+  prices: null,
+  previous_price: null
+)
+```
+

data/docs/CatalogueOfferOrNull.md

@@ -0,0 +1,24 @@
+# Growwer::CatalogueOfferOrNull
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price** | [**Money**](Money.md) | What you pay for the offer with its dearest link type, flash offer discount included. |  |
+| **link_type** | **String** | The link type `price` is for. |  |
+| **prices** | [**Hash<String, Money>**](Money.md) | What you pay for each link type the offer gives, by link type. |  |
+| **previous_price** | [**MoneyOrNull**](MoneyOrNull.md) | The highest price the offer has had, when `price` is more than 5% below it; otherwise null. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CatalogueOfferOrNull.new(
+  price: null,
+  link_type: null,
+  prices: null,
+  previous_price: null
+)
+```
+

data/docs/CataloguePostOffer.md

@@ -0,0 +1,30 @@
+# Growwer::CataloguePostOffer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price** | [**Money**](Money.md) | What you pay for the offer with its dearest link type, flash offer discount included. |  |
+| **link_type** | **String** | The link type `price` is for. |  |
+| **prices** | [**Hash<String, Money>**](Money.md) | What you pay for each link type the offer gives, by link type. |  |
+| **previous_price** | [**MoneyOrNull**](MoneyOrNull.md) | The highest price the offer has had, when `price` is more than 5% below it; otherwise null. |  |
+| **advertising_label** | **Boolean** | Whether the media always labels posts as advertising. |  |
+| **promoted_social_networks** | **Array<String>** | Where the media promotes the post. |  |
+| **extras** | [**CataloguePostOfferAllOfExtras**](CataloguePostOfferAllOfExtras.md) |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CataloguePostOffer.new(
+  price: null,
+  link_type: null,
+  prices: null,
+  previous_price: null,
+  advertising_label: null,
+  promoted_social_networks: null,
+  extras: null
+)
+```
+

data/docs/CataloguePostOfferAllOfExtras.md

@@ -0,0 +1,20 @@
+# Growwer::CataloguePostOfferAllOfExtras
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **homepage_listing** | [**MoneyOrNull**](MoneyOrNull.md) | What listing the post on the homepage costs, or null when the media does not offer it. |  |
+| **sensitive_topic** | [**CataloguePostOfferAllOfExtrasSensitiveTopic**](CataloguePostOfferAllOfExtrasSensitiveTopic.md) |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CataloguePostOfferAllOfExtras.new(
+  homepage_listing: null,
+  sensitive_topic: null
+)
+```
+

data/docs/CataloguePostOfferAllOfExtrasSensitiveTopic.md

@@ -0,0 +1,20 @@
+# Growwer::CataloguePostOfferAllOfExtrasSensitiveTopic
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed** | **Boolean** | Whether the media publishes on sensitive topics. |  |
+| **extra_price** | [**MoneyOrNull**](MoneyOrNull.md) | What a post on a sensitive topic costs on top, or null when it costs nothing more. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CataloguePostOfferAllOfExtrasSensitiveTopic.new(
+  allowed: null,
+  extra_price: null
+)
+```
+

data/docs/CodeName.md

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

data/docs/CountSavedFilterMedias200Response.md

@@ -0,0 +1,18 @@
+# Growwer::CountSavedFilterMedias200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CountSavedFilterMedias200Response.new(
+  count: null
+)
+```
+

data/docs/CreateProjectRequest.md

@@ -0,0 +1,32 @@
+# Growwer::CreateProjectRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **root_url** | **String** |  |  |
+| **website_type** | **String** |  |  |
+| **topics** | **Array<Integer>** | Exactly one topic id from GET /vocabulary. |  |
+| **language** | **String** | A language code from GET /vocabulary. |  |
+| **country** | **String** | A country code from GET /vocabulary; omit it or send null for worldwide. | [optional] |
+| **promoted_products** | **Array<String>** | 5 to 10 products or services the campaign promotes. |  |
+| **user_keywords** | **Array<String>** | At most 100 keywords, none with a line break. | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CreateProjectRequest.new(
+  name: null,
+  root_url: https://www.example.com,
+  website_type: null,
+  topics: null,
+  language: es,
+  country: ES,
+  promoted_products: null,
+  user_keywords: null
+)
+```
+

data/docs/CreateSavedFilterRequest.md

@@ -0,0 +1,22 @@
+# Growwer::CreateSavedFilterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | 1 to 255 characters. |  |
+| **filters** | **Hash<String, Object>** | At least one filter parameter of GET /projects/{id}/medias, or `source`, by name. |  |
+| **notification_frequency** | **String** | Email new matching medias this often. Omit it for no emails. | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::CreateSavedFilterRequest.new(
+  name: null,
+  filters: {"language":["es"],"minDomainRating":30,"favourite":true},
+  notification_frequency: null
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,24 @@
+# Growwer::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | A stable, machine-readable error code. |  |
+| **message** | **String** | A human-readable explanation. It may change. |  |
+| **request_id** | **String** | The X-Request-Id of the call. Quote it when reporting a problem. |  |
+| **details** | **Hash<String, Object>** | Extra data on some errors, such as the invalid fields of a validation_failed error. | [optional] |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::Error.new(
+  code: unauthorized,
+  message: null,
+  request_id: null,
+  details: null
+)
+```
+

data/docs/FilesApi.md

@@ -0,0 +1,79 @@
+# Growwer::FilesApi
+
+All URIs are relative to *https://tool.growwer.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**upload_file**](FilesApi.md#upload_file) | **POST** /api/v1/files | Upload a file |
+
+
+## upload_file
+
+> <UploadFile201Response> upload_file(idempotency_key, file)
+
+Upload a file
+
+Uploads a document (odt, doc, docx or txt, up to 8 MB) for a later write to reference by its `id`. A file belongs to you, can be used by one write, and expires 24 hours after it was uploaded; an expired or used file is answered like an unknown one.
+
+### 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::FilesApi.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`.
+file = File.new('/path/to/some/file') # File | 
+
+begin
+  # Upload a file
+  result = api_instance.upload_file(idempotency_key, file)
+  p result
+rescue Growwer::ApiError => e
+  puts "Error when calling FilesApi->upload_file: #{e}"
+end
+```
+
+#### Using the upload_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UploadFile201Response>, Integer, Hash)> upload_file_with_http_info(idempotency_key, file)
+
+```ruby
+begin
+  # Upload a file
+  data, status_code, headers = api_instance.upload_file_with_http_info(idempotency_key, file)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UploadFile201Response>
+rescue Growwer::ApiError => e
+  puts "Error when calling FilesApi->upload_file_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;. |  |
+| **file** | **File** |  |  |
+
+### Return type
+
+[**UploadFile201Response**](UploadFile201Response.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/GetBuyerWallet200Response.md

@@ -0,0 +1,20 @@
+# Growwer::GetBuyerWallet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance** | [**Balance**](Balance.md) |  |  |
+| **top_up_url** | **String** | The wallet page, in your language (English when the web is not available in it), where you top up your balance. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetBuyerWallet200Response.new(
+  balance: null,
+  top_up_url: null
+)
+```
+

data/docs/GetMe200Response.md

@@ -0,0 +1,34 @@
+# Growwer::GetMe200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **email** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **language** | **String** | The language Growwer writes to you in. |  |
+| **created_at** | **Time** |  |  |
+| **buyer** | [**GetMe200ResponseBuyer**](GetMe200ResponseBuyer.md) |  |  |
+| **seller** | [**GetMe200ResponseSeller**](GetMe200ResponseSeller.md) |  |  |
+| **catalogue** | [**GetMe200ResponseCatalogue**](GetMe200ResponseCatalogue.md) |  |  |
+| **managed_service** | [**GetMe200ResponseManagedService**](GetMe200ResponseManagedService.md) |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetMe200Response.new(
+  id: null,
+  email: null,
+  first_name: null,
+  language: en,
+  created_at: null,
+  buyer: null,
+  seller: null,
+  catalogue: null,
+  managed_service: null
+)
+```
+

data/docs/GetMe200ResponseBuyer.md

@@ -0,0 +1,18 @@
+# Growwer::GetMe200ResponseBuyer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance** | [**Balance**](Balance.md) |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetMe200ResponseBuyer.new(
+  balance: null
+)
+```
+

data/docs/GetMe200ResponseCatalogue.md

@@ -0,0 +1,18 @@
+# Growwer::GetMe200ResponseCatalogue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **eligible** | **Boolean** | Whether the catalogue operations (tag Catalogue: searching a project's medias, flash offers and media details) are open to you. They are open to accounts with recent completed orders, as buyer or as seller; until then they answer 403 `catalogue_requires_recent_order`. A media you have ordered is always readable with GET /medias/{id}. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetMe200ResponseCatalogue.new(
+  eligible: null
+)
+```
+

data/docs/GetMe200ResponseManagedService.md

@@ -0,0 +1,18 @@
+# Growwer::GetMe200ResponseManagedService
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Whether you have a managed service: Growwer's team runs link building campaigns for you (tag Managed services). With one, request a new campaign with POST /managed-service/campaign-requests; without one, ask about the service with POST /managed-service/info-requests. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetMe200ResponseManagedService.new(
+  active: null
+)
+```
+

data/docs/GetMe200ResponseSeller.md

@@ -0,0 +1,24 @@
+# Growwer::GetMe200ResponseSeller
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance** | [**Balance**](Balance.md) |  |  |
+| **restricted** | **Boolean** | Whether your seller account is restricted: it accepts no orders and its balance is held. Contact support for the reason. |  |
+| **on_holiday** | **Boolean** | Whether you are on holiday: your medias take no orders. Set it with PUT /seller/holiday. |  |
+| **holiday_end_date** | **Date** | The day your holiday ends, at 00:00 of that day in Growwer's server time, or null when you are not on holiday or end it yourself. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetMe200ResponseSeller.new(
+  balance: null,
+  restricted: null,
+  on_holiday: null,
+  holiday_end_date: null
+)
+```
+

data/docs/GetSellerWallet200Response.md

@@ -0,0 +1,20 @@
+# Growwer::GetSellerWallet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance** | [**Balance**](Balance.md) |  |  |
+| **restricted** | **Boolean** | Whether your seller account is restricted. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetSellerWallet200Response.new(
+  balance: null,
+  restricted: null
+)
+```
+

data/docs/GetVocabulary200Response.md

@@ -0,0 +1,28 @@
+# Growwer::GetVocabulary200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **countries** | [**Array<CodeName>**](CodeName.md) | ISO 3166-1 alpha-2 codes. |  |
+| **languages** | [**Array<CodeName>**](CodeName.md) | ISO 639 codes, as the web's language selectors offer them. |  |
+| **topics** | [**Array<GetVocabulary200ResponseTopicsInner>**](GetVocabulary200ResponseTopicsInner.md) |  |  |
+| **product_types** | **Array<String>** | What an order buys: a sponsored post, or a link added to an existing page. |  |
+| **link_types** | **Array<String>** |  |  |
+| **order_states** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::GetVocabulary200Response.new(
+  countries: null,
+  languages: null,
+  topics: null,
+  product_types: null,
+  link_types: null,
+  order_states: null
+)
+```
+

data/docs/GetVocabulary200ResponseTopicsInner.md

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

data/docs/Invoice.md

@@ -0,0 +1,24 @@
+# Growwer::Invoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **number** | **String** |  |  |
+| **issued_at** | **Time** |  |  |
+| **total** | [**Money**](Money.md) | The invoice total, taxes included. |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::Invoice.new(
+  id: null,
+  number: null,
+  issued_at: null,
+  total: null
+)
+```
+

data/docs/LinkAdditionOrderBriefing.md

@@ -0,0 +1,22 @@
+# Growwer::LinkAdditionOrderBriefing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **linking_from** | **String** | The existing article of the media the link goes into. |  |
+| **link** | [**OrderLink**](OrderLink.md) |  |  |
+| **additional_info** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'growwer'
+
+instance = Growwer::LinkAdditionOrderBriefing.new(
+  linking_from: null,
+  link: null,
+  additional_info: null
+)
+```
+