Documentation

Brand
in package
implements ModelInterface, ArrayAccess

Brand Class Doc Comment

Tags
category

Class

description

Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getBrandCompany()  : string|null
Gets brand_company
getBrandId()  : string|null
Gets brand_id
getBrandLanguages()  : array<string|int, ?string>
Gets brand_languages
getBrandName()  : string|null
Gets brand_name
getColors()  : array<string|int, NameValue>
Gets colors
getDefaultBrandLanguage()  : string|null
Gets default_brand_language
getEmailContent()  : array<string|int, BrandEmailContent>
Gets email_content
getErrorDetails()  : ErrorDetails
Gets error_details
getIsOrganizationBrand()  : string|null
Gets is_organization_brand
getIsOverridingCompanyName()  : bool|null
Gets is_overriding_company_name
getIsSendingDefault()  : bool|null
Gets is_sending_default
getIsSigningDefault()  : bool|null
Gets is_signing_default
getLandingPages()  : array<string|int, NameValue>
Gets landing_pages
getLinks()  : array<string|int, BrandLink>
Gets links
getLogos()  : BrandLogos
Gets logos
getModelName()  : string
The original name of the model.
getOrganizationBrandLogo()  : string|null
Gets organization_brand_logo
getResources()  : BrandResourceUrls
Gets resources
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setBrandCompany()  : $this
Sets brand_company
setBrandId()  : $this
Sets brand_id
setBrandLanguages()  : $this
Sets brand_languages
setBrandName()  : $this
Sets brand_name
setColors()  : $this
Sets colors
setDefaultBrandLanguage()  : $this
Sets default_brand_language
setEmailContent()  : $this
Sets email_content
setErrorDetails()  : $this
Sets error_details
setIsOrganizationBrand()  : $this
Sets is_organization_brand
setIsOverridingCompanyName()  : $this
Sets is_overriding_company_name
setIsSendingDefault()  : $this
Sets is_sending_default
setIsSigningDefault()  : $this
Sets is_signing_default
setLandingPages()  : $this
Sets landing_pages
setLinks()  : $this
Sets links
setLogos()  : $this
Sets logos
setOrganizationBrandLogo()  : $this
Sets organization_brand_logo
setResources()  : $this
Sets resources
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['brand_company' => 'brandCompany', 'brand_id' => 'brandId', 'brand_languages' => 'brandLanguages', 'brand_name' => 'brandName', 'colors' => 'colors', 'default_brand_language' => 'defaultBrandLanguage', 'email_content' => 'emailContent', 'error_details' => 'errorDetails', 'is_organization_brand' => 'isOrganizationBrand', 'is_overriding_company_name' => 'isOverridingCompanyName', 'is_sending_default' => 'isSendingDefault', 'is_signing_default' => 'isSigningDefault', 'landing_pages' => 'landingPages', 'links' => 'links', 'logos' => 'logos', 'organization_brand_logo' => 'organizationBrandLogo', 'resources' => 'resources']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['brand_company' => 'getBrandCompany', 'brand_id' => 'getBrandId', 'brand_languages' => 'getBrandLanguages', 'brand_name' => 'getBrandName', 'colors' => 'getColors', 'default_brand_language' => 'getDefaultBrandLanguage', 'email_content' => 'getEmailContent', 'error_details' => 'getErrorDetails', 'is_organization_brand' => 'getIsOrganizationBrand', 'is_overriding_company_name' => 'getIsOverridingCompanyName', 'is_sending_default' => 'getIsSendingDefault', 'is_signing_default' => 'getIsSigningDefault', 'landing_pages' => 'getLandingPages', 'links' => 'getLinks', 'logos' => 'getLogos', 'organization_brand_logo' => 'getOrganizationBrandLogo', 'resources' => 'getResources']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['brand_company' => 'setBrandCompany', 'brand_id' => 'setBrandId', 'brand_languages' => 'setBrandLanguages', 'brand_name' => 'setBrandName', 'colors' => 'setColors', 'default_brand_language' => 'setDefaultBrandLanguage', 'email_content' => 'setEmailContent', 'error_details' => 'setErrorDetails', 'is_organization_brand' => 'setIsOrganizationBrand', 'is_overriding_company_name' => 'setIsOverridingCompanyName', 'is_sending_default' => 'setIsSendingDefault', 'is_signing_default' => 'setIsSigningDefault', 'landing_pages' => 'setLandingPages', 'links' => 'setLinks', 'logos' => 'setLogos', 'organization_brand_logo' => 'setOrganizationBrandLogo', 'resources' => 'setResources']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['brand_company' => null, 'brand_id' => null, 'brand_languages' => null, 'brand_name' => null, 'colors' => null, 'default_brand_language' => null, 'email_content' => null, 'error_details' => null, 'is_organization_brand' => null, 'is_overriding_company_name' => null, 'is_sending_default' => null, 'is_signing_default' => null, 'landing_pages' => null, 'links' => null, 'logos' => null, 'organization_brand_logo' => null, 'resources' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'brand'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['brand_company' => '?string', 'brand_id' => '?string', 'brand_languages' => '?string[]', 'brand_name' => '?string', 'colors' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'default_brand_language' => '?string', 'email_content' => '\\DocuSign\\eSign\\Model\\BrandEmailContent[]', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'is_organization_brand' => '?string', 'is_overriding_company_name' => '?bool', 'is_sending_default' => '?bool', 'is_signing_default' => '?bool', 'landing_pages' => '\\DocuSign\\eSign\\Model\\NameValue[]', 'links' => '\\DocuSign\\eSign\\Model\\BrandLink[]', 'logos' => '\\DocuSign\\eSign\\Model\\BrandLogos', 'organization_brand_logo' => '?string', 'resources' => '\\DocuSign\\eSign\\Model\\BrandResourceUrls']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getBrandCompany()

Gets brand_company

public getBrandCompany() : string|null
Return values
string|null —

getBrandId()

Gets brand_id

public getBrandId() : string|null
Return values
string|null —

getBrandLanguages()

Gets brand_languages

public getBrandLanguages() : array<string|int, ?string>
Return values
array<string|int, ?string> —

getBrandName()

Gets brand_name

public getBrandName() : string|null
Return values
string|null —

getColors()

Gets colors

public getColors() : array<string|int, NameValue>
Return values
array<string|int, NameValue> —

getDefaultBrandLanguage()

Gets default_brand_language

public getDefaultBrandLanguage() : string|null
Return values
string|null —

getIsOrganizationBrand()

Gets is_organization_brand

public getIsOrganizationBrand() : string|null
Return values
string|null —

getIsOverridingCompanyName()

Gets is_overriding_company_name

public getIsOverridingCompanyName() : bool|null
Return values
bool|null —

getIsSendingDefault()

Gets is_sending_default

public getIsSendingDefault() : bool|null
Return values
bool|null —

getIsSigningDefault()

Gets is_signing_default

public getIsSigningDefault() : bool|null
Return values
bool|null —

getLandingPages()

Gets landing_pages

public getLandingPages() : array<string|int, NameValue>
Return values
array<string|int, NameValue> —

getLinks()

Gets links

public getLinks() : array<string|int, BrandLink>
Return values
array<string|int, BrandLink> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

Gets organization_brand_logo

public getOrganizationBrandLogo() : string|null
Return values
string|null —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

setBrandCompany()

Sets brand_company

public setBrandCompany(string|null $brand_company) : $this
Parameters
$brand_company : string|null

The name of the company associated with this brand.

Return values
$this —

setBrandId()

Sets brand_id

public setBrandId(string|null $brand_id) : $this
Parameters
$brand_id : string|null

The ID used to identify a specific brand in API calls.

Return values
$this —

setBrandLanguages()

Sets brand_languages

public setBrandLanguages(array<string|int, ?string> $brand_languages) : $this
Parameters
$brand_languages : array<string|int, ?string>
Return values
$this —

setBrandName()

Sets brand_name

public setBrandName(string|null $brand_name) : $this
Parameters
$brand_name : string|null

The name of the brand.

Return values
$this —

setColors()

Sets colors

public setColors(array<string|int, NameValue> $colors) : $this
Parameters
$colors : array<string|int, NameValue>
Return values
$this —

setDefaultBrandLanguage()

Sets default_brand_language

public setDefaultBrandLanguage(string|null $default_brand_language) : $this
Parameters
$default_brand_language : string|null
Return values
$this —

setEmailContent()

Sets email_content

public setEmailContent(array<string|int, BrandEmailContent> $email_content) : $this
Parameters
$email_content : array<string|int, BrandEmailContent>
Return values
$this —

setErrorDetails()

Sets error_details

public setErrorDetails(ErrorDetails $error_details) : $this
Parameters
$error_details : ErrorDetails

Array or errors.

Return values
$this —

setIsOrganizationBrand()

Sets is_organization_brand

public setIsOrganizationBrand(string|null $is_organization_brand) : $this
Parameters
$is_organization_brand : string|null
Return values
$this —

setIsOverridingCompanyName()

Sets is_overriding_company_name

public setIsOverridingCompanyName(bool|null $is_overriding_company_name) : $this
Parameters
$is_overriding_company_name : bool|null
Return values
$this —

setIsSendingDefault()

Sets is_sending_default

public setIsSendingDefault(bool|null $is_sending_default) : $this
Parameters
$is_sending_default : bool|null
Return values
$this —

setIsSigningDefault()

Sets is_signing_default

public setIsSigningDefault(bool|null $is_signing_default) : $this
Parameters
$is_signing_default : bool|null
Return values
$this —

setLandingPages()

Sets landing_pages

public setLandingPages(array<string|int, NameValue> $landing_pages) : $this
Parameters
$landing_pages : array<string|int, NameValue>
Return values
$this —

setLinks()

Sets links

public setLinks(array<string|int, BrandLink> $links) : $this
Parameters
$links : array<string|int, BrandLink>
Return values
$this —

setLogos()

Sets logos

public setLogos(BrandLogos $logos) : $this
Parameters
$logos : BrandLogos

The URIs for retrieving the logos that are associated with the brand.

Return values
$this —

Sets organization_brand_logo

public setOrganizationBrandLogo(string|null $organization_brand_logo) : $this
Parameters
$organization_brand_logo : string|null
Return values
$this —

setResources()

Sets resources

public setResources(BrandResourceUrls $resources) : $this
Parameters
$resources : BrandResourceUrls

An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. Note: This object is returned only when the resourceContentType is sending, signing, email, or signing_captive.

Return values
$this —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

Search results