|
| 1 | +# OpenAPIClient-php |
| 2 | + |
| 3 | +Public API for WhatPulse user data access. This API allows authenticated users to access their own data and public data from other users, depending on privacy settings. |
| 4 | + |
| 5 | + |
| 6 | +## Installation & Usage |
| 7 | + |
| 8 | +### Requirements |
| 9 | + |
| 10 | +PHP 8.1 and later. |
| 11 | + |
| 12 | +### Composer |
| 13 | + |
| 14 | +To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`: |
| 15 | + |
| 16 | +```json |
| 17 | +{ |
| 18 | + "repositories": [ |
| 19 | + { |
| 20 | + "type": "vcs", |
| 21 | + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" |
| 22 | + } |
| 23 | + ], |
| 24 | + "require": { |
| 25 | + "GIT_USER_ID/GIT_REPO_ID": "*@dev" |
| 26 | + } |
| 27 | +} |
| 28 | +``` |
| 29 | + |
| 30 | +Then run `composer install` |
| 31 | + |
| 32 | +### Manual Installation |
| 33 | + |
| 34 | +Download the files and include `autoload.php`: |
| 35 | + |
| 36 | +```php |
| 37 | +<?php |
| 38 | +require_once('/path/to/OpenAPIClient-php/vendor/autoload.php'); |
| 39 | +``` |
| 40 | + |
| 41 | +## Getting Started |
| 42 | + |
| 43 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 44 | + |
| 45 | +```php |
| 46 | +<?php |
| 47 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +// Configure Bearer authorization: http |
| 52 | +$config = WhatPulse\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 53 | + |
| 54 | + |
| 55 | +$apiInstance = new WhatPulse\Api\ComputersApi( |
| 56 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 57 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 58 | + new GuzzleHttp\Client(), |
| 59 | + $config |
| 60 | +); |
| 61 | +$id = 'id_example'; // string | User ID or username |
| 62 | +$is_archived = 'is_archived_example'; // string | Get filter parameters |
| 63 | + |
| 64 | +try { |
| 65 | + $result = $apiInstance->v1UsersComputers($id, $is_archived); |
| 66 | + print_r($result); |
| 67 | +} catch (Exception $e) { |
| 68 | + echo 'Exception when calling ComputersApi->v1UsersComputers: ', $e->getMessage(), PHP_EOL; |
| 69 | +} |
| 70 | + |
| 71 | +``` |
| 72 | + |
| 73 | +## API Endpoints |
| 74 | + |
| 75 | +All URIs are relative to *https://whatpulse.org/api/v1* |
| 76 | + |
| 77 | +Class | Method | HTTP request | Description |
| 78 | +------------ | ------------- | ------------- | ------------- |
| 79 | +*ComputersApi* | [**v1UsersComputers**](docs/Api/ComputersApi.md#v1userscomputers) | **GET** /users/{id}/computers | Get user computers |
| 80 | +*MembersApi* | [**v1TeamsMembers**](docs/Api/MembersApi.md#v1teamsmembers) | **GET** /teams/{team_id}/members | Get team members |
| 81 | +*ProfilesApi* | [**v1UsersProfiles**](docs/Api/ProfilesApi.md#v1usersprofiles) | **GET** /users/{id}/profiles | Get user profiles |
| 82 | +*PulsesApi* | [**v1UsersPulses**](docs/Api/PulsesApi.md#v1userspulses) | **GET** /users/{id}/pulses | Get user pulses |
| 83 | +*SubteamMembersApi* | [**v1TeamsSubteamsMembers**](docs/Api/SubteamMembersApi.md#v1teamssubteamsmembers) | **GET** /teams/{team_id}/subteams/{subteam_id}/members | Get subteam members |
| 84 | +*SubteamsApi* | [**v1TeamsSubteams**](docs/Api/SubteamsApi.md#v1teamssubteams) | **GET** /teams/{team_id}/subteams | Get team subteams |
| 85 | +*SubteamsApi* | [**v1TeamsSubteamsShow**](docs/Api/SubteamsApi.md#v1teamssubteamsshow) | **GET** /teams/{team_id}/subteams/{subteam_id} | Get subteam details |
| 86 | +*TeamsApi* | [**v1TeamsIndex**](docs/Api/TeamsApi.md#v1teamsindex) | **GET** /teams | Search teams |
| 87 | +*TeamsApi* | [**v1TeamsShow**](docs/Api/TeamsApi.md#v1teamsshow) | **GET** /teams/{team_id} | Get team details |
| 88 | +*TimeSeriesApi* | [**v1UsersTimeSeries**](docs/Api/TimeSeriesApi.md#v1userstimeseries) | **GET** /users/{id}/time-series | Get user time series |
| 89 | +*UsersApi* | [**v1UsersIndex**](docs/Api/UsersApi.md#v1usersindex) | **GET** /users | Search users |
| 90 | +*UsersApi* | [**v1UsersShow**](docs/Api/UsersApi.md#v1usersshow) | **GET** /users/{id} | Get user details |
| 91 | + |
| 92 | +## Models |
| 93 | + |
| 94 | +- [ClientProfileResource](docs/Model/ClientProfileResource.md) |
| 95 | +- [ClientProfileResourceComputer](docs/Model/ClientProfileResourceComputer.md) |
| 96 | +- [ComputerResource](docs/Model/ComputerResource.md) |
| 97 | +- [ComputerResourceTotals](docs/Model/ComputerResourceTotals.md) |
| 98 | +- [DetailedSubteamResource](docs/Model/DetailedSubteamResource.md) |
| 99 | +- [DetailedSubteamResourceLinks](docs/Model/DetailedSubteamResourceLinks.md) |
| 100 | +- [DetailedSubteamResourceTotals](docs/Model/DetailedSubteamResourceTotals.md) |
| 101 | +- [ErrorResource](docs/Model/ErrorResource.md) |
| 102 | +- [InlineObject](docs/Model/InlineObject.md) |
| 103 | +- [InlineObject1](docs/Model/InlineObject1.md) |
| 104 | +- [LinksResource](docs/Model/LinksResource.md) |
| 105 | +- [PaginationResource](docs/Model/PaginationResource.md) |
| 106 | +- [PulseResource](docs/Model/PulseResource.md) |
| 107 | +- [SubteamResource](docs/Model/SubteamResource.md) |
| 108 | +- [TeamListResource](docs/Model/TeamListResource.md) |
| 109 | +- [TeamResource](docs/Model/TeamResource.md) |
| 110 | +- [TeamResourceLinks](docs/Model/TeamResourceLinks.md) |
| 111 | +- [TeamResourceRanks](docs/Model/TeamResourceRanks.md) |
| 112 | +- [TeamResourceTotals](docs/Model/TeamResourceTotals.md) |
| 113 | +- [TimeSeriesResource](docs/Model/TimeSeriesResource.md) |
| 114 | +- [TimeSeriesResourceDistanceMiles](docs/Model/TimeSeriesResourceDistanceMiles.md) |
| 115 | +- [UserListResource](docs/Model/UserListResource.md) |
| 116 | +- [UserResource](docs/Model/UserResource.md) |
| 117 | +- [UserResourceLastPulse](docs/Model/UserResourceLastPulse.md) |
| 118 | +- [UserResourceRanks](docs/Model/UserResourceRanks.md) |
| 119 | +- [UserResourceTotals](docs/Model/UserResourceTotals.md) |
| 120 | +- [V1TeamsIndex200Response](docs/Model/V1TeamsIndex200Response.md) |
| 121 | +- [V1TeamsIndex200ResponseFilters](docs/Model/V1TeamsIndex200ResponseFilters.md) |
| 122 | +- [V1TeamsMembers200Response](docs/Model/V1TeamsMembers200Response.md) |
| 123 | +- [V1TeamsShow200Response](docs/Model/V1TeamsShow200Response.md) |
| 124 | +- [V1TeamsShow200ResponseAnyOf](docs/Model/V1TeamsShow200ResponseAnyOf.md) |
| 125 | +- [V1TeamsSubteams200Response](docs/Model/V1TeamsSubteams200Response.md) |
| 126 | +- [V1TeamsSubteamsMembers200Response](docs/Model/V1TeamsSubteamsMembers200Response.md) |
| 127 | +- [V1TeamsSubteamsShow200Response](docs/Model/V1TeamsSubteamsShow200Response.md) |
| 128 | +- [V1TeamsSubteamsShow200ResponseAnyOf](docs/Model/V1TeamsSubteamsShow200ResponseAnyOf.md) |
| 129 | +- [V1UsersComputers200Response](docs/Model/V1UsersComputers200Response.md) |
| 130 | +- [V1UsersComputers200ResponseFilters](docs/Model/V1UsersComputers200ResponseFilters.md) |
| 131 | +- [V1UsersIndex200Response](docs/Model/V1UsersIndex200Response.md) |
| 132 | +- [V1UsersProfiles200Response](docs/Model/V1UsersProfiles200Response.md) |
| 133 | +- [V1UsersProfiles200ResponseFilters](docs/Model/V1UsersProfiles200ResponseFilters.md) |
| 134 | +- [V1UsersPulses200Response](docs/Model/V1UsersPulses200Response.md) |
| 135 | +- [V1UsersPulses200ResponseFilters](docs/Model/V1UsersPulses200ResponseFilters.md) |
| 136 | +- [V1UsersShow200Response](docs/Model/V1UsersShow200Response.md) |
| 137 | +- [V1UsersShow200ResponseAnyOf](docs/Model/V1UsersShow200ResponseAnyOf.md) |
| 138 | +- [V1UsersTimeSeries200Response](docs/Model/V1UsersTimeSeries200Response.md) |
| 139 | +- [V1UsersTimeSeries200ResponseFilters](docs/Model/V1UsersTimeSeries200ResponseFilters.md) |
| 140 | + |
| 141 | +## Authorization |
| 142 | + |
| 143 | +Authentication schemes defined for the API: |
| 144 | +### http |
| 145 | + |
| 146 | +- **Type**: Bearer authentication |
| 147 | + |
| 148 | +## Tests |
| 149 | + |
| 150 | +To run the tests, use: |
| 151 | + |
| 152 | +```bash |
| 153 | +composer install |
| 154 | +vendor/bin/phpunit |
| 155 | +``` |
| 156 | + |
| 157 | +## Author |
| 158 | + |
| 159 | + |
| 160 | + |
| 161 | +## About this package |
| 162 | + |
| 163 | +This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
| 164 | + |
| 165 | +- API version: `1.0.0` |
| 166 | + - Generator version: `7.14.0` |
| 167 | +- Build package: `org.openapitools.codegen.languages.PhpClientCodegen` |
0 commit comments