| POST | /portal/10dlc |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
/** @description Submits a registration for the current customer's 10DLC */
// @Api(Description="Submits a registration for the current customer's 10DLC")
class AppRegister10Dlc implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $accountId=null,
/** @var string|null */
public ?string $customerId=null,
/** @var bool|null */
public ?bool $usOrCanada=null,
/** @var string|null */
public ?string $taxId=null,
/** @var string|null */
public ?string $taxIdValue=null,
/** @var string|null */
public ?string $businessName=null,
/** @var string|null */
public ?string $firstName=null,
/** @var string|null */
public ?string $lastName=null,
/** @var string|null */
public ?string $email=null,
/** @var string|null */
public ?string $country=null,
/** @var string|null */
public ?string $phoneNumber=null,
/** @var string|null */
public ?string $addressStreet1=null,
/** @var string|null */
public ?string $addressStreet2=null,
/** @var string|null */
public ?string $addressCity=null,
/** @var string|null */
public ?string $addressState=null,
/** @var string|null */
public ?string $addressPostalCode=null,
/** @var string|null */
public ?string $description=null,
/** @var bool|null */
public ?bool $acceptTerms=null,
/** @var string|null */
public ?string $representative=null,
/** @var string|null */
public ?string $websiteUrl=null,
/** @var string|null */
public ?string $businessIndustry=null,
/** @var string|null */
public ?string $businessRegistrationNumber=null,
/** @var string|null */
public ?string $businessRegistrationIDType=null,
/** @var string|null */
public ?string $businessType=null,
/** @var string|null */
public ?string $businesTitle=null,
/** @var string|null */
public ?string $brandName=null,
/** @var string|null */
public ?string $brandType=null,
/** @var string|null */
public ?string $companyType=null,
/** @var string|null */
public ?string $politicalOrganization=null,
/** @var string|null */
public ?string $mobilePhoneNumber=null,
/** @var string|null */
public ?string $stockExchange=null,
/** @var string|null */
public ?string $stockTicker=null,
/** @var string|null */
public ?string $campaignVerifyToken=null,
/** @var bool|null */
public ?bool $campaign=null,
/** @var string|null */
public ?string $campaignDescription=null,
/** @var string|null */
public ?string $sampleMessage1=null,
/** @var string|null */
public ?string $sampleMessage2=null,
/** @var string|null */
public ?string $sampleMessage3=null,
/** @var string|null */
public ?string $sampleMessage4=null,
/** @var string|null */
public ?string $sampleMessage5=null,
/** @var string|null */
public ?string $consentMessage=null,
/** @var string|null */
public ?string $optKeywords=null,
/** @var string|null */
public ?string $optMessage=null,
/** @var string|null */
public ?string $campaignUseCases=null,
/** @var bool|null */
public ?bool $embeddedLinks=null,
/** @var bool|null */
public ?bool $includePhonenumbers=null,
/** @var bool|null */
public ?bool $loanArrangement=null,
/** @var string|null */
public ?string $vertical=null,
/** @var string|null */
public ?string $jobPosition=null,
/** @var bool|null */
public ?bool $ctia=null,
/** @var string[]|null */
public ?array $businessRegions=null,
/** @var string|null */
public ?string $brandMobilePhoneNumber=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['accountId'])) $this->accountId = $o['accountId'];
if (isset($o['customerId'])) $this->customerId = $o['customerId'];
if (isset($o['usOrCanada'])) $this->usOrCanada = $o['usOrCanada'];
if (isset($o['taxId'])) $this->taxId = $o['taxId'];
if (isset($o['taxIdValue'])) $this->taxIdValue = $o['taxIdValue'];
if (isset($o['businessName'])) $this->businessName = $o['businessName'];
if (isset($o['firstName'])) $this->firstName = $o['firstName'];
if (isset($o['lastName'])) $this->lastName = $o['lastName'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['phoneNumber'])) $this->phoneNumber = $o['phoneNumber'];
if (isset($o['addressStreet1'])) $this->addressStreet1 = $o['addressStreet1'];
if (isset($o['addressStreet2'])) $this->addressStreet2 = $o['addressStreet2'];
if (isset($o['addressCity'])) $this->addressCity = $o['addressCity'];
if (isset($o['addressState'])) $this->addressState = $o['addressState'];
if (isset($o['addressPostalCode'])) $this->addressPostalCode = $o['addressPostalCode'];
if (isset($o['description'])) $this->description = $o['description'];
if (isset($o['acceptTerms'])) $this->acceptTerms = $o['acceptTerms'];
if (isset($o['representative'])) $this->representative = $o['representative'];
if (isset($o['websiteUrl'])) $this->websiteUrl = $o['websiteUrl'];
if (isset($o['businessIndustry'])) $this->businessIndustry = $o['businessIndustry'];
if (isset($o['businessRegistrationNumber'])) $this->businessRegistrationNumber = $o['businessRegistrationNumber'];
if (isset($o['businessRegistrationIDType'])) $this->businessRegistrationIDType = $o['businessRegistrationIDType'];
if (isset($o['businessType'])) $this->businessType = $o['businessType'];
if (isset($o['businesTitle'])) $this->businesTitle = $o['businesTitle'];
if (isset($o['brandName'])) $this->brandName = $o['brandName'];
if (isset($o['brandType'])) $this->brandType = $o['brandType'];
if (isset($o['companyType'])) $this->companyType = $o['companyType'];
if (isset($o['politicalOrganization'])) $this->politicalOrganization = $o['politicalOrganization'];
if (isset($o['mobilePhoneNumber'])) $this->mobilePhoneNumber = $o['mobilePhoneNumber'];
if (isset($o['stockExchange'])) $this->stockExchange = $o['stockExchange'];
if (isset($o['stockTicker'])) $this->stockTicker = $o['stockTicker'];
if (isset($o['campaignVerifyToken'])) $this->campaignVerifyToken = $o['campaignVerifyToken'];
if (isset($o['campaign'])) $this->campaign = $o['campaign'];
if (isset($o['campaignDescription'])) $this->campaignDescription = $o['campaignDescription'];
if (isset($o['sampleMessage1'])) $this->sampleMessage1 = $o['sampleMessage1'];
if (isset($o['sampleMessage2'])) $this->sampleMessage2 = $o['sampleMessage2'];
if (isset($o['sampleMessage3'])) $this->sampleMessage3 = $o['sampleMessage3'];
if (isset($o['sampleMessage4'])) $this->sampleMessage4 = $o['sampleMessage4'];
if (isset($o['sampleMessage5'])) $this->sampleMessage5 = $o['sampleMessage5'];
if (isset($o['consentMessage'])) $this->consentMessage = $o['consentMessage'];
if (isset($o['optKeywords'])) $this->optKeywords = $o['optKeywords'];
if (isset($o['optMessage'])) $this->optMessage = $o['optMessage'];
if (isset($o['campaignUseCases'])) $this->campaignUseCases = $o['campaignUseCases'];
if (isset($o['embeddedLinks'])) $this->embeddedLinks = $o['embeddedLinks'];
if (isset($o['includePhonenumbers'])) $this->includePhonenumbers = $o['includePhonenumbers'];
if (isset($o['loanArrangement'])) $this->loanArrangement = $o['loanArrangement'];
if (isset($o['vertical'])) $this->vertical = $o['vertical'];
if (isset($o['jobPosition'])) $this->jobPosition = $o['jobPosition'];
if (isset($o['ctia'])) $this->ctia = $o['ctia'];
if (isset($o['businessRegions'])) $this->businessRegions = JsonConverters::fromArray('string', $o['businessRegions']);
if (isset($o['brandMobilePhoneNumber'])) $this->brandMobilePhoneNumber = $o['brandMobilePhoneNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->accountId)) $o['accountId'] = $this->accountId;
if (isset($this->customerId)) $o['customerId'] = $this->customerId;
if (isset($this->usOrCanada)) $o['usOrCanada'] = $this->usOrCanada;
if (isset($this->taxId)) $o['taxId'] = $this->taxId;
if (isset($this->taxIdValue)) $o['taxIdValue'] = $this->taxIdValue;
if (isset($this->businessName)) $o['businessName'] = $this->businessName;
if (isset($this->firstName)) $o['firstName'] = $this->firstName;
if (isset($this->lastName)) $o['lastName'] = $this->lastName;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->phoneNumber)) $o['phoneNumber'] = $this->phoneNumber;
if (isset($this->addressStreet1)) $o['addressStreet1'] = $this->addressStreet1;
if (isset($this->addressStreet2)) $o['addressStreet2'] = $this->addressStreet2;
if (isset($this->addressCity)) $o['addressCity'] = $this->addressCity;
if (isset($this->addressState)) $o['addressState'] = $this->addressState;
if (isset($this->addressPostalCode)) $o['addressPostalCode'] = $this->addressPostalCode;
if (isset($this->description)) $o['description'] = $this->description;
if (isset($this->acceptTerms)) $o['acceptTerms'] = $this->acceptTerms;
if (isset($this->representative)) $o['representative'] = $this->representative;
if (isset($this->websiteUrl)) $o['websiteUrl'] = $this->websiteUrl;
if (isset($this->businessIndustry)) $o['businessIndustry'] = $this->businessIndustry;
if (isset($this->businessRegistrationNumber)) $o['businessRegistrationNumber'] = $this->businessRegistrationNumber;
if (isset($this->businessRegistrationIDType)) $o['businessRegistrationIDType'] = $this->businessRegistrationIDType;
if (isset($this->businessType)) $o['businessType'] = $this->businessType;
if (isset($this->businesTitle)) $o['businesTitle'] = $this->businesTitle;
if (isset($this->brandName)) $o['brandName'] = $this->brandName;
if (isset($this->brandType)) $o['brandType'] = $this->brandType;
if (isset($this->companyType)) $o['companyType'] = $this->companyType;
if (isset($this->politicalOrganization)) $o['politicalOrganization'] = $this->politicalOrganization;
if (isset($this->mobilePhoneNumber)) $o['mobilePhoneNumber'] = $this->mobilePhoneNumber;
if (isset($this->stockExchange)) $o['stockExchange'] = $this->stockExchange;
if (isset($this->stockTicker)) $o['stockTicker'] = $this->stockTicker;
if (isset($this->campaignVerifyToken)) $o['campaignVerifyToken'] = $this->campaignVerifyToken;
if (isset($this->campaign)) $o['campaign'] = $this->campaign;
if (isset($this->campaignDescription)) $o['campaignDescription'] = $this->campaignDescription;
if (isset($this->sampleMessage1)) $o['sampleMessage1'] = $this->sampleMessage1;
if (isset($this->sampleMessage2)) $o['sampleMessage2'] = $this->sampleMessage2;
if (isset($this->sampleMessage3)) $o['sampleMessage3'] = $this->sampleMessage3;
if (isset($this->sampleMessage4)) $o['sampleMessage4'] = $this->sampleMessage4;
if (isset($this->sampleMessage5)) $o['sampleMessage5'] = $this->sampleMessage5;
if (isset($this->consentMessage)) $o['consentMessage'] = $this->consentMessage;
if (isset($this->optKeywords)) $o['optKeywords'] = $this->optKeywords;
if (isset($this->optMessage)) $o['optMessage'] = $this->optMessage;
if (isset($this->campaignUseCases)) $o['campaignUseCases'] = $this->campaignUseCases;
if (isset($this->embeddedLinks)) $o['embeddedLinks'] = $this->embeddedLinks;
if (isset($this->includePhonenumbers)) $o['includePhonenumbers'] = $this->includePhonenumbers;
if (isset($this->loanArrangement)) $o['loanArrangement'] = $this->loanArrangement;
if (isset($this->vertical)) $o['vertical'] = $this->vertical;
if (isset($this->jobPosition)) $o['jobPosition'] = $this->jobPosition;
if (isset($this->ctia)) $o['ctia'] = $this->ctia;
if (isset($this->businessRegions)) $o['businessRegions'] = JsonConverters::toArray('string', $this->businessRegions);
if (isset($this->brandMobilePhoneNumber)) $o['brandMobilePhoneNumber'] = $this->brandMobilePhoneNumber;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /portal/10dlc HTTP/1.1
Host: team.evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AppRegister10Dlc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Portal">
<AcceptTerms>false</AcceptTerms>
<AccountId>String</AccountId>
<AddressCity>String</AddressCity>
<AddressPostalCode>String</AddressPostalCode>
<AddressState>String</AddressState>
<AddressStreet1>String</AddressStreet1>
<AddressStreet2>String</AddressStreet2>
<BrandMobilePhoneNumber>String</BrandMobilePhoneNumber>
<BrandName>String</BrandName>
<BrandType>String</BrandType>
<BusinesTitle>String</BusinesTitle>
<BusinessIndustry>String</BusinessIndustry>
<BusinessName>String</BusinessName>
<BusinessRegions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</BusinessRegions>
<BusinessRegistrationIDType>String</BusinessRegistrationIDType>
<BusinessRegistrationNumber>String</BusinessRegistrationNumber>
<BusinessType>String</BusinessType>
<CTIA>false</CTIA>
<Campaign>false</Campaign>
<CampaignDescription>String</CampaignDescription>
<CampaignUseCases>String</CampaignUseCases>
<CampaignVerifyToken>String</CampaignVerifyToken>
<CompanyType>String</CompanyType>
<ConsentMessage>String</ConsentMessage>
<Country>String</Country>
<CustomerId>String</CustomerId>
<Description>String</Description>
<Email>String</Email>
<EmbeddedLinks>false</EmbeddedLinks>
<FirstName>String</FirstName>
<IncludePhonenumbers>false</IncludePhonenumbers>
<JobPosition>String</JobPosition>
<LastName>String</LastName>
<LoanArrangement>false</LoanArrangement>
<MobilePhoneNumber>String</MobilePhoneNumber>
<OptKeywords>String</OptKeywords>
<OptMessage>String</OptMessage>
<PhoneNumber>String</PhoneNumber>
<PoliticalOrganization>String</PoliticalOrganization>
<Representative>String</Representative>
<SampleMessage1>String</SampleMessage1>
<SampleMessage2>String</SampleMessage2>
<SampleMessage3>String</SampleMessage3>
<SampleMessage4>String</SampleMessage4>
<SampleMessage5>String</SampleMessage5>
<StockExchange>String</StockExchange>
<StockTicker>String</StockTicker>
<TaxId>String</TaxId>
<TaxIdValue>String</TaxIdValue>
<USOrCanada>false</USOrCanada>
<Vertical>String</Vertical>
<WebsiteUrl>String</WebsiteUrl>
</AppRegister10Dlc>