FastComments.com

FastComments PHP SDK

Dies ist das offizielle PHP-SDK für FastComments.

Offizielles PHP-SDK für die FastComments-API

Repository

Auf GitHub ansehen


Installation & Verwendung Internal Link

Anforderungen

PHP 7.4 und höher. Sollte auch mit PHP 8.0 funktionieren.

Composer

Um die Bindings über Composer zu installieren, fügen Sie Folgendes zu composer.json hinzu:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/fastcomments/fastcomments-php.git"
    }
  ],
  "require": {
    "fastcomments/fastcomments-php": "*@dev"
  }
}

Führen Sie dann composer install aus

Manuelle Installation

Laden Sie die Dateien herunter und binden Sie autoload.php ein:

<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');

Erste Schritte Internal Link

Bitte befolgen Sie die Installationsanleitung und führen Sie dann Folgendes aus:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// API-Schlüsselauthorisierung konfigurieren: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
    // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams

try {
    $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}

Modelle Internal Link



Autorisierung Internal Link


Für die API definierte Authentifizierungsschemata:

api_key

  • Typ: API-Schlüssel
  • Name des API-Schlüsselparameters: x-api-key
  • Ort: HTTP-Header

Autor Internal Link

support@fastcomments.com

aggregate Internal Link

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
parentTenantId string query Nein
includeStats boolean query Nein

Antwort

Gibt zurück: AggregationResponse

Beispiel

aggregate Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
20$parent_tenant_id = 'parent_tenant_id_example'; // string
21$include_stats = True; // bool
22
23try {
24 $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $parent_tenant_id, $include_stats);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
28}
29

getAuditLogs Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
limit number query Nein
skip number query Nein
order string query Nein
after number query Nein
before number query Nein

Antwort

Gibt zurück: GetAuditLogs200Response

Beispiel

getAuditLogs Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Auskommentierten Code unten aktivieren, um Präfix (z.B. Bearer) für den API-Schlüssel zu setzen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$limit = 3.4; // float
20$skip = 3.4; // float
21$order = new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(); // \FastComments\Client\Model\SORTDIR
22$after = 3.4; // float
23$before = 3.4; // float
24
25try {
26 $result = $apiInstance->getAuditLogs($tenant_id, $limit, $skip, $order, $after, $before);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
30}
31

blockFromCommentPublic Internal Link


Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
commentId string path Ja
sso string query Nein

Antwort

Gibt zurück: BlockFromCommentPublic200Response

Beispiel

blockFromCommentPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23

unBlockCommentPublic Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
commentId string path Ja
sso string query Nein

Antwort

Gibt zurück: UnBlockCommentPublic200Response

Beispiel

Beispiel für unBlockCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23

checkedCommentsForBlocked Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
commentIds string query Ja Eine durch Kommas getrennte Liste von Kommentar-IDs.
sso string query Nein

Antwort

Gibt zurück: CheckedCommentsForBlocked200Response

Beispiel

checkedCommentsForBlocked Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_ids = 'comment_ids_example'; // string | Eine durch Kommas getrennte Liste von Kommentar-IDs.
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
21}
22

blockUserFromComment Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
userId string query Nein
anonUserId string query Nein

Antwort

Gibt zurück: BlockFromCommentPublic200Response

Beispiel

blockUserFromComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
29}
30

createCommentPublic Internal Link

Parameter

Name Type Location Required Description
tenantId string path Ja
urlId string query Ja
broadcastId string query Ja
sessionId string query Nein
sso string query Nein

Antwort

Gibt zurück: CreateCommentPublic200Response

Beispiel

createCommentPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, standardmäßig wird `GuzzleHttp\Client` verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
16$session_id = 'session_id_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $session_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25

deleteComment Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
contextUserId string query Nein
isLive boolean query Nein

Antwort

Gibt zurück: DeleteComment200Response

Beispiel

Beispiel für deleteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$context_user_id = 'context_user_id_example'; // string
21$is_live = True; // bool
22
23try {
24 $result = $apiInstance->deleteComment($tenant_id, $id, $context_user_id, $is_live);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
28}
29

deleteCommentPublic Internal Link


Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
editKey string query Nein
sso string query Nein

Antwort

Gibt zurück: DeleteCommentPublic200Response

Beispiel

deleteCommentPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$edit_key = 'edit_key_example'; // string
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $edit_key, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
23}
24

deleteCommentVote Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string path Ja
commentId string path Ja
voteId string path Ja
urlId string query Ja
broadcastId string query Ja
editKey string query Nein
sso string query Nein

Antwort

Gibt zurück: DeleteCommentVote200Response

Beispiel

Beispiel für deleteCommentVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$vote_id = 'vote_id_example'; // string
15$url_id = 'url_id_example'; // string
16$broadcast_id = 'broadcast_id_example'; // string
17$edit_key = 'edit_key_example'; // string
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $edit_key, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
25}
26

flagComment Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
id string path Yes
userId string query No
anonUserId string query No

Antwort

Gibt zurück: FlagComment200Response

Beispiel

flagComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->flagComment($tenant_id, $id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
28}
29

getComment Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetComment200Response

Beispiel

getComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// API-Schlüssel-Authentifizierung konfigurieren: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // Dies ist optional, es wird standardmäßig `GuzzleHttp\Client` verwendet.
19 new GuzzleHttp\Client(),
20 $config
21);
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24
25try {
26 $result = $apiInstance->getComment($tenant_id, $id);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
30}
31

getComments Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
page integer query Nein
limit integer query Nein
skip integer query Nein
asTree boolean query Nein
skipChildren integer query Nein
limitChildren integer query Nein
maxTreeDepth integer query Nein
urlId string query Nein
userId string query Nein
anonUserId string query Nein
contextUserId string query Nein
hashTag string query Nein
parentId string query Nein
direction string query Nein

Antwort

Gibt zurück: GetComments200Response

Beispiel

getComments Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentieren Sie die folgende Zeile aus, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$page = 56; // int
20$limit = 56; // int
21$skip = 56; // int
22$as_tree = True; // bool
23$skip_children = 56; // int
24$limit_children = 56; // int
25$max_tree_depth = 56; // int
26$url_id = 'url_id_example'; // string
27$user_id = 'user_id_example'; // string
28$anon_user_id = 'anon_user_id_example'; // string
29$context_user_id = 'context_user_id_example'; // string
30$hash_tag = 'hash_tag_example'; // string
31$parent_id = 'parent_id_example'; // string
32$direction = new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(); // \FastComments\Client\Model\SortDirections
33
34try {
35 $result = $apiInstance->getComments($tenant_id, $page, $limit, $skip, $as_tree, $skip_children, $limit_children, $max_tree_depth, $url_id, $user_id, $anon_user_id, $context_user_id, $hash_tag, $parent_id, $direction);
36 print_r($result);
37} catch (Exception $e) {
38 echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
39}
40

getCommentsPublic Internal Link

req tenantId urlId

Parameter

Name Type Location Required Description
tenantId string path Ja
urlId string query Ja
page integer query Nein
direction string query Nein
sso string query Nein
skip integer query Nein
skipChildren integer query Nein
limit integer query Nein
limitChildren integer query Nein
countChildren boolean query Nein
fetchPageForCommentId string query Nein
includeConfig boolean query Nein
countAll boolean query Nein
includei10n boolean query Nein
locale string query Nein
modules string query Nein
isCrawler boolean query Nein
includeNotificationCount boolean query Nein
asTree boolean query Nein
maxTreeDepth integer query Nein
useFullTranslationIds boolean query Nein
parentId string query Nein
searchText string query Nein
hashTags array query Nein
userId string query Nein
customConfigStr string query Nein
afterCommentId string query Nein
beforeCommentId string query Nein

Antwort

Gibt zurück: GetCommentsPublic200Response

Beispiel

getCommentsPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$page = 56; // int
15$direction = new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(); // \FastComments\Client\Model\SortDirections
16$sso = 'sso_example'; // string
17$skip = 56; // int
18$skip_children = 56; // int
19$limit = 56; // int
20$limit_children = 56; // int
21$count_children = True; // bool
22$fetch_page_for_comment_id = 'fetch_page_for_comment_id_example'; // string
23$include_config = True; // bool
24$count_all = True; // bool
25$includei10n = True; // bool
26$locale = 'locale_example'; // string
27$modules = 'modules_example'; // string
28$is_crawler = True; // bool
29$include_notification_count = True; // bool
30$as_tree = True; // bool
31$max_tree_depth = 56; // int
32$use_full_translation_ids = True; // bool
33$parent_id = 'parent_id_example'; // string
34$search_text = 'search_text_example'; // string
35$hash_tags = array('hash_tags_example'); // string[]
36$user_id = 'user_id_example'; // string
37$custom_config_str = 'custom_config_str_example'; // string
38$after_comment_id = 'after_comment_id_example'; // string
39$before_comment_id = 'before_comment_id_example'; // string
40
41try {
42 $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $page, $direction, $sso, $skip, $skip_children, $limit, $limit_children, $count_children, $fetch_page_for_comment_id, $include_config, $count_all, $includei10n, $locale, $modules, $is_crawler, $include_notification_count, $as_tree, $max_tree_depth, $use_full_translation_ids, $parent_id, $search_text, $hash_tags, $user_id, $custom_config_str, $after_comment_id, $before_comment_id);
43 print_r($result);
44} catch (Exception $e) {
45 echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
46}
47

getCommentText Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
commentId string path Ja
editKey string query Nein
sso string query Nein

Antwort

Gibt zurück: GetCommentText200Response

Beispiel

getCommentText Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$edit_key = 'edit_key_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->getCommentText($tenant_id, $comment_id, $edit_key, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
22}
23

getCommentVoteUserNames Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Yes
commentId string path Yes
dir integer query Yes
sso string query No

Antwort

Gibt zurück: GetCommentVoteUserNames200Response

Beispiel

getCommentVoteUserNames Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$dir = 56; // int
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
22}
23

lockComment Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
sso string query Nein

Antwort

Gibt zurück: LockComment200Response

Beispiel

lockComment-Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Das ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
22}
23

pinComment Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
sso string query Nein

Antwort

Gibt zurück: PinComment200Response

Beispiel

Beispiel für pinComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
22}
23

saveComment Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
isLive boolean query Nein
doSpamCheck boolean query Nein
sendEmails boolean query Nein
populateNotifications boolean query Nein

Antwort

Gibt zurück: SaveComment200Response

Beispiel

saveComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie die folgende Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie einen Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
20$is_live = True; // bool
21$do_spam_check = True; // bool
22$send_emails = True; // bool
23$populate_notifications = True; // bool
24
25try {
26 $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $is_live, $do_spam_check, $send_emails, $populate_notifications);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
30}
31

saveCommentsBulk Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
isLive boolean query Nein
doSpamCheck boolean query Nein
sendEmails boolean query Nein
populateNotifications boolean query Nein

Antwort

Gibt zurück: SaveComment200Response

Beispiel

saveCommentsBulk Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
20$is_live = True; // bool
21$do_spam_check = True; // bool
22$send_emails = True; // bool
23$populate_notifications = True; // bool
24
25try {
26 $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $is_live, $do_spam_check, $send_emails, $populate_notifications);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
30}
31

setCommentText Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
editKey string query Nein
sso string query Nein

Antwort

Gibt zurück: SetCommentText200Response

Beispiel

Beispiel für setCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
16$edit_key = 'edit_key_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $edit_key, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
24}
25

unBlockUserFromComment Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
userId string query Nein
anonUserId string query Nein

Antwort

Gibt zurück: UnBlockCommentPublic200Response

Beispiel

unBlockUserFromComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentarzeichen unten entfernen, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Das ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
29}
30

unFlagComment Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
userId string query Nein
anonUserId string query Nein

Antwort

Gibt zurück: FlagComment200Response

Beispiel

Beispiel für unFlagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->unFlagComment($tenant_id, $id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
28}
29

unLockComment Internal Link

Parameter

Name Type Location Required Description
tenantId string Pfad Ja
commentId string Pfad Ja
broadcastId string query Ja
sso string query Nein

Antwort

Gibt zurück: LockComment200Response

Beispiel

unLockComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
22}
23

unPinComment Internal Link

Parameter

Name Type Location Required Description
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
sso string query Nein

Antwort

Gibt zurück: PinComment200Response

Beispiel

unPinComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
22}
23

updateComment Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
contextUserId string query Nein
doSpamCheck boolean query Nein
isLive boolean query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierten Code einkommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$body = new \FastComments\Client\Model\PickAPICommentUpdatableCommentFields(); // \FastComments\Client\Model\PickAPICommentUpdatableCommentFields
21$context_user_id = 'context_user_id_example'; // string
22$do_spam_check = True; // bool
23$is_live = True; // bool
24
25try {
26 $result = $apiInstance->updateComment($tenant_id, $id, $body, $context_user_id, $do_spam_check, $is_live);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
30}
31

voteComment Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string path Ja
commentId string path Ja
urlId string query Ja
broadcastId string query Ja
sessionId string query Nein
sso string query Nein

Antwort

Gibt zurück: VoteComment200Response

Beispiel

voteComment Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$url_id = 'url_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
17$session_id = 'session_id_example'; // string
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $session_id, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
25}
26

addDomainConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: AddDomainConfig200Response

Beispiel

addDomainConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
20
21try {
22 $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27

deleteDomainConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
domain string path Ja

Antwort

Rückgabe: DeleteDomainConfig200Response

Beispiel

Beispiel für deleteDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentarzeichen unten entfernen, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain = 'domain_example'; // string
20
21try {
22 $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getDomainConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
domain string path Yes

Antwort

Gibt zurück: GetDomainConfig200Response

Beispiel

getDomainConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierten Code einkommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain = 'domain_example'; // string
20
21try {
22 $result = $apiInstance->getDomainConfig($tenant_id, $domain);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getDomainConfigs Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: GetDomainConfigs200Response

Beispiel

Beispiel für getDomainConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie unten die Kommentarzeichen, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19
20try {
21 $result = $apiInstance->getDomainConfigs($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
25}
26

patchDomainConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
domainToUpdate string path Ja

Antwort

Gibt zurück: GetDomainConfig200Response

Beispiel

patchDomainConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Auskommentierung unten aufheben, um Präfix (z. B. Bearer) für API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain_to_update = 'domain_to_update_example'; // string
20$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
21
22try {
23 $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
27}
28

putDomainConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
domainToUpdate string path Ja

Antwort

Gibt zurück: GetDomainConfig200Response

Beispiel

putDomainConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Untenstehende Zeile auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain_to_update = 'domain_to_update_example'; // string
20$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
21
22try {
23 $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
27}
28

createEmailTemplate Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: CreateEmailTemplate200Response

Beispiel

createEmailTemplate Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfiguriere API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
20
21try {
22 $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27

deleteEmailTemplate Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
id string path Yes

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteEmailTemplate Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27

deleteEmailTemplateRenderError Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
id string path Yes
errorId string path Yes

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteEmailTemplateRenderError Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie den Kommentar unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie einen Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$error_id = 'error_id_example'; // string
21
22try {
23 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
27}
28

getEmailTemplate Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetEmailTemplate200Response

Beispiel

getEmailTemplate Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten entkommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getEmailTemplate($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27

getEmailTemplateDefinitions Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: GetEmailTemplateDefinitions200Response

Beispiel

getEmailTemplateDefinitions Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierten Code aktivieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, geben Sie Ihren Client an, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19
20try {
21 $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
25}
26

getEmailTemplateRenderErrors Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Yes
id string path Yes
skip number query No

Antwort

Gibt zurück: GetEmailTemplateRenderErrors200Response

Beispiel

getEmailTemplateRenderErrors Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$skip = 3.4; // float
21
22try {
23 $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
27}
28

getEmailTemplates Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
skip number query Nein

Antwort

Gibt zurück: GetEmailTemplates200Response

Beispiel

getEmailTemplates Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
26}
27

renderEmailTemplate Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
locale string query Nein

Antwort

Gibt zurück: RenderEmailTemplate200Response

Beispiel

renderEmailTemplate Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüsselautorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
20$locale = 'locale_example'; // string
21
22try {
23 $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
27}
28

updateEmailTemplate Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateEmailTemplate Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_email_template_body = new \FastComments\Client\Model\UpdateEmailTemplateBody(); // \FastComments\Client\Model\UpdateEmailTemplateBody
21
22try {
23 $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
27}
28

getEventLog Internal Link

req tenantId urlId userIdWS

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
urlId string query Ja
userIdWS string query Ja
startTime integer query Ja
endTime integer query Ja

Antwort

Gibt zurück: GetEventLog200Response

Beispiel

Beispiel für getEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, geben Sie Ihren Client an, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$user_id_ws = 'user_id_ws_example'; // string
15$start_time = 56; // int
16$end_time = 56; // int
17
18try {
19 $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
23}
24

getGlobalEventLog Internal Link

req tenantId urlId userIdWS

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Yes
urlId string query Yes
userIdWS string query Yes
startTime integer query Yes
endTime integer query Yes

Antwort

Gibt zurück: GetEventLog200Response

Beispiel

getGlobalEventLog Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$user_id_ws = 'user_id_ws_example'; // string
15$start_time = 56; // int
16$end_time = 56; // int
17
18try {
19 $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
23}
24

createFeedPost Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
broadcastId string query Nein
isLive boolean query Nein
doSpamCheck boolean query Nein
skipDupCheck boolean query Nein

Antwort

Gibt zurück: CreateFeedPost200Response

Beispiel

createFeedPost Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Bei Bedarf die folgende Zeile auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
20$broadcast_id = 'broadcast_id_example'; // string
21$is_live = True; // bool
22$do_spam_check = True; // bool
23$skip_dup_check = True; // bool
24
25try {
26 $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $broadcast_id, $is_live, $do_spam_check, $skip_dup_check);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
30}
31

createFeedPostPublic Internal Link

Parameter

Name Type Ort Erforderlich Beschreibung
tenantId string path Ja
broadcastId string query Nein
sso string query Nein

Antwort

Gibt zurück: CreateFeedPostPublic200Response

Beispiel

createFeedPostPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
22}
23

deleteFeedPostPublic Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
postId string path Ja
broadcastId string query Nein
sso string query Nein

Antwort

Gibt zurück: DeleteFeedPostPublic200Response

Beispiel

deleteFeedPostPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
22}
23

getFeedPosts Internal Link

req tenantId afterId

Parameter

Name Type Location Required Description
tenantId string query Ja
afterId string query Nein
limit integer query Nein
tags array query Nein

Antwort

Gibt zurück: GetFeedPosts200Response

Beispiel

getFeedPosts Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierten Code einkommentieren, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzustellen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$after_id = 'after_id_example'; // string
20$limit = 56; // int
21$tags = array('tags_example'); // string[]
22
23try {
24 $result = $apiInstance->getFeedPosts($tenant_id, $after_id, $limit, $tags);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
28}
29

getFeedPostsPublic Internal Link

req tenantId afterId

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string path Ja
afterId string query Nein
limit integer query Nein
tags array query Nein
sso string query Nein
isCrawler boolean query Nein
includeUserInfo boolean query Nein

Antwort

Gibt zurück: GetFeedPostsPublic200Response

Beispiel

getFeedPostsPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$after_id = 'after_id_example'; // string
14$limit = 56; // int
15$tags = array('tags_example'); // string[]
16$sso = 'sso_example'; // string
17$is_crawler = True; // bool
18$include_user_info = True; // bool
19
20try {
21 $result = $apiInstance->getFeedPostsPublic($tenant_id, $after_id, $limit, $tags, $sso, $is_crawler, $include_user_info);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
25}
26

getFeedPostsStats Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
postIds array query Ja
sso string query Nein

Antwort

Gibt zurück: GetFeedPostsStats200Response

Beispiel

getFeedPostsStats Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_ids = array('post_ids_example'); // string[]
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
21}
22

getUserReactsPublic Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
postIds array query Nein
sso string query Nein

Antwort

Gibt zurück: GetUserReactsPublic200Response

Beispiel

getUserReactsPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_ids = array('post_ids_example'); // string[]
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->getUserReactsPublic($tenant_id, $post_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
21}
22

reactFeedPostPublic Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string path Ja
postId string path Ja
isUndo boolean query Nein
broadcastId string query Nein
sso string query Nein

Antwort

Gibt zurück: ReactFeedPostPublic200Response

Beispiel

reactFeedPostPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
15$is_undo = True; // bool
16$broadcast_id = 'broadcast_id_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $is_undo, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
24}
25

updateFeedPost Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
id string path Yes

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateFeedPost Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
21
22try {
23 $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
27}
28

updateFeedPostPublic Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string path Ja
postId string path Ja
broadcastId string query Nein
sso string query Nein

Antwort

Gibt zurück: CreateFeedPostPublic200Response

Beispiel

updateFeedPostPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, geben Sie Ihren Client an, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $broadcast_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
23}
24

flagCommentPublic Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
commentId string path Ja
isFlagged boolean query Ja
sso string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

flagCommentPublic Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$is_flagged = True; // bool
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23

addHashTag Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Nein

Antwort

Gibt zurück: AddHashTag200Response

Beispiel

addHashTag Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfiguriere API-Schlüssel-Autorisierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentieren Sie die folgende Zeile aus, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
20
21try {
22 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
26}
27

addHashTagsBulk Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Nein

Antwort

Gibt zurück: AddHashTagsBulk200Response

Beispiel

addHashTagsBulk Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
20
21try {
22 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
26}
27

deleteHashTag Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tag string path Ja
tenantId string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteHashTag-Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie die folgende Zeile, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tag = 'tag_example'; // string
19$tenant_id = 'tenant_id_example'; // string
20$delete_hash_tag_request = new \FastComments\Client\Model\DeleteHashTagRequest(); // \FastComments\Client\Model\DeleteHashTagRequest
21
22try {
23 $result = $apiInstance->deleteHashTag($tag, $tenant_id, $delete_hash_tag_request);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteHashTag: ', $e->getMessage(), PHP_EOL;
27}
28

getHashTags Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
page number query Nein

Antwort

Gibt zurück: GetHashTags200Response

Beispiel

getHashTags Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie einen Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$page = 3.4; // float
20
21try {
22 $result = $apiInstance->getHashTags($tenant_id, $page);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
26}
27

patchHashTag Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tag string path Ja
tenantId string query Nein

Antwort

Gibt zurück: PatchHashTag200Response

Beispiel

patchHashTag Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfigurieren der API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Aktivieren Sie die folgende Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tag = 'tag_example'; // string
19$tenant_id = 'tenant_id_example'; // string
20$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
21
22try {
23 $result = $apiInstance->patchHashTag($tag, $tenant_id, $update_hash_tag_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
27}
28

createModerator Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja

Antwort

Gibt zurück: CreateModerator200Response

Beispiel

createModerator Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfiguriere API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentar-Markierung unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
20
21try {
22 $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
26}
27

deleteModerator Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
sendEmail string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteModerator Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Auskommentierung unten, um ein Präfix (z.B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$send_email = 'send_email_example'; // string
21
22try {
23 $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
27}
28

getModerator Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetModerator200Response

Beispiel

getModerator Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getModerator($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
26}
27

getModerators Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
skip number query Nein

Antwort

Gibt zurück: GetModerators200Response

Beispiel

getModerators Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfigurieren Sie die API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getModerators($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
26}
27

sendInvite Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
fromName string query Ja

Rückgabe

Gibt zurück: FlagCommentPublic200Response

Beispiel

sendInvite Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen der folgenden Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$from_name = 'from_name_example'; // string
21
22try {
23 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
27}
28

updateModerator Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Response

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateModerator Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
21
22try {
23 $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
27}
28

deleteNotificationCount Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deleteNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfigurieren der API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentierung unten, um ein Präfix einzurichten (z. B. Bearer) für den API-Schlüssel, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
26}
27

getCachedNotificationCount Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetCachedNotificationCount200Response

Beispiel

getCachedNotificationCount Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
26}
27

getNotificationCount Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
userId string query Nein
urlId string query Nein
fromCommentId string query Nein
viewed boolean query Nein
type string query Nein

Antwort

Gibt zurück: GetNotificationCount200Response

Beispiel

getNotificationCount Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentiere unten aus, um ein Präfix einzurichten (z. B. Bearer) für den API-Schlüssel, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$url_id = 'url_id_example'; // string
21$from_comment_id = 'from_comment_id_example'; // string
22$viewed = True; // bool
23$type = 'type_example'; // string
24
25try {
26 $result = $apiInstance->getNotificationCount($tenant_id, $user_id, $url_id, $from_comment_id, $viewed, $type);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
30}
31

getNotifications Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
userId string query Nein
urlId string query Nein
fromCommentId string query Nein
viewed boolean query Nein
type string query Nein
skip number query Nein

Antwort

Gibt zurück: GetNotifications200Response

Beispiel

getNotifications Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// API-Schlüssel-Authentifizierung konfigurieren: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
18 new GuzzleHttp\Client(),
19 $config
20);
21$tenant_id = 'tenant_id_example'; // string
22$user_id = 'user_id_example'; // string
23$url_id = 'url_id_example'; // string
24$from_comment_id = 'from_comment_id_example'; // string
25$viewed = True; // bool
26$type = 'type_example'; // string
27$skip = 3.4; // float
28
29try {
30 $result = $apiInstance->getNotifications($tenant_id, $user_id, $url_id, $from_comment_id, $viewed, $type, $skip);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
34}
35

updateNotification Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
userId string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateNotification
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
21$user_id = 'user_id_example'; // string
22
23try {
24 $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
28}
29

addPage Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: AddPageAPIResponse

Beispiel

Beispiel für addPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Falls erforderlich: unten das Kommentarzeichen entfernen, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Das ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
20
21try {
22 $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
26}
27

deletePage Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: DeletePageAPIResponse

Beispiel

deletePage Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentierung unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deletePage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
26}
27

getPageByURLId Internal Link

Parameter

Name Type Location Erforderlich Beschreibung
tenantId string query Ja
urlId string query Ja

Antwort

Gibt zurück: GetPageByURLIdAPIResponse

Beispiel

getPageByURLId Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Dekommentieren Sie die nächste Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20
21try {
22 $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
26}
27

getPages Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: GetPagesAPIResponse

Beispiel

getPages Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfigurieren der API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie unten, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19
20try {
21 $result = $apiInstance->getPages($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
25}
26

patchPage Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: PatchPageAPIResponse

Beispiel

patchPage Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Key-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
21
22try {
23 $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
27}
28

deletePendingWebhookEvent Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deletePendingWebhookEvent Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
26}
27

getPendingWebhookEventCount Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
commentId string query Nein
externalId string query Nein
eventType string query Nein
type string query Nein
domain string query Nein
attemptCountGT number query Nein

Antwort

Gibt zurück: GetPendingWebhookEventCount200Response

Beispiel

getPendingWebhookEventCount Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$external_id = 'external_id_example'; // string
21$event_type = 'event_type_example'; // string
22$type = 'type_example'; // string
23$domain = 'domain_example'; // string
24$attempt_count_gt = 3.4; // float
25
26try {
27 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
31}
32

getPendingWebhookEvents Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
commentId string query Nein
externalId string query Nein
eventType string query Nein
type string query Nein
domain string query Nein
attemptCountGT number query Nein
skip number query Nein

Antwort

Gibt zurück: GetPendingWebhookEvents200Response

Beispiel

getPendingWebhookEvents Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Untenstehende Zeile auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls nötig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$external_id = 'external_id_example'; // string
21$event_type = 'event_type_example'; // string
22$type = 'type_example'; // string
23$domain = 'domain_example'; // string
24$attempt_count_gt = 3.4; // float
25$skip = 3.4; // float
26
27try {
28 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt, $skip);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
32}
33

createQuestionConfig Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: CreateQuestionConfig200Response

Beispiel

createQuestionConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
20
21try {
22 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27

deleteQuestionConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteQuestionConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Das ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetQuestionConfig200Response

Beispiel

getQuestionConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Auskommentierung unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls nötig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getQuestionConfig($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionConfigs Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
skip number query Nein

Antwort

Gibt zurück: GetQuestionConfigs200Response

Beispiel

getQuestionConfigs Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird als Standard verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
26}
27

updateQuestionConfig Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
id string path Yes

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateQuestionConfig Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Falls benötigt, die folgende Zeile einkommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_question_config_body = new \FastComments\Client\Model\UpdateQuestionConfigBody(); // \FastComments\Client\Model\UpdateQuestionConfigBody
21
22try {
23 $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
27}
28

createQuestionResult Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja

Antwort

Gibt zurück: CreateQuestionResult200Response

Beispiel

createQuestionResult Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
20
21try {
22 $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27

deleteQuestionResult Internal Link


Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteQuestionResult Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional. `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionResult Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetQuestionResult200Response

Beispiel

getQuestionResult Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getQuestionResult($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionResults Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
urlId string query No
userId string query No
startDate string query No
questionId string query No
questionIds string query No
skip number query No

Antwort

Gibt zurück: GetQuestionResults200Response

Beispiel

Beispiel für getQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Untenstehende Zeile auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls nötig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20$user_id = 'user_id_example'; // string
21$start_date = 'start_date_example'; // string
22$question_id = 'question_id_example'; // string
23$question_ids = 'question_ids_example'; // string
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getQuestionResults($tenant_id, $url_id, $user_id, $start_date, $question_id, $question_ids, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
31}
32

updateQuestionResult Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateQuestionResult Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfiguriere API-Schlüssel-Autorisierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
21
22try {
23 $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
27}
28

aggregateQuestionResults Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
questionId string query Nein
questionIds array query Nein
urlId string query Nein
timeBucket string query Nein
startDate string query Nein
forceRecalculate boolean query Nein

Antwort

Gibt zurück: AggregateQuestionResults200Response

Beispiel

Beispiel für aggregateQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$question_id = 'question_id_example'; // string
20$question_ids = array('question_ids_example'); // string[]
21$url_id = 'url_id_example'; // string
22$time_bucket = new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(); // \FastComments\Client\Model\AggregateTimeBucket
23$start_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
24$force_recalculate = True; // bool
25
26try {
27 $result = $apiInstance->aggregateQuestionResults($tenant_id, $question_id, $question_ids, $url_id, $time_bucket, $start_date, $force_recalculate);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
31}
32

bulkAggregateQuestionResults Internal Link

Parameter

Name Type Location Erforderlich Beschreibung
tenantId string query Ja
forceRecalculate boolean query Nein

Antwort

Gibt zurück: BulkAggregateQuestionResults200Response

Beispiel

bulkAggregateQuestionResults Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Auskommentieren Sie die folgende Zeile, um einen Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
20$force_recalculate = True; // bool
21
22try {
23 $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
27}
28

combineCommentsWithQuestionResults Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
questionId string query Nein
questionIds array query Nein
urlId string query Nein
startDate string query Nein
forceRecalculate boolean query Nein
minValue number query Nein
maxValue number query Nein
limit number query Nein

Antwort

Gibt zurück: CombineCommentsWithQuestionResults200Response

Beispiel

combineCommentsWithQuestionResults Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierten Code entfernen, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls nötig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$question_id = 'question_id_example'; // string
20$question_ids = array('question_ids_example'); // string[]
21$url_id = 'url_id_example'; // string
22$start_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
23$force_recalculate = True; // bool
24$min_value = 3.4; // float
25$max_value = 3.4; // float
26$limit = 3.4; // float
27
28try {
29 $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $question_id, $question_ids, $url_id, $start_date, $force_recalculate, $min_value, $max_value, $limit);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
33}
34

addSSOUser Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: AddSSOUserAPIResponse

Beispiel

addSSOUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Auskommentieren Sie die folgende Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
20
21try {
22 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
26}
27

deleteSSOUser Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
deleteComments boolean query Nein
commentDeleteMode string query Nein

Antwort

Gibt zurück: DeleteSSOUserAPIResponse

Beispiel

deleteSSOUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie die folgende Zeile, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$delete_comments = True; // bool
21$comment_delete_mode = 'comment_delete_mode_example'; // string
22
23try {
24 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

getSSOUserByEmail Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
email string path Ja

Antwort

Gibt zurück: GetSSOUserByEmailAPIResponse

Beispiel

getSSOUserByEmail Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Konfiguriere API-Schlüssel-Authentifizierung: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Entkommentieren Sie die folgende Zeile, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
19 new GuzzleHttp\Client(),
20 $config
21);
22$tenant_id = 'tenant_id_example'; // string
23$email = 'email_example'; // string
24
25try {
26 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
30}
31

getSSOUserById Internal Link

Parameter

Name Type Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetSSOUserByIdAPIResponse

Beispiel

getSSOUserById Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentar entfernen, um ein Präfix einzurichten (z. B. Bearer) für den API-Schlüssel, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getSSOUserById($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
26}
27

getSSOUsers Internal Link

Parameter

Name Type Location Required Description
tenantId string query Yes
skip integer query No

Antwort

Gibt zurück: GetSSOUsers200Response

Beispiel

getSSOUsers Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie die folgende Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 56; // int
20
21try {
22 $result = $apiInstance->getSSOUsers($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
26}
27

patchSSOUser Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
id string path Ja
updateComments boolean query Nein

Antwort

Gibt zurück: PatchSSOUserAPIResponse

Beispiel

patchSSOUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierten Code aktivieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
21$update_comments = True; // bool
22
23try {
24 $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

putSSOUser Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
id string path Ja
updateComments boolean query Nein

Antwort

Gibt zurück: PutSSOUserAPIResponse

Beispiel

putSSOUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um ein Präfix einzurichten (z. B. Bearer) für den API-Schlüssel, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
21$update_comments = True; // bool
22
23try {
24 $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

createSubscription Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: CreateSubscriptionAPIResponse

Beispiel

createSubscription Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Heben Sie unten die Kommentierung auf, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
20
21try {
22 $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
26}
27

deleteSubscription Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
id string path Ja
userId string query Nein

Antwort

Gibt zurück: DeleteSubscriptionAPIResponse

Beispiel

deleteSubscription Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21
22try {
23 $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
27}
28

getSubscriptions Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
userId string query Nein

Antwort

Gibt zurück: GetSubscriptionsAPIResponse

Beispiel

getSubscriptions Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um Präfix einzurichten (z. B. Bearer) für den API-Schlüssel, falls nötig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20
21try {
22 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantDailyUsages Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
yearNumber number query Nein
monthNumber number query Nein
dayNumber number query Nein
skip number query Nein

Antwort

Gibt zurück: GetTenantDailyUsages200Response

Beispiel

getTenantDailyUsages Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$year_number = 3.4; // float
20$month_number = 3.4; // float
21$day_number = 3.4; // float
22$skip = 3.4; // float
23
24try {
25 $result = $apiInstance->getTenantDailyUsages($tenant_id, $year_number, $month_number, $day_number, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
29}
30

createTenantPackage Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: CreateTenantPackage200Response

Beispiel

createTenantPackage Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfiguriere API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie die folgende Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
20
21try {
22 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27

deleteTenantPackage Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteTenantPackage Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfigurieren der API-Schlüssel-Authentifizierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantPackage Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetTenantPackage200Response

Beispiel

getTenantPackage Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getTenantPackage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantPackages Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
skip number query Nein

Antwort

Gibt zurück: GetTenantPackages200Response

Beispiel

getTenantPackages Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getTenantPackages($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
26}
27

replaceTenantPackage Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

replaceTenantPackage Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
21
22try {
23 $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28

updateTenantPackage Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
id string path Yes

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
21
22try {
23 $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28

createTenantUser Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes

Antwort

Gibt zurück: CreateTenantUser200Response

Beispiel

createTenantUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten entkommentieren, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
20
21try {
22 $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
26}
27

deleteTenantUser Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
id string path Ja
deleteComments string query Nein
commentDeleteMode string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deleteTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel festzulegen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie einen Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$delete_comments = 'delete_comments_example'; // string
21$comment_delete_mode = 'comment_delete_mode_example'; // string
22
23try {
24 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

getTenantUser Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetTenantUser200Response

Beispiel

getTenantUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfiguriere API-Schlüssel-Autorisierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentieren Sie die folgende Zeile aus, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getTenantUser($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantUsers Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
skip number query Nein

Antwort

Gibt zurück: GetTenantUsers200Response

Beispiel

getTenantUsers Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Nachfolgende Zeile auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getTenantUsers($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
26}
27

replaceTenantUser Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
updateComments string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

replaceTenantUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23try {
24 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
redirectURL string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

sendLoginLink Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie die folgende Zeile, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$redirect_url = 'redirect_url_example'; // string
21
22try {
23 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
27}
28

updateTenantUser Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
updateComments string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateTenantUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierten Code einkommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls nötig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23try {
24 $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

createTenant Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: CreateTenant200Response

Beispiel

createTenant Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, geben Sie Ihren Client an, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
20
21try {
22 $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
26}
27

deleteTenant Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
sure string query Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteTenant Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfiguriere API-Schlüssel-Autorisierung: api_key
7// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
13 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
14 new GuzzleHttp\Client(),
15 $config
16);
17$tenant_id = 'tenant_id_example'; // string
18$id = 'id_example'; // string
19$sure = 'sure_example'; // string
20
21try {
22 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
26}
27

getTenant Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetTenant200Response

Beispiel

getTenant Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getTenant($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
26}
27

getTenants Internal Link

Parameter

Name Type Location Required Description
tenantId string query Ja
meta string query Nein
skip number query Nein

Antwort

Gibt zurück: GetTenants200Response

Beispiel

getTenants-Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$meta = 'meta_example'; // string
20$skip = 3.4; // float
21
22try {
23 $result = $apiInstance->getTenants($tenant_id, $meta, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
27}
28

updateTenant Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
id string path Yes

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
21
22try {
23 $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
27}
28

uploadImage Internal Link

Bild hochladen und skalieren

Parameter

Name Type Location Required Description
tenantId string path Ja
sizePreset string query Nein Größen-Preset: "Default" (1000x1000px) oder "CrossPlatform" (erstellt Größen für gängige Geräte)
urlId string query Nein Seiten-ID, von der der Upload erfolgt, zur Konfiguration

Antwort

Gibt zurück: UploadImageResponse

Beispiel

uploadImage Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$file = '/path/to/file.txt'; // \SplFileObject
14$size_preset = new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(); // \FastComments\Client\Model\SizePreset | Größen-Preset: \"Default\" (1000x1000px) oder \"CrossPlatform\" (erstellt Größen für gängige Geräte)
15$url_id = 'url_id_example'; // string | Seiten-ID, von der der Upload erfolgt, zur Konfiguration
16
17try {
18 $result = $apiInstance->uploadImage($tenant_id, $file, $size_preset, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
22}
23

getUserBadgeProgressById Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetUserBadgeProgressById200Response

Beispiel

getUserBadgeProgressById Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Konfigurieren der API-Schlüssel-Autorisierung: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadgeProgressByUserId Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
userId string path Ja

Antwort

Gibt zurück: GetUserBadgeProgressById200Response

Beispiel

getUserBadgeProgressByUserId Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20
21try {
22 $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadgeProgressList Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
userId string query Nein
limit number query Nein
skip number query Nein

Antwort

Gibt zurück: GetUserBadgeProgressList200Response

Beispiel

getUserBadgeProgressList Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie die folgende Zeile, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$limit = 3.4; // float
21$skip = 3.4; // float
22
23try {
24 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $user_id, $limit, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
28}
29

createUserBadge Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja

Antwort

Gibt zurück: CreateUserBadge200Response

Beispiel

createUserBadge Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentierung unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
20
21try {
22 $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27

deleteUserBadge Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: UpdateUserBadge200Response

Beispiel

deleteUserBadge Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteUserBadge($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadge Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetUserBadge200Response

Beispiel

getUserBadge Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7// Unten auskommentieren, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
13 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
14 new GuzzleHttp\Client(),
15 $config
16);
17$tenant_id = 'tenant_id_example'; // string
18$id = 'id_example'; // string
19
20try {
21 $result = $apiInstance->getUserBadge($tenant_id, $id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
25}
26

getUserBadges Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
userId string query Nein
badgeId string query Nein
type number query Nein
displayedOnComments boolean query Nein
limit number query Nein
skip number query Nein

Antwort

Gibt zurück: GetUserBadges200Response

Beispiel

getUserBadges Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entkommentieren Sie das Folgende, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$badge_id = 'badge_id_example'; // string
21$type = 3.4; // float
22$displayed_on_comments = True; // bool
23$limit = 3.4; // float
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getUserBadges($tenant_id, $user_id, $badge_id, $type, $displayed_on_comments, $limit, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
31}
32

updateUserBadge Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: UpdateUserBadge200Response

Beispiel

updateUserBadge Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls benötigt
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie einen Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
21
22try {
23 $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
27}
28

getUserNotificationCount Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
sso string query Nein

Antwort

Gibt zurück: GetUserNotificationCount200Response

Beispiel

Beispiel für getUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$sso = 'sso_example'; // string
14
15try {
16 $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
20}
21

getUserNotifications Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
pageSize integer query Nein
afterId string query Nein
includeContext boolean query Nein
afterCreatedAt integer query Nein
unreadOnly boolean query Nein
dmOnly boolean query Nein
noDm boolean query Nein
includeTranslations boolean query Nein
sso string query Nein

Antwort

Gibt zurück: GetUserNotifications200Response

Beispiel

getUserNotifications Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$page_size = 56; // int
14$after_id = 'after_id_example'; // string
15$include_context = True; // bool
16$after_created_at = 56; // int
17$unread_only = True; // bool
18$dm_only = True; // bool
19$no_dm = True; // bool
20$include_translations = True; // bool
21$sso = 'sso_example'; // string
22
23try {
24 $result = $apiInstance->getUserNotifications($tenant_id, $page_size, $after_id, $include_context, $after_created_at, $unread_only, $dm_only, $no_dm, $include_translations, $sso);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
28}
29

resetUserNotificationCount Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
sso string query Nein

Antwort

Gibt zurück: ResetUserNotifications200Response

Beispiel

Beispiel für resetUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$sso = 'sso_example'; // string
14
15try {
16 $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
20}
21

resetUserNotifications Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
afterId string query No
afterCreatedAt integer query No
unreadOnly boolean query No
dmOnly boolean query No
noDm boolean query No
sso string query No

Antwort

Gibt zurück: ResetUserNotifications200Response

Beispiel

Beispiel für resetUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, standardmäßig wird `GuzzleHttp\Client` verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$after_id = 'after_id_example'; // string
14$after_created_at = 56; // int
15$unread_only = True; // bool
16$dm_only = True; // bool
17$no_dm = True; // bool
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->resetUserNotifications($tenant_id, $after_id, $after_created_at, $unread_only, $dm_only, $no_dm, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
25}
26

updateUserNotificationCommentSubscriptionStatus Internal Link

Benachrichtigungen für einen bestimmten Kommentar aktivieren oder deaktivieren.

Parameter

Name Type Location Required Description
tenantId string query Ja
notificationId string path Ja
optedInOrOut string path Ja
commentId string query Ja
sso string query Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Beispiel

Beispiel für updateUserNotificationCommentSubscriptionStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, geben Sie Ihren Client an, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, standardmäßig wird `GuzzleHttp\Client` verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$notification_id = 'notification_id_example'; // string
14$opted_in_or_out = 'opted_in_or_out_example'; // string
15$comment_id = 'comment_id_example'; // string
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
23}
24

updateUserNotificationPageSubscriptionStatus Internal Link

Benachrichtigungen für eine Seite aktivieren oder deaktivieren. Wenn Benutzer für eine Seite abonniert sind, werden Benachrichtigungen für neue Root-Kommentare erstellt, und auch

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
urlId string query Ja
url string query Ja
pageTitle string query Ja
subscribedOrUnsubscribed string path Ja
sso string query Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Beispiel

updateUserNotificationPageSubscriptionStatus Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$url = 'url_example'; // string
15$page_title = 'page_title_example'; // string
16$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
24}
25

updateUserNotificationStatus Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Yes
notificationId string path Yes
newStatus string path Yes
sso string query No

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Beispiel

updateUserNotificationStatus Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$notification_id = 'notification_id_example'; // string
14$new_status = 'new_status_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
22}
23

getUserPresenceStatuses Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
urlIdWS string query Ja
userIds string query Ja

Antwort

Gibt zurück: GetUserPresenceStatuses200Response

Beispiel

Beispiel für getUserPresenceStatuses
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id_ws = 'url_id_ws_example'; // string
14$user_ids = 'user_ids_example'; // string
15
16try {
17 $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
21}
22

searchUsers Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja
urlId string query Ja
usernameStartsWith string query Ja
mentionGroupIds array query Nein
sso string query Nein

Antwort

Gibt zurück: SearchUsers200Response

Beispiel

searchUsers Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
9 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$username_starts_with = 'username_starts_with_example'; // string
15$mention_group_ids = array('mention_group_ids_example'); // string[]
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->searchUsers($tenant_id, $url_id, $username_starts_with, $mention_group_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
23}
24

getUser Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja

Antwort

Gibt zurück: GetUser200Response

Beispiel

getUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie die Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; standardmäßig wird `GuzzleHttp\Client` verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getUser($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
26}
27

createVote Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
commentId string query Ja
direction string query Ja
userId string query Nein
anonUserId string query Nein

Antwort

Gibt zurück: VoteComment200Response

Beispiel

createVote Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Unten auskommentierte Zeile aufheben, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional; `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$direction = 'direction_example'; // string
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
29}
30

deleteVote Internal Link

Parameter

Name Typ Location Erforderlich Beschreibung
tenantId string query Ja
id string path Ja
editKey string query Nein

Antwort

Gibt zurück: DeleteCommentVote200Response

Beispiel

deleteVote Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Autorisierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um bei Bedarf ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$edit_key = 'edit_key_example'; // string
21
22try {
23 $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
27}
28

getVotes Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
urlId string query Ja

Antwort

Gibt zurück: GetVotes200Response

Beispiel

getVotes Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Kommentieren Sie die folgende Zeile aus, um ein Präfix (z. B. Bearer) für den API-Schlüssel zu setzen, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen eigenen HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20
21try {
22 $result = $apiInstance->getVotes($tenant_id, $url_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
26}
27

getVotesForUser Internal Link

Parameter

Name Typ Ort Erforderlich Beschreibung
tenantId string query Ja
urlId string query Ja
userId string query Nein
anonUserId string query Nein

Antwort

Gibt zurück: GetVotesForUser200Response

Beispiel

getVotesForUser Beispiel
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// API-Schlüssel-Authentifizierung konfigurieren: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Entfernen Sie das Kommentarzeichen unten, um ein Präfix (z. B. Bearer) für den API-Schlüssel einzurichten, falls erforderlich
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Wenn Sie einen benutzerdefinierten HTTP-Client verwenden möchten, übergeben Sie Ihren Client, der `GuzzleHttp\ClientInterface` implementiert.
14 // Dies ist optional, `GuzzleHttp\Client` wird standardmäßig verwendet.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
28}
29

Brauchen Sie Hilfe?

Wenn Sie auf Probleme stoßen oder Fragen zum PHP SDK haben, bitte:

Mitwirken

Beiträge sind willkommen! Bitte besuchen Sie das GitHub-Repository für die Richtlinien zur Mitwirkung.