File "AddressConfigurationOptions.php"
Full Path: /home/clickysoft/public_html/jmapi5.clickysoft.net/vendor/twilio/sdk/src/Twilio/Rest/Conversations/V1/AddressConfigurationOptions.php
File size: 21.75 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Conversations
* 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\Conversations\V1;
use Twilio\Options;
use Twilio\Values;
abstract class AddressConfigurationOptions
{
/**
* @param string $friendlyName The human-readable name of this configuration, limited to 256 characters. Optional.
* @param bool $autoCreationEnabled Enable/Disable auto-creating conversations for messages to this address
* @param string $autoCreationType
* @param string $autoCreationConversationServiceSid Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
* @param string $autoCreationWebhookUrl For type `webhook`, the url for the webhook request.
* @param string $autoCreationWebhookMethod
* @param string[] $autoCreationWebhookFilters The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
* @param string $autoCreationStudioFlowSid For type `studio`, the studio flow SID where the webhook should be sent to.
* @param int $autoCreationStudioRetryCount For type `studio`, number of times to retry the webhook request
* @param string $addressCountry An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
* @return CreateAddressConfigurationOptions Options builder
*/
public static function create(
string $friendlyName = Values::NONE,
bool $autoCreationEnabled = Values::BOOL_NONE,
string $autoCreationType = Values::NONE,
string $autoCreationConversationServiceSid = Values::NONE,
string $autoCreationWebhookUrl = Values::NONE,
string $autoCreationWebhookMethod = Values::NONE,
array $autoCreationWebhookFilters = Values::ARRAY_NONE,
string $autoCreationStudioFlowSid = Values::NONE,
int $autoCreationStudioRetryCount = Values::INT_NONE,
string $addressCountry = Values::NONE
): CreateAddressConfigurationOptions
{
return new CreateAddressConfigurationOptions(
$friendlyName,
$autoCreationEnabled,
$autoCreationType,
$autoCreationConversationServiceSid,
$autoCreationWebhookUrl,
$autoCreationWebhookMethod,
$autoCreationWebhookFilters,
$autoCreationStudioFlowSid,
$autoCreationStudioRetryCount,
$addressCountry
);
}
/**
* @param string $type Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
* @return ReadAddressConfigurationOptions Options builder
*/
public static function read(
string $type = Values::NONE
): ReadAddressConfigurationOptions
{
return new ReadAddressConfigurationOptions(
$type
);
}
/**
* @param string $friendlyName The human-readable name of this configuration, limited to 256 characters. Optional.
* @param bool $autoCreationEnabled Enable/Disable auto-creating conversations for messages to this address
* @param string $autoCreationType
* @param string $autoCreationConversationServiceSid Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
* @param string $autoCreationWebhookUrl For type `webhook`, the url for the webhook request.
* @param string $autoCreationWebhookMethod
* @param string[] $autoCreationWebhookFilters The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
* @param string $autoCreationStudioFlowSid For type `studio`, the studio flow SID where the webhook should be sent to.
* @param int $autoCreationStudioRetryCount For type `studio`, number of times to retry the webhook request
* @return UpdateAddressConfigurationOptions Options builder
*/
public static function update(
string $friendlyName = Values::NONE,
bool $autoCreationEnabled = Values::BOOL_NONE,
string $autoCreationType = Values::NONE,
string $autoCreationConversationServiceSid = Values::NONE,
string $autoCreationWebhookUrl = Values::NONE,
string $autoCreationWebhookMethod = Values::NONE,
array $autoCreationWebhookFilters = Values::ARRAY_NONE,
string $autoCreationStudioFlowSid = Values::NONE,
int $autoCreationStudioRetryCount = Values::INT_NONE
): UpdateAddressConfigurationOptions
{
return new UpdateAddressConfigurationOptions(
$friendlyName,
$autoCreationEnabled,
$autoCreationType,
$autoCreationConversationServiceSid,
$autoCreationWebhookUrl,
$autoCreationWebhookMethod,
$autoCreationWebhookFilters,
$autoCreationStudioFlowSid,
$autoCreationStudioRetryCount
);
}
}
class CreateAddressConfigurationOptions extends Options
{
/**
* @param string $friendlyName The human-readable name of this configuration, limited to 256 characters. Optional.
* @param bool $autoCreationEnabled Enable/Disable auto-creating conversations for messages to this address
* @param string $autoCreationType
* @param string $autoCreationConversationServiceSid Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
* @param string $autoCreationWebhookUrl For type `webhook`, the url for the webhook request.
* @param string $autoCreationWebhookMethod
* @param string[] $autoCreationWebhookFilters The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
* @param string $autoCreationStudioFlowSid For type `studio`, the studio flow SID where the webhook should be sent to.
* @param int $autoCreationStudioRetryCount For type `studio`, number of times to retry the webhook request
* @param string $addressCountry An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
*/
public function __construct(
string $friendlyName = Values::NONE,
bool $autoCreationEnabled = Values::BOOL_NONE,
string $autoCreationType = Values::NONE,
string $autoCreationConversationServiceSid = Values::NONE,
string $autoCreationWebhookUrl = Values::NONE,
string $autoCreationWebhookMethod = Values::NONE,
array $autoCreationWebhookFilters = Values::ARRAY_NONE,
string $autoCreationStudioFlowSid = Values::NONE,
int $autoCreationStudioRetryCount = Values::INT_NONE,
string $addressCountry = Values::NONE
) {
$this->options['friendlyName'] = $friendlyName;
$this->options['autoCreationEnabled'] = $autoCreationEnabled;
$this->options['autoCreationType'] = $autoCreationType;
$this->options['autoCreationConversationServiceSid'] = $autoCreationConversationServiceSid;
$this->options['autoCreationWebhookUrl'] = $autoCreationWebhookUrl;
$this->options['autoCreationWebhookMethod'] = $autoCreationWebhookMethod;
$this->options['autoCreationWebhookFilters'] = $autoCreationWebhookFilters;
$this->options['autoCreationStudioFlowSid'] = $autoCreationStudioFlowSid;
$this->options['autoCreationStudioRetryCount'] = $autoCreationStudioRetryCount;
$this->options['addressCountry'] = $addressCountry;
}
/**
* The human-readable name of this configuration, limited to 256 characters. Optional.
*
* @param string $friendlyName The human-readable name of this configuration, limited to 256 characters. Optional.
* @return $this Fluent Builder
*/
public function setFriendlyName(string $friendlyName): self
{
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* Enable/Disable auto-creating conversations for messages to this address
*
* @param bool $autoCreationEnabled Enable/Disable auto-creating conversations for messages to this address
* @return $this Fluent Builder
*/
public function setAutoCreationEnabled(bool $autoCreationEnabled): self
{
$this->options['autoCreationEnabled'] = $autoCreationEnabled;
return $this;
}
/**
* @param string $autoCreationType
* @return $this Fluent Builder
*/
public function setAutoCreationType(string $autoCreationType): self
{
$this->options['autoCreationType'] = $autoCreationType;
return $this;
}
/**
* Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
*
* @param string $autoCreationConversationServiceSid Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
* @return $this Fluent Builder
*/
public function setAutoCreationConversationServiceSid(string $autoCreationConversationServiceSid): self
{
$this->options['autoCreationConversationServiceSid'] = $autoCreationConversationServiceSid;
return $this;
}
/**
* For type `webhook`, the url for the webhook request.
*
* @param string $autoCreationWebhookUrl For type `webhook`, the url for the webhook request.
* @return $this Fluent Builder
*/
public function setAutoCreationWebhookUrl(string $autoCreationWebhookUrl): self
{
$this->options['autoCreationWebhookUrl'] = $autoCreationWebhookUrl;
return $this;
}
/**
* @param string $autoCreationWebhookMethod
* @return $this Fluent Builder
*/
public function setAutoCreationWebhookMethod(string $autoCreationWebhookMethod): self
{
$this->options['autoCreationWebhookMethod'] = $autoCreationWebhookMethod;
return $this;
}
/**
* The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
*
* @param string[] $autoCreationWebhookFilters The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
* @return $this Fluent Builder
*/
public function setAutoCreationWebhookFilters(array $autoCreationWebhookFilters): self
{
$this->options['autoCreationWebhookFilters'] = $autoCreationWebhookFilters;
return $this;
}
/**
* For type `studio`, the studio flow SID where the webhook should be sent to.
*
* @param string $autoCreationStudioFlowSid For type `studio`, the studio flow SID where the webhook should be sent to.
* @return $this Fluent Builder
*/
public function setAutoCreationStudioFlowSid(string $autoCreationStudioFlowSid): self
{
$this->options['autoCreationStudioFlowSid'] = $autoCreationStudioFlowSid;
return $this;
}
/**
* For type `studio`, number of times to retry the webhook request
*
* @param int $autoCreationStudioRetryCount For type `studio`, number of times to retry the webhook request
* @return $this Fluent Builder
*/
public function setAutoCreationStudioRetryCount(int $autoCreationStudioRetryCount): self
{
$this->options['autoCreationStudioRetryCount'] = $autoCreationStudioRetryCount;
return $this;
}
/**
* An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
*
* @param string $addressCountry An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
* @return $this Fluent Builder
*/
public function setAddressCountry(string $addressCountry): self
{
$this->options['addressCountry'] = $addressCountry;
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.CreateAddressConfigurationOptions ' . $options . ']';
}
}
class ReadAddressConfigurationOptions extends Options
{
/**
* @param string $type Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
*/
public function __construct(
string $type = Values::NONE
) {
$this->options['type'] = $type;
}
/**
* Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
*
* @param string $type Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
* @return $this Fluent Builder
*/
public function setType(string $type): self
{
$this->options['type'] = $type;
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.ReadAddressConfigurationOptions ' . $options . ']';
}
}
class UpdateAddressConfigurationOptions extends Options
{
/**
* @param string $friendlyName The human-readable name of this configuration, limited to 256 characters. Optional.
* @param bool $autoCreationEnabled Enable/Disable auto-creating conversations for messages to this address
* @param string $autoCreationType
* @param string $autoCreationConversationServiceSid Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
* @param string $autoCreationWebhookUrl For type `webhook`, the url for the webhook request.
* @param string $autoCreationWebhookMethod
* @param string[] $autoCreationWebhookFilters The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
* @param string $autoCreationStudioFlowSid For type `studio`, the studio flow SID where the webhook should be sent to.
* @param int $autoCreationStudioRetryCount For type `studio`, number of times to retry the webhook request
*/
public function __construct(
string $friendlyName = Values::NONE,
bool $autoCreationEnabled = Values::BOOL_NONE,
string $autoCreationType = Values::NONE,
string $autoCreationConversationServiceSid = Values::NONE,
string $autoCreationWebhookUrl = Values::NONE,
string $autoCreationWebhookMethod = Values::NONE,
array $autoCreationWebhookFilters = Values::ARRAY_NONE,
string $autoCreationStudioFlowSid = Values::NONE,
int $autoCreationStudioRetryCount = Values::INT_NONE
) {
$this->options['friendlyName'] = $friendlyName;
$this->options['autoCreationEnabled'] = $autoCreationEnabled;
$this->options['autoCreationType'] = $autoCreationType;
$this->options['autoCreationConversationServiceSid'] = $autoCreationConversationServiceSid;
$this->options['autoCreationWebhookUrl'] = $autoCreationWebhookUrl;
$this->options['autoCreationWebhookMethod'] = $autoCreationWebhookMethod;
$this->options['autoCreationWebhookFilters'] = $autoCreationWebhookFilters;
$this->options['autoCreationStudioFlowSid'] = $autoCreationStudioFlowSid;
$this->options['autoCreationStudioRetryCount'] = $autoCreationStudioRetryCount;
}
/**
* The human-readable name of this configuration, limited to 256 characters. Optional.
*
* @param string $friendlyName The human-readable name of this configuration, limited to 256 characters. Optional.
* @return $this Fluent Builder
*/
public function setFriendlyName(string $friendlyName): self
{
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* Enable/Disable auto-creating conversations for messages to this address
*
* @param bool $autoCreationEnabled Enable/Disable auto-creating conversations for messages to this address
* @return $this Fluent Builder
*/
public function setAutoCreationEnabled(bool $autoCreationEnabled): self
{
$this->options['autoCreationEnabled'] = $autoCreationEnabled;
return $this;
}
/**
* @param string $autoCreationType
* @return $this Fluent Builder
*/
public function setAutoCreationType(string $autoCreationType): self
{
$this->options['autoCreationType'] = $autoCreationType;
return $this;
}
/**
* Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
*
* @param string $autoCreationConversationServiceSid Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
* @return $this Fluent Builder
*/
public function setAutoCreationConversationServiceSid(string $autoCreationConversationServiceSid): self
{
$this->options['autoCreationConversationServiceSid'] = $autoCreationConversationServiceSid;
return $this;
}
/**
* For type `webhook`, the url for the webhook request.
*
* @param string $autoCreationWebhookUrl For type `webhook`, the url for the webhook request.
* @return $this Fluent Builder
*/
public function setAutoCreationWebhookUrl(string $autoCreationWebhookUrl): self
{
$this->options['autoCreationWebhookUrl'] = $autoCreationWebhookUrl;
return $this;
}
/**
* @param string $autoCreationWebhookMethod
* @return $this Fluent Builder
*/
public function setAutoCreationWebhookMethod(string $autoCreationWebhookMethod): self
{
$this->options['autoCreationWebhookMethod'] = $autoCreationWebhookMethod;
return $this;
}
/**
* The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
*
* @param string[] $autoCreationWebhookFilters The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
* @return $this Fluent Builder
*/
public function setAutoCreationWebhookFilters(array $autoCreationWebhookFilters): self
{
$this->options['autoCreationWebhookFilters'] = $autoCreationWebhookFilters;
return $this;
}
/**
* For type `studio`, the studio flow SID where the webhook should be sent to.
*
* @param string $autoCreationStudioFlowSid For type `studio`, the studio flow SID where the webhook should be sent to.
* @return $this Fluent Builder
*/
public function setAutoCreationStudioFlowSid(string $autoCreationStudioFlowSid): self
{
$this->options['autoCreationStudioFlowSid'] = $autoCreationStudioFlowSid;
return $this;
}
/**
* For type `studio`, number of times to retry the webhook request
*
* @param int $autoCreationStudioRetryCount For type `studio`, number of times to retry the webhook request
* @return $this Fluent Builder
*/
public function setAutoCreationStudioRetryCount(int $autoCreationStudioRetryCount): self
{
$this->options['autoCreationStudioRetryCount'] = $autoCreationStudioRetryCount;
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.UpdateAddressConfigurationOptions ' . $options . ']';
}
}