Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/test_php
A php SDK for accessing the test_php API.
https://github.com/speakeasy-sdks/test_php
Last synced: 2 days ago
JSON representation
A php SDK for accessing the test_php API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/test_php
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-07-07T16:56:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:22:49.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:54.199Z (6 months ago)
- Language: PHP
- Size: 107 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# my-workspace/updater
## SDK Installation
### Composer
To install the SDK first add the below to your `composer.json` file:
```json
{
"repositories": [
{
"type": "github",
"url": "https://github.com/speakeasy-sdks/test_php.git"
}
],
"require": {
"my-workspace/updater": "*"
}
}
```
Then run the following command:
```bash
composer update
```
## SDK Example Usage
### Example
```php
bearerAuth = '';
$sdk = Updater\Updater::builder()
->setSecurity($security)
->build();
try {
$request = new Operations\ReadDealRequest();
$request->dealId = 259512;
$response = $sdk->deal->readDeal($request);
if ($response->object !== null) {
// handle response
}
} catch (Throwable $e) {
// handle exception
}
```
## Available Resources and Operations
### [Deal](docs/sdks/deal/README.md)
* [readDeal](docs/sdks/deal/README.md#readdeal) - Read a deal.
* [updateDeal](docs/sdks/deal/README.md#updatedeal) - Update a deal.
### [Order](docs/sdks/order/README.md)
* [readOrder](docs/sdks/order/README.md#readorder) - Read a order.
* [updateOrder](docs/sdks/order/README.md#updateorder) - Update an order.
### [Product](docs/sdks/product/README.md)
* [readProduct](docs/sdks/product/README.md#readproduct) - Read a product.
* [updateProduct](docs/sdks/product/README.md#updateproduct) - Update a product.
## Server Selection
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://updater.com/api` | None |
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
### Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
### Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)