Configuration.php 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Terminal;
  4. /**
  5. * A Configurations object represents how features should be configured for terminal readers.
  6. *
  7. * @property string $id Unique identifier for the object.
  8. * @property string $object String representing the object's type. Objects of the same type share the same value.
  9. * @property null|\Stripe\StripeObject $bbpos_wisepos_e
  10. * @property null|bool $is_account_default Whether this Configuration is the default for your account
  11. * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  12. * @property null|string $name String indicating the name of the Configuration object, set by the user
  13. * @property null|\Stripe\StripeObject $offline
  14. * @property null|\Stripe\StripeObject $reboot_window
  15. * @property null|\Stripe\StripeObject $stripe_s700
  16. * @property null|\Stripe\StripeObject $tipping
  17. * @property null|\Stripe\StripeObject $verifone_p400
  18. */
  19. class Configuration extends \Stripe\ApiResource
  20. {
  21. const OBJECT_NAME = 'terminal.configuration';
  22. use \Stripe\ApiOperations\Update;
  23. /**
  24. * Creates a new <code>Configuration</code> object.
  25. *
  26. * @param null|array $params
  27. * @param null|array|string $options
  28. *
  29. * @throws \Stripe\Exception\ApiErrorException if the request fails
  30. *
  31. * @return \Stripe\Terminal\Configuration the created resource
  32. */
  33. public static function create($params = null, $options = null)
  34. {
  35. self::_validateParams($params);
  36. $url = static::classUrl();
  37. list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
  38. $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
  39. $obj->setLastResponse($response);
  40. return $obj;
  41. }
  42. /**
  43. * Deletes a <code>Configuration</code> object.
  44. *
  45. * @param null|array $params
  46. * @param null|array|string $opts
  47. *
  48. * @throws \Stripe\Exception\ApiErrorException if the request fails
  49. *
  50. * @return \Stripe\Terminal\Configuration the deleted resource
  51. */
  52. public function delete($params = null, $opts = null)
  53. {
  54. self::_validateParams($params);
  55. $url = $this->instanceUrl();
  56. list($response, $opts) = $this->_request('delete', $url, $params, $opts);
  57. $this->refreshFrom($response, $opts);
  58. return $this;
  59. }
  60. /**
  61. * Returns a list of <code>Configuration</code> objects.
  62. *
  63. * @param null|array $params
  64. * @param null|array|string $opts
  65. *
  66. * @throws \Stripe\Exception\ApiErrorException if the request fails
  67. *
  68. * @return \Stripe\Collection<\Stripe\Terminal\Configuration> of ApiResources
  69. */
  70. public static function all($params = null, $opts = null)
  71. {
  72. $url = static::classUrl();
  73. return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
  74. }
  75. /**
  76. * Retrieves a <code>Configuration</code> object.
  77. *
  78. * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
  79. * @param null|array|string $opts
  80. *
  81. * @throws \Stripe\Exception\ApiErrorException if the request fails
  82. *
  83. * @return \Stripe\Terminal\Configuration
  84. */
  85. public static function retrieve($id, $opts = null)
  86. {
  87. $opts = \Stripe\Util\RequestOptions::parse($opts);
  88. $instance = new static($id, $opts);
  89. $instance->refresh();
  90. return $instance;
  91. }
  92. /**
  93. * Updates a new <code>Configuration</code> object.
  94. *
  95. * @param string $id the ID of the resource to update
  96. * @param null|array $params
  97. * @param null|array|string $opts
  98. *
  99. * @throws \Stripe\Exception\ApiErrorException if the request fails
  100. *
  101. * @return \Stripe\Terminal\Configuration the updated resource
  102. */
  103. public static function update($id, $params = null, $opts = null)
  104. {
  105. self::_validateParams($params);
  106. $url = static::resourceUrl($id);
  107. list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
  108. $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
  109. $obj->setLastResponse($response);
  110. return $obj;
  111. }
  112. }