BrandingPoliciesApi
BrandingPoliciesApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createOrganizationBrandingPolicy() : object
- Operation createOrganizationBrandingPolicy
- createOrganizationBrandingPolicyAsync() : PromiseInterface
- Operation createOrganizationBrandingPolicyAsync
- createOrganizationBrandingPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation createOrganizationBrandingPolicyAsyncWithHttpInfo
- createOrganizationBrandingPolicyWithHttpInfo() : array<string|int, mixed>
- Operation createOrganizationBrandingPolicyWithHttpInfo
- deleteOrganizationBrandingPolicy() : void
- Operation deleteOrganizationBrandingPolicy
- deleteOrganizationBrandingPolicyAsync() : PromiseInterface
- Operation deleteOrganizationBrandingPolicyAsync
- deleteOrganizationBrandingPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation deleteOrganizationBrandingPolicyAsyncWithHttpInfo
- deleteOrganizationBrandingPolicyWithHttpInfo() : array<string|int, mixed>
- Operation deleteOrganizationBrandingPolicyWithHttpInfo
- getConfig() : Configuration
- getOrganizationBrandingPolicies() : object
- Operation getOrganizationBrandingPolicies
- getOrganizationBrandingPoliciesAsync() : PromiseInterface
- Operation getOrganizationBrandingPoliciesAsync
- getOrganizationBrandingPoliciesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationBrandingPoliciesAsyncWithHttpInfo
- getOrganizationBrandingPoliciesPriorities() : object
- Operation getOrganizationBrandingPoliciesPriorities
- getOrganizationBrandingPoliciesPrioritiesAsync() : PromiseInterface
- Operation getOrganizationBrandingPoliciesPrioritiesAsync
- getOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo
- getOrganizationBrandingPoliciesPrioritiesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationBrandingPoliciesPrioritiesWithHttpInfo
- getOrganizationBrandingPoliciesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationBrandingPoliciesWithHttpInfo
- getOrganizationBrandingPolicy() : object
- Operation getOrganizationBrandingPolicy
- getOrganizationBrandingPolicyAsync() : PromiseInterface
- Operation getOrganizationBrandingPolicyAsync
- getOrganizationBrandingPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationBrandingPolicyAsyncWithHttpInfo
- getOrganizationBrandingPolicyWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationBrandingPolicyWithHttpInfo
- updateOrganizationBrandingPoliciesPriorities() : object
- Operation updateOrganizationBrandingPoliciesPriorities
- updateOrganizationBrandingPoliciesPrioritiesAsync() : PromiseInterface
- Operation updateOrganizationBrandingPoliciesPrioritiesAsync
- updateOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo
- updateOrganizationBrandingPoliciesPrioritiesWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationBrandingPoliciesPrioritiesWithHttpInfo
- updateOrganizationBrandingPolicy() : object
- Operation updateOrganizationBrandingPolicy
- updateOrganizationBrandingPolicyAsync() : PromiseInterface
- Operation updateOrganizationBrandingPolicyAsync
- updateOrganizationBrandingPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationBrandingPolicyAsyncWithHttpInfo
- updateOrganizationBrandingPolicyWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationBrandingPolicyWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createOrganizationBrandingPolicyRequest() : Request
- Create request for operation 'createOrganizationBrandingPolicy'
- deleteOrganizationBrandingPolicyRequest() : Request
- Create request for operation 'deleteOrganizationBrandingPolicy'
- getOrganizationBrandingPoliciesPrioritiesRequest() : Request
- Create request for operation 'getOrganizationBrandingPoliciesPriorities'
- getOrganizationBrandingPoliciesRequest() : Request
- Create request for operation 'getOrganizationBrandingPolicies'
- getOrganizationBrandingPolicyRequest() : Request
- Create request for operation 'getOrganizationBrandingPolicy'
- updateOrganizationBrandingPoliciesPrioritiesRequest() : Request
- Create request for operation 'updateOrganizationBrandingPoliciesPriorities'
- updateOrganizationBrandingPolicyRequest() : Request
- Create request for operation 'updateOrganizationBrandingPolicy'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —createOrganizationBrandingPolicy()
Operation createOrganizationBrandingPolicy
public
createOrganizationBrandingPolicy(string $organization_id, CreateOrganizationBrandingPolicy $create_organization_branding_policy) : object
Add a new branding policy to an organization
Parameters
- $organization_id : string
-
organization_id (required)
- $create_organization_branding_policy : CreateOrganizationBrandingPolicy
-
create_organization_branding_policy (required)
Tags
Return values
object —createOrganizationBrandingPolicyAsync()
Operation createOrganizationBrandingPolicyAsync
public
createOrganizationBrandingPolicyAsync(string $organization_id, CreateOrganizationBrandingPolicy $create_organization_branding_policy) : PromiseInterface
Add a new branding policy to an organization
Parameters
- $organization_id : string
-
(required)
- $create_organization_branding_policy : CreateOrganizationBrandingPolicy
-
(required)
Tags
Return values
PromiseInterface —createOrganizationBrandingPolicyAsyncWithHttpInfo()
Operation createOrganizationBrandingPolicyAsyncWithHttpInfo
public
createOrganizationBrandingPolicyAsyncWithHttpInfo(string $organization_id, CreateOrganizationBrandingPolicy $create_organization_branding_policy) : PromiseInterface
Add a new branding policy to an organization
Parameters
- $organization_id : string
-
(required)
- $create_organization_branding_policy : CreateOrganizationBrandingPolicy
-
(required)
Tags
Return values
PromiseInterface —createOrganizationBrandingPolicyWithHttpInfo()
Operation createOrganizationBrandingPolicyWithHttpInfo
public
createOrganizationBrandingPolicyWithHttpInfo(string $organization_id, CreateOrganizationBrandingPolicy $create_organization_branding_policy) : array<string|int, mixed>
Add a new branding policy to an organization
Parameters
- $organization_id : string
-
(required)
- $create_organization_branding_policy : CreateOrganizationBrandingPolicy
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteOrganizationBrandingPolicy()
Operation deleteOrganizationBrandingPolicy
public
deleteOrganizationBrandingPolicy(string $organization_id, string $branding_policy_id) : void
Delete a branding policy
Parameters
- $organization_id : string
-
organization_id (required)
- $branding_policy_id : string
-
branding_policy_id (required)
Tags
Return values
void —deleteOrganizationBrandingPolicyAsync()
Operation deleteOrganizationBrandingPolicyAsync
public
deleteOrganizationBrandingPolicyAsync(string $organization_id, string $branding_policy_id) : PromiseInterface
Delete a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationBrandingPolicyAsyncWithHttpInfo()
Operation deleteOrganizationBrandingPolicyAsyncWithHttpInfo
public
deleteOrganizationBrandingPolicyAsyncWithHttpInfo(string $organization_id, string $branding_policy_id) : PromiseInterface
Delete a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationBrandingPolicyWithHttpInfo()
Operation deleteOrganizationBrandingPolicyWithHttpInfo
public
deleteOrganizationBrandingPolicyWithHttpInfo(string $organization_id, string $branding_policy_id) : array<string|int, mixed>
Delete a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getOrganizationBrandingPolicies()
Operation getOrganizationBrandingPolicies
public
getOrganizationBrandingPolicies(string $organization_id) : object
List the branding policies of an organization
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationBrandingPoliciesAsync()
Operation getOrganizationBrandingPoliciesAsync
public
getOrganizationBrandingPoliciesAsync(string $organization_id) : PromiseInterface
List the branding policies of an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationBrandingPoliciesAsyncWithHttpInfo()
Operation getOrganizationBrandingPoliciesAsyncWithHttpInfo
public
getOrganizationBrandingPoliciesAsyncWithHttpInfo(string $organization_id) : PromiseInterface
List the branding policies of an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationBrandingPoliciesPriorities()
Operation getOrganizationBrandingPoliciesPriorities
public
getOrganizationBrandingPoliciesPriorities(string $organization_id) : object
Return the branding policy IDs of an organization in priority order
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationBrandingPoliciesPrioritiesAsync()
Operation getOrganizationBrandingPoliciesPrioritiesAsync
public
getOrganizationBrandingPoliciesPrioritiesAsync(string $organization_id) : PromiseInterface
Return the branding policy IDs of an organization in priority order
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo()
Operation getOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo
public
getOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo(string $organization_id) : PromiseInterface
Return the branding policy IDs of an organization in priority order
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationBrandingPoliciesPrioritiesWithHttpInfo()
Operation getOrganizationBrandingPoliciesPrioritiesWithHttpInfo
public
getOrganizationBrandingPoliciesPrioritiesWithHttpInfo(string $organization_id) : array<string|int, mixed>
Return the branding policy IDs of an organization in priority order
Parameters
- $organization_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationBrandingPoliciesWithHttpInfo()
Operation getOrganizationBrandingPoliciesWithHttpInfo
public
getOrganizationBrandingPoliciesWithHttpInfo(string $organization_id) : array<string|int, mixed>
List the branding policies of an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationBrandingPolicy()
Operation getOrganizationBrandingPolicy
public
getOrganizationBrandingPolicy(string $organization_id, string $branding_policy_id) : object
Return a branding policy
Parameters
- $organization_id : string
-
organization_id (required)
- $branding_policy_id : string
-
branding_policy_id (required)
Tags
Return values
object —getOrganizationBrandingPolicyAsync()
Operation getOrganizationBrandingPolicyAsync
public
getOrganizationBrandingPolicyAsync(string $organization_id, string $branding_policy_id) : PromiseInterface
Return a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationBrandingPolicyAsyncWithHttpInfo()
Operation getOrganizationBrandingPolicyAsyncWithHttpInfo
public
getOrganizationBrandingPolicyAsyncWithHttpInfo(string $organization_id, string $branding_policy_id) : PromiseInterface
Return a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationBrandingPolicyWithHttpInfo()
Operation getOrganizationBrandingPolicyWithHttpInfo
public
getOrganizationBrandingPolicyWithHttpInfo(string $organization_id, string $branding_policy_id) : array<string|int, mixed>
Return a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationBrandingPoliciesPriorities()
Operation updateOrganizationBrandingPoliciesPriorities
public
updateOrganizationBrandingPoliciesPriorities(string $organization_id, UpdateOrganizationBrandingPoliciesPriorities $update_organization_branding_policies_priorities) : object
Update the priority ordering of an organization's branding policies.
Parameters
- $organization_id : string
-
organization_id (required)
- $update_organization_branding_policies_priorities : UpdateOrganizationBrandingPoliciesPriorities
-
update_organization_branding_policies_priorities (required)
Tags
Return values
object —updateOrganizationBrandingPoliciesPrioritiesAsync()
Operation updateOrganizationBrandingPoliciesPrioritiesAsync
public
updateOrganizationBrandingPoliciesPrioritiesAsync(string $organization_id, UpdateOrganizationBrandingPoliciesPriorities $update_organization_branding_policies_priorities) : PromiseInterface
Update the priority ordering of an organization's branding policies.
Parameters
- $organization_id : string
-
(required)
- $update_organization_branding_policies_priorities : UpdateOrganizationBrandingPoliciesPriorities
-
(required)
Tags
Return values
PromiseInterface —updateOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo()
Operation updateOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo
public
updateOrganizationBrandingPoliciesPrioritiesAsyncWithHttpInfo(string $organization_id, UpdateOrganizationBrandingPoliciesPriorities $update_organization_branding_policies_priorities) : PromiseInterface
Update the priority ordering of an organization's branding policies.
Parameters
- $organization_id : string
-
(required)
- $update_organization_branding_policies_priorities : UpdateOrganizationBrandingPoliciesPriorities
-
(required)
Tags
Return values
PromiseInterface —updateOrganizationBrandingPoliciesPrioritiesWithHttpInfo()
Operation updateOrganizationBrandingPoliciesPrioritiesWithHttpInfo
public
updateOrganizationBrandingPoliciesPrioritiesWithHttpInfo(string $organization_id, UpdateOrganizationBrandingPoliciesPriorities $update_organization_branding_policies_priorities) : array<string|int, mixed>
Update the priority ordering of an organization's branding policies.
Parameters
- $organization_id : string
-
(required)
- $update_organization_branding_policies_priorities : UpdateOrganizationBrandingPoliciesPriorities
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationBrandingPolicy()
Operation updateOrganizationBrandingPolicy
public
updateOrganizationBrandingPolicy(string $organization_id, string $branding_policy_id[, UpdateOrganizationBrandingPolicy $update_organization_branding_policy = null ]) : object
Update a branding policy
Parameters
- $organization_id : string
-
organization_id (required)
- $branding_policy_id : string
-
branding_policy_id (required)
- $update_organization_branding_policy : UpdateOrganizationBrandingPolicy = null
-
update_organization_branding_policy (optional)
Tags
Return values
object —updateOrganizationBrandingPolicyAsync()
Operation updateOrganizationBrandingPolicyAsync
public
updateOrganizationBrandingPolicyAsync(string $organization_id, string $branding_policy_id[, UpdateOrganizationBrandingPolicy $update_organization_branding_policy = null ]) : PromiseInterface
Update a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
- $update_organization_branding_policy : UpdateOrganizationBrandingPolicy = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationBrandingPolicyAsyncWithHttpInfo()
Operation updateOrganizationBrandingPolicyAsyncWithHttpInfo
public
updateOrganizationBrandingPolicyAsyncWithHttpInfo(string $organization_id, string $branding_policy_id[, UpdateOrganizationBrandingPolicy $update_organization_branding_policy = null ]) : PromiseInterface
Update a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
- $update_organization_branding_policy : UpdateOrganizationBrandingPolicy = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationBrandingPolicyWithHttpInfo()
Operation updateOrganizationBrandingPolicyWithHttpInfo
public
updateOrganizationBrandingPolicyWithHttpInfo(string $organization_id, string $branding_policy_id[, UpdateOrganizationBrandingPolicy $update_organization_branding_policy = null ]) : array<string|int, mixed>
Update a branding policy
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
- $update_organization_branding_policy : UpdateOrganizationBrandingPolicy = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
createOrganizationBrandingPolicyRequest()
Create request for operation 'createOrganizationBrandingPolicy'
protected
createOrganizationBrandingPolicyRequest(string $organization_id, CreateOrganizationBrandingPolicy $create_organization_branding_policy) : Request
Parameters
- $organization_id : string
-
(required)
- $create_organization_branding_policy : CreateOrganizationBrandingPolicy
-
(required)
Tags
Return values
Request —deleteOrganizationBrandingPolicyRequest()
Create request for operation 'deleteOrganizationBrandingPolicy'
protected
deleteOrganizationBrandingPolicyRequest(string $organization_id, string $branding_policy_id) : Request
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
Request —getOrganizationBrandingPoliciesPrioritiesRequest()
Create request for operation 'getOrganizationBrandingPoliciesPriorities'
protected
getOrganizationBrandingPoliciesPrioritiesRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —getOrganizationBrandingPoliciesRequest()
Create request for operation 'getOrganizationBrandingPolicies'
protected
getOrganizationBrandingPoliciesRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —getOrganizationBrandingPolicyRequest()
Create request for operation 'getOrganizationBrandingPolicy'
protected
getOrganizationBrandingPolicyRequest(string $organization_id, string $branding_policy_id) : Request
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
Tags
Return values
Request —updateOrganizationBrandingPoliciesPrioritiesRequest()
Create request for operation 'updateOrganizationBrandingPoliciesPriorities'
protected
updateOrganizationBrandingPoliciesPrioritiesRequest(string $organization_id, UpdateOrganizationBrandingPoliciesPriorities $update_organization_branding_policies_priorities) : Request
Parameters
- $organization_id : string
-
(required)
- $update_organization_branding_policies_priorities : UpdateOrganizationBrandingPoliciesPriorities
-
(required)
Tags
Return values
Request —updateOrganizationBrandingPolicyRequest()
Create request for operation 'updateOrganizationBrandingPolicy'
protected
updateOrganizationBrandingPolicyRequest(string $organization_id, string $branding_policy_id[, UpdateOrganizationBrandingPolicy $update_organization_branding_policy = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $branding_policy_id : string
-
(required)
- $update_organization_branding_policy : UpdateOrganizationBrandingPolicy = null
-
(optional)