Skip to content

Commit

Permalink
Initial generation from OpenAPI Spec v2
Browse files Browse the repository at this point in the history
  • Loading branch information
Caffe1neAdd1ct committed Jul 29, 2021
0 parents commit f91a0c2
Show file tree
Hide file tree
Showing 90 changed files with 14,758 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ref: https://github.com/github/gitignore/blob/master/Composer.gitignore

composer.phar
/vendor/

# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
# composer.lock

# php-cs-fixer cache
.php_cs.cache

# PHPUnit cache
.phpunit.result.cache
23 changes: 23 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
88 changes: 88 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
.gitignore
.openapi-generator-ignore
.php_cs
.travis.yml
README.md
composer.json
docs/Api/CustomerServiceMetricApi.md
docs/Api/SellerStandardsProfileApi.md
docs/Api/TrafficReportApi.md
docs/Model/BenchmarkMetadata.md
docs/Model/Cycle.md
docs/Model/Definition.md
docs/Model/Dimension.md
docs/Model/DimensionMetric.md
docs/Model/Distribution.md
docs/Model/Error.md
docs/Model/ErrorParameter.md
docs/Model/EvaluationCycle.md
docs/Model/FindSellerStandardsProfilesResponse.md
docs/Model/GetCustomerServiceMetricResponse.md
docs/Model/Header.md
docs/Model/Metadata.md
docs/Model/MetadataHeader.md
docs/Model/MetadataRecord.md
docs/Model/Metric.md
docs/Model/MetricBenchmark.md
docs/Model/MetricDistribution.md
docs/Model/Record.md
docs/Model/Report.md
docs/Model/StandardsProfile.md
docs/Model/Value.md
git_push.sh
lib/Analytics/CustomerServiceMetricApi.php
lib/Analytics/Model/BenchmarkMetadata.php
lib/Analytics/Model/Cycle.php
lib/Analytics/Model/Definition.php
lib/Analytics/Model/Dimension.php
lib/Analytics/Model/DimensionMetric.php
lib/Analytics/Model/Distribution.php
lib/Analytics/Model/Error.php
lib/Analytics/Model/ErrorParameter.php
lib/Analytics/Model/EvaluationCycle.php
lib/Analytics/Model/FindSellerStandardsProfilesResponse.php
lib/Analytics/Model/GetCustomerServiceMetricResponse.php
lib/Analytics/Model/Header.php
lib/Analytics/Model/Metadata.php
lib/Analytics/Model/MetadataHeader.php
lib/Analytics/Model/MetadataRecord.php
lib/Analytics/Model/Metric.php
lib/Analytics/Model/MetricBenchmark.php
lib/Analytics/Model/MetricDistribution.php
lib/Analytics/Model/ModelInterface.php
lib/Analytics/Model/Record.php
lib/Analytics/Model/Report.php
lib/Analytics/Model/StandardsProfile.php
lib/Analytics/Model/Value.php
lib/Analytics/SellerStandardsProfileApi.php
lib/Analytics/TrafficReportApi.php
lib/ApiException.php
lib/Configuration.php
lib/HeaderSelector.php
lib/ObjectSerializer.php
phpunit.xml.dist
test/Api/CustomerServiceMetricApiTest.php
test/Api/SellerStandardsProfileApiTest.php
test/Api/TrafficReportApiTest.php
test/Model/BenchmarkMetadataTest.php
test/Model/CycleTest.php
test/Model/DefinitionTest.php
test/Model/DimensionMetricTest.php
test/Model/DimensionTest.php
test/Model/DistributionTest.php
test/Model/ErrorParameterTest.php
test/Model/ErrorTest.php
test/Model/EvaluationCycleTest.php
test/Model/FindSellerStandardsProfilesResponseTest.php
test/Model/GetCustomerServiceMetricResponseTest.php
test/Model/HeaderTest.php
test/Model/MetadataHeaderTest.php
test/Model/MetadataRecordTest.php
test/Model/MetadataTest.php
test/Model/MetricBenchmarkTest.php
test/Model/MetricDistributionTest.php
test/Model/MetricTest.php
test/Model/RecordTest.php
test/Model/ReportTest.php
test/Model/StandardsProfileTest.php
test/Model/ValueTest.php
1 change: 1 addition & 0 deletions .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
5.1.1
23 changes: 23 additions & 0 deletions .php_cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

return PhpCsFixer\Config::create()
->setUsingCache(true)
->setRules([
'@PSR2' => true,
'ordered_imports' => true,
'phpdoc_order' => true,
'array_syntax' => [ 'syntax' => 'short' ],
'strict_comparison' => true,
'strict_param' => true,
'no_trailing_whitespace' => false,
'no_trailing_whitespace_in_comment' => false,
'braces' => false,
'single_blank_line_at_eof' => false,
'blank_line_after_namespace' => false,
])
->setFinder(
PhpCsFixer\Finder::create()
->exclude('test')
->exclude('tests')
->in(__DIR__)
);
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
language: php
# Bionic environment has preinstalled PHP from 7.1 to 7.4
# https://docs.travis-ci.com/user/reference/bionic/#php-support
dist: bionic
php:
- 7.2
- 7.3
- 7.4
before_install: "composer install"
script: "vendor/bin/phpunit"
139 changes: 139 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
# OpenAPIClient-php

The Analytics API provides data and information about a seller and their eBay business. The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating. The three resources in the Analytics API provide the following data and information: Customer Service Metric &ndash; Returns data on a seller's customer service performance as compared to other seller's in the same peer group. Traffic Report &ndash; Returns data that shows how buyers are engaging with a seller's listings. Seller Standards Profile &ndash; Returns data pertaining to a seller's performance rating. Sellers can use the data and information returned by the various Analytics API methods to determine where they can make improvements to increase sales and how they might improve their seller status as viewed by eBay buyers. For details on using this API, see Analyzing seller performance.


## Installation & Usage

### Requirements

PHP 7.2 and later.

### Composer

To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:

```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github/zvps/ebay-sell-analytics-php-client.git"
}
],
"require": {
"zvps/ebay-sell-analytics-php-client": "*@dev"
}
}
```

Then run `composer install`

### Manual Installation

Download the files and include `autoload.php`:

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

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

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



// Configure OAuth2 access token for authorization: Authorization Code
$config = Ebay\Sell\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Ebay\Sell\Api\CustomerServiceMetricApi(
// 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
);
$customer_service_metric_type = 'customer_service_metric_type_example'; // string | Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller. Supported types are: ITEM_NOT_AS_DESCRIBED ITEM_NOT_RECEIVED
$evaluation_marketplace_id = 'evaluation_marketplace_id_example'; // string | Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data. For the list of supported marketplaces, see Analytics API requirements and restrictions. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/bas:MarketplaceIdEnum
$evaluation_type = 'evaluation_type_example'; // string | Use this path parameter to specify the type of the seller evaluation you want returned, either: CURRENT &ndash; A monthly evaluation that occurs on the 20th of every month. PROJECTED &ndash; A daily evaluation that provides a projection of how the seller is currently performing with regards to the upcoming evaluation period.

try {
$result = $apiInstance->getCustomerServiceMetric($customer_service_metric_type, $evaluation_marketplace_id, $evaluation_type);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomerServiceMetricApi->getCustomerServiceMetric: ', $e->getMessage(), PHP_EOL;
}

```

## API Endpoints

All URIs are relative to *https://api.ebay.com/sell/analytics/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CustomerServiceMetricApi* | [**getCustomerServiceMetric**](docs/Api/CustomerServiceMetricApi.md#getcustomerservicemetric) | **GET** /customer_service_metric/{customer_service_metric_type}/{evaluation_type} |
*SellerStandardsProfileApi* | [**findSellerStandardsProfiles**](docs/Api/SellerStandardsProfileApi.md#findsellerstandardsprofiles) | **GET** /seller_standards_profile |
*SellerStandardsProfileApi* | [**getSellerStandardsProfile**](docs/Api/SellerStandardsProfileApi.md#getsellerstandardsprofile) | **GET** /seller_standards_profile/{program}/{cycle} |
*TrafficReportApi* | [**getTrafficReport**](docs/Api/TrafficReportApi.md#gettrafficreport) | **GET** /traffic_report |

## Models

- [BenchmarkMetadata](docs/Model/BenchmarkMetadata.md)
- [Cycle](docs/Model/Cycle.md)
- [Definition](docs/Model/Definition.md)
- [Dimension](docs/Model/Dimension.md)
- [DimensionMetric](docs/Model/DimensionMetric.md)
- [Distribution](docs/Model/Distribution.md)
- [Error](docs/Model/Error.md)
- [ErrorParameter](docs/Model/ErrorParameter.md)
- [EvaluationCycle](docs/Model/EvaluationCycle.md)
- [FindSellerStandardsProfilesResponse](docs/Model/FindSellerStandardsProfilesResponse.md)
- [GetCustomerServiceMetricResponse](docs/Model/GetCustomerServiceMetricResponse.md)
- [Header](docs/Model/Header.md)
- [Metadata](docs/Model/Metadata.md)
- [MetadataHeader](docs/Model/MetadataHeader.md)
- [MetadataRecord](docs/Model/MetadataRecord.md)
- [Metric](docs/Model/Metric.md)
- [MetricBenchmark](docs/Model/MetricBenchmark.md)
- [MetricDistribution](docs/Model/MetricDistribution.md)
- [Record](docs/Model/Record.md)
- [Report](docs/Model/Report.md)
- [StandardsProfile](docs/Model/StandardsProfile.md)
- [Value](docs/Model/Value.md)

## Authorization

### Authorization Code

- **Type**: `OAuth`
- **Flow**: `accessCode`
- **Authorization URL**: `https://auth.ebay.com/oauth2/authorize`
- **Scopes**:
- **https://api.ebay.com/oauth/api_scope/sell.analytics.readonly**: View your selling analytics data, such as performance reports

## Tests

To run the tests, use:

```bash
composer install
vendor/bin/phpunit
```

## Author



## About this package

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `1.2.0`
- Package version: `5.0.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
43 changes: 43 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"name": "zvps\/ebay-sell-analytics-php-client",
"version": "5.0.0",
"description": "The Analytics API provides data and information about a seller and their eBay business. The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating. The three resources in the Analytics API provide the following data and information: Customer Service Metric &ndash; Returns data on a seller's customer service performance as compared to other seller's in the same peer group. Traffic Report &ndash; Returns data that shows how buyers are engaging with a seller's listings. Seller Standards Profile &ndash; Returns data pertaining to a seller's performance rating. Sellers can use the data and information returned by the various Analytics API methods to determine where they can make improvements to increase sales and how they might improve their seller status as viewed by eBay buyers. For details on using this API, see Analyzing seller performance.",
"keywords": [
"openapitools",
"openapi-generator",
"openapi",
"php",
"sdk",
"rest",
"api"
],
"homepage": "https:\/\/openapi-generator.tech",
"license": "unlicense",
"authors": [
{
"name": "OpenAPI-Generator contributors",
"homepage": "https:\/\/openapi-generator.tech"
}
],
"require": {
"php": ">=5.6",
"ext-curl": "*",
"ext-json": "*",
"ext-mbstring": "*",
"guzzlehttp\/guzzle": "^6.2"
},
"require-dev": {
"phpunit\/phpunit": "^8.0 || ^9.0",
"friendsofphp\/php-cs-fixer": "^2.12"
},
"autoload": {
"psr-4": {
"Ebay\\Sell\\": "lib\/"
}
},
"autoload-dev": {
"psr-4": {
"Ebay\\Sell\\Test\\": "test\/"
}
}
}
Loading

0 comments on commit f91a0c2

Please sign in to comment.