Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * ErrorCode.
5 *
6 * @category Enum
7 *
8 * @author   Fingerprint
9 *
10 * @see      https://fingerprint.com
11 */
12
13/**
14 * Server API.
15 *
16 * Fingerprint Server API allows you to get, search, and update Events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.
17 *
18 * The version of the OpenAPI document: 4
19 * Contact: support@fingerprint.com
20 * Generated by: https://openapi-generator.tech
21 * Generator version: 7.21.0
22 */
23
24/**
25 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26 * https://openapi-generator.tech
27 * Do not edit the class manually.
28 */
29
30namespace Fingerprint\ServerSdk\Model;
31
32/**
33 * Error code:
34 * `request_cannot_be_parsed` - The query parameters or JSON payload contains some errors
35 * that prevented us from parsing it (wrong type/surpassed limits).
36 * `secret_api_key_required` - secret API key in header is missing or empty.
37 * `secret_api_key_not_found` - No Fingerprint workspace found for specified secret API key.
38 * `public_api_key_required` - public API key in header is missing or empty.
39 * `public_api_key_not_found` - No Fingerprint workspace found for specified public API key.
40 * `subscription_not_active` - Fingerprint workspace is not active.
41 * `wrong_region` - Server and workspace region differ.
42 * `feature_not_enabled` - This feature (for example, Delete API) is not enabled for your workspace.
43 * `visitor_not_found` - The specified visitor ID was not found. It never existed or it may have already been deleted.
44 * `too_many_requests` - The limit on secret API key requests per second has been exceeded.
45 * `state_not_ready` - The event specified with event ID is
46 * not ready for updates yet. Try again.
47 * This error happens in rare cases when update API is called immediately
48 * after receiving the event ID on the client. In case you need to send
49 * information right away, we recommend using the JS agent API instead.
50 * `failed` - Internal server error.
51 * `event_not_found` - The specified event ID was not found. It never existed, expired, or it has been deleted.
52 * `missing_module` - The request is invalid because it is missing a required module.
53 * `payload_too_large` - The request payload is too large and cannot be processed.
54 * `service_unavailable` - The service was unable to process the request.
55 * `ruleset_not_found` - The specified ruleset was not found. It never existed or it has been deleted.
56 *
57 * @category Enum
58 *
59 * @description Error code: * &#x60;request_cannot_be_parsed&#x60; - The query parameters or JSON payload contains some errors   that prevented us from parsing it (wrong type/surpassed limits). * &#x60;secret_api_key_required&#x60; - secret API key in header is missing or empty. * &#x60;secret_api_key_not_found&#x60; - No Fingerprint workspace found for specified secret API key. * &#x60;public_api_key_required&#x60; - public API key in header is missing or empty. * &#x60;public_api_key_not_found&#x60; - No Fingerprint workspace found for specified public API key. * &#x60;subscription_not_active&#x60; - Fingerprint workspace is not active. * &#x60;wrong_region&#x60; - Server and workspace region differ. * &#x60;feature_not_enabled&#x60; - This feature (for example, Delete API) is not enabled for your workspace. * &#x60;visitor_not_found&#x60; - The specified visitor ID was not found. It never existed or it may have already been deleted. * &#x60;too_many_requests&#x60; - The limit on secret API key requests per second has been exceeded. * &#x60;state_not_ready&#x60; - The event specified with event ID is   not ready for updates yet. Try again.   This error happens in rare cases when update API is called immediately   after receiving the event ID on the client. In case you need to send   information right away, we recommend using the JS agent API instead. * &#x60;failed&#x60; - Internal server error. * &#x60;event_not_found&#x60; - The specified event ID was not found. It never existed, expired, or it has been deleted. * &#x60;missing_module&#x60; - The request is invalid because it is missing a required module. * &#x60;payload_too_large&#x60; - The request payload is too large and cannot be processed. * &#x60;service_unavailable&#x60; - The service was unable to process the request. * &#x60;ruleset_not_found&#x60; - The specified ruleset was not found. It never existed or it has been deleted.
60 *
61 * @author   Fingerprint
62 *
63 * @see      https://fingerprint.com
64 *
65 * @noinspection GrazieInspection
66 * @noinspection RedundantSuppression
67 */
68enum ErrorCode: string
69{
70    case REQUEST_CANNOT_BE_PARSED = 'request_cannot_be_parsed';
71    case SECRET_API_KEY_REQUIRED = 'secret_api_key_required';
72    case SECRET_API_KEY_NOT_FOUND = 'secret_api_key_not_found';
73    case PUBLIC_API_KEY_REQUIRED = 'public_api_key_required';
74    case PUBLIC_API_KEY_NOT_FOUND = 'public_api_key_not_found';
75    case SUBSCRIPTION_NOT_ACTIVE = 'subscription_not_active';
76    case WRONG_REGION = 'wrong_region';
77    case FEATURE_NOT_ENABLED = 'feature_not_enabled';
78    case VISITOR_NOT_FOUND = 'visitor_not_found';
79    case TOO_MANY_REQUESTS = 'too_many_requests';
80    case STATE_NOT_READY = 'state_not_ready';
81    case FAILED = 'failed';
82    case EVENT_NOT_FOUND = 'event_not_found';
83    case MISSING_MODULE = 'missing_module';
84    case PAYLOAD_TOO_LARGE = 'payload_too_large';
85    case SERVICE_UNAVAILABLE = 'service_unavailable';
86    case RULESET_NOT_FOUND = 'ruleset_not_found';
87}