everyday/gmodstore-sdk

Release 3.1.0

Welcome to the GmodStore API! You can use our API to access GmodStore API endpoints, which can be used interact with GmodStore programmatically. # Rate limits Every request you make to the GmodStore API will count against your rate limit, which at the time of writing this, is 60 requests / minute. An up-to-date value will always provided in the `X-RateLimit-Limit` header The number of requests you have remaining before you must wait is provided in the `X-RateLimit-Remaining` header. # API SDKs For a list of available API SDKs check the README here: https://github.com/everyday-as/gmodstore-api-docs#client-libraries

Repository Packagist PHP

Keywords
php, rest, api, sdk, gmodstore
License
MIT

Documentation

GmodStore SDK

Welcome to the GmodStore API! You can use our API to access GmodStore API endpoints, which can be used interact with GmodStore programmatically.

Rate limits

Every request you make to the GmodStore API will count against your rate limit, which at the time of writing this, is 60 requests / minute. An up-to-date value will always provided in the X-RateLimit-Limit header The number of requests you have remaining before you must wait is provided in the X-RateLimit-Remaining header.

API SDKs

For a list of available API SDKs check the README here: https://github.com/everyday-as/gmodstore-api-docs#client-libraries

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

  • API version: 3.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen For more information, please visit https://docs.gmodstore.com

Requirements

PHP 7.2 and later

Installation & Usage

Composer

To install the bindings via Composer, run the following command:

composer require everyday/gmodstore-sdk

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/GmodStore SDK/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer authorization: PersonalAccessToken
$config = Everyday\GmodStore\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Everyday\GmodStore\Sdk\Api\PermissionGroupsApi(
    // 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
);
$newPermissionGroupPayload = new \Everyday\GmodStore\Sdk\Model\NewPermissionGroupPayload(); // \Everyday\GmodStore\Sdk\Model\NewPermissionGroupPayload | 

try {
    $result = $apiInstance->createPermissionGroup($newPermissionGroupPayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PermissionGroupsApi->createPermissionGroup: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://www.gmodstore.com

Class Method HTTP request Description
PermissionGroupsApi createPermissionGroup POST /api/v3/permission-groups Create a permission group
PermissionGroupsApi deletePermissionGroup DELETE /api/v3/permission-groups/{permission_group} Delete the specified permission group
PermissionGroupsApi getPermissionGroup GET /api/v3/permission-groups/{permission_group} Show the specified permission group
PermissionGroupsApi listPermissionGroups GET /api/v3/permission-groups List all permission groups
PermissionGroupsApi updatePermissionGroup PUT /api/v3/permission-groups/{permission_group} Update the specified permission group
PersonalAccessTokensApi createPersonalAccessToken POST /api/v3/me/personal-access-tokens Create a new personal access token for the current user
PersonalAccessTokensApi deletePersonalAccessToken DELETE /api/v3/me/personal-access-tokens/{personal_access_token} Delete the specified personal access token
PersonalAccessTokensApi getPersonalAccessToken GET /api/v3/me/personal-access-tokens/{personal_access_token} Get a personal access token belonging to the current user
PersonalAccessTokensApi listPersonalAccessTokens GET /api/v3/me/personal-access-tokens List all the current user's personal access tokens
PersonalAccessTokensApi updatePersonalAccessToken PUT /api/v3/me/personal-access-tokens/{personal_access_token} Update a personal access token
ProductCouponsApi createProductCoupon POST /api/v3/products/{product}/coupons Create a coupon for a product
ProductCouponsApi deleteProductCoupon DELETE /api/v3/products/{product}/coupons/{coupon} Delete the specified coupon for a product
ProductCouponsApi getProductCoupon GET /api/v3/products/{product}/coupons/{coupon} Show the specified coupon for a product
ProductCouponsApi listProductCoupons GET /api/v3/products/{product}/coupons List all coupons for a product
ProductCouponsApi updateProductCoupon PUT /api/v3/products/{product}/coupons/{coupon} Update the specified coupon for a product
ProductPurchasesApi createProductPurchase POST /api/v3/products/{product}/purchases Create a purchase for a product
ProductPurchasesApi getProductPurchase GET /api/v3/products/{product}/purchases/{purchase} Show the specified purchase for a product
ProductPurchasesApi listProductPurchases GET /api/v3/products/{product}/purchases List all purchases for a product
ProductPurchasesApi updateProductPurchase PUT /api/v3/products/{product}/purchases/{purchase} Update the specified purchase for a product
ProductReviewsApi getProductReview GET /api/v3/products/{product}/reviews/{review} Show the specified review for a product
ProductReviewsApi listProductReviews GET /api/v3/products/{product}/reviews List all reviews for a product
ProductVersionsApi createProductVersion POST /api/v3/products/{product}/versions Create a version for a product
ProductVersionsApi deleteProductVersion DELETE /api/v3/products/{product}/versions/{version} Delete the specified version for a product
ProductVersionsApi getProductDownloadToken POST /api/v3/products/{product}/versions/{version}/download Get a one time use url for downloading a product
ProductVersionsApi getProductVersion GET /api/v3/products/{product}/versions/{version} Show the specified version for a product
ProductVersionsApi listProductVersions GET /api/v3/products/{product}/versions List all versions for a product
ProductVersionsApi updateProductVersion PUT /api/v3/products/{product}/versions/{version} Update the specified version for a product
ProductsApi getProduct GET /api/v3/products/{product} Get the specified product
ProductsApi getProducts GET /api/v3/products/batch Get a batch of products by id
ProductsApi listProducts GET /api/v3/teams/{team}/products List all products for a team
ProductsApi updateProduct PUT /api/v3/products/{product} Update the specified product
TeamUsersApi listTeamUsers GET /api/v3/teams/{team}/users List all users in a team
TeamsApi createTeam POST /api/v3/teams Create a new team
TeamsApi deleteTeam DELETE /api/v3/teams/{team} Delete the specified team
TeamsApi getTeam GET /api/v3/teams/{team} Fetch the specified team
TeamsApi getTeams GET /api/v3/teams/batch Fetch a batch of teams by id
TeamsApi listTeams GET /api/v3/teams List all teams
TeamsApi updateTeam PUT /api/v3/teams/{team} Update the specified team
UserBadgesApi createUserBadge POST /api/v3/users/{user}/badges Attach a badge to a user
UserBadgesApi deleteUserBadge DELETE /api/v3/users/{user}/badges/{badge} Detach a badge from a user
UserBadgesApi listUserBadges GET /api/v3/users/{user}/badges List all the specified user's badges
UserBansApi listUserBans GET /api/v3/users/{user}/bans List all the specified user's bans
UserProductPurchasesApi listUserPurchases GET /api/v3/users/{user}/purchases List all the specified user's purchases
UserProductsApi listUserProducts GET /api/v3/users/{user}/products List all the specified user's products
UserTeamsApi listUserTeams GET /api/v3/users/{user}/teams List all the specified user's teams
UsersApi getMe GET /api/v3/me Fetch the current authenticated user and their access token
UsersApi getUser GET /api/v3/users/{user} Fetch the specified user
UsersApi getUsers GET /api/v3/users/batch Fetch a batch of users by id
UsersApi listUsers GET /api/v3/users List all users

Documentation For Models

Documentation For Authorization

PersonalAccessToken

  • Type: Bearer authentication

Stats

Dependencies
0
Dependent packages
0
Dependent repositories
0
Total releases
14
Latest release
First release
Stars
3
Forks
1
Watchers
5
Contributors
3
Repository size
694 KB
SourceRank
9

Releases

3.1.0
3.0.0
2.4.3
2.4.2
2.4.1
2.4.0
2.3.1
2.3.0
2.2.0
2.1.0
See all 14 releases

Contributors

actions-user Marcus Theodoor


See all contributors

Login to resync this project