growwer 2.0.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +61 -6
- data/docs/AccountApi.md +1 -1
- data/docs/AdvanceTestOrderRequest.md +18 -0
- data/docs/BalanceLowEventData.md +20 -0
- data/docs/BalanceLowEventDataWallet.md +20 -0
- data/docs/CatalogueApi.md +2 -2
- data/docs/CreateWebhookRequest.md +24 -0
- data/docs/GetMe200Response.md +3 -1
- data/docs/ListWebhookDeliveries200Response.md +20 -0
- data/docs/ListWebhooks200Response.md +20 -0
- data/docs/Money.md +4 -2
- data/docs/MoneyOrNull.md +4 -2
- data/docs/OrderCreateRequest.md +1 -1
- data/docs/OrderEventData.md +18 -0
- data/docs/SellerMedia.md +3 -1
- data/docs/SellerMediaCompetitiveFeesByLinkTypeInner.md +22 -0
- data/docs/SellerMediasApi.md +5 -5
- data/docs/TestHelpersApi.md +222 -0
- data/docs/TopUpTestWallet200Response.md +20 -0
- data/docs/TopUpTestWalletRequest.md +18 -0
- data/docs/UpdateWebhookRequest.md +26 -0
- data/docs/Webhook.md +38 -0
- data/docs/WebhookDelivery.md +32 -0
- data/docs/WebhookDeliveryAttempt.md +26 -0
- data/docs/WebhookEvent.md +28 -0
- data/docs/WebhookEventData.md +51 -0
- data/docs/WebhookEventType.md +15 -0
- data/docs/WebhookTestEventData.md +18 -0
- data/docs/WebhookWithSecret.md +40 -0
- data/docs/WebhooksApi.md +662 -0
- data/growwer.gemspec +1 -1
- data/lib/growwer/api/account_api.rb +3 -3
- data/lib/growwer/api/buyer_orders_api.rb +1 -1
- data/lib/growwer/api/buyer_wallet_api.rb +1 -1
- data/lib/growwer/api/catalogue_api.rb +5 -5
- data/lib/growwer/api/files_api.rb +1 -1
- data/lib/growwer/api/managed_services_api.rb +1 -1
- data/lib/growwer/api/projects_api.rb +1 -1
- data/lib/growwer/api/saved_filters_api.rb +1 -1
- data/lib/growwer/api/seller_account_api.rb +1 -1
- data/lib/growwer/api/seller_medias_api.rb +5 -5
- data/lib/growwer/api/seller_orders_api.rb +1 -1
- data/lib/growwer/api/seller_wallet_api.rb +1 -1
- data/lib/growwer/api/test_helpers_api.rb +254 -0
- data/lib/growwer/api/webhooks_api.rb +707 -0
- data/lib/growwer/api_client.rb +2 -2
- data/lib/growwer/api_error.rb +1 -1
- data/lib/growwer/api_model_base.rb +1 -1
- data/lib/growwer/configuration.rb +1 -1
- data/lib/growwer/models/advance_test_order_request.rb +189 -0
- data/lib/growwer/models/balance.rb +1 -1
- data/lib/growwer/models/balance_low_event_data.rb +192 -0
- data/lib/growwer/models/balance_low_event_data_wallet.rb +192 -0
- data/lib/growwer/models/catalogue_media.rb +1 -1
- data/lib/growwer/models/catalogue_media_flash_offer.rb +1 -1
- data/lib/growwer/models/catalogue_media_metrics.rb +1 -1
- data/lib/growwer/models/catalogue_offer.rb +1 -1
- data/lib/growwer/models/catalogue_offer_or_null.rb +1 -1
- data/lib/growwer/models/catalogue_post_offer.rb +1 -1
- data/lib/growwer/models/catalogue_post_offer_all_of_extras.rb +1 -1
- data/lib/growwer/models/catalogue_post_offer_all_of_extras_sensitive_topic.rb +1 -1
- data/lib/growwer/models/code_name.rb +1 -1
- data/lib/growwer/models/count_saved_filter_medias200_response.rb +1 -1
- data/lib/growwer/models/create_project_request.rb +1 -1
- data/lib/growwer/models/create_saved_filter_request.rb +1 -1
- data/lib/growwer/models/create_seller_media_request.rb +1 -1
- data/lib/growwer/models/create_seller_media_request_post_offer.rb +1 -1
- data/lib/growwer/models/create_webhook_request.rb +248 -0
- data/lib/growwer/models/error.rb +1 -1
- data/lib/growwer/models/get_buyer_wallet200_response.rb +1 -1
- data/lib/growwer/models/get_me200_response.rb +57 -20
- data/lib/growwer/models/get_me200_response_buyer.rb +1 -1
- data/lib/growwer/models/get_me200_response_catalogue.rb +1 -1
- data/lib/growwer/models/get_me200_response_managed_service.rb +1 -1
- data/lib/growwer/models/get_me200_response_seller.rb +2 -1
- data/lib/growwer/models/get_seller_wallet200_response.rb +1 -1
- data/lib/growwer/models/get_vocabulary200_response.rb +1 -1
- data/lib/growwer/models/get_vocabulary200_response_topics_inner.rb +1 -1
- data/lib/growwer/models/invoice.rb +1 -1
- data/lib/growwer/models/link_addition_order_briefing.rb +1 -1
- data/lib/growwer/models/link_addition_order_briefing_request.rb +1 -1
- data/lib/growwer/models/list_buyer_transactions200_response.rb +1 -1
- data/lib/growwer/models/list_flash_offers200_response.rb +1 -1
- data/lib/growwer/models/list_invoices200_response.rb +1 -1
- data/lib/growwer/models/list_managed_service_campaigns200_response.rb +1 -1
- data/lib/growwer/models/list_managed_service_proposals200_response.rb +1 -1
- data/lib/growwer/models/list_orders200_response.rb +1 -1
- data/lib/growwer/models/list_projects200_response.rb +1 -1
- data/lib/growwer/models/list_saved_filters200_response.rb +1 -1
- data/lib/growwer/models/list_seller_medias200_response.rb +1 -1
- data/lib/growwer/models/list_seller_orders200_response.rb +1 -1
- data/lib/growwer/models/list_seller_transactions200_response.rb +1 -1
- data/lib/growwer/models/list_webhook_deliveries200_response.rb +192 -0
- data/lib/growwer/models/list_webhooks200_response.rb +192 -0
- data/lib/growwer/models/list_withdrawals200_response.rb +1 -1
- data/lib/growwer/models/managed_service_campaign.rb +1 -1
- data/lib/growwer/models/managed_service_campaign_project.rb +1 -1
- data/lib/growwer/models/managed_service_campaign_proposal_counts.rb +1 -1
- data/lib/growwer/models/managed_service_campaign_strategy.rb +1 -1
- data/lib/growwer/models/managed_service_proposal.rb +1 -1
- data/lib/growwer/models/managed_service_proposal_briefing.rb +1 -1
- data/lib/growwer/models/managed_service_proposal_briefing_links_inner.rb +1 -1
- data/lib/growwer/models/managed_service_proposal_media.rb +1 -1
- data/lib/growwer/models/managed_service_proposal_review.rb +1 -1
- data/lib/growwer/models/managed_service_proposal_review_request.rb +1 -1
- data/lib/growwer/models/managed_service_proposal_review_request_reviews_inner.rb +1 -1
- data/lib/growwer/models/managed_service_proposals_estimate.rb +1 -1
- data/lib/growwer/models/managed_service_proposals_estimate_request.rb +1 -1
- data/lib/growwer/models/managed_service_request.rb +1 -1
- data/lib/growwer/models/managed_service_request_sent.rb +1 -1
- data/lib/growwer/models/money.rb +16 -6
- data/lib/growwer/models/money_or_null.rb +16 -6
- data/lib/growwer/models/order.rb +1 -1
- data/lib/growwer/models/order_action_reason.rb +1 -1
- data/lib/growwer/models/order_briefing.rb +1 -1
- data/lib/growwer/models/order_channel.rb +1 -1
- data/lib/growwer/models/order_create_request.rb +2 -2
- data/lib/growwer/models/order_delivery.rb +1 -1
- data/lib/growwer/models/order_draft.rb +1 -1
- data/lib/growwer/models/order_estimate.rb +1 -1
- data/lib/growwer/models/order_estimate_request.rb +1 -1
- data/lib/growwer/models/order_estimate_request_briefing.rb +1 -1
- data/lib/growwer/models/order_event_data.rb +165 -0
- data/lib/growwer/models/order_link.rb +1 -1
- data/lib/growwer/models/order_link_request.rb +1 -1
- data/lib/growwer/models/order_media.rb +1 -1
- data/lib/growwer/models/order_project.rb +1 -1
- data/lib/growwer/models/order_state_history_inner.rb +1 -1
- data/lib/growwer/models/order_state_history_inner_reason.rb +1 -1
- data/lib/growwer/models/post_order_briefing.rb +1 -1
- data/lib/growwer/models/post_order_briefing_request.rb +1 -1
- data/lib/growwer/models/project.rb +1 -1
- data/lib/growwer/models/project_catalogue_media.rb +1 -1
- data/lib/growwer/models/project_catalogue_media_all_of_project.rb +1 -1
- data/lib/growwer/models/project_catalogue_media_all_of_project_ai_keywords.rb +1 -1
- data/lib/growwer/models/put_seller_holiday200_response.rb +1 -1
- data/lib/growwer/models/put_seller_holiday_request.rb +1 -1
- data/lib/growwer/models/request_medias201_response.rb +1 -1
- data/lib/growwer/models/request_medias_request.rb +1 -1
- data/lib/growwer/models/saved_filter.rb +1 -1
- data/lib/growwer/models/saved_filter_notifications.rb +1 -1
- data/lib/growwer/models/seller_fees.rb +1 -1
- data/lib/growwer/models/seller_fees_or_null.rb +1 -1
- data/lib/growwer/models/seller_media.rb +18 -3
- data/lib/growwer/models/seller_media_competitive_fees_by_link_type_inner.rb +214 -0
- data/lib/growwer/models/seller_media_flash_offer.rb +1 -1
- data/lib/growwer/models/seller_media_link_addition_offer.rb +1 -1
- data/lib/growwer/models/seller_media_link_addition_offer_pricing_options_inner.rb +1 -1
- data/lib/growwer/models/seller_media_post_offer.rb +1 -1
- data/lib/growwer/models/seller_media_post_offer_pricing_options_inner.rb +1 -1
- data/lib/growwer/models/seller_order.rb +1 -1
- data/lib/growwer/models/seller_order_briefing.rb +1 -1
- data/lib/growwer/models/seller_order_channel.rb +1 -1
- data/lib/growwer/models/seller_order_draft.rb +1 -1
- data/lib/growwer/models/seller_order_draft_file.rb +1 -1
- data/lib/growwer/models/seller_order_post_delivery.rb +1 -1
- data/lib/growwer/models/seller_order_project.rb +1 -1
- data/lib/growwer/models/seller_order_refutation.rb +1 -1
- data/lib/growwer/models/seller_order_rejection.rb +1 -1
- data/lib/growwer/models/seller_order_rejection_reason.rb +1 -1
- data/lib/growwer/models/seller_post_order_briefing.rb +1 -1
- data/lib/growwer/models/seller_transaction.rb +1 -1
- data/lib/growwer/models/top_up_test_wallet200_response.rb +191 -0
- data/lib/growwer/models/top_up_test_wallet_request.rb +165 -0
- data/lib/growwer/models/transaction.rb +1 -1
- data/lib/growwer/models/update_project_request.rb +1 -1
- data/lib/growwer/models/update_seller_media_request.rb +1 -1
- data/lib/growwer/models/update_seller_media_request_extra_services_inner.rb +1 -1
- data/lib/growwer/models/update_seller_media_request_link_addition_offer.rb +1 -1
- data/lib/growwer/models/update_seller_media_request_link_addition_offer_pricing_options_inner.rb +1 -1
- data/lib/growwer/models/update_seller_media_request_post_offer.rb +1 -1
- data/lib/growwer/models/update_seller_media_request_post_offer_pricing_options_inner.rb +1 -1
- data/lib/growwer/models/update_webhook_request.rb +245 -0
- data/lib/growwer/models/upload_file201_response.rb +1 -1
- data/lib/growwer/models/webhook.rb +395 -0
- data/lib/growwer/models/webhook_delivery.rb +365 -0
- data/lib/growwer/models/webhook_delivery_attempt.rb +264 -0
- data/lib/growwer/models/webhook_event.rb +324 -0
- data/lib/growwer/models/webhook_event_data.rb +104 -0
- data/lib/growwer/models/webhook_event_type.rb +46 -0
- data/lib/growwer/models/webhook_test_event_data.rb +166 -0
- data/lib/growwer/models/webhook_with_secret.rb +413 -0
- data/lib/growwer/models/withdrawal.rb +1 -1
- data/lib/growwer/version.rb +2 -2
- data/lib/growwer.rb +22 -1
- data/spec/api/test_helpers_api_spec.rb +74 -0
- data/spec/api/webhooks_api_spec.rb +154 -0
- data/spec/models/advance_test_order_request_spec.rb +40 -0
- data/spec/models/balance_low_event_data_spec.rb +42 -0
- data/spec/models/balance_low_event_data_wallet_spec.rb +42 -0
- data/spec/models/create_webhook_request_spec.rb +54 -0
- data/spec/models/list_webhook_deliveries200_response_spec.rb +42 -0
- data/spec/models/list_webhooks200_response_spec.rb +42 -0
- data/spec/models/order_event_data_spec.rb +36 -0
- data/spec/models/seller_media_competitive_fees_by_link_type_inner_spec.rb +52 -0
- data/spec/models/top_up_test_wallet200_response_spec.rb +42 -0
- data/spec/models/top_up_test_wallet_request_spec.rb +36 -0
- data/spec/models/update_webhook_request_spec.rb +60 -0
- data/spec/models/webhook_delivery_attempt_spec.rb +64 -0
- data/spec/models/webhook_delivery_spec.rb +86 -0
- data/spec/models/webhook_event_data_spec.rb +32 -0
- data/spec/models/webhook_event_spec.rb +78 -0
- data/spec/models/webhook_event_type_spec.rb +30 -0
- data/spec/models/webhook_spec.rb +100 -0
- data/spec/models/webhook_test_event_data_spec.rb +36 -0
- data/spec/models/webhook_with_secret_spec.rb +106 -0
- data/spec/spec_helper.rb +1 -1
- metadata +86 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d614b99ecc86a69e42e7136f83197ca0e308a558250583ac14ae0e6688fdca47
|
|
4
|
+
data.tar.gz: 90b5f78dab6b629dfec21c56c60e49f13610851340a0d702a774289370951491
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5104993bf0eff025bf072dd6d0f763ec3f40ceb4de052e2a1316f42f2efda92cae62ca8103585cbe403d55d5c43cac3fd745e1a24a1afd9c9580063199f24c97
|
|
7
|
+
data.tar.gz: a7302b27e95f9b90aa0d941bf018b9b6f9c595e970ed1025742319a31da80bd8293bd24f2f801e1257ac623f7a585e1703d25154b6b29f5686048a1bea57caf7
|
data/README.md
CHANGED
|
@@ -25,15 +25,39 @@ operation. Keys belong to your account, not to one API key.
|
|
|
25
25
|
409 `idempotency_key_reused`. A write without the header gets 400
|
|
26
26
|
`idempotency_key_required`.
|
|
27
27
|
|
|
28
|
+
Test mode: a test key (`gw_sk_test_` plus 43 characters) works on your
|
|
29
|
+
account's test data alone, apart from the real catalogue: test projects,
|
|
30
|
+
orders and files, and a test wallet that starts at 1,000.00 EUR. Every
|
|
31
|
+
response to a test key carries `Growwer-Mode: test`, and an id of the other
|
|
32
|
+
mode answers 404 as a missing object would.
|
|
33
|
+
- A test order is validated and debited from the test wallet as a live one
|
|
34
|
+
is. A simulated seller accepts it a minute later and delivers it two
|
|
35
|
+
minutes after that; you approve the delivery or request an update.
|
|
36
|
+
- The Test helpers top the test wallet up, move a test order on at once and
|
|
37
|
+
reset your test data. A live key on them gets 403 `test_mode_only`.
|
|
38
|
+
- A test key on the seller and managed service operations, on a project's
|
|
39
|
+
catalogue writes and on media requests gets 403
|
|
40
|
+
`not_available_in_test_mode`.
|
|
41
|
+
- Idempotency keys are scoped per mode: the same `Idempotency-Key` sent with
|
|
42
|
+
a live and a test key never replays the other mode's response.
|
|
43
|
+
|
|
44
|
+
Webhooks: a subscription receives the events of its mode, signed as Standard
|
|
45
|
+
Webhooks. A subscription created with a live key gets the events of your
|
|
46
|
+
orders and your wallet; one created with a test key gets those of your test
|
|
47
|
+
orders and test wallet, with `mode: test`, and never a live event.
|
|
48
|
+
`x-webhooks` lists every event Growwer POSTs and its payload; the
|
|
49
|
+
WebhookEvent schema describes the headers, the signature and the retries.
|
|
50
|
+
|
|
28
51
|
Every response carries `X-Request-Id`. Errors share one shape,
|
|
29
52
|
`{code, message, requestId, details?}`. Money is integer cents plus a
|
|
30
|
-
currency code
|
|
53
|
+
currency code (12500 is 125.00 EUR), answered with `amountDecimal`, the same
|
|
54
|
+
amount as an exact decimal string (\"125.00\"); dates are ISO-8601.
|
|
31
55
|
|
|
32
56
|
|
|
33
57
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
34
58
|
|
|
35
59
|
- API version: 1
|
|
36
|
-
- Package version: 2.
|
|
60
|
+
- Package version: 2.2.0
|
|
37
61
|
- Generator version: 7.24.0
|
|
38
62
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
39
63
|
For more information, please visit [https://growwer.com/contact/](https://growwer.com/contact/)
|
|
@@ -51,16 +75,16 @@ gem build growwer.gemspec
|
|
|
51
75
|
Then either install the gem locally:
|
|
52
76
|
|
|
53
77
|
```shell
|
|
54
|
-
gem install ./growwer-2.
|
|
78
|
+
gem install ./growwer-2.2.0.gem
|
|
55
79
|
```
|
|
56
80
|
|
|
57
|
-
(for development, run `gem install --dev ./growwer-2.
|
|
81
|
+
(for development, run `gem install --dev ./growwer-2.2.0.gem` to install the development dependencies)
|
|
58
82
|
|
|
59
83
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
60
84
|
|
|
61
85
|
Finally add this to the Gemfile:
|
|
62
86
|
|
|
63
|
-
gem 'growwer', '~> 2.
|
|
87
|
+
gem 'growwer', '~> 2.2.0'
|
|
64
88
|
|
|
65
89
|
### Install from Git
|
|
66
90
|
|
|
@@ -157,7 +181,7 @@ Class | Method | HTTP request | Description
|
|
|
157
181
|
*Growwer::SavedFiltersApi* | [**delete_saved_filter**](docs/SavedFiltersApi.md#delete_saved_filter) | **DELETE** /api/v1/projects/{id}/saved-filters/{filterId} | Delete a saved filter
|
|
158
182
|
*Growwer::SavedFiltersApi* | [**list_saved_filters**](docs/SavedFiltersApi.md#list_saved_filters) | **GET** /api/v1/projects/{id}/saved-filters | List the saved filters of a project
|
|
159
183
|
*Growwer::SellerAccountApi* | [**put_seller_holiday**](docs/SellerAccountApi.md#put_seller_holiday) | **PUT** /api/v1/seller/holiday | Set your holiday
|
|
160
|
-
*Growwer::SellerMediasApi* | [**apply_seller_media_competitive_fees**](docs/SellerMediasApi.md#apply_seller_media_competitive_fees) | **POST** /api/v1/seller/medias/{id}/apply-competitive-fees |
|
|
184
|
+
*Growwer::SellerMediasApi* | [**apply_seller_media_competitive_fees**](docs/SellerMediasApi.md#apply_seller_media_competitive_fees) | **POST** /api/v1/seller/medias/{id}/apply-competitive-fees | Lower your fees to the competitive fees Growwer suggests
|
|
161
185
|
*Growwer::SellerMediasApi* | [**create_seller_media**](docs/SellerMediasApi.md#create_seller_media) | **POST** /api/v1/seller/medias | Register a media you sell on
|
|
162
186
|
*Growwer::SellerMediasApi* | [**delete_seller_media**](docs/SellerMediasApi.md#delete_seller_media) | **DELETE** /api/v1/seller/medias/{id} | Delete a media you sell on
|
|
163
187
|
*Growwer::SellerMediasApi* | [**get_seller_media**](docs/SellerMediasApi.md#get_seller_media) | **GET** /api/v1/seller/medias/{id} | Get a media you sell on
|
|
@@ -180,11 +204,26 @@ Class | Method | HTTP request | Description
|
|
|
180
204
|
*Growwer::SellerWalletApi* | [**get_seller_wallet**](docs/SellerWalletApi.md#get_seller_wallet) | **GET** /api/v1/wallets/seller | Get your seller wallet
|
|
181
205
|
*Growwer::SellerWalletApi* | [**list_seller_transactions**](docs/SellerWalletApi.md#list_seller_transactions) | **GET** /api/v1/wallets/seller/transactions | List your seller wallet movements
|
|
182
206
|
*Growwer::SellerWalletApi* | [**list_withdrawals**](docs/SellerWalletApi.md#list_withdrawals) | **GET** /api/v1/withdrawals | List your withdrawals
|
|
207
|
+
*Growwer::TestHelpersApi* | [**advance_test_order**](docs/TestHelpersApi.md#advance_test_order) | **POST** /api/v1/test-helpers/orders/{id}/advance | Advance a test order
|
|
208
|
+
*Growwer::TestHelpersApi* | [**reset_test_data**](docs/TestHelpersApi.md#reset_test_data) | **POST** /api/v1/test-helpers/reset | Reset your test data
|
|
209
|
+
*Growwer::TestHelpersApi* | [**top_up_test_wallet**](docs/TestHelpersApi.md#top_up_test_wallet) | **POST** /api/v1/test-helpers/wallet/top-up | Top up your test wallet
|
|
210
|
+
*Growwer::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /api/v1/webhooks | Create a webhook subscription
|
|
211
|
+
*Growwer::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /api/v1/webhooks/{id} | Delete a webhook subscription
|
|
212
|
+
*Growwer::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /api/v1/webhooks/{id} | Get a webhook subscription
|
|
213
|
+
*Growwer::WebhooksApi* | [**list_webhook_deliveries**](docs/WebhooksApi.md#list_webhook_deliveries) | **GET** /api/v1/webhooks/{id}/deliveries | List the deliveries of a webhook subscription
|
|
214
|
+
*Growwer::WebhooksApi* | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /api/v1/webhooks | List your webhook subscriptions
|
|
215
|
+
*Growwer::WebhooksApi* | [**redeliver_webhook**](docs/WebhooksApi.md#redeliver_webhook) | **POST** /api/v1/webhooks/{id}/deliveries/{deliveryId}/redeliver | Redeliver a webhook event
|
|
216
|
+
*Growwer::WebhooksApi* | [**rotate_webhook_secret**](docs/WebhooksApi.md#rotate_webhook_secret) | **POST** /api/v1/webhooks/{id}/rotate-secret | Rotate a webhook secret
|
|
217
|
+
*Growwer::WebhooksApi* | [**send_webhook_test**](docs/WebhooksApi.md#send_webhook_test) | **POST** /api/v1/webhooks/{id}/test | Send a test event
|
|
218
|
+
*Growwer::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PATCH** /api/v1/webhooks/{id} | Edit a webhook subscription
|
|
183
219
|
|
|
184
220
|
|
|
185
221
|
## Documentation for Models
|
|
186
222
|
|
|
223
|
+
- [Growwer::AdvanceTestOrderRequest](docs/AdvanceTestOrderRequest.md)
|
|
187
224
|
- [Growwer::Balance](docs/Balance.md)
|
|
225
|
+
- [Growwer::BalanceLowEventData](docs/BalanceLowEventData.md)
|
|
226
|
+
- [Growwer::BalanceLowEventDataWallet](docs/BalanceLowEventDataWallet.md)
|
|
188
227
|
- [Growwer::CatalogueMedia](docs/CatalogueMedia.md)
|
|
189
228
|
- [Growwer::CatalogueMediaFlashOffer](docs/CatalogueMediaFlashOffer.md)
|
|
190
229
|
- [Growwer::CatalogueMediaMetrics](docs/CatalogueMediaMetrics.md)
|
|
@@ -199,6 +238,7 @@ Class | Method | HTTP request | Description
|
|
|
199
238
|
- [Growwer::CreateSavedFilterRequest](docs/CreateSavedFilterRequest.md)
|
|
200
239
|
- [Growwer::CreateSellerMediaRequest](docs/CreateSellerMediaRequest.md)
|
|
201
240
|
- [Growwer::CreateSellerMediaRequestPostOffer](docs/CreateSellerMediaRequestPostOffer.md)
|
|
241
|
+
- [Growwer::CreateWebhookRequest](docs/CreateWebhookRequest.md)
|
|
202
242
|
- [Growwer::Error](docs/Error.md)
|
|
203
243
|
- [Growwer::GetBuyerWallet200Response](docs/GetBuyerWallet200Response.md)
|
|
204
244
|
- [Growwer::GetMe200Response](docs/GetMe200Response.md)
|
|
@@ -223,6 +263,8 @@ Class | Method | HTTP request | Description
|
|
|
223
263
|
- [Growwer::ListSellerMedias200Response](docs/ListSellerMedias200Response.md)
|
|
224
264
|
- [Growwer::ListSellerOrders200Response](docs/ListSellerOrders200Response.md)
|
|
225
265
|
- [Growwer::ListSellerTransactions200Response](docs/ListSellerTransactions200Response.md)
|
|
266
|
+
- [Growwer::ListWebhookDeliveries200Response](docs/ListWebhookDeliveries200Response.md)
|
|
267
|
+
- [Growwer::ListWebhooks200Response](docs/ListWebhooks200Response.md)
|
|
226
268
|
- [Growwer::ListWithdrawals200Response](docs/ListWithdrawals200Response.md)
|
|
227
269
|
- [Growwer::ManagedServiceCampaign](docs/ManagedServiceCampaign.md)
|
|
228
270
|
- [Growwer::ManagedServiceCampaignProject](docs/ManagedServiceCampaignProject.md)
|
|
@@ -251,6 +293,7 @@ Class | Method | HTTP request | Description
|
|
|
251
293
|
- [Growwer::OrderEstimate](docs/OrderEstimate.md)
|
|
252
294
|
- [Growwer::OrderEstimateRequest](docs/OrderEstimateRequest.md)
|
|
253
295
|
- [Growwer::OrderEstimateRequestBriefing](docs/OrderEstimateRequestBriefing.md)
|
|
296
|
+
- [Growwer::OrderEventData](docs/OrderEventData.md)
|
|
254
297
|
- [Growwer::OrderLink](docs/OrderLink.md)
|
|
255
298
|
- [Growwer::OrderLinkRequest](docs/OrderLinkRequest.md)
|
|
256
299
|
- [Growwer::OrderMedia](docs/OrderMedia.md)
|
|
@@ -272,6 +315,7 @@ Class | Method | HTTP request | Description
|
|
|
272
315
|
- [Growwer::SellerFees](docs/SellerFees.md)
|
|
273
316
|
- [Growwer::SellerFeesOrNull](docs/SellerFeesOrNull.md)
|
|
274
317
|
- [Growwer::SellerMedia](docs/SellerMedia.md)
|
|
318
|
+
- [Growwer::SellerMediaCompetitiveFeesByLinkTypeInner](docs/SellerMediaCompetitiveFeesByLinkTypeInner.md)
|
|
275
319
|
- [Growwer::SellerMediaFlashOffer](docs/SellerMediaFlashOffer.md)
|
|
276
320
|
- [Growwer::SellerMediaLinkAdditionOffer](docs/SellerMediaLinkAdditionOffer.md)
|
|
277
321
|
- [Growwer::SellerMediaLinkAdditionOfferPricingOptionsInner](docs/SellerMediaLinkAdditionOfferPricingOptionsInner.md)
|
|
@@ -289,6 +333,8 @@ Class | Method | HTTP request | Description
|
|
|
289
333
|
- [Growwer::SellerOrderRejectionReason](docs/SellerOrderRejectionReason.md)
|
|
290
334
|
- [Growwer::SellerPostOrderBriefing](docs/SellerPostOrderBriefing.md)
|
|
291
335
|
- [Growwer::SellerTransaction](docs/SellerTransaction.md)
|
|
336
|
+
- [Growwer::TopUpTestWallet200Response](docs/TopUpTestWallet200Response.md)
|
|
337
|
+
- [Growwer::TopUpTestWalletRequest](docs/TopUpTestWalletRequest.md)
|
|
292
338
|
- [Growwer::Transaction](docs/Transaction.md)
|
|
293
339
|
- [Growwer::UpdateProjectRequest](docs/UpdateProjectRequest.md)
|
|
294
340
|
- [Growwer::UpdateSellerMediaRequest](docs/UpdateSellerMediaRequest.md)
|
|
@@ -297,7 +343,16 @@ Class | Method | HTTP request | Description
|
|
|
297
343
|
- [Growwer::UpdateSellerMediaRequestLinkAdditionOfferPricingOptionsInner](docs/UpdateSellerMediaRequestLinkAdditionOfferPricingOptionsInner.md)
|
|
298
344
|
- [Growwer::UpdateSellerMediaRequestPostOffer](docs/UpdateSellerMediaRequestPostOffer.md)
|
|
299
345
|
- [Growwer::UpdateSellerMediaRequestPostOfferPricingOptionsInner](docs/UpdateSellerMediaRequestPostOfferPricingOptionsInner.md)
|
|
346
|
+
- [Growwer::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
|
|
300
347
|
- [Growwer::UploadFile201Response](docs/UploadFile201Response.md)
|
|
348
|
+
- [Growwer::Webhook](docs/Webhook.md)
|
|
349
|
+
- [Growwer::WebhookDelivery](docs/WebhookDelivery.md)
|
|
350
|
+
- [Growwer::WebhookDeliveryAttempt](docs/WebhookDeliveryAttempt.md)
|
|
351
|
+
- [Growwer::WebhookEvent](docs/WebhookEvent.md)
|
|
352
|
+
- [Growwer::WebhookEventData](docs/WebhookEventData.md)
|
|
353
|
+
- [Growwer::WebhookEventType](docs/WebhookEventType.md)
|
|
354
|
+
- [Growwer::WebhookTestEventData](docs/WebhookTestEventData.md)
|
|
355
|
+
- [Growwer::WebhookWithSecret](docs/WebhookWithSecret.md)
|
|
301
356
|
- [Growwer::Withdrawal](docs/Withdrawal.md)
|
|
302
357
|
|
|
303
358
|
|
data/docs/AccountApi.md
CHANGED
|
@@ -14,7 +14,7 @@ All URIs are relative to *https://tool.growwer.com*
|
|
|
14
14
|
|
|
15
15
|
Your account
|
|
16
16
|
|
|
17
|
-
Profile basics, the buyer and seller balances, whether your seller account is restricted, whether the catalogue is open to you,
|
|
17
|
+
Profile basics, the buyer and seller balances, whether your seller account is restricted, whether the catalogue is open to you, whether you have a managed service, and whether the key you called with is live or test. A test key reads its test wallet as the buyer balance (1,000.00 EUR until test orders and top-ups move it), never your real balance, and no seller side.
|
|
18
18
|
|
|
19
19
|
### Examples
|
|
20
20
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Growwer::AdvanceTestOrderRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **to** | **String** | The state to move the test order to. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'growwer'
|
|
13
|
+
|
|
14
|
+
instance = Growwer::AdvanceTestOrderRequest.new(
|
|
15
|
+
to: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Growwer::BalanceLowEventData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **wallet** | [**BalanceLowEventDataWallet**](BalanceLowEventDataWallet.md) | | |
|
|
8
|
+
| **threshold** | [**Money**](Money.md) | The subscription's `lowBalanceThreshold` that the balance dropped below. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'growwer'
|
|
14
|
+
|
|
15
|
+
instance = Growwer::BalanceLowEventData.new(
|
|
16
|
+
wallet: null,
|
|
17
|
+
threshold: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Growwer::BalanceLowEventDataWallet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **available_balance** | [**Money**](Money.md) | | |
|
|
8
|
+
| **currency** | **String** | The currency of the wallet. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'growwer'
|
|
14
|
+
|
|
15
|
+
instance = Growwer::BalanceLowEventDataWallet.new(
|
|
16
|
+
available_balance: null,
|
|
17
|
+
currency: EUR
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/CatalogueApi.md
CHANGED
|
@@ -592,7 +592,7 @@ end
|
|
|
592
592
|
|
|
593
593
|
Restore a discarded media for a project
|
|
594
594
|
|
|
595
|
-
Restores a media you discarded for one of your projects. Restoring one that is not discarded changes nothing. It works for any media, even one the catalogue no longer shows.
|
|
595
|
+
Restores a media you discarded for one of your projects. Restoring one that is not discarded, or an id no media has, changes nothing and answers the same. It works for any media, even one the catalogue no longer shows.
|
|
596
596
|
|
|
597
597
|
### Examples
|
|
598
598
|
|
|
@@ -664,7 +664,7 @@ nil (empty response body)
|
|
|
664
664
|
|
|
665
665
|
Remove a media from the favourites of a project
|
|
666
666
|
|
|
667
|
-
Removes a media from the favourites of one of your projects. Removing one that is not a favourite changes nothing. It works for any media, even one the catalogue no longer shows.
|
|
667
|
+
Removes a media from the favourites of one of your projects. Removing one that is not a favourite, or an id no media has, changes nothing and answers the same. It works for any media, even one the catalogue no longer shows.
|
|
668
668
|
|
|
669
669
|
### Examples
|
|
670
670
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Growwer::CreateWebhookRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **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. | |
|
|
8
|
+
| **events** | [**Array<WebhookEventType>**](WebhookEventType.md) | The events to send, at least one. | |
|
|
9
|
+
| **low_balance_threshold** | [**Money**](Money.md) | With `balance.low`: the available buyer balance below which the event fires, in EUR. | [optional] |
|
|
10
|
+
| **description** | **String** | A note of yours, at most 255 characters. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'growwer'
|
|
16
|
+
|
|
17
|
+
instance = Growwer::CreateWebhookRequest.new(
|
|
18
|
+
url: null,
|
|
19
|
+
events: null,
|
|
20
|
+
low_balance_threshold: null,
|
|
21
|
+
description: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/GetMe200Response.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **seller** | [**GetMe200ResponseSeller**](GetMe200ResponseSeller.md) | | |
|
|
14
14
|
| **catalogue** | [**GetMe200ResponseCatalogue**](GetMe200ResponseCatalogue.md) | | |
|
|
15
15
|
| **managed_service** | [**GetMe200ResponseManagedService**](GetMe200ResponseManagedService.md) | | |
|
|
16
|
+
| **mode** | **String** | The mode of the key you called with. `live` works on your real account; `test` works in test mode, where nothing you do reaches real sellers, money or orders. Every response to a test key also carries the header `Growwer-Mode: test`. | |
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,7 +29,8 @@ instance = Growwer::GetMe200Response.new(
|
|
|
28
29
|
buyer: null,
|
|
29
30
|
seller: null,
|
|
30
31
|
catalogue: null,
|
|
31
|
-
managed_service: null
|
|
32
|
+
managed_service: null,
|
|
33
|
+
mode: null
|
|
32
34
|
)
|
|
33
35
|
```
|
|
34
36
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Growwer::ListWebhookDeliveries200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **items** | [**Array<WebhookDelivery>**](WebhookDelivery.md) | | |
|
|
8
|
+
| **total** | **Integer** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'growwer'
|
|
14
|
+
|
|
15
|
+
instance = Growwer::ListWebhookDeliveries200Response.new(
|
|
16
|
+
items: null,
|
|
17
|
+
total: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Growwer::ListWebhooks200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **items** | [**Array<Webhook>**](Webhook.md) | | |
|
|
8
|
+
| **total** | **Integer** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'growwer'
|
|
14
|
+
|
|
15
|
+
instance = Growwer::ListWebhooks200Response.new(
|
|
16
|
+
items: null,
|
|
17
|
+
total: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/Money.md
CHANGED
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **amount** | **Integer** | Integer cents. | |
|
|
7
|
+
| **amount** | **Integer** | Integer cents: 12500 is 125.00 EUR. | |
|
|
8
8
|
| **currency** | **String** | ISO 4217 currency code. | |
|
|
9
|
+
| **amount_decimal** | **String** | Exact decimal of `amount` in major units: \"125.00\". An input may only echo it unchanged. | [optional][readonly] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'growwer'
|
|
|
14
15
|
|
|
15
16
|
instance = Growwer::Money.new(
|
|
16
17
|
amount: 12500,
|
|
17
|
-
currency: EUR
|
|
18
|
+
currency: EUR,
|
|
19
|
+
amount_decimal: 125.00
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
data/docs/MoneyOrNull.md
CHANGED
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **amount** | **Integer** | Integer cents. | |
|
|
7
|
+
| **amount** | **Integer** | Integer cents: 12500 is 125.00 EUR. | |
|
|
8
8
|
| **currency** | **String** | ISO 4217 currency code. | |
|
|
9
|
+
| **amount_decimal** | **String** | Exact decimal of `amount` in major units: \"125.00\". An input may only echo it unchanged. | [optional][readonly] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'growwer'
|
|
|
14
15
|
|
|
15
16
|
instance = Growwer::MoneyOrNull.new(
|
|
16
17
|
amount: 12500,
|
|
17
|
-
currency: EUR
|
|
18
|
+
currency: EUR,
|
|
19
|
+
amount_decimal: 125.00
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
data/docs/OrderCreateRequest.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **scheduled_publication_date** | **Date** | The day to publish on, at least a few days ahead as the web requires. | [optional] |
|
|
12
12
|
| **draft_reviewable** | **Boolean** | Whether you review the draft before it is published. Defaults to false. | [optional] |
|
|
13
13
|
| **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] |
|
|
14
|
-
| **expected_price** | [**Money**](Money.md) | The `price` POST /orders/estimate answered. Only EUR is accepted. | |
|
|
14
|
+
| **expected_price** | [**Money**](Money.md) | The `price` POST /orders/estimate answered. Only EUR is accepted. In cents, as the estimate answered it: 1800 is 18.00 EUR. | |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Growwer::OrderEventData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **order** | [**Order**](Order.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'growwer'
|
|
13
|
+
|
|
14
|
+
instance = Growwer::OrderEventData.new(
|
|
15
|
+
order: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/SellerMedia.md
CHANGED
|
@@ -22,7 +22,8 @@
|
|
|
22
22
|
| **flash_offer** | [**SellerMediaFlashOffer**](SellerMediaFlashOffer.md) | | |
|
|
23
23
|
| **post_offer** | [**SellerMediaPostOffer**](SellerMediaPostOffer.md) | | |
|
|
24
24
|
| **link_addition_offer** | [**SellerMediaLinkAdditionOffer**](SellerMediaLinkAdditionOffer.md) | | |
|
|
25
|
-
| **competitive_fees** | [**SellerFeesOrNull**](SellerFeesOrNull.md) | The post fees Growwer suggests to sell more, as the seller media
|
|
25
|
+
| **competitive_fees** | [**SellerFeesOrNull**](SellerFeesOrNull.md) | The post fees Growwer suggests to sell more, as the seller media pages do, or null when it suggests none: for each side, the highest fee POST /seller/medias/{id}/apply-competitive-fees would set on that side, else null. The apply lowers, per link type, a fee above the highest whole-euro fee that lists the media at least 1 EUR below its cheapest price on the marketplaces Growwer compares with to that fee, and lowers by 1 EUR one fee of a link type that then still does not list the media at least 1 EUR below that price. It never raises a fee. Where it lowers several link types, this is the highest per side across them, so a link type's own new fee can be lower: `competitiveFeesByLinkType` gives the fees the apply sets on each link type. | |
|
|
26
|
+
| **competitive_fees_by_link_type** | [**Array<SellerMediaCompetitiveFeesByLinkTypeInner>**](SellerMediaCompetitiveFeesByLinkTypeInner.md) | The fees POST /seller/medias/{id}/apply-competitive-fees would set, per link type: one entry per link type it lowers, in the order dofollow, nofollow, citation, or null when it suggests none (exactly when `competitiveFees` is null). Per side, the highest of these is `competitiveFees`. | |
|
|
26
27
|
| **created_at** | **Time** | | |
|
|
27
28
|
|
|
28
29
|
## Example
|
|
@@ -50,6 +51,7 @@ instance = Growwer::SellerMedia.new(
|
|
|
50
51
|
post_offer: null,
|
|
51
52
|
link_addition_offer: null,
|
|
52
53
|
competitive_fees: null,
|
|
54
|
+
competitive_fees_by_link_type: null,
|
|
53
55
|
created_at: null
|
|
54
56
|
)
|
|
55
57
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Growwer::SellerMediaCompetitiveFeesByLinkTypeInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **link_type** | **String** | | |
|
|
8
|
+
| **fee_when_seller_writes_post** | [**MoneyOrNull**](MoneyOrNull.md) | The fee the apply sets for a post you write on this link type, or null when it keeps your fee on that side. | |
|
|
9
|
+
| **fee_when_seller_does_not_write_post** | [**MoneyOrNull**](MoneyOrNull.md) | The fee the apply sets for a post the buyer or Growwer writes on this link type, or null when it keeps your fee on that side. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'growwer'
|
|
15
|
+
|
|
16
|
+
instance = Growwer::SellerMediaCompetitiveFeesByLinkTypeInner.new(
|
|
17
|
+
link_type: null,
|
|
18
|
+
fee_when_seller_writes_post: null,
|
|
19
|
+
fee_when_seller_does_not_write_post: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/SellerMediasApi.md
CHANGED
|
@@ -4,7 +4,7 @@ All URIs are relative to *https://tool.growwer.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**apply_seller_media_competitive_fees**](SellerMediasApi.md#apply_seller_media_competitive_fees) | **POST** /api/v1/seller/medias/{id}/apply-competitive-fees |
|
|
7
|
+
| [**apply_seller_media_competitive_fees**](SellerMediasApi.md#apply_seller_media_competitive_fees) | **POST** /api/v1/seller/medias/{id}/apply-competitive-fees | Lower your fees to the competitive fees Growwer suggests |
|
|
8
8
|
| [**create_seller_media**](SellerMediasApi.md#create_seller_media) | **POST** /api/v1/seller/medias | Register a media you sell on |
|
|
9
9
|
| [**delete_seller_media**](SellerMediasApi.md#delete_seller_media) | **DELETE** /api/v1/seller/medias/{id} | Delete a media you sell on |
|
|
10
10
|
| [**get_seller_media**](SellerMediasApi.md#get_seller_media) | **GET** /api/v1/seller/medias/{id} | Get a media you sell on |
|
|
@@ -16,9 +16,9 @@ All URIs are relative to *https://tool.growwer.com*
|
|
|
16
16
|
|
|
17
17
|
> <SellerMedia> apply_seller_media_competitive_fees(id, idempotency_key)
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Lower your fees to the competitive fees Growwer suggests
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Lowers your post fees for the media to the competitive fees Growwer suggests, per link type. On each side, a fee above the highest whole-euro fee that lists the media at least 1 EUR below its cheapest price on the marketplaces Growwer compares with is lowered to that fee, and a link type that then still does not list the media at least 1 EUR below that price has one of its fees lowered by 1 EUR, which does. GET /seller/medias/{id} shows, per side, the highest fee this sets on that side as `competitiveFees`, and the fees it sets on each link type it lowers as `competitiveFeesByLinkType`. Only fees above their suggestion change: a fee is never raised, a cheaper link type keeps its fee, no link type gains a side it did not offer, and a side without a suggestion keeps your fee. When there is no suggestion (Growwer sets the media's prices, it is not listed on a marketplace Growwer compares with, it already lists below its price there, or no fee would bring it below), or your fees already are at or below the suggested ones, nothing changes and the answer is 200 with the media as it is. The fees set are your base fees: a running flash offer keeps discounting them. As with a fee edit, a change of the price may cancel the managed-service proposals accepted for the media whose price it changes. Send no body, or an empty object.
|
|
22
22
|
|
|
23
23
|
### Examples
|
|
24
24
|
|
|
@@ -36,7 +36,7 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
36
36
|
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`.
|
|
37
37
|
|
|
38
38
|
begin
|
|
39
|
-
#
|
|
39
|
+
# Lower your fees to the competitive fees Growwer suggests
|
|
40
40
|
result = api_instance.apply_seller_media_competitive_fees(id, idempotency_key)
|
|
41
41
|
p result
|
|
42
42
|
rescue Growwer::ApiError => e
|
|
@@ -52,7 +52,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
52
52
|
|
|
53
53
|
```ruby
|
|
54
54
|
begin
|
|
55
|
-
#
|
|
55
|
+
# Lower your fees to the competitive fees Growwer suggests
|
|
56
56
|
data, status_code, headers = api_instance.apply_seller_media_competitive_fees_with_http_info(id, idempotency_key)
|
|
57
57
|
p status_code # => 2xx
|
|
58
58
|
p headers # => { ... }
|