Documentation

UpdateAccountDTO extends AbstractBaseDto
in package
implements DTOInterface

Data Transfer Object for updating an existing Canvas account

Table of Contents

Interfaces

DTOInterface

Properties

$courseTemplateId  : int|null
The ID of a course to be used as a template for all newly created courses
$defaultGroupStorageQuotaMb  : int|null
The default group storage quota in megabytes
$defaultStorageQuotaMb  : int|null
The default course storage quota in megabytes
$defaultTimeZone  : string|null
The default time zone of the account.
$defaultUserStorageQuotaMb  : int|null
The default user storage quota in megabytes
$integrationId  : string|null
Updates the account integration_id
$name  : string|null
Updates the account name
$overrideSisStickiness  : bool|null
Override SIS stickiness for this update (default true)
$parentAccountId  : int|null
The ID of a parent account to move the account to
$services  : array<string, bool>|null
Enable or disable services (hash of service names to boolean values)
$settings  : array<string, mixed>|null
Account settings
$sisAccountId  : string|null
Updates the account sis_account_id
$apiPropertyName  : string
The name of the property in the API

Methods

__construct()  : mixed
BaseDto constructor.
addSetting()  : self
Add a setting to the account settings
getCourseTemplateId()  : int|null
Get the course template ID
getDefaultGroupStorageQuotaMb()  : int|null
Get the default group storage quota in MB
getDefaultStorageQuotaMb()  : int|null
Get the default storage quota in MB
getDefaultTimeZone()  : string|null
Get the default time zone
getDefaultUserStorageQuotaMb()  : int|null
Get the default user storage quota in MB
getIntegrationId()  : string|null
Get the integration ID
getName()  : string|null
Get the account name
getOverrideSisStickiness()  : bool|null
Get the override SIS stickiness flag
getParentAccountId()  : int|null
Get the parent account ID
getServices()  : array<string, bool>|null
Get the services
getSettings()  : array<string, mixed>|null
Get the account settings
getSisAccountId()  : string|null
Get the SIS account ID
setCourseTemplateId()  : self
Set the course template ID
setDefaultGroupStorageQuotaMb()  : self
Set the default group storage quota in MB
setDefaultStorageQuotaMb()  : self
Set the default storage quota in MB
setDefaultTimeZone()  : self
Set the default time zone
setDefaultUserStorageQuotaMb()  : self
Set the default user storage quota in MB
setIntegrationId()  : self
Set the integration ID
setName()  : self
Set the account name
setOverrideSisStickiness()  : self
Set the override SIS stickiness flag
setParentAccountId()  : self
Set the parent account ID
setService()  : self
Enable or disable a specific service
setServices()  : self
Set the services
setSettings()  : self
Set the account settings
setSisAccountId()  : self
Set the SIS account ID
toApiArray()  : array<int, array{name: string, contents: mixed}>
Convert the DTO to an array for API requests This override handles nested settings array properly
toArray()  : array<string|int, mixed>
Convert the DTO to an array

Properties

$courseTemplateId

The ID of a course to be used as a template for all newly created courses

public int|null $courseTemplateId = null

$defaultGroupStorageQuotaMb

The default group storage quota in megabytes

public int|null $defaultGroupStorageQuotaMb = null

$defaultStorageQuotaMb

The default course storage quota in megabytes

public int|null $defaultStorageQuotaMb = null

$defaultTimeZone

The default time zone of the account.

public string|null $defaultTimeZone = null

Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

$defaultUserStorageQuotaMb

The default user storage quota in megabytes

public int|null $defaultUserStorageQuotaMb = null

$integrationId

Updates the account integration_id

public string|null $integrationId = null

$overrideSisStickiness

Override SIS stickiness for this update (default true)

public bool|null $overrideSisStickiness = null

$parentAccountId

The ID of a parent account to move the account to

public int|null $parentAccountId = null

$services

Enable or disable services (hash of service names to boolean values)

public array<string, bool>|null $services = null

$settings

Account settings

public array<string, mixed>|null $settings = null

$sisAccountId

Updates the account sis_account_id

public string|null $sisAccountId = null

$apiPropertyName

The name of the property in the API

protected string $apiPropertyName = 'account'

Methods

__construct()

BaseDto constructor.

public __construct(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Tags
throws
Exception

addSetting()

Add a setting to the account settings

public addSetting(string $key, mixed $value) : self
Parameters
$key : string
$value : mixed
Return values
self

getCourseTemplateId()

Get the course template ID

public getCourseTemplateId() : int|null
Return values
int|null

getDefaultGroupStorageQuotaMb()

Get the default group storage quota in MB

public getDefaultGroupStorageQuotaMb() : int|null
Return values
int|null

getDefaultStorageQuotaMb()

Get the default storage quota in MB

public getDefaultStorageQuotaMb() : int|null
Return values
int|null

getDefaultTimeZone()

Get the default time zone

public getDefaultTimeZone() : string|null
Return values
string|null

getDefaultUserStorageQuotaMb()

Get the default user storage quota in MB

public getDefaultUserStorageQuotaMb() : int|null
Return values
int|null

getIntegrationId()

Get the integration ID

public getIntegrationId() : string|null
Return values
string|null

getName()

Get the account name

public getName() : string|null
Return values
string|null

getOverrideSisStickiness()

Get the override SIS stickiness flag

public getOverrideSisStickiness() : bool|null
Return values
bool|null

getParentAccountId()

Get the parent account ID

public getParentAccountId() : int|null
Return values
int|null

getServices()

Get the services

public getServices() : array<string, bool>|null
Return values
array<string, bool>|null

getSettings()

Get the account settings

public getSettings() : array<string, mixed>|null
Return values
array<string, mixed>|null

getSisAccountId()

Get the SIS account ID

public getSisAccountId() : string|null
Return values
string|null

setCourseTemplateId()

Set the course template ID

public setCourseTemplateId(int|null $courseTemplateId) : self
Parameters
$courseTemplateId : int|null
Return values
self

setDefaultGroupStorageQuotaMb()

Set the default group storage quota in MB

public setDefaultGroupStorageQuotaMb(int|null $defaultGroupStorageQuotaMb) : self
Parameters
$defaultGroupStorageQuotaMb : int|null
Return values
self

setDefaultStorageQuotaMb()

Set the default storage quota in MB

public setDefaultStorageQuotaMb(int|null $defaultStorageQuotaMb) : self
Parameters
$defaultStorageQuotaMb : int|null
Return values
self

setDefaultTimeZone()

Set the default time zone

public setDefaultTimeZone(string|null $defaultTimeZone) : self
Parameters
$defaultTimeZone : string|null
Return values
self

setDefaultUserStorageQuotaMb()

Set the default user storage quota in MB

public setDefaultUserStorageQuotaMb(int|null $defaultUserStorageQuotaMb) : self
Parameters
$defaultUserStorageQuotaMb : int|null
Return values
self

setIntegrationId()

Set the integration ID

public setIntegrationId(string|null $integrationId) : self
Parameters
$integrationId : string|null
Return values
self

setName()

Set the account name

public setName(string|null $name) : self
Parameters
$name : string|null
Return values
self

setOverrideSisStickiness()

Set the override SIS stickiness flag

public setOverrideSisStickiness(bool|null $overrideSisStickiness) : self
Parameters
$overrideSisStickiness : bool|null
Return values
self

setParentAccountId()

Set the parent account ID

public setParentAccountId(int|null $parentAccountId) : self
Parameters
$parentAccountId : int|null
Return values
self

setService()

Enable or disable a specific service

public setService(string $serviceName, bool $enabled) : self
Parameters
$serviceName : string
$enabled : bool
Return values
self

setServices()

Set the services

public setServices(array<string, bool>|null $services) : self
Parameters
$services : array<string, bool>|null
Return values
self

setSettings()

Set the account settings

public setSettings(array<string, mixed>|null $settings) : self
Parameters
$settings : array<string, mixed>|null
Return values
self

setSisAccountId()

Set the SIS account ID

public setSisAccountId(string|null $sisAccountId) : self
Parameters
$sisAccountId : string|null
Return values
self

toApiArray()

Convert the DTO to an array for API requests This override handles nested settings array properly

public toApiArray() : array<int, array{name: string, contents: mixed}>
Return values
array<int, array{name: string, contents: mixed}>

toArray()

Convert the DTO to an array

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results