Viewing file:  ConversationOptions.php (18.96 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Conversations\V1\Service;
use Twilio\Options;
use Twilio\Values;
abstract class ConversationOptions {
/**
* @param string $friendlyName The human-readable name of this conversation.
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @param string $attributes An optional string metadata field you can use to
* store any data you wish.
* @param string $messagingServiceSid The unique ID of the Messaging Service
* this conversation belongs to.
* @param \DateTime $dateCreated The date that this resource was created.
* @param \DateTime $dateUpdated The date that this resource was last updated.
* @param string $state Current state of this conversation.
* @param string $timersInactive ISO8601 duration when conversation will be
* switched to `inactive` state.
* @param string $timersClosed ISO8601 duration when conversation will be
* switched to `closed` state.
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return CreateConversationOptions Options builder
*/
public static function create(string $friendlyName = Values::NONE, string $uniqueName = Values::NONE, string $attributes = Values::NONE, string $messagingServiceSid = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $state = Values::NONE, string $timersInactive = Values::NONE, string $timersClosed = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE): CreateConversationOptions {
return new CreateConversationOptions($friendlyName, $uniqueName, $attributes, $messagingServiceSid, $dateCreated, $dateUpdated, $state, $timersInactive, $timersClosed, $xTwilioWebhookEnabled);
}
/**
* @param string $friendlyName The human-readable name of this conversation.
* @param \DateTime $dateCreated The date that this resource was created.
* @param \DateTime $dateUpdated The date that this resource was last updated.
* @param string $attributes An optional string metadata field you can use to
* store any data you wish.
* @param string $messagingServiceSid The unique ID of the Messaging Service
* this conversation belongs to.
* @param string $state Current state of this conversation.
* @param string $timersInactive ISO8601 duration when conversation will be
* switched to `inactive` state.
* @param string $timersClosed ISO8601 duration when conversation will be
* switched to `closed` state.
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return UpdateConversationOptions Options builder
*/
public static function update(string $friendlyName = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $attributes = Values::NONE, string $messagingServiceSid = Values::NONE, string $state = Values::NONE, string $timersInactive = Values::NONE, string $timersClosed = Values::NONE, string $uniqueName = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE): UpdateConversationOptions {
return new UpdateConversationOptions($friendlyName, $dateCreated, $dateUpdated, $attributes, $messagingServiceSid, $state, $timersInactive, $timersClosed, $uniqueName, $xTwilioWebhookEnabled);
}
/**
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return DeleteConversationOptions Options builder
*/
public static function delete(string $xTwilioWebhookEnabled = Values::NONE): DeleteConversationOptions {
return new DeleteConversationOptions($xTwilioWebhookEnabled);
}
}
class CreateConversationOptions extends Options {
/**
* @param string $friendlyName The human-readable name of this conversation.
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @param string $attributes An optional string metadata field you can use to
* store any data you wish.
* @param string $messagingServiceSid The unique ID of the Messaging Service
* this conversation belongs to.
* @param \DateTime $dateCreated The date that this resource was created.
* @param \DateTime $dateUpdated The date that this resource was last updated.
* @param string $state Current state of this conversation.
* @param string $timersInactive ISO8601 duration when conversation will be
* switched to `inactive` state.
* @param string $timersClosed ISO8601 duration when conversation will be
* switched to `closed` state.
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
*/
public function __construct(string $friendlyName = Values::NONE, string $uniqueName = Values::NONE, string $attributes = Values::NONE, string $messagingServiceSid = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $state = Values::NONE, string $timersInactive = Values::NONE, string $timersClosed = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE) {
$this->options['friendlyName'] = $friendlyName;
$this->options['uniqueName'] = $uniqueName;
$this->options['attributes'] = $attributes;
$this->options['messagingServiceSid'] = $messagingServiceSid;
$this->options['dateCreated'] = $dateCreated;
$this->options['dateUpdated'] = $dateUpdated;
$this->options['state'] = $state;
$this->options['timersInactive'] = $timersInactive;
$this->options['timersClosed'] = $timersClosed;
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
}
/**
* The human-readable name of this conversation, limited to 256 characters. Optional.
*
* @param string $friendlyName The human-readable name of this conversation.
* @return $this Fluent Builder
*/
public function setFriendlyName(string $friendlyName): self {
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
*
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @return $this Fluent Builder
*/
public function setUniqueName(string $uniqueName): self {
$this->options['uniqueName'] = $uniqueName;
return $this;
}
/**
* An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned.
*
* @param string $attributes An optional string metadata field you can use to
* store any data you wish.
* @return $this Fluent Builder
*/
public function setAttributes(string $attributes): self {
$this->options['attributes'] = $attributes;
return $this;
}
/**
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to.
*
* @param string $messagingServiceSid The unique ID of the Messaging Service
* this conversation belongs to.
* @return $this Fluent Builder
*/
public function setMessagingServiceSid(string $messagingServiceSid): self {
$this->options['messagingServiceSid'] = $messagingServiceSid;
return $this;
}
/**
* The date that this resource was created.
*
* @param \DateTime $dateCreated The date that this resource was created.
* @return $this Fluent Builder
*/
public function setDateCreated(\DateTime $dateCreated): self {
$this->options['dateCreated'] = $dateCreated;
return $this;
}
/**
* The date that this resource was last updated.
*
* @param \DateTime $dateUpdated The date that this resource was last updated.
* @return $this Fluent Builder
*/
public function setDateUpdated(\DateTime $dateUpdated): self {
$this->options['dateUpdated'] = $dateUpdated;
return $this;
}
/**
* Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`
*
* @param string $state Current state of this conversation.
* @return $this Fluent Builder
*/
public function setState(string $state): self {
$this->options['state'] = $state;
return $this;
}
/**
* ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
*
* @param string $timersInactive ISO8601 duration when conversation will be
* switched to `inactive` state.
* @return $this Fluent Builder
*/
public function setTimersInactive(string $timersInactive): self {
$this->options['timersInactive'] = $timersInactive;
return $this;
}
/**
* ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
*
* @param string $timersClosed ISO8601 duration when conversation will be
* switched to `closed` state.
* @return $this Fluent Builder
*/
public function setTimersClosed(string $timersClosed): self {
$this->options['timersClosed'] = $timersClosed;
return $this;
}
/**
* The X-Twilio-Webhook-Enabled HTTP request header
*
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return $this Fluent Builder
*/
public function setXTwilioWebhookEnabled(string $xTwilioWebhookEnabled): self {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
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.Conversations.V1.CreateConversationOptions ' . $options . ']';
}
}
class UpdateConversationOptions extends Options {
/**
* @param string $friendlyName The human-readable name of this conversation.
* @param \DateTime $dateCreated The date that this resource was created.
* @param \DateTime $dateUpdated The date that this resource was last updated.
* @param string $attributes An optional string metadata field you can use to
* store any data you wish.
* @param string $messagingServiceSid The unique ID of the Messaging Service
* this conversation belongs to.
* @param string $state Current state of this conversation.
* @param string $timersInactive ISO8601 duration when conversation will be
* switched to `inactive` state.
* @param string $timersClosed ISO8601 duration when conversation will be
* switched to `closed` state.
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
*/
public function __construct(string $friendlyName = Values::NONE, \DateTime $dateCreated = Values::NONE, \DateTime $dateUpdated = Values::NONE, string $attributes = Values::NONE, string $messagingServiceSid = Values::NONE, string $state = Values::NONE, string $timersInactive = Values::NONE, string $timersClosed = Values::NONE, string $uniqueName = Values::NONE, string $xTwilioWebhookEnabled = Values::NONE) {
$this->options['friendlyName'] = $friendlyName;
$this->options['dateCreated'] = $dateCreated;
$this->options['dateUpdated'] = $dateUpdated;
$this->options['attributes'] = $attributes;
$this->options['messagingServiceSid'] = $messagingServiceSid;
$this->options['state'] = $state;
$this->options['timersInactive'] = $timersInactive;
$this->options['timersClosed'] = $timersClosed;
$this->options['uniqueName'] = $uniqueName;
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
}
/**
* The human-readable name of this conversation, limited to 256 characters. Optional.
*
* @param string $friendlyName The human-readable name of this conversation.
* @return $this Fluent Builder
*/
public function setFriendlyName(string $friendlyName): self {
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* The date that this resource was created.
*
* @param \DateTime $dateCreated The date that this resource was created.
* @return $this Fluent Builder
*/
public function setDateCreated(\DateTime $dateCreated): self {
$this->options['dateCreated'] = $dateCreated;
return $this;
}
/**
* The date that this resource was last updated.
*
* @param \DateTime $dateUpdated The date that this resource was last updated.
* @return $this Fluent Builder
*/
public function setDateUpdated(\DateTime $dateUpdated): self {
$this->options['dateUpdated'] = $dateUpdated;
return $this;
}
/**
* An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned.
*
* @param string $attributes An optional string metadata field you can use to
* store any data you wish.
* @return $this Fluent Builder
*/
public function setAttributes(string $attributes): self {
$this->options['attributes'] = $attributes;
return $this;
}
/**
* The unique ID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to.
*
* @param string $messagingServiceSid The unique ID of the Messaging Service
* this conversation belongs to.
* @return $this Fluent Builder
*/
public function setMessagingServiceSid(string $messagingServiceSid): self {
$this->options['messagingServiceSid'] = $messagingServiceSid;
return $this;
}
/**
* Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`
*
* @param string $state Current state of this conversation.
* @return $this Fluent Builder
*/
public function setState(string $state): self {
$this->options['state'] = $state;
return $this;
}
/**
* ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
*
* @param string $timersInactive ISO8601 duration when conversation will be
* switched to `inactive` state.
* @return $this Fluent Builder
*/
public function setTimersInactive(string $timersInactive): self {
$this->options['timersInactive'] = $timersInactive;
return $this;
}
/**
* ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
*
* @param string $timersClosed ISO8601 duration when conversation will be
* switched to `closed` state.
* @return $this Fluent Builder
*/
public function setTimersClosed(string $timersClosed): self {
$this->options['timersClosed'] = $timersClosed;
return $this;
}
/**
* An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
*
* @param string $uniqueName An application-defined string that uniquely
* identifies the resource
* @return $this Fluent Builder
*/
public function setUniqueName(string $uniqueName): self {
$this->options['uniqueName'] = $uniqueName;
return $this;
}
/**
* The X-Twilio-Webhook-Enabled HTTP request header
*
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return $this Fluent Builder
*/
public function setXTwilioWebhookEnabled(string $xTwilioWebhookEnabled): self {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
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.Conversations.V1.UpdateConversationOptions ' . $options . ']';
}
}
class DeleteConversationOptions extends Options {
/**
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
*/
public function __construct(string $xTwilioWebhookEnabled = Values::NONE) {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
}
/**
* The X-Twilio-Webhook-Enabled HTTP request header
*
* @param string $xTwilioWebhookEnabled The X-Twilio-Webhook-Enabled HTTP
* request header
* @return $this Fluent Builder
*/
public function setXTwilioWebhookEnabled(string $xTwilioWebhookEnabled): self {
$this->options['xTwilioWebhookEnabled'] = $xTwilioWebhookEnabled;
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.Conversations.V1.DeleteConversationOptions ' . $options . ']';
}
}
|