File "SyncMapItemOptions.php"
Full Path: /home/clickysoft/public_html/jmapi5.clickysoft.net/vendor/twilio/sdk/src/Twilio/Rest/Sync/V1/Service/SyncMap/SyncMapItemOptions.php
File size: 16.42 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Sync
* This is the public Twilio REST API.
*
* NOTE: This class is auto generated by OpenAPI Generator.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
namespace Twilio\Rest\Sync\V1\Service\SyncMap;
use Twilio\Options;
use Twilio\Values;
abstract class SyncMapItemOptions
{
/**
* @param int $ttl An alias for `item_ttl`. If both parameters are provided, this value is ignored.
* @param int $itemTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
* @param int $collectionTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
* @return CreateSyncMapItemOptions Options builder
*/
public static function create(
int $ttl = Values::INT_NONE,
int $itemTtl = Values::INT_NONE,
int $collectionTtl = Values::INT_NONE
): CreateSyncMapItemOptions
{
return new CreateSyncMapItemOptions(
$ttl,
$itemTtl,
$collectionTtl
);
}
/**
* @param string $ifMatch If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
* @return DeleteSyncMapItemOptions Options builder
*/
public static function delete(
string $ifMatch = Values::NONE
): DeleteSyncMapItemOptions
{
return new DeleteSyncMapItemOptions(
$ifMatch
);
}
/**
* @param string $order How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
* @param string $from The `key` of the first Sync Map Item resource to read. See also `bounds`.
* @param string $bounds Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
* @return ReadSyncMapItemOptions Options builder
*/
public static function read(
string $order = Values::NONE,
string $from = Values::NONE,
string $bounds = Values::NONE
): ReadSyncMapItemOptions
{
return new ReadSyncMapItemOptions(
$order,
$from,
$bounds
);
}
/**
* @param array $data A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
* @param int $ttl An alias for `item_ttl`. If both parameters are provided, this value is ignored.
* @param int $itemTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
* @param int $collectionTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
* @param string $ifMatch If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
* @return UpdateSyncMapItemOptions Options builder
*/
public static function update(
array $data = Values::ARRAY_NONE,
int $ttl = Values::INT_NONE,
int $itemTtl = Values::INT_NONE,
int $collectionTtl = Values::INT_NONE,
string $ifMatch = Values::NONE
): UpdateSyncMapItemOptions
{
return new UpdateSyncMapItemOptions(
$data,
$ttl,
$itemTtl,
$collectionTtl,
$ifMatch
);
}
}
class CreateSyncMapItemOptions extends Options
{
/**
* @param int $ttl An alias for `item_ttl`. If both parameters are provided, this value is ignored.
* @param int $itemTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
* @param int $collectionTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
*/
public function __construct(
int $ttl = Values::INT_NONE,
int $itemTtl = Values::INT_NONE,
int $collectionTtl = Values::INT_NONE
) {
$this->options['ttl'] = $ttl;
$this->options['itemTtl'] = $itemTtl;
$this->options['collectionTtl'] = $collectionTtl;
}
/**
* An alias for `item_ttl`. If both parameters are provided, this value is ignored.
*
* @param int $ttl An alias for `item_ttl`. If both parameters are provided, this value is ignored.
* @return $this Fluent Builder
*/
public function setTtl(int $ttl): self
{
$this->options['ttl'] = $ttl;
return $this;
}
/**
* How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
*
* @param int $itemTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
* @return $this Fluent Builder
*/
public function setItemTtl(int $itemTtl): self
{
$this->options['itemTtl'] = $itemTtl;
return $this;
}
/**
* How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
*
* @param int $collectionTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
* @return $this Fluent Builder
*/
public function setCollectionTtl(int $collectionTtl): self
{
$this->options['collectionTtl'] = $collectionTtl;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string
{
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Sync.V1.CreateSyncMapItemOptions ' . $options . ']';
}
}
class DeleteSyncMapItemOptions extends Options
{
/**
* @param string $ifMatch If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
*/
public function __construct(
string $ifMatch = Values::NONE
) {
$this->options['ifMatch'] = $ifMatch;
}
/**
* If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
*
* @param string $ifMatch If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
* @return $this Fluent Builder
*/
public function setIfMatch(string $ifMatch): self
{
$this->options['ifMatch'] = $ifMatch;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string
{
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Sync.V1.DeleteSyncMapItemOptions ' . $options . ']';
}
}
class ReadSyncMapItemOptions extends Options
{
/**
* @param string $order How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
* @param string $from The `key` of the first Sync Map Item resource to read. See also `bounds`.
* @param string $bounds Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
*/
public function __construct(
string $order = Values::NONE,
string $from = Values::NONE,
string $bounds = Values::NONE
) {
$this->options['order'] = $order;
$this->options['from'] = $from;
$this->options['bounds'] = $bounds;
}
/**
* How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
*
* @param string $order How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
* @return $this Fluent Builder
*/
public function setOrder(string $order): self
{
$this->options['order'] = $order;
return $this;
}
/**
* The `key` of the first Sync Map Item resource to read. See also `bounds`.
*
* @param string $from The `key` of the first Sync Map Item resource to read. See also `bounds`.
* @return $this Fluent Builder
*/
public function setFrom(string $from): self
{
$this->options['from'] = $from;
return $this;
}
/**
* Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
*
* @param string $bounds Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
* @return $this Fluent Builder
*/
public function setBounds(string $bounds): self
{
$this->options['bounds'] = $bounds;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string
{
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Sync.V1.ReadSyncMapItemOptions ' . $options . ']';
}
}
class UpdateSyncMapItemOptions extends Options
{
/**
* @param array $data A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
* @param int $ttl An alias for `item_ttl`. If both parameters are provided, this value is ignored.
* @param int $itemTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
* @param int $collectionTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
* @param string $ifMatch If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
*/
public function __construct(
array $data = Values::ARRAY_NONE,
int $ttl = Values::INT_NONE,
int $itemTtl = Values::INT_NONE,
int $collectionTtl = Values::INT_NONE,
string $ifMatch = Values::NONE
) {
$this->options['data'] = $data;
$this->options['ttl'] = $ttl;
$this->options['itemTtl'] = $itemTtl;
$this->options['collectionTtl'] = $collectionTtl;
$this->options['ifMatch'] = $ifMatch;
}
/**
* A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
*
* @param array $data A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
* @return $this Fluent Builder
*/
public function setData(array $data): self
{
$this->options['data'] = $data;
return $this;
}
/**
* An alias for `item_ttl`. If both parameters are provided, this value is ignored.
*
* @param int $ttl An alias for `item_ttl`. If both parameters are provided, this value is ignored.
* @return $this Fluent Builder
*/
public function setTtl(int $ttl): self
{
$this->options['ttl'] = $ttl;
return $this;
}
/**
* How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
*
* @param int $itemTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
* @return $this Fluent Builder
*/
public function setItemTtl(int $itemTtl): self
{
$this->options['itemTtl'] = $itemTtl;
return $this;
}
/**
* How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
*
* @param int $collectionTtl How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
* @return $this Fluent Builder
*/
public function setCollectionTtl(int $collectionTtl): self
{
$this->options['collectionTtl'] = $collectionTtl;
return $this;
}
/**
* If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
*
* @param string $ifMatch If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
* @return $this Fluent Builder
*/
public function setIfMatch(string $ifMatch): self
{
$this->options['ifMatch'] = $ifMatch;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString(): string
{
$options = \http_build_query(Values::of($this->options), '', ' ');
return '[Twilio.Sync.V1.UpdateSyncMapItemOptions ' . $options . ']';
}
}