76 lines
2.5 KiB
PHP
76 lines
2.5 KiB
PHP
<?php
|
||
|
||
// File generated from our OpenAPI spec
|
||
|
||
namespace Stripe\Service\Entitlements;
|
||
|
||
/**
|
||
* @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
|
||
*
|
||
* @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
|
||
*/
|
||
class FeatureService extends \Stripe\Service\AbstractService
|
||
{
|
||
/**
|
||
* Retrieve a list of features.
|
||
*
|
||
* @param null|array{archived?: bool, ending_before?: string, expand?: string[], limit?: int, lookup_key?: string, starting_after?: string} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\Collection<\Stripe\Entitlements\Feature>
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function all($params = null, $opts = null)
|
||
{
|
||
return $this->requestCollection('get', '/v1/entitlements/features', $params, $opts);
|
||
}
|
||
|
||
/**
|
||
* Creates a feature.
|
||
*
|
||
* @param null|array{expand?: string[], lookup_key: string, metadata?: array<string, string>, name: string} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\Entitlements\Feature
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function create($params = null, $opts = null)
|
||
{
|
||
return $this->request('post', '/v1/entitlements/features', $params, $opts);
|
||
}
|
||
|
||
/**
|
||
* Retrieves a feature.
|
||
*
|
||
* @param string $id
|
||
* @param null|array{expand?: string[]} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\Entitlements\Feature
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function retrieve($id, $params = null, $opts = null)
|
||
{
|
||
return $this->request('get', $this->buildPath('/v1/entitlements/features/%s', $id), $params, $opts);
|
||
}
|
||
|
||
/**
|
||
* Update a feature’s metadata or permanently deactivate it.
|
||
*
|
||
* @param string $id
|
||
* @param null|array{active?: bool, expand?: string[], metadata?: null|array<string, string>, name?: string} $params
|
||
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
|
||
*
|
||
* @return \Stripe\Entitlements\Feature
|
||
*
|
||
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
||
*/
|
||
public function update($id, $params = null, $opts = null)
|
||
{
|
||
return $this->request('post', $this->buildPath('/v1/entitlements/features/%s', $id), $params, $opts);
|
||
}
|
||
}
|