Skip to content
This repository was archived by the owner on Sep 3, 2024. It is now read-only.

Commit 3a5d504

Browse files
committed
rename api keys
1 parent 22417c1 commit 3a5d504

19 files changed

+414
-422
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ require_once(__DIR__ . '/vendor/autoload.php');
4949

5050

5151

52-
// Configure API key authorization: X-App-Id-1
52+
// Configure API key authorization: X-App-Id
5353
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
5454
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
5555
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
5656

57-
// Configure API key authorization: X-App-Token-1
57+
// Configure API key authorization: X-App-Token
5858
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
5959
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6060
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -839,45 +839,37 @@ Class | Method | HTTP request | Description
839839

840840
## Authorization
841841

842-
### X-App-Id-1
842+
### X-App-Id
843843

844844
- **Type**: API key
845845
- **API key parameter name**: X-App-Id
846846
- **Location**: HTTP header
847847

848848

849849

850-
### X-App-Token-1
850+
### X-App-Token
851851

852852
- **Type**: API key
853853
- **API key parameter name**: X-App-Token
854854
- **Location**: HTTP header
855855

856856

857857

858-
### X-Client-Token-1
858+
### X-Client-Token
859859

860860
- **Type**: API key
861861
- **API key parameter name**: X-Client-Token
862862
- **Location**: HTTP header
863863

864864

865865

866-
### X-Client-Application-Id-1
866+
### X-Client-Application-Id
867867

868868
- **Type**: API key
869869
- **API key parameter name**: X-Client-Application-Id
870870
- **Location**: HTTP header
871871

872872

873-
874-
### Download-Token-1
875-
876-
- **Type**: API key
877-
- **API key parameter name**: token
878-
- **Location**: URL query string
879-
880-
881873
## Run local tests with docker
882874

883875
1. Copy `.env.example` to `.env` and fill in the values.

docs/Api/CampaignsApi.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ This method gives a possibility to add a new voucher to an existing campaign. Th
3434
require_once(__DIR__ . '/vendor/autoload.php');
3535

3636

37-
// Configure API key authorization: X-App-Id-1
37+
// Configure API key authorization: X-App-Id
3838
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
3939
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
4040
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
4141

42-
// Configure API key authorization: X-App-Token-1
42+
// Configure API key authorization: X-App-Token
4343
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
4444
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
4545
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -77,7 +77,7 @@ try {
7777

7878
### Authorization
7979

80-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
80+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
8181

8282
### HTTP request headers
8383

@@ -105,12 +105,12 @@ This method gives the possibility to push new vouchers to an existing campaign.
105105
require_once(__DIR__ . '/vendor/autoload.php');
106106

107107

108-
// Configure API key authorization: X-App-Id-1
108+
// Configure API key authorization: X-App-Id
109109
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
110110
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
111111
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
112112

113-
// Configure API key authorization: X-App-Token-1
113+
// Configure API key authorization: X-App-Token
114114
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
115115
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
116116
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -148,7 +148,7 @@ try {
148148

149149
### Authorization
150150

151-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
151+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
152152

153153
### HTTP request headers
154154

@@ -176,12 +176,12 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose
176176
require_once(__DIR__ . '/vendor/autoload.php');
177177

178178

179-
// Configure API key authorization: X-App-Id-1
179+
// Configure API key authorization: X-App-Id
180180
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
181181
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
182182
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
183183

184-
// Configure API key authorization: X-App-Token-1
184+
// Configure API key authorization: X-App-Token
185185
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
186186
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
187187
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -215,7 +215,7 @@ try {
215215

216216
### Authorization
217217

218-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
218+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
219219

220220
### HTTP request headers
221221

@@ -243,12 +243,12 @@ Permanently deletes a campaign and all related vouchers. This action cannot be u
243243
require_once(__DIR__ . '/vendor/autoload.php');
244244

245245

246-
// Configure API key authorization: X-App-Id-1
246+
// Configure API key authorization: X-App-Id
247247
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
248248
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
249249
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
250250

251-
// Configure API key authorization: X-App-Token-1
251+
// Configure API key authorization: X-App-Token
252252
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
253253
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
254254
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -284,7 +284,7 @@ try {
284284

285285
### Authorization
286286

287-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
287+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
288288

289289
### HTTP request headers
290290

@@ -312,12 +312,12 @@ There are various times when you'll want to manage a campaign's accessibility. T
312312
require_once(__DIR__ . '/vendor/autoload.php');
313313

314314

315-
// Configure API key authorization: X-App-Id-1
315+
// Configure API key authorization: X-App-Id
316316
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
317317
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
318318
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
319319

320-
// Configure API key authorization: X-App-Token-1
320+
// Configure API key authorization: X-App-Token
321321
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
322322
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
323323
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -351,7 +351,7 @@ try {
351351

352352
### Authorization
353353

354-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
354+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
355355

356356
### HTTP request headers
357357

@@ -379,12 +379,12 @@ There are various times when you'll want to manage a campaign's accessibility. T
379379
require_once(__DIR__ . '/vendor/autoload.php');
380380

381381

382-
// Configure API key authorization: X-App-Id-1
382+
// Configure API key authorization: X-App-Id
383383
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
384384
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
385385
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
386386

387-
// Configure API key authorization: X-App-Token-1
387+
// Configure API key authorization: X-App-Token
388388
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
389389
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
390390
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -418,7 +418,7 @@ try {
418418

419419
### Authorization
420420

421-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
421+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
422422

423423
### HTTP request headers
424424

@@ -446,12 +446,12 @@ Retrieves the campaign with the given campaign ID or campaign name.
446446
require_once(__DIR__ . '/vendor/autoload.php');
447447

448448

449-
// Configure API key authorization: X-App-Id-1
449+
// Configure API key authorization: X-App-Id
450450
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
451451
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
452452
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
453453

454-
// Configure API key authorization: X-App-Token-1
454+
// Configure API key authorization: X-App-Token
455455
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
456456
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
457457
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -485,7 +485,7 @@ try {
485485

486486
### Authorization
487487

488-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
488+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
489489

490490
### HTTP request headers
491491

@@ -513,12 +513,12 @@ Imports vouchers to an **existing** campaign. This API request starts a process
513513
require_once(__DIR__ . '/vendor/autoload.php');
514514

515515

516-
// Configure API key authorization: X-App-Id-1
516+
// Configure API key authorization: X-App-Id
517517
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
518518
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
519519
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
520520

521-
// Configure API key authorization: X-App-Token-1
521+
// Configure API key authorization: X-App-Token
522522
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
523523
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
524524
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -554,7 +554,7 @@ try {
554554

555555
### Authorization
556556

557-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
557+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
558558

559559
### HTTP request headers
560560

@@ -582,12 +582,12 @@ Imports vouchers to an **existing** campaign. The CSV file has to include he
582582
require_once(__DIR__ . '/vendor/autoload.php');
583583

584584

585-
// Configure API key authorization: X-App-Id-1
585+
// Configure API key authorization: X-App-Id
586586
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
587587
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
588588
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
589589

590-
// Configure API key authorization: X-App-Token-1
590+
// Configure API key authorization: X-App-Token
591591
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
592592
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
593593
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -623,7 +623,7 @@ try {
623623

624624
### Authorization
625625

626-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
626+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
627627

628628
### HTTP request headers
629629

@@ -651,12 +651,12 @@ Retrieve a list of campaigns in a project. The campaigns are returned sorted b
651651
require_once(__DIR__ . '/vendor/autoload.php');
652652

653653

654-
// Configure API key authorization: X-App-Id-1
654+
// Configure API key authorization: X-App-Id
655655
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
656656
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
657657
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
658658

659-
// Configure API key authorization: X-App-Token-1
659+
// Configure API key authorization: X-App-Token
660660
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
661661
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
662662
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -698,7 +698,7 @@ try {
698698

699699
### Authorization
700700

701-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
701+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
702702

703703
### HTTP request headers
704704

@@ -726,12 +726,12 @@ Updates the specified campaign by setting the values of the parameters passed in
726726
require_once(__DIR__ . '/vendor/autoload.php');
727727

728728

729-
// Configure API key authorization: X-App-Id-1
729+
// Configure API key authorization: X-App-Id
730730
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
731731
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
732732
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
733733

734-
// Configure API key authorization: X-App-Token-1
734+
// Configure API key authorization: X-App-Token
735735
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
736736
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
737737
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
@@ -767,7 +767,7 @@ try {
767767

768768
### Authorization
769769

770-
[X-App-Id-1](../../README.md#X-App-Id-1), [X-App-Token-1](../../README.md#X-App-Token-1)
770+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
771771

772772
### HTTP request headers
773773

0 commit comments

Comments
 (0)