OrganizationsApi
in package
OrganizationsApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- getApiClient() : ApiClient
- Get API client
- getReportV2() : mixed
- Operation getReportV2
- getReportV2WithHttpInfo() : array<string|int, mixed>
- Operation getReportV2WithHttpInfo
- setApiClient() : self
- Set the API client
- updateResourcePath() : string
- Update $resourcePath with $
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getReportV2()
Operation getReportV2
public
getReportV2(string|null $organization_id, string|null $report_correlation_id) : mixed
Retrieves org level report by correlation id and site.
Parameters
- $organization_id : string|null
- $report_correlation_id : string|null
Tags
Return values
mixed —getReportV2WithHttpInfo()
Operation getReportV2WithHttpInfo
public
getReportV2WithHttpInfo(string|null $organization_id, string|null $report_correlation_id) : array<string|int, mixed>
Retrieves org level report by correlation id and site.
Parameters
- $organization_id : string|null
- $report_correlation_id : string|null
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name