AdminsApi
AdminsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createOrganizationAdmin() : object
- Operation createOrganizationAdmin
- createOrganizationAdminAsync() : PromiseInterface
- Operation createOrganizationAdminAsync
- createOrganizationAdminAsyncWithHttpInfo() : PromiseInterface
- Operation createOrganizationAdminAsyncWithHttpInfo
- createOrganizationAdminWithHttpInfo() : array<string|int, mixed>
- Operation createOrganizationAdminWithHttpInfo
- deleteOrganizationAdmin() : void
- Operation deleteOrganizationAdmin
- deleteOrganizationAdminAsync() : PromiseInterface
- Operation deleteOrganizationAdminAsync
- deleteOrganizationAdminAsyncWithHttpInfo() : PromiseInterface
- Operation deleteOrganizationAdminAsyncWithHttpInfo
- deleteOrganizationAdminWithHttpInfo() : array<string|int, mixed>
- Operation deleteOrganizationAdminWithHttpInfo
- getConfig() : Configuration
- getOrganizationAdmins() : object
- Operation getOrganizationAdmins
- getOrganizationAdminsAsync() : PromiseInterface
- Operation getOrganizationAdminsAsync
- getOrganizationAdminsAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationAdminsAsyncWithHttpInfo
- getOrganizationAdminsWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationAdminsWithHttpInfo
- updateOrganizationAdmin() : object
- Operation updateOrganizationAdmin
- updateOrganizationAdminAsync() : PromiseInterface
- Operation updateOrganizationAdminAsync
- updateOrganizationAdminAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationAdminAsyncWithHttpInfo
- updateOrganizationAdminWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationAdminWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createOrganizationAdminRequest() : Request
- Create request for operation 'createOrganizationAdmin'
- deleteOrganizationAdminRequest() : Request
- Create request for operation 'deleteOrganizationAdmin'
- getOrganizationAdminsRequest() : Request
- Create request for operation 'getOrganizationAdmins'
- updateOrganizationAdminRequest() : Request
- Create request for operation 'updateOrganizationAdmin'
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 —createOrganizationAdmin()
Operation createOrganizationAdmin
public
createOrganizationAdmin(string $organization_id, CreateOrganizationAdmin $create_organization_admin) : object
Create a new dashboard administrator
Parameters
- $organization_id : string
-
organization_id (required)
- $create_organization_admin : CreateOrganizationAdmin
-
create_organization_admin (required)
Tags
Return values
object —createOrganizationAdminAsync()
Operation createOrganizationAdminAsync
public
createOrganizationAdminAsync(string $organization_id, CreateOrganizationAdmin $create_organization_admin) : PromiseInterface
Create a new dashboard administrator
Parameters
- $organization_id : string
-
(required)
- $create_organization_admin : CreateOrganizationAdmin
-
(required)
Tags
Return values
PromiseInterface —createOrganizationAdminAsyncWithHttpInfo()
Operation createOrganizationAdminAsyncWithHttpInfo
public
createOrganizationAdminAsyncWithHttpInfo(string $organization_id, CreateOrganizationAdmin $create_organization_admin) : PromiseInterface
Create a new dashboard administrator
Parameters
- $organization_id : string
-
(required)
- $create_organization_admin : CreateOrganizationAdmin
-
(required)
Tags
Return values
PromiseInterface —createOrganizationAdminWithHttpInfo()
Operation createOrganizationAdminWithHttpInfo
public
createOrganizationAdminWithHttpInfo(string $organization_id, CreateOrganizationAdmin $create_organization_admin) : array<string|int, mixed>
Create a new dashboard administrator
Parameters
- $organization_id : string
-
(required)
- $create_organization_admin : CreateOrganizationAdmin
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteOrganizationAdmin()
Operation deleteOrganizationAdmin
public
deleteOrganizationAdmin(string $organization_id, string $admin_id) : void
Revoke all access for a dashboard administrator within this organization
Parameters
- $organization_id : string
-
organization_id (required)
- $admin_id : string
-
admin_id (required)
Tags
Return values
void —deleteOrganizationAdminAsync()
Operation deleteOrganizationAdminAsync
public
deleteOrganizationAdminAsync(string $organization_id, string $admin_id) : PromiseInterface
Revoke all access for a dashboard administrator within this organization
Parameters
- $organization_id : string
-
(required)
- $admin_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationAdminAsyncWithHttpInfo()
Operation deleteOrganizationAdminAsyncWithHttpInfo
public
deleteOrganizationAdminAsyncWithHttpInfo(string $organization_id, string $admin_id) : PromiseInterface
Revoke all access for a dashboard administrator within this organization
Parameters
- $organization_id : string
-
(required)
- $admin_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationAdminWithHttpInfo()
Operation deleteOrganizationAdminWithHttpInfo
public
deleteOrganizationAdminWithHttpInfo(string $organization_id, string $admin_id) : array<string|int, mixed>
Revoke all access for a dashboard administrator within this organization
Parameters
- $organization_id : string
-
(required)
- $admin_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 —getOrganizationAdmins()
Operation getOrganizationAdmins
public
getOrganizationAdmins(string $organization_id) : object
List the dashboard administrators in this organization
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationAdminsAsync()
Operation getOrganizationAdminsAsync
public
getOrganizationAdminsAsync(string $organization_id) : PromiseInterface
List the dashboard administrators in this organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationAdminsAsyncWithHttpInfo()
Operation getOrganizationAdminsAsyncWithHttpInfo
public
getOrganizationAdminsAsyncWithHttpInfo(string $organization_id) : PromiseInterface
List the dashboard administrators in this organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationAdminsWithHttpInfo()
Operation getOrganizationAdminsWithHttpInfo
public
getOrganizationAdminsWithHttpInfo(string $organization_id) : array<string|int, mixed>
List the dashboard administrators in this organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationAdmin()
Operation updateOrganizationAdmin
public
updateOrganizationAdmin(string $organization_id, string $admin_id[, UpdateOrganizationAdmin $update_organization_admin = null ]) : object
Update an administrator
Parameters
- $organization_id : string
-
organization_id (required)
- $admin_id : string
-
admin_id (required)
- $update_organization_admin : UpdateOrganizationAdmin = null
-
update_organization_admin (optional)
Tags
Return values
object —updateOrganizationAdminAsync()
Operation updateOrganizationAdminAsync
public
updateOrganizationAdminAsync(string $organization_id, string $admin_id[, UpdateOrganizationAdmin $update_organization_admin = null ]) : PromiseInterface
Update an administrator
Parameters
- $organization_id : string
-
(required)
- $admin_id : string
-
(required)
- $update_organization_admin : UpdateOrganizationAdmin = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationAdminAsyncWithHttpInfo()
Operation updateOrganizationAdminAsyncWithHttpInfo
public
updateOrganizationAdminAsyncWithHttpInfo(string $organization_id, string $admin_id[, UpdateOrganizationAdmin $update_organization_admin = null ]) : PromiseInterface
Update an administrator
Parameters
- $organization_id : string
-
(required)
- $admin_id : string
-
(required)
- $update_organization_admin : UpdateOrganizationAdmin = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationAdminWithHttpInfo()
Operation updateOrganizationAdminWithHttpInfo
public
updateOrganizationAdminWithHttpInfo(string $organization_id, string $admin_id[, UpdateOrganizationAdmin $update_organization_admin = null ]) : array<string|int, mixed>
Update an administrator
Parameters
- $organization_id : string
-
(required)
- $admin_id : string
-
(required)
- $update_organization_admin : UpdateOrganizationAdmin = 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
createOrganizationAdminRequest()
Create request for operation 'createOrganizationAdmin'
protected
createOrganizationAdminRequest(string $organization_id, CreateOrganizationAdmin $create_organization_admin) : Request
Parameters
- $organization_id : string
-
(required)
- $create_organization_admin : CreateOrganizationAdmin
-
(required)
Tags
Return values
Request —deleteOrganizationAdminRequest()
Create request for operation 'deleteOrganizationAdmin'
protected
deleteOrganizationAdminRequest(string $organization_id, string $admin_id) : Request
Parameters
- $organization_id : string
-
(required)
- $admin_id : string
-
(required)
Tags
Return values
Request —getOrganizationAdminsRequest()
Create request for operation 'getOrganizationAdmins'
protected
getOrganizationAdminsRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —updateOrganizationAdminRequest()
Create request for operation 'updateOrganizationAdmin'
protected
updateOrganizationAdminRequest(string $organization_id, string $admin_id[, UpdateOrganizationAdmin $update_organization_admin = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $admin_id : string
-
(required)
- $update_organization_admin : UpdateOrganizationAdmin = null
-
(optional)