Interface IOrganizationsSplash

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsSplash

Methods

CreateOrganizationSplashThemeAssetAsync(string, string, OrganizationSplashThemeAssetCreateRequest, CancellationToken)

Create a Splash Theme Asset

[Post("/organizations/{organizationId}/splash/themes/{themeIdentifier}/assets")]
Task<OrganizationSplashAsset> CreateOrganizationSplashThemeAssetAsync(string organizationId, string themeIdentifier, OrganizationSplashThemeAssetCreateRequest splashThemeCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

themeIdentifier string

The splash theme id

splashThemeCreateRequest OrganizationSplashThemeAssetCreateRequest

The splash theme create request body

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationSplashAsset>

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationSplashThemeAsync(string, OrganizationSplashThemeCreateRequest, CancellationToken)

Create a Splash Theme

[Post("/organizations/{organizationId}/splash/themes")]
Task<OrganizationSplashTheme> CreateOrganizationSplashThemeAsync(string organizationId, OrganizationSplashThemeCreateRequest splashThemeCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

splashThemeCreateRequest OrganizationSplashThemeCreateRequest

The splash theme create request body

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationSplashTheme>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationSplashAssetAsync(string, string, CancellationToken)

Delete a Splash Theme Asset

[Delete("/organizations/{organizationId}/splash/assets/{id}")]
Task DeleteOrganizationSplashAssetAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

ID

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationSplashThemeAsync(string, string, CancellationToken)

Delete a Splash Theme

[Delete("/organizations/{organizationId}/splash/themes/{id}")]
Task DeleteOrganizationSplashThemeAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

ID

cancellationToken CancellationToken

The cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSplashAssetAsync(string, string, CancellationToken)

Get a Splash Theme Asset

[Get("/organizations/{organizationId}/splash/assets/{id}")]
Task<OrganizationSplashAsset> GetOrganizationSplashAssetAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

ID

cancellationToken CancellationToken

Returns

Task<OrganizationSplashAsset>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSplashThemesAsync(string, CancellationToken)

List Splash Themes

[Get("/organizations/{organizationId}/splash/themes")]
Task<List<OrganizationSplashTheme>> GetOrganizationSplashThemesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<OrganizationSplashTheme>>

Exceptions

ApiException

Thrown when fails to make API call