growwer 1.0.0 → 1.0.2
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 +26 -26
- data/docs/AccountApi.md +0 -72
- data/docs/{OrdersApi.md → BuyerOrdersApi.md} +45 -45
- data/docs/{BuyerMoneyApi.md → BuyerWalletApi.md} +21 -21
- data/docs/CatalogueApi.md +2 -2
- data/docs/Error.md +2 -2
- data/docs/FilesApi.md +1 -1
- data/docs/GetMe200ResponseCatalogue.md +6 -2
- data/docs/SellerAccountApi.md +79 -0
- data/docs/{SellerMoneyApi.md → SellerWalletApi.md} +21 -21
- data/lib/growwer/api/account_api.rb +0 -79
- data/lib/growwer/api/{orders_api.rb → buyer_orders_api.rb} +62 -62
- data/lib/growwer/api/{buyer_money_api.rb → buyer_wallet_api.rb} +24 -24
- data/lib/growwer/api/catalogue_api.rb +4 -4
- data/lib/growwer/api/files_api.rb +2 -2
- data/lib/growwer/api/seller_account_api.rb +101 -0
- data/lib/growwer/api/{seller_money_api.rb → seller_wallet_api.rb} +24 -24
- data/lib/growwer/api_client.rb +1 -1
- data/lib/growwer/models/error.rb +1 -1
- data/lib/growwer/models/get_me200_response_catalogue.rb +69 -5
- data/lib/growwer/version.rb +1 -1
- data/lib/growwer.rb +4 -3
- data/spec/api/account_api_spec.rb +1 -14
- data/spec/api/{orders_api_spec.rb → buyer_orders_api_spec.rb} +13 -13
- data/spec/api/{buyer_money_api_spec.rb → buyer_wallet_api_spec.rb} +7 -7
- data/spec/api/seller_account_api_spec.rb +48 -0
- data/spec/api/{seller_money_api_spec.rb → seller_wallet_api_spec.rb} +7 -7
- metadata +17 -13
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ae94a4a42d430f85da4acd6056bb4ec98052e77633a0a4bc3d3c167044baeabe
|
|
4
|
+
data.tar.gz: a04ef0cf407e8d2ead37c41b485bdd04d7518c1b58653d93270032fef77938e2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bdfe61d545e913011bba9c129be9a033fc6ba9a247c0cd594d0e711d1bb632e1be2e7936e7c00a90c466225f8d3df227d47740da549c293596d6af2eb3319553
|
|
7
|
+
data.tar.gz: cc335b05d428ea0470773481fa1e29e315ca66bfc1c0ad914c77ccc1a2ebb6e690720c8359dbb39bb10de82226d99db73f52fdd6b004d6c15edf767c6a39366d
|
data/README.md
CHANGED
|
@@ -33,7 +33,7 @@ currency code and dates are ISO-8601.
|
|
|
33
33
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
34
34
|
|
|
35
35
|
- API version: 1
|
|
36
|
-
- Package version: 1.0.
|
|
36
|
+
- Package version: 1.0.2
|
|
37
37
|
- Generator version: 7.24.0
|
|
38
38
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
39
39
|
For more information, please visit [https://growwer.com/contact/](https://growwer.com/contact/)
|
|
@@ -51,16 +51,16 @@ gem build growwer.gemspec
|
|
|
51
51
|
Then either install the gem locally:
|
|
52
52
|
|
|
53
53
|
```shell
|
|
54
|
-
gem install ./growwer-1.0.
|
|
54
|
+
gem install ./growwer-1.0.2.gem
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
(for development, run `gem install --dev ./growwer-1.0.
|
|
57
|
+
(for development, run `gem install --dev ./growwer-1.0.2.gem` to install the development dependencies)
|
|
58
58
|
|
|
59
59
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
60
60
|
|
|
61
61
|
Finally add this to the Gemfile:
|
|
62
62
|
|
|
63
|
-
gem 'growwer', '~> 1.0.
|
|
63
|
+
gem 'growwer', '~> 1.0.2'
|
|
64
64
|
|
|
65
65
|
### Install from Git
|
|
66
66
|
|
|
@@ -114,12 +114,22 @@ Class | Method | HTTP request | Description
|
|
|
114
114
|
------------ | ------------- | ------------- | -------------
|
|
115
115
|
*Growwer::AccountApi* | [**get_me**](docs/AccountApi.md#get_me) | **GET** /api/v1/me | Your account
|
|
116
116
|
*Growwer::AccountApi* | [**get_vocabulary**](docs/AccountApi.md#get_vocabulary) | **GET** /api/v1/vocabulary | Codes and names
|
|
117
|
-
*Growwer::
|
|
118
|
-
*Growwer::
|
|
119
|
-
*Growwer::
|
|
120
|
-
*Growwer::
|
|
121
|
-
*Growwer::
|
|
122
|
-
*Growwer::
|
|
117
|
+
*Growwer::BuyerOrdersApi* | [**approve_order**](docs/BuyerOrdersApi.md#approve_order) | **POST** /api/v1/orders/{id}/approve | Approve an order's delivery
|
|
118
|
+
*Growwer::BuyerOrdersApi* | [**approve_order_draft**](docs/BuyerOrdersApi.md#approve_order_draft) | **POST** /api/v1/orders/{id}/approve-draft | Approve a draft
|
|
119
|
+
*Growwer::BuyerOrdersApi* | [**cancel_order**](docs/BuyerOrdersApi.md#cancel_order) | **POST** /api/v1/orders/{id}/cancel | Cancel an order
|
|
120
|
+
*Growwer::BuyerOrdersApi* | [**create_order**](docs/BuyerOrdersApi.md#create_order) | **POST** /api/v1/orders | Place an order
|
|
121
|
+
*Growwer::BuyerOrdersApi* | [**download_order_briefing**](docs/BuyerOrdersApi.md#download_order_briefing) | **GET** /api/v1/orders/{id}/briefing | Download the draft you attached to an order
|
|
122
|
+
*Growwer::BuyerOrdersApi* | [**download_order_draft**](docs/BuyerOrdersApi.md#download_order_draft) | **GET** /api/v1/orders/{id}/draft | Download the draft of an order
|
|
123
|
+
*Growwer::BuyerOrdersApi* | [**estimate_order**](docs/BuyerOrdersApi.md#estimate_order) | **POST** /api/v1/orders/estimate | Estimate an order
|
|
124
|
+
*Growwer::BuyerOrdersApi* | [**get_order**](docs/BuyerOrdersApi.md#get_order) | **GET** /api/v1/orders/{id} | Get an order
|
|
125
|
+
*Growwer::BuyerOrdersApi* | [**list_orders**](docs/BuyerOrdersApi.md#list_orders) | **GET** /api/v1/orders | List your orders
|
|
126
|
+
*Growwer::BuyerOrdersApi* | [**request_order_draft_update**](docs/BuyerOrdersApi.md#request_order_draft_update) | **POST** /api/v1/orders/{id}/request-draft-update | Request changes to a draft
|
|
127
|
+
*Growwer::BuyerOrdersApi* | [**request_order_update**](docs/BuyerOrdersApi.md#request_order_update) | **POST** /api/v1/orders/{id}/request-update | Request changes to a delivery
|
|
128
|
+
*Growwer::BuyerWalletApi* | [**download_buyer_transaction_document**](docs/BuyerWalletApi.md#download_buyer_transaction_document) | **GET** /api/v1/wallets/buyer/transactions/{id}/document | Download the document of a wallet movement
|
|
129
|
+
*Growwer::BuyerWalletApi* | [**get_buyer_wallet**](docs/BuyerWalletApi.md#get_buyer_wallet) | **GET** /api/v1/wallets/buyer | Get your buyer wallet
|
|
130
|
+
*Growwer::BuyerWalletApi* | [**get_invoice_pdf**](docs/BuyerWalletApi.md#get_invoice_pdf) | **GET** /api/v1/invoices/{id}/pdf | Download an invoice
|
|
131
|
+
*Growwer::BuyerWalletApi* | [**list_buyer_transactions**](docs/BuyerWalletApi.md#list_buyer_transactions) | **GET** /api/v1/wallets/buyer/transactions | List your buyer wallet movements
|
|
132
|
+
*Growwer::BuyerWalletApi* | [**list_invoices**](docs/BuyerWalletApi.md#list_invoices) | **GET** /api/v1/invoices | List your invoices
|
|
123
133
|
*Growwer::CatalogueApi* | [**discard_media**](docs/CatalogueApi.md#discard_media) | **PUT** /api/v1/projects/{id}/discards/{mediaId} | Discard a media for a project
|
|
124
134
|
*Growwer::CatalogueApi* | [**favourite_media**](docs/CatalogueApi.md#favourite_media) | **PUT** /api/v1/projects/{id}/favourites/{mediaId} | Add a media to the favourites of a project
|
|
125
135
|
*Growwer::CatalogueApi* | [**get_catalogue_media**](docs/CatalogueApi.md#get_catalogue_media) | **GET** /api/v1/medias/{id} | Get a media
|
|
@@ -137,17 +147,6 @@ Class | Method | HTTP request | Description
|
|
|
137
147
|
*Growwer::ManagedServicesApi* | [**request_managed_service_campaign**](docs/ManagedServicesApi.md#request_managed_service_campaign) | **POST** /api/v1/managed-service/campaign-requests | Request a new campaign
|
|
138
148
|
*Growwer::ManagedServicesApi* | [**request_managed_service_info**](docs/ManagedServicesApi.md#request_managed_service_info) | **POST** /api/v1/managed-service/info-requests | Ask about the managed service
|
|
139
149
|
*Growwer::ManagedServicesApi* | [**review_managed_service_proposals**](docs/ManagedServicesApi.md#review_managed_service_proposals) | **POST** /api/v1/managed-service/campaigns/{id}/proposals/review | Accept or reject proposals
|
|
140
|
-
*Growwer::OrdersApi* | [**approve_order**](docs/OrdersApi.md#approve_order) | **POST** /api/v1/orders/{id}/approve | Approve an order's delivery
|
|
141
|
-
*Growwer::OrdersApi* | [**approve_order_draft**](docs/OrdersApi.md#approve_order_draft) | **POST** /api/v1/orders/{id}/approve-draft | Approve a draft
|
|
142
|
-
*Growwer::OrdersApi* | [**cancel_order**](docs/OrdersApi.md#cancel_order) | **POST** /api/v1/orders/{id}/cancel | Cancel an order
|
|
143
|
-
*Growwer::OrdersApi* | [**create_order**](docs/OrdersApi.md#create_order) | **POST** /api/v1/orders | Place an order
|
|
144
|
-
*Growwer::OrdersApi* | [**download_order_briefing**](docs/OrdersApi.md#download_order_briefing) | **GET** /api/v1/orders/{id}/briefing | Download the draft you attached to an order
|
|
145
|
-
*Growwer::OrdersApi* | [**download_order_draft**](docs/OrdersApi.md#download_order_draft) | **GET** /api/v1/orders/{id}/draft | Download the draft of an order
|
|
146
|
-
*Growwer::OrdersApi* | [**estimate_order**](docs/OrdersApi.md#estimate_order) | **POST** /api/v1/orders/estimate | Estimate an order
|
|
147
|
-
*Growwer::OrdersApi* | [**get_order**](docs/OrdersApi.md#get_order) | **GET** /api/v1/orders/{id} | Get an order
|
|
148
|
-
*Growwer::OrdersApi* | [**list_orders**](docs/OrdersApi.md#list_orders) | **GET** /api/v1/orders | List your orders
|
|
149
|
-
*Growwer::OrdersApi* | [**request_order_draft_update**](docs/OrdersApi.md#request_order_draft_update) | **POST** /api/v1/orders/{id}/request-draft-update | Request changes to a draft
|
|
150
|
-
*Growwer::OrdersApi* | [**request_order_update**](docs/OrdersApi.md#request_order_update) | **POST** /api/v1/orders/{id}/request-update | Request changes to a delivery
|
|
151
150
|
*Growwer::ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/v1/projects | Create a project
|
|
152
151
|
*Growwer::ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /api/v1/projects/{id} | Delete a project
|
|
153
152
|
*Growwer::ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/v1/projects/{id} | Get a project
|
|
@@ -157,15 +156,11 @@ Class | Method | HTTP request | Description
|
|
|
157
156
|
*Growwer::SavedFiltersApi* | [**create_saved_filter**](docs/SavedFiltersApi.md#create_saved_filter) | **POST** /api/v1/projects/{id}/saved-filters | Save a filter
|
|
158
157
|
*Growwer::SavedFiltersApi* | [**delete_saved_filter**](docs/SavedFiltersApi.md#delete_saved_filter) | **DELETE** /api/v1/projects/{id}/saved-filters/{filterId} | Delete a saved filter
|
|
159
158
|
*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
|
+
*Growwer::SellerAccountApi* | [**put_seller_holiday**](docs/SellerAccountApi.md#put_seller_holiday) | **PUT** /api/v1/seller/holiday | Set your holiday
|
|
160
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 | Set the competitive fees Growwer suggests
|
|
161
161
|
*Growwer::SellerMediasApi* | [**get_seller_media**](docs/SellerMediasApi.md#get_seller_media) | **GET** /api/v1/seller/medias/{id} | Get a media you sell on
|
|
162
162
|
*Growwer::SellerMediasApi* | [**list_seller_medias**](docs/SellerMediasApi.md#list_seller_medias) | **GET** /api/v1/seller/medias | List the medias you sell on
|
|
163
163
|
*Growwer::SellerMediasApi* | [**update_seller_media**](docs/SellerMediasApi.md#update_seller_media) | **PATCH** /api/v1/seller/medias/{id} | Edit the fees of a media you sell on
|
|
164
|
-
*Growwer::SellerMoneyApi* | [**download_seller_transaction_document**](docs/SellerMoneyApi.md#download_seller_transaction_document) | **GET** /api/v1/wallets/seller/transactions/{id}/document | Download the document of a seller wallet movement
|
|
165
|
-
*Growwer::SellerMoneyApi* | [**download_withdrawal_invoice**](docs/SellerMoneyApi.md#download_withdrawal_invoice) | **GET** /api/v1/withdrawals/{id}/invoice | Download the invoice of a withdrawal
|
|
166
|
-
*Growwer::SellerMoneyApi* | [**get_seller_wallet**](docs/SellerMoneyApi.md#get_seller_wallet) | **GET** /api/v1/wallets/seller | Get your seller wallet
|
|
167
|
-
*Growwer::SellerMoneyApi* | [**list_seller_transactions**](docs/SellerMoneyApi.md#list_seller_transactions) | **GET** /api/v1/wallets/seller/transactions | List your seller wallet movements
|
|
168
|
-
*Growwer::SellerMoneyApi* | [**list_withdrawals**](docs/SellerMoneyApi.md#list_withdrawals) | **GET** /api/v1/withdrawals | List your withdrawals
|
|
169
164
|
*Growwer::SellerOrdersApi* | [**accept_seller_order**](docs/SellerOrdersApi.md#accept_seller_order) | **POST** /api/v1/seller/orders/{id}/accept | Accept an order
|
|
170
165
|
*Growwer::SellerOrdersApi* | [**deliver_seller_order**](docs/SellerOrdersApi.md#deliver_seller_order) | **POST** /api/v1/seller/orders/{id}/deliver | Deliver an order
|
|
171
166
|
*Growwer::SellerOrdersApi* | [**deliver_seller_order_draft**](docs/SellerOrdersApi.md#deliver_seller_order_draft) | **POST** /api/v1/seller/orders/{id}/deliver-draft | Deliver a draft
|
|
@@ -178,6 +173,11 @@ Class | Method | HTTP request | Description
|
|
|
178
173
|
*Growwer::SellerOrdersApi* | [**refute_seller_order_draft_update**](docs/SellerOrdersApi.md#refute_seller_order_draft_update) | **POST** /api/v1/seller/orders/{id}/refute-draft-update | Refuse a draft update
|
|
179
174
|
*Growwer::SellerOrdersApi* | [**refute_seller_order_update**](docs/SellerOrdersApi.md#refute_seller_order_update) | **POST** /api/v1/seller/orders/{id}/refute-update | Refuse an update
|
|
180
175
|
*Growwer::SellerOrdersApi* | [**reject_seller_order**](docs/SellerOrdersApi.md#reject_seller_order) | **POST** /api/v1/seller/orders/{id}/reject | Reject an order
|
|
176
|
+
*Growwer::SellerWalletApi* | [**download_seller_transaction_document**](docs/SellerWalletApi.md#download_seller_transaction_document) | **GET** /api/v1/wallets/seller/transactions/{id}/document | Download the document of a seller wallet movement
|
|
177
|
+
*Growwer::SellerWalletApi* | [**download_withdrawal_invoice**](docs/SellerWalletApi.md#download_withdrawal_invoice) | **GET** /api/v1/withdrawals/{id}/invoice | Download the invoice of a withdrawal
|
|
178
|
+
*Growwer::SellerWalletApi* | [**get_seller_wallet**](docs/SellerWalletApi.md#get_seller_wallet) | **GET** /api/v1/wallets/seller | Get your seller wallet
|
|
179
|
+
*Growwer::SellerWalletApi* | [**list_seller_transactions**](docs/SellerWalletApi.md#list_seller_transactions) | **GET** /api/v1/wallets/seller/transactions | List your seller wallet movements
|
|
180
|
+
*Growwer::SellerWalletApi* | [**list_withdrawals**](docs/SellerWalletApi.md#list_withdrawals) | **GET** /api/v1/withdrawals | List your withdrawals
|
|
181
181
|
|
|
182
182
|
|
|
183
183
|
## Documentation for Models
|
data/docs/AccountApi.md
CHANGED
|
@@ -6,7 +6,6 @@ All URIs are relative to *https://tool.growwer.com*
|
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**get_me**](AccountApi.md#get_me) | **GET** /api/v1/me | Your account |
|
|
8
8
|
| [**get_vocabulary**](AccountApi.md#get_vocabulary) | **GET** /api/v1/vocabulary | Codes and names |
|
|
9
|
-
| [**put_seller_holiday**](AccountApi.md#put_seller_holiday) | **PUT** /api/v1/seller/holiday | Set your holiday |
|
|
10
9
|
|
|
11
10
|
|
|
12
11
|
## get_me
|
|
@@ -140,74 +139,3 @@ This endpoint does not need any parameter.
|
|
|
140
139
|
- **Content-Type**: Not defined
|
|
141
140
|
- **Accept**: application/json
|
|
142
141
|
|
|
143
|
-
|
|
144
|
-
## put_seller_holiday
|
|
145
|
-
|
|
146
|
-
> <PutSellerHoliday200Response> put_seller_holiday(idempotency_key, put_seller_holiday_request)
|
|
147
|
-
|
|
148
|
-
Set your holiday
|
|
149
|
-
|
|
150
|
-
Starts, changes or ends your holiday, as the holiday settings of your profile page do. While you are on holiday your medias take no orders. `endDate` is the day your holiday ends, at 00:00 of that day in Growwer's server time, and must be later than now; leave it out, or send null, for a holiday you end yourself. Ending the holiday takes no `endDate`. A holiday that already is as you ask is answered 200 without a change. A restricted seller account stays on holiday until the restriction is lifted, so any change is refused. Your holiday is also in GET /me.
|
|
151
|
-
|
|
152
|
-
### Examples
|
|
153
|
-
|
|
154
|
-
```ruby
|
|
155
|
-
require 'time'
|
|
156
|
-
require 'growwer'
|
|
157
|
-
# setup authorization
|
|
158
|
-
Growwer.configure do |config|
|
|
159
|
-
# Configure Bearer authorization: apiKey
|
|
160
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
161
|
-
end
|
|
162
|
-
|
|
163
|
-
api_instance = Growwer::AccountApi.new
|
|
164
|
-
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`.
|
|
165
|
-
put_seller_holiday_request = Growwer::PutSellerHolidayRequest.new({on_holiday: false}) # PutSellerHolidayRequest |
|
|
166
|
-
|
|
167
|
-
begin
|
|
168
|
-
# Set your holiday
|
|
169
|
-
result = api_instance.put_seller_holiday(idempotency_key, put_seller_holiday_request)
|
|
170
|
-
p result
|
|
171
|
-
rescue Growwer::ApiError => e
|
|
172
|
-
puts "Error when calling AccountApi->put_seller_holiday: #{e}"
|
|
173
|
-
end
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
#### Using the put_seller_holiday_with_http_info variant
|
|
177
|
-
|
|
178
|
-
This returns an Array which contains the response data, status code and headers.
|
|
179
|
-
|
|
180
|
-
> <Array(<PutSellerHoliday200Response>, Integer, Hash)> put_seller_holiday_with_http_info(idempotency_key, put_seller_holiday_request)
|
|
181
|
-
|
|
182
|
-
```ruby
|
|
183
|
-
begin
|
|
184
|
-
# Set your holiday
|
|
185
|
-
data, status_code, headers = api_instance.put_seller_holiday_with_http_info(idempotency_key, put_seller_holiday_request)
|
|
186
|
-
p status_code # => 2xx
|
|
187
|
-
p headers # => { ... }
|
|
188
|
-
p data # => <PutSellerHoliday200Response>
|
|
189
|
-
rescue Growwer::ApiError => e
|
|
190
|
-
puts "Error when calling AccountApi->put_seller_holiday_with_http_info: #{e}"
|
|
191
|
-
end
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### Parameters
|
|
195
|
-
|
|
196
|
-
| Name | Type | Description | Notes |
|
|
197
|
-
| ---- | ---- | ----------- | ----- |
|
|
198
|
-
| **idempotency_key** | **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`. | |
|
|
199
|
-
| **put_seller_holiday_request** | [**PutSellerHolidayRequest**](PutSellerHolidayRequest.md) | | |
|
|
200
|
-
|
|
201
|
-
### Return type
|
|
202
|
-
|
|
203
|
-
[**PutSellerHoliday200Response**](PutSellerHoliday200Response.md)
|
|
204
|
-
|
|
205
|
-
### Authorization
|
|
206
|
-
|
|
207
|
-
[apiKey](../README.md#apiKey)
|
|
208
|
-
|
|
209
|
-
### HTTP request headers
|
|
210
|
-
|
|
211
|
-
- **Content-Type**: application/json
|
|
212
|
-
- **Accept**: application/json
|
|
213
|
-
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
# Growwer::
|
|
1
|
+
# Growwer::BuyerOrdersApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://tool.growwer.com*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**approve_order**](
|
|
8
|
-
| [**approve_order_draft**](
|
|
9
|
-
| [**cancel_order**](
|
|
10
|
-
| [**create_order**](
|
|
11
|
-
| [**download_order_briefing**](
|
|
12
|
-
| [**download_order_draft**](
|
|
13
|
-
| [**estimate_order**](
|
|
14
|
-
| [**get_order**](
|
|
15
|
-
| [**list_orders**](
|
|
16
|
-
| [**request_order_draft_update**](
|
|
17
|
-
| [**request_order_update**](
|
|
7
|
+
| [**approve_order**](BuyerOrdersApi.md#approve_order) | **POST** /api/v1/orders/{id}/approve | Approve an order's delivery |
|
|
8
|
+
| [**approve_order_draft**](BuyerOrdersApi.md#approve_order_draft) | **POST** /api/v1/orders/{id}/approve-draft | Approve a draft |
|
|
9
|
+
| [**cancel_order**](BuyerOrdersApi.md#cancel_order) | **POST** /api/v1/orders/{id}/cancel | Cancel an order |
|
|
10
|
+
| [**create_order**](BuyerOrdersApi.md#create_order) | **POST** /api/v1/orders | Place an order |
|
|
11
|
+
| [**download_order_briefing**](BuyerOrdersApi.md#download_order_briefing) | **GET** /api/v1/orders/{id}/briefing | Download the draft you attached to an order |
|
|
12
|
+
| [**download_order_draft**](BuyerOrdersApi.md#download_order_draft) | **GET** /api/v1/orders/{id}/draft | Download the draft of an order |
|
|
13
|
+
| [**estimate_order**](BuyerOrdersApi.md#estimate_order) | **POST** /api/v1/orders/estimate | Estimate an order |
|
|
14
|
+
| [**get_order**](BuyerOrdersApi.md#get_order) | **GET** /api/v1/orders/{id} | Get an order |
|
|
15
|
+
| [**list_orders**](BuyerOrdersApi.md#list_orders) | **GET** /api/v1/orders | List your orders |
|
|
16
|
+
| [**request_order_draft_update**](BuyerOrdersApi.md#request_order_draft_update) | **POST** /api/v1/orders/{id}/request-draft-update | Request changes to a draft |
|
|
17
|
+
| [**request_order_update**](BuyerOrdersApi.md#request_order_update) | **POST** /api/v1/orders/{id}/request-update | Request changes to a delivery |
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
## approve_order
|
|
@@ -36,7 +36,7 @@ Growwer.configure do |config|
|
|
|
36
36
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
37
37
|
end
|
|
38
38
|
|
|
39
|
-
api_instance = Growwer::
|
|
39
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
40
40
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
41
41
|
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`.
|
|
42
42
|
|
|
@@ -45,7 +45,7 @@ begin
|
|
|
45
45
|
result = api_instance.approve_order(id, idempotency_key)
|
|
46
46
|
p result
|
|
47
47
|
rescue Growwer::ApiError => e
|
|
48
|
-
puts "Error when calling
|
|
48
|
+
puts "Error when calling BuyerOrdersApi->approve_order: #{e}"
|
|
49
49
|
end
|
|
50
50
|
```
|
|
51
51
|
|
|
@@ -63,7 +63,7 @@ begin
|
|
|
63
63
|
p headers # => { ... }
|
|
64
64
|
p data # => <Order>
|
|
65
65
|
rescue Growwer::ApiError => e
|
|
66
|
-
puts "Error when calling
|
|
66
|
+
puts "Error when calling BuyerOrdersApi->approve_order_with_http_info: #{e}"
|
|
67
67
|
end
|
|
68
68
|
```
|
|
69
69
|
|
|
@@ -107,7 +107,7 @@ Growwer.configure do |config|
|
|
|
107
107
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
108
108
|
end
|
|
109
109
|
|
|
110
|
-
api_instance = Growwer::
|
|
110
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
111
111
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
112
112
|
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`.
|
|
113
113
|
|
|
@@ -116,7 +116,7 @@ begin
|
|
|
116
116
|
result = api_instance.approve_order_draft(id, idempotency_key)
|
|
117
117
|
p result
|
|
118
118
|
rescue Growwer::ApiError => e
|
|
119
|
-
puts "Error when calling
|
|
119
|
+
puts "Error when calling BuyerOrdersApi->approve_order_draft: #{e}"
|
|
120
120
|
end
|
|
121
121
|
```
|
|
122
122
|
|
|
@@ -134,7 +134,7 @@ begin
|
|
|
134
134
|
p headers # => { ... }
|
|
135
135
|
p data # => <Order>
|
|
136
136
|
rescue Growwer::ApiError => e
|
|
137
|
-
puts "Error when calling
|
|
137
|
+
puts "Error when calling BuyerOrdersApi->approve_order_draft_with_http_info: #{e}"
|
|
138
138
|
end
|
|
139
139
|
```
|
|
140
140
|
|
|
@@ -178,7 +178,7 @@ Growwer.configure do |config|
|
|
|
178
178
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
179
179
|
end
|
|
180
180
|
|
|
181
|
-
api_instance = Growwer::
|
|
181
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
182
182
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
183
183
|
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`.
|
|
184
184
|
order_action_reason = Growwer::OrderActionReason.new({reason: 'reason_example'}) # OrderActionReason |
|
|
@@ -188,7 +188,7 @@ begin
|
|
|
188
188
|
result = api_instance.cancel_order(id, idempotency_key, order_action_reason)
|
|
189
189
|
p result
|
|
190
190
|
rescue Growwer::ApiError => e
|
|
191
|
-
puts "Error when calling
|
|
191
|
+
puts "Error when calling BuyerOrdersApi->cancel_order: #{e}"
|
|
192
192
|
end
|
|
193
193
|
```
|
|
194
194
|
|
|
@@ -206,7 +206,7 @@ begin
|
|
|
206
206
|
p headers # => { ... }
|
|
207
207
|
p data # => <Order>
|
|
208
208
|
rescue Growwer::ApiError => e
|
|
209
|
-
puts "Error when calling
|
|
209
|
+
puts "Error when calling BuyerOrdersApi->cancel_order_with_http_info: #{e}"
|
|
210
210
|
end
|
|
211
211
|
```
|
|
212
212
|
|
|
@@ -251,7 +251,7 @@ Growwer.configure do |config|
|
|
|
251
251
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
252
252
|
end
|
|
253
253
|
|
|
254
|
-
api_instance = Growwer::
|
|
254
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
255
255
|
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`.
|
|
256
256
|
order_create_request = Growwer::OrderCreateRequest.new({type: 'post', project_id: 'project_id_example', media_id: 'media_id_example', briefing: Growwer::LinkAdditionOrderBriefingRequest.new({linking_from: 'linking_from_example', link: Growwer::OrderLinkRequest.new({type: 'dofollow'})}), expected_price: Growwer::Money.new({amount: 12500, currency: 'EUR'})}) # OrderCreateRequest |
|
|
257
257
|
|
|
@@ -260,7 +260,7 @@ begin
|
|
|
260
260
|
result = api_instance.create_order(idempotency_key, order_create_request)
|
|
261
261
|
p result
|
|
262
262
|
rescue Growwer::ApiError => e
|
|
263
|
-
puts "Error when calling
|
|
263
|
+
puts "Error when calling BuyerOrdersApi->create_order: #{e}"
|
|
264
264
|
end
|
|
265
265
|
```
|
|
266
266
|
|
|
@@ -278,7 +278,7 @@ begin
|
|
|
278
278
|
p headers # => { ... }
|
|
279
279
|
p data # => <Order>
|
|
280
280
|
rescue Growwer::ApiError => e
|
|
281
|
-
puts "Error when calling
|
|
281
|
+
puts "Error when calling BuyerOrdersApi->create_order_with_http_info: #{e}"
|
|
282
282
|
end
|
|
283
283
|
```
|
|
284
284
|
|
|
@@ -322,7 +322,7 @@ Growwer.configure do |config|
|
|
|
322
322
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
323
323
|
end
|
|
324
324
|
|
|
325
|
-
api_instance = Growwer::
|
|
325
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
326
326
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
327
327
|
|
|
328
328
|
begin
|
|
@@ -330,7 +330,7 @@ begin
|
|
|
330
330
|
result = api_instance.download_order_briefing(id)
|
|
331
331
|
p result
|
|
332
332
|
rescue Growwer::ApiError => e
|
|
333
|
-
puts "Error when calling
|
|
333
|
+
puts "Error when calling BuyerOrdersApi->download_order_briefing: #{e}"
|
|
334
334
|
end
|
|
335
335
|
```
|
|
336
336
|
|
|
@@ -348,7 +348,7 @@ begin
|
|
|
348
348
|
p headers # => { ... }
|
|
349
349
|
p data # => File
|
|
350
350
|
rescue Growwer::ApiError => e
|
|
351
|
-
puts "Error when calling
|
|
351
|
+
puts "Error when calling BuyerOrdersApi->download_order_briefing_with_http_info: #{e}"
|
|
352
352
|
end
|
|
353
353
|
```
|
|
354
354
|
|
|
@@ -391,7 +391,7 @@ Growwer.configure do |config|
|
|
|
391
391
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
392
392
|
end
|
|
393
393
|
|
|
394
|
-
api_instance = Growwer::
|
|
394
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
395
395
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
396
396
|
|
|
397
397
|
begin
|
|
@@ -399,7 +399,7 @@ begin
|
|
|
399
399
|
result = api_instance.download_order_draft(id)
|
|
400
400
|
p result
|
|
401
401
|
rescue Growwer::ApiError => e
|
|
402
|
-
puts "Error when calling
|
|
402
|
+
puts "Error when calling BuyerOrdersApi->download_order_draft: #{e}"
|
|
403
403
|
end
|
|
404
404
|
```
|
|
405
405
|
|
|
@@ -417,7 +417,7 @@ begin
|
|
|
417
417
|
p headers # => { ... }
|
|
418
418
|
p data # => File
|
|
419
419
|
rescue Growwer::ApiError => e
|
|
420
|
-
puts "Error when calling
|
|
420
|
+
puts "Error when calling BuyerOrdersApi->download_order_draft_with_http_info: #{e}"
|
|
421
421
|
end
|
|
422
422
|
```
|
|
423
423
|
|
|
@@ -460,7 +460,7 @@ Growwer.configure do |config|
|
|
|
460
460
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
461
461
|
end
|
|
462
462
|
|
|
463
|
-
api_instance = Growwer::
|
|
463
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
464
464
|
order_estimate_request = Growwer::OrderEstimateRequest.new({type: 'post', project_id: 'project_id_example', media_id: 'media_id_example', briefing: Growwer::LinkAdditionOrderBriefingRequest.new({linking_from: 'linking_from_example', link: Growwer::OrderLinkRequest.new({type: 'dofollow'})})}) # OrderEstimateRequest |
|
|
465
465
|
|
|
466
466
|
begin
|
|
@@ -468,7 +468,7 @@ begin
|
|
|
468
468
|
result = api_instance.estimate_order(order_estimate_request)
|
|
469
469
|
p result
|
|
470
470
|
rescue Growwer::ApiError => e
|
|
471
|
-
puts "Error when calling
|
|
471
|
+
puts "Error when calling BuyerOrdersApi->estimate_order: #{e}"
|
|
472
472
|
end
|
|
473
473
|
```
|
|
474
474
|
|
|
@@ -486,7 +486,7 @@ begin
|
|
|
486
486
|
p headers # => { ... }
|
|
487
487
|
p data # => <OrderEstimate>
|
|
488
488
|
rescue Growwer::ApiError => e
|
|
489
|
-
puts "Error when calling
|
|
489
|
+
puts "Error when calling BuyerOrdersApi->estimate_order_with_http_info: #{e}"
|
|
490
490
|
end
|
|
491
491
|
```
|
|
492
492
|
|
|
@@ -529,7 +529,7 @@ Growwer.configure do |config|
|
|
|
529
529
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
530
530
|
end
|
|
531
531
|
|
|
532
|
-
api_instance = Growwer::
|
|
532
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
533
533
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
534
534
|
|
|
535
535
|
begin
|
|
@@ -537,7 +537,7 @@ begin
|
|
|
537
537
|
result = api_instance.get_order(id)
|
|
538
538
|
p result
|
|
539
539
|
rescue Growwer::ApiError => e
|
|
540
|
-
puts "Error when calling
|
|
540
|
+
puts "Error when calling BuyerOrdersApi->get_order: #{e}"
|
|
541
541
|
end
|
|
542
542
|
```
|
|
543
543
|
|
|
@@ -555,7 +555,7 @@ begin
|
|
|
555
555
|
p headers # => { ... }
|
|
556
556
|
p data # => <Order>
|
|
557
557
|
rescue Growwer::ApiError => e
|
|
558
|
-
puts "Error when calling
|
|
558
|
+
puts "Error when calling BuyerOrdersApi->get_order_with_http_info: #{e}"
|
|
559
559
|
end
|
|
560
560
|
```
|
|
561
561
|
|
|
@@ -598,7 +598,7 @@ Growwer.configure do |config|
|
|
|
598
598
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
599
599
|
end
|
|
600
600
|
|
|
601
|
-
api_instance = Growwer::
|
|
601
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
602
602
|
opts = {
|
|
603
603
|
project_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Only the orders of this project of yours.
|
|
604
604
|
media_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Only the orders on this media.
|
|
@@ -614,7 +614,7 @@ begin
|
|
|
614
614
|
result = api_instance.list_orders(opts)
|
|
615
615
|
p result
|
|
616
616
|
rescue Growwer::ApiError => e
|
|
617
|
-
puts "Error when calling
|
|
617
|
+
puts "Error when calling BuyerOrdersApi->list_orders: #{e}"
|
|
618
618
|
end
|
|
619
619
|
```
|
|
620
620
|
|
|
@@ -632,7 +632,7 @@ begin
|
|
|
632
632
|
p headers # => { ... }
|
|
633
633
|
p data # => <ListOrders200Response>
|
|
634
634
|
rescue Growwer::ApiError => e
|
|
635
|
-
puts "Error when calling
|
|
635
|
+
puts "Error when calling BuyerOrdersApi->list_orders_with_http_info: #{e}"
|
|
636
636
|
end
|
|
637
637
|
```
|
|
638
638
|
|
|
@@ -681,7 +681,7 @@ Growwer.configure do |config|
|
|
|
681
681
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
682
682
|
end
|
|
683
683
|
|
|
684
|
-
api_instance = Growwer::
|
|
684
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
685
685
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
686
686
|
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`.
|
|
687
687
|
order_action_reason = Growwer::OrderActionReason.new({reason: 'reason_example'}) # OrderActionReason |
|
|
@@ -691,7 +691,7 @@ begin
|
|
|
691
691
|
result = api_instance.request_order_draft_update(id, idempotency_key, order_action_reason)
|
|
692
692
|
p result
|
|
693
693
|
rescue Growwer::ApiError => e
|
|
694
|
-
puts "Error when calling
|
|
694
|
+
puts "Error when calling BuyerOrdersApi->request_order_draft_update: #{e}"
|
|
695
695
|
end
|
|
696
696
|
```
|
|
697
697
|
|
|
@@ -709,7 +709,7 @@ begin
|
|
|
709
709
|
p headers # => { ... }
|
|
710
710
|
p data # => <Order>
|
|
711
711
|
rescue Growwer::ApiError => e
|
|
712
|
-
puts "Error when calling
|
|
712
|
+
puts "Error when calling BuyerOrdersApi->request_order_draft_update_with_http_info: #{e}"
|
|
713
713
|
end
|
|
714
714
|
```
|
|
715
715
|
|
|
@@ -754,7 +754,7 @@ Growwer.configure do |config|
|
|
|
754
754
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
755
755
|
end
|
|
756
756
|
|
|
757
|
-
api_instance = Growwer::
|
|
757
|
+
api_instance = Growwer::BuyerOrdersApi.new
|
|
758
758
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
759
759
|
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`.
|
|
760
760
|
order_action_reason = Growwer::OrderActionReason.new({reason: 'reason_example'}) # OrderActionReason |
|
|
@@ -764,7 +764,7 @@ begin
|
|
|
764
764
|
result = api_instance.request_order_update(id, idempotency_key, order_action_reason)
|
|
765
765
|
p result
|
|
766
766
|
rescue Growwer::ApiError => e
|
|
767
|
-
puts "Error when calling
|
|
767
|
+
puts "Error when calling BuyerOrdersApi->request_order_update: #{e}"
|
|
768
768
|
end
|
|
769
769
|
```
|
|
770
770
|
|
|
@@ -782,7 +782,7 @@ begin
|
|
|
782
782
|
p headers # => { ... }
|
|
783
783
|
p data # => <Order>
|
|
784
784
|
rescue Growwer::ApiError => e
|
|
785
|
-
puts "Error when calling
|
|
785
|
+
puts "Error when calling BuyerOrdersApi->request_order_update_with_http_info: #{e}"
|
|
786
786
|
end
|
|
787
787
|
```
|
|
788
788
|
|