LicensesApi
LicensesApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- assignOrganizationLicensesSeats() : object
- Operation assignOrganizationLicensesSeats
- assignOrganizationLicensesSeatsAsync() : PromiseInterface
- Operation assignOrganizationLicensesSeatsAsync
- assignOrganizationLicensesSeatsAsyncWithHttpInfo() : PromiseInterface
- Operation assignOrganizationLicensesSeatsAsyncWithHttpInfo
- assignOrganizationLicensesSeatsWithHttpInfo() : array<string|int, mixed>
- Operation assignOrganizationLicensesSeatsWithHttpInfo
- getConfig() : Configuration
- getOrganizationLicense() : object
- Operation getOrganizationLicense
- getOrganizationLicenseAsync() : PromiseInterface
- Operation getOrganizationLicenseAsync
- getOrganizationLicenseAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationLicenseAsyncWithHttpInfo
- getOrganizationLicenses() : object
- Operation getOrganizationLicenses
- getOrganizationLicensesAsync() : PromiseInterface
- Operation getOrganizationLicensesAsync
- getOrganizationLicensesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationLicensesAsyncWithHttpInfo
- getOrganizationLicensesOverview() : object
- Operation getOrganizationLicensesOverview
- getOrganizationLicensesOverviewAsync() : PromiseInterface
- Operation getOrganizationLicensesOverviewAsync
- getOrganizationLicensesOverviewAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationLicensesOverviewAsyncWithHttpInfo
- getOrganizationLicensesOverviewWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationLicensesOverviewWithHttpInfo
- getOrganizationLicensesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationLicensesWithHttpInfo
- getOrganizationLicenseWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationLicenseWithHttpInfo
- moveOrganizationLicenses() : object
- Operation moveOrganizationLicenses
- moveOrganizationLicensesAsync() : PromiseInterface
- Operation moveOrganizationLicensesAsync
- moveOrganizationLicensesAsyncWithHttpInfo() : PromiseInterface
- Operation moveOrganizationLicensesAsyncWithHttpInfo
- moveOrganizationLicensesSeats() : object
- Operation moveOrganizationLicensesSeats
- moveOrganizationLicensesSeatsAsync() : PromiseInterface
- Operation moveOrganizationLicensesSeatsAsync
- moveOrganizationLicensesSeatsAsyncWithHttpInfo() : PromiseInterface
- Operation moveOrganizationLicensesSeatsAsyncWithHttpInfo
- moveOrganizationLicensesSeatsWithHttpInfo() : array<string|int, mixed>
- Operation moveOrganizationLicensesSeatsWithHttpInfo
- moveOrganizationLicensesWithHttpInfo() : array<string|int, mixed>
- Operation moveOrganizationLicensesWithHttpInfo
- renewOrganizationLicensesSeats() : object
- Operation renewOrganizationLicensesSeats
- renewOrganizationLicensesSeatsAsync() : PromiseInterface
- Operation renewOrganizationLicensesSeatsAsync
- renewOrganizationLicensesSeatsAsyncWithHttpInfo() : PromiseInterface
- Operation renewOrganizationLicensesSeatsAsyncWithHttpInfo
- renewOrganizationLicensesSeatsWithHttpInfo() : array<string|int, mixed>
- Operation renewOrganizationLicensesSeatsWithHttpInfo
- updateOrganizationLicense() : object
- Operation updateOrganizationLicense
- updateOrganizationLicenseAsync() : PromiseInterface
- Operation updateOrganizationLicenseAsync
- updateOrganizationLicenseAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationLicenseAsyncWithHttpInfo
- updateOrganizationLicenseWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationLicenseWithHttpInfo
- assignOrganizationLicensesSeatsRequest() : Request
- Create request for operation 'assignOrganizationLicensesSeats'
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getOrganizationLicenseRequest() : Request
- Create request for operation 'getOrganizationLicense'
- getOrganizationLicensesOverviewRequest() : Request
- Create request for operation 'getOrganizationLicensesOverview'
- getOrganizationLicensesRequest() : Request
- Create request for operation 'getOrganizationLicenses'
- moveOrganizationLicensesRequest() : Request
- Create request for operation 'moveOrganizationLicenses'
- moveOrganizationLicensesSeatsRequest() : Request
- Create request for operation 'moveOrganizationLicensesSeats'
- renewOrganizationLicensesSeatsRequest() : Request
- Create request for operation 'renewOrganizationLicensesSeats'
- updateOrganizationLicenseRequest() : Request
- Create request for operation 'updateOrganizationLicense'
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 —assignOrganizationLicensesSeats()
Operation assignOrganizationLicensesSeats
public
assignOrganizationLicensesSeats(string $organization_id, AssignOrganizationLicensesSeats $assign_organization_licenses_seats) : object
Assign SM seats to a network
Parameters
- $organization_id : string
-
organization_id (required)
- $assign_organization_licenses_seats : AssignOrganizationLicensesSeats
-
assign_organization_licenses_seats (required)
Tags
Return values
object —assignOrganizationLicensesSeatsAsync()
Operation assignOrganizationLicensesSeatsAsync
public
assignOrganizationLicensesSeatsAsync(string $organization_id, AssignOrganizationLicensesSeats $assign_organization_licenses_seats) : PromiseInterface
Assign SM seats to a network
Parameters
- $organization_id : string
-
(required)
- $assign_organization_licenses_seats : AssignOrganizationLicensesSeats
-
(required)
Tags
Return values
PromiseInterface —assignOrganizationLicensesSeatsAsyncWithHttpInfo()
Operation assignOrganizationLicensesSeatsAsyncWithHttpInfo
public
assignOrganizationLicensesSeatsAsyncWithHttpInfo(string $organization_id, AssignOrganizationLicensesSeats $assign_organization_licenses_seats) : PromiseInterface
Assign SM seats to a network
Parameters
- $organization_id : string
-
(required)
- $assign_organization_licenses_seats : AssignOrganizationLicensesSeats
-
(required)
Tags
Return values
PromiseInterface —assignOrganizationLicensesSeatsWithHttpInfo()
Operation assignOrganizationLicensesSeatsWithHttpInfo
public
assignOrganizationLicensesSeatsWithHttpInfo(string $organization_id, AssignOrganizationLicensesSeats $assign_organization_licenses_seats) : array<string|int, mixed>
Assign SM seats to a network
Parameters
- $organization_id : string
-
(required)
- $assign_organization_licenses_seats : AssignOrganizationLicensesSeats
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getOrganizationLicense()
Operation getOrganizationLicense
public
getOrganizationLicense(string $organization_id, string $license_id) : object
Display a license
Parameters
- $organization_id : string
-
organization_id (required)
- $license_id : string
-
license_id (required)
Tags
Return values
object —getOrganizationLicenseAsync()
Operation getOrganizationLicenseAsync
public
getOrganizationLicenseAsync(string $organization_id, string $license_id) : PromiseInterface
Display a license
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationLicenseAsyncWithHttpInfo()
Operation getOrganizationLicenseAsyncWithHttpInfo
public
getOrganizationLicenseAsyncWithHttpInfo(string $organization_id, string $license_id) : PromiseInterface
Display a license
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationLicenses()
Operation getOrganizationLicenses
public
getOrganizationLicenses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $device_serial = null ][, string $network_id = null ][, string $state = null ]) : object
List the licenses for an organization
Parameters
- $organization_id : string
-
organization_id (required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $device_serial : string = null
-
Filter the licenses to those assigned to a particular device (optional)
- $network_id : string = null
-
Filter the licenses to those assigned in a particular network (optional)
- $state : string = null
-
Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'unused', 'unusedActive' or 'recentlyQueued' (optional)
Tags
Return values
object —getOrganizationLicensesAsync()
Operation getOrganizationLicensesAsync
public
getOrganizationLicensesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $device_serial = null ][, string $network_id = null ][, string $state = null ]) : PromiseInterface
List the licenses for an organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $device_serial : string = null
-
Filter the licenses to those assigned to a particular device (optional)
- $network_id : string = null
-
Filter the licenses to those assigned in a particular network (optional)
- $state : string = null
-
Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'unused', 'unusedActive' or 'recentlyQueued' (optional)
Tags
Return values
PromiseInterface —getOrganizationLicensesAsyncWithHttpInfo()
Operation getOrganizationLicensesAsyncWithHttpInfo
public
getOrganizationLicensesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $device_serial = null ][, string $network_id = null ][, string $state = null ]) : PromiseInterface
List the licenses for an organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $device_serial : string = null
-
Filter the licenses to those assigned to a particular device (optional)
- $network_id : string = null
-
Filter the licenses to those assigned in a particular network (optional)
- $state : string = null
-
Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'unused', 'unusedActive' or 'recentlyQueued' (optional)
Tags
Return values
PromiseInterface —getOrganizationLicensesOverview()
Operation getOrganizationLicensesOverview
public
getOrganizationLicensesOverview(string $organization_id) : object
Return an overview of the license state for an organization
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationLicensesOverviewAsync()
Operation getOrganizationLicensesOverviewAsync
public
getOrganizationLicensesOverviewAsync(string $organization_id) : PromiseInterface
Return an overview of the license state for an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationLicensesOverviewAsyncWithHttpInfo()
Operation getOrganizationLicensesOverviewAsyncWithHttpInfo
public
getOrganizationLicensesOverviewAsyncWithHttpInfo(string $organization_id) : PromiseInterface
Return an overview of the license state for an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationLicensesOverviewWithHttpInfo()
Operation getOrganizationLicensesOverviewWithHttpInfo
public
getOrganizationLicensesOverviewWithHttpInfo(string $organization_id) : array<string|int, mixed>
Return an overview of the license state for 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)
getOrganizationLicensesWithHttpInfo()
Operation getOrganizationLicensesWithHttpInfo
public
getOrganizationLicensesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $device_serial = null ][, string $network_id = null ][, string $state = null ]) : array<string|int, mixed>
List the licenses for an organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $device_serial : string = null
-
Filter the licenses to those assigned to a particular device (optional)
- $network_id : string = null
-
Filter the licenses to those assigned in a particular network (optional)
- $state : string = null
-
Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'unused', 'unusedActive' or 'recentlyQueued' (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationLicenseWithHttpInfo()
Operation getOrganizationLicenseWithHttpInfo
public
getOrganizationLicenseWithHttpInfo(string $organization_id, string $license_id) : array<string|int, mixed>
Display a license
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
moveOrganizationLicenses()
Operation moveOrganizationLicenses
public
moveOrganizationLicenses(string $organization_id, MoveOrganizationLicenses $move_organization_licenses) : object
Move licenses to another organization
Parameters
- $organization_id : string
-
organization_id (required)
- $move_organization_licenses : MoveOrganizationLicenses
-
move_organization_licenses (required)
Tags
Return values
object —moveOrganizationLicensesAsync()
Operation moveOrganizationLicensesAsync
public
moveOrganizationLicensesAsync(string $organization_id, MoveOrganizationLicenses $move_organization_licenses) : PromiseInterface
Move licenses to another organization
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses : MoveOrganizationLicenses
-
(required)
Tags
Return values
PromiseInterface —moveOrganizationLicensesAsyncWithHttpInfo()
Operation moveOrganizationLicensesAsyncWithHttpInfo
public
moveOrganizationLicensesAsyncWithHttpInfo(string $organization_id, MoveOrganizationLicenses $move_organization_licenses) : PromiseInterface
Move licenses to another organization
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses : MoveOrganizationLicenses
-
(required)
Tags
Return values
PromiseInterface —moveOrganizationLicensesSeats()
Operation moveOrganizationLicensesSeats
public
moveOrganizationLicensesSeats(string $organization_id, MoveOrganizationLicensesSeats $move_organization_licenses_seats) : object
Move SM seats to another organization
Parameters
- $organization_id : string
-
organization_id (required)
- $move_organization_licenses_seats : MoveOrganizationLicensesSeats
-
move_organization_licenses_seats (required)
Tags
Return values
object —moveOrganizationLicensesSeatsAsync()
Operation moveOrganizationLicensesSeatsAsync
public
moveOrganizationLicensesSeatsAsync(string $organization_id, MoveOrganizationLicensesSeats $move_organization_licenses_seats) : PromiseInterface
Move SM seats to another organization
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses_seats : MoveOrganizationLicensesSeats
-
(required)
Tags
Return values
PromiseInterface —moveOrganizationLicensesSeatsAsyncWithHttpInfo()
Operation moveOrganizationLicensesSeatsAsyncWithHttpInfo
public
moveOrganizationLicensesSeatsAsyncWithHttpInfo(string $organization_id, MoveOrganizationLicensesSeats $move_organization_licenses_seats) : PromiseInterface
Move SM seats to another organization
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses_seats : MoveOrganizationLicensesSeats
-
(required)
Tags
Return values
PromiseInterface —moveOrganizationLicensesSeatsWithHttpInfo()
Operation moveOrganizationLicensesSeatsWithHttpInfo
public
moveOrganizationLicensesSeatsWithHttpInfo(string $organization_id, MoveOrganizationLicensesSeats $move_organization_licenses_seats) : array<string|int, mixed>
Move SM seats to another organization
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses_seats : MoveOrganizationLicensesSeats
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
moveOrganizationLicensesWithHttpInfo()
Operation moveOrganizationLicensesWithHttpInfo
public
moveOrganizationLicensesWithHttpInfo(string $organization_id, MoveOrganizationLicenses $move_organization_licenses) : array<string|int, mixed>
Move licenses to another organization
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses : MoveOrganizationLicenses
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
renewOrganizationLicensesSeats()
Operation renewOrganizationLicensesSeats
public
renewOrganizationLicensesSeats(string $organization_id, RenewOrganizationLicensesSeats $renew_organization_licenses_seats) : object
Renew SM seats of a license
Parameters
- $organization_id : string
-
organization_id (required)
- $renew_organization_licenses_seats : RenewOrganizationLicensesSeats
-
renew_organization_licenses_seats (required)
Tags
Return values
object —renewOrganizationLicensesSeatsAsync()
Operation renewOrganizationLicensesSeatsAsync
public
renewOrganizationLicensesSeatsAsync(string $organization_id, RenewOrganizationLicensesSeats $renew_organization_licenses_seats) : PromiseInterface
Renew SM seats of a license
Parameters
- $organization_id : string
-
(required)
- $renew_organization_licenses_seats : RenewOrganizationLicensesSeats
-
(required)
Tags
Return values
PromiseInterface —renewOrganizationLicensesSeatsAsyncWithHttpInfo()
Operation renewOrganizationLicensesSeatsAsyncWithHttpInfo
public
renewOrganizationLicensesSeatsAsyncWithHttpInfo(string $organization_id, RenewOrganizationLicensesSeats $renew_organization_licenses_seats) : PromiseInterface
Renew SM seats of a license
Parameters
- $organization_id : string
-
(required)
- $renew_organization_licenses_seats : RenewOrganizationLicensesSeats
-
(required)
Tags
Return values
PromiseInterface —renewOrganizationLicensesSeatsWithHttpInfo()
Operation renewOrganizationLicensesSeatsWithHttpInfo
public
renewOrganizationLicensesSeatsWithHttpInfo(string $organization_id, RenewOrganizationLicensesSeats $renew_organization_licenses_seats) : array<string|int, mixed>
Renew SM seats of a license
Parameters
- $organization_id : string
-
(required)
- $renew_organization_licenses_seats : RenewOrganizationLicensesSeats
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationLicense()
Operation updateOrganizationLicense
public
updateOrganizationLicense(string $organization_id, string $license_id[, UpdateOrganizationLicense $update_organization_license = null ]) : object
Update a license
Parameters
- $organization_id : string
-
organization_id (required)
- $license_id : string
-
license_id (required)
- $update_organization_license : UpdateOrganizationLicense = null
-
update_organization_license (optional)
Tags
Return values
object —updateOrganizationLicenseAsync()
Operation updateOrganizationLicenseAsync
public
updateOrganizationLicenseAsync(string $organization_id, string $license_id[, UpdateOrganizationLicense $update_organization_license = null ]) : PromiseInterface
Update a license
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
- $update_organization_license : UpdateOrganizationLicense = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationLicenseAsyncWithHttpInfo()
Operation updateOrganizationLicenseAsyncWithHttpInfo
public
updateOrganizationLicenseAsyncWithHttpInfo(string $organization_id, string $license_id[, UpdateOrganizationLicense $update_organization_license = null ]) : PromiseInterface
Update a license
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
- $update_organization_license : UpdateOrganizationLicense = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationLicenseWithHttpInfo()
Operation updateOrganizationLicenseWithHttpInfo
public
updateOrganizationLicenseWithHttpInfo(string $organization_id, string $license_id[, UpdateOrganizationLicense $update_organization_license = null ]) : array<string|int, mixed>
Update a license
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
- $update_organization_license : UpdateOrganizationLicense = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
assignOrganizationLicensesSeatsRequest()
Create request for operation 'assignOrganizationLicensesSeats'
protected
assignOrganizationLicensesSeatsRequest(string $organization_id, AssignOrganizationLicensesSeats $assign_organization_licenses_seats) : Request
Parameters
- $organization_id : string
-
(required)
- $assign_organization_licenses_seats : AssignOrganizationLicensesSeats
-
(required)
Tags
Return values
Request —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getOrganizationLicenseRequest()
Create request for operation 'getOrganizationLicense'
protected
getOrganizationLicenseRequest(string $organization_id, string $license_id) : Request
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
Tags
Return values
Request —getOrganizationLicensesOverviewRequest()
Create request for operation 'getOrganizationLicensesOverview'
protected
getOrganizationLicensesOverviewRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —getOrganizationLicensesRequest()
Create request for operation 'getOrganizationLicenses'
protected
getOrganizationLicensesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $device_serial = null ][, string $network_id = null ][, string $state = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $device_serial : string = null
-
Filter the licenses to those assigned to a particular device (optional)
- $network_id : string = null
-
Filter the licenses to those assigned in a particular network (optional)
- $state : string = null
-
Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'unused', 'unusedActive' or 'recentlyQueued' (optional)
Tags
Return values
Request —moveOrganizationLicensesRequest()
Create request for operation 'moveOrganizationLicenses'
protected
moveOrganizationLicensesRequest(string $organization_id, MoveOrganizationLicenses $move_organization_licenses) : Request
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses : MoveOrganizationLicenses
-
(required)
Tags
Return values
Request —moveOrganizationLicensesSeatsRequest()
Create request for operation 'moveOrganizationLicensesSeats'
protected
moveOrganizationLicensesSeatsRequest(string $organization_id, MoveOrganizationLicensesSeats $move_organization_licenses_seats) : Request
Parameters
- $organization_id : string
-
(required)
- $move_organization_licenses_seats : MoveOrganizationLicensesSeats
-
(required)
Tags
Return values
Request —renewOrganizationLicensesSeatsRequest()
Create request for operation 'renewOrganizationLicensesSeats'
protected
renewOrganizationLicensesSeatsRequest(string $organization_id, RenewOrganizationLicensesSeats $renew_organization_licenses_seats) : Request
Parameters
- $organization_id : string
-
(required)
- $renew_organization_licenses_seats : RenewOrganizationLicensesSeats
-
(required)
Tags
Return values
Request —updateOrganizationLicenseRequest()
Create request for operation 'updateOrganizationLicense'
protected
updateOrganizationLicenseRequest(string $organization_id, string $license_id[, UpdateOrganizationLicense $update_organization_license = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $license_id : string
-
(required)
- $update_organization_license : UpdateOrganizationLicense = null
-
(optional)