Lokasi ngalangkungan proxy:   [ UP ]  
[Ngawartoskeun bug]   [Panyetelan cookie]                
Skip to content

Latest commit

 

History

History

README.md

OpenAPIClient-php

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure HTTP basic authorization: basic_auth
$config = PlausibleAnalyticsWPClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new PlausibleAnalyticsWPClient\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$custom_prop_disable_request = new \PlausibleAnalyticsWPClient\Model\CustomPropDisableRequest(); // \PlausibleAnalyticsWPClient\Model\CustomPropDisableRequest | CustomProp disable params

try {
    $apiInstance->customPropDisableBulk($custom_prop_disable_request);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->customPropDisableBulk: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://plausible.io

Class Method HTTP request Description
DefaultApi customPropDisableBulk DELETE /api/plugins/v1/custom_props Disable CustomProp(s)
DefaultApi customPropGetOrEnable PUT /api/plugins/v1/custom_props Get or enable CustomProp(s)
DefaultApi funnelGetOrCreate PUT /api/plugins/v1/funnels Get or create Funnel
DefaultApi goalDeleteBulk DELETE /api/plugins/v1/goals Delete Goals in bulk
DefaultApi goalGetOrCreate PUT /api/plugins/v1/goals Get or create Goal
DefaultApi plausibleWebPluginsAPIControllersCapabilitiesIndex GET /api/plugins/v1/capabilities Retrieve Capabilities
DefaultApi plausibleWebPluginsAPIControllersFunnelsGet GET /api/plugins/v1/funnels/{id} Retrieve Funnel by ID
DefaultApi plausibleWebPluginsAPIControllersFunnelsIndex GET /api/plugins/v1/funnels Retrieve Funnels
DefaultApi plausibleWebPluginsAPIControllersGoalsDelete DELETE /api/plugins/v1/goals/{id} Delete Goal by ID
DefaultApi plausibleWebPluginsAPIControllersGoalsGet GET /api/plugins/v1/goals/{id} Retrieve Goal by ID
DefaultApi plausibleWebPluginsAPIControllersGoalsIndex GET /api/plugins/v1/goals Retrieve Goals
DefaultApi plausibleWebPluginsAPIControllersSharedLinksCreate PUT /api/plugins/v1/shared_links Get or create Shared Link
DefaultApi plausibleWebPluginsAPIControllersSharedLinksGet GET /api/plugins/v1/shared_links/{id} Retrieve Shared Link by ID
DefaultApi plausibleWebPluginsAPIControllersSharedLinksIndex GET /api/plugins/v1/shared_links Retrieve Shared Links
DefaultApi plausibleWebPluginsAPIControllersTrackerScriptConfigurationGet GET /api/plugins/v1/tracker_script_configuration Retrieve Tracker Script Configuration
DefaultApi plausibleWebPluginsAPIControllersTrackerScriptConfigurationUpdate PUT /api/plugins/v1/tracker_script_configuration Update Tracker Script Configuration

Models

Authorization

Authentication schemes defined for the API:

basic_auth

  • Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0-rc
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen