You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 3, 2024. It is now read-only.
|[**getExport()**](ExportsApi.md#getExport)|**GET** /v1/exports/{exportId} | Get Export |
10
11
|[**listExports()**](ExportsApi.md#listExports)|**GET** /v1/exports | List Exports |
11
12
@@ -143,6 +144,64 @@ void (empty response body)
143
144
[[Back to Model list]](../../README.md#models)
144
145
[[Back to README]](../../README.md)
145
146
147
+
## `downloadExport()`
148
+
149
+
```php
150
+
downloadExport($export_id, $token): string
151
+
```
152
+
153
+
Download Export
154
+
155
+
Download the contents of the exported CSV file. <!-- theme: info --> > 📘 Important notes > > **Base URL:** > - `https://download.voucherify.io` (Europe) > - `https://us1.download.voucherify.io` (US) > - `https://as1.download.voucherify.io` (Asia) > > **Token:** Can be found within the `result` parameter of the <!-- [Get Export](OpenAPI.json/paths/~1exports~1{exportId}/get) -->[Get Export](ref:get-export) method response.
156
+
157
+
### Example
158
+
159
+
```php
160
+
<?php
161
+
require_once(__DIR__ . '/vendor/autoload.php');
162
+
163
+
164
+
165
+
$apiInstance = new OpenAPI\Client\Api\ExportsApi(
166
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
167
+
// This is optional, `GuzzleHttp\Client` will be used as default.
Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. <!-- theme: info --> > 📘 Global uniqueness > > All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. <!-- theme: warning --> > 🚧 Code generation status > > This is an asynchronous action; you can't read or modify a newly created campaign until the code generation is completed. See the `creation_status` field in the <!-- [campaign object](OpenAPI.json/components/schemas/Campaign) -->[campaign object](ref:get-campaign) description.
$apiInstance = new OpenAPI\Client\Api\PromotionsApi(
50
-
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
51
-
// This is optional, `GuzzleHttp\Client` will be used as default.
52
-
new GuzzleHttp\Client(),
53
-
$config
54
-
);
55
-
$campaigns_create_request_body = {"name":"Discount Campaign 4","campaign_type":"DISCOUNT_COUPONS","join_once":true,"type":"AUTO_UPDATE","category_id":"cat_0bb343dee3cdb5ec0c","start_date":"2020-08-16T00:00:00Z","expiration_date":"2023-12-26T00:00:00Z","vouchers_count":3,"voucher":{"type":"DISCOUNT_VOUCHER","discount":{"percent_off":10,"type":"PERCENT"},"redemption":{"quantity":10},"code_config":{"pattern":"10OFF-#######"}},"validity_timeframe":{"interval":"P2D","duration":"P1D"},"validity_day_of_week":[0,1,2],"activity_duration_after_publishing":"P24D","use_voucher_metadata_schema":false,"metadata":{"region":"AMER"}}; // \OpenAPI\Client\Model\CampaignsCreateRequestBody | Specify the details of the campaign that you would like to create.
|**campaigns_create_request_body**|[**\OpenAPI\Client\Model\CampaignsCreateRequestBody**](../Model/CampaignsCreateRequestBody.md)| Specify the details of the campaign that you would like to create. |[optional]|
Copy file name to clipboardExpand all lines: docs/Api/RedemptionsApi.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -182,7 +182,7 @@ $limit = 56; // int | A limit on the number of objects to be returned. Limit can
182
182
$page = 56; // int | Which page of results to return.
183
183
$result = 'result_example'; // string | A filter on the list based on the redemption result. Available options are: `SUCCESS`, `FAILURE`. You can provide multiple values by repeating the param.
184
184
$campaign = 'campaign_example'; // string | A filter by the campaign **name** that the redemption resources originate from.
185
-
$customer = 'customer_example'; // string | Return redemptions performed by the customer with given `id`.
185
+
$customer = 'customer_example'; // string | Return redemptions performed by the customer with given `id` or `source_id`.
186
186
$order = new \OpenAPI\Client\Model\ParameterOrderListRedemptions(); // ParameterOrderListRedemptions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
187
187
$created_at = new \OpenAPI\Client\Model\ParameterCreatedBeforeAfter(); // ParameterCreatedBeforeAfter | A filter on the list based on the object `created_at` field. The value is a dictionary with the following options: `before`, `after`. A date value must be presented in ISO 8601 format (`2016-11-16T14:14:31Z` or `2016-11-16`). An example: `[created_at][before]=2017-09-08T13:52:18.227Z`
188
188
$filters = new \OpenAPI\Client\Model\ParameterFiltersListRedemptions(); // ParameterFiltersListRedemptions | Filters for listing responses.
@@ -203,7 +203,7 @@ try {
203
203
|**page**|**int**| Which page of results to return. |[optional]|
204
204
|**result**|**string**| A filter on the list based on the redemption result. Available options are: `SUCCESS`, `FAILURE`. You can provide multiple values by repeating the param. |[optional]|
205
205
|**campaign**|**string**| A filter by the campaign **name** that the redemption resources originate from. |[optional]|
206
-
|**customer**|**string**| Return redemptions performed by the customer with given `id`. |[optional]|
206
+
|**customer**|**string**| Return redemptions performed by the customer with given `id` or `source_id`. |[optional]|
207
207
|**order**|[**ParameterOrderListRedemptions**](../Model/.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. |[optional]|
208
208
|**created_at**|[**ParameterCreatedBeforeAfter**](../Model/.md)| A filter on the list based on the object `created_at` field. The value is a dictionary with the following options: `before`, `after`. A date value must be presented in ISO 8601 format (`2016-11-16T14:14:31Z` or `2016-11-16`). An example: `[created_at][before]=2017-09-08T13:52:18.227Z`|[optional]|
209
209
|**filters**|[**ParameterFiltersListRedemptions**](../Model/.md)| Filters for listing responses. |[optional]|
0 commit comments