Documentation

ConfigurationChangesApi

ConfigurationChangesApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
__construct()  : mixed
getConfig()  : Configuration
getOrganizationConfigurationChanges()  : object
Operation getOrganizationConfigurationChanges
getOrganizationConfigurationChangesAsync()  : PromiseInterface
Operation getOrganizationConfigurationChangesAsync
getOrganizationConfigurationChangesAsyncWithHttpInfo()  : PromiseInterface
Operation getOrganizationConfigurationChangesAsyncWithHttpInfo
getOrganizationConfigurationChangesWithHttpInfo()  : array<string|int, mixed>
Operation getOrganizationConfigurationChangesWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getOrganizationConfigurationChangesRequest()  : Request
Create request for operation 'getOrganizationConfigurationChanges'

Properties

Methods

getOrganizationConfigurationChanges()

Operation getOrganizationConfigurationChanges

public getOrganizationConfigurationChanges(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : object

View the Change Log for your organization

Parameters
$organization_id : string

organization_id (required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days. (optional)

$per_page : int = null

The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (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)

$network_id : string = null

Filters on the given network (optional)

$admin_id : string = null

Filters on the given Admin (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getOrganizationConfigurationChangesAsync()

Operation getOrganizationConfigurationChangesAsync

public getOrganizationConfigurationChangesAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : PromiseInterface

View the Change Log for your organization

Parameters
$organization_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days. (optional)

$per_page : int = null

The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (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)

$network_id : string = null

Filters on the given network (optional)

$admin_id : string = null

Filters on the given Admin (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getOrganizationConfigurationChangesAsyncWithHttpInfo()

Operation getOrganizationConfigurationChangesAsyncWithHttpInfo

public getOrganizationConfigurationChangesAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : PromiseInterface

View the Change Log for your organization

Parameters
$organization_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days. (optional)

$per_page : int = null

The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (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)

$network_id : string = null

Filters on the given network (optional)

$admin_id : string = null

Filters on the given Admin (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getOrganizationConfigurationChangesWithHttpInfo()

Operation getOrganizationConfigurationChangesWithHttpInfo

public getOrganizationConfigurationChangesWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : array<string|int, mixed>

View the Change Log for your organization

Parameters
$organization_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days. (optional)

$per_page : int = null

The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (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)

$network_id : string = null

Filters on the given network (optional)

$admin_id : string = null

Filters on the given Admin (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

getOrganizationConfigurationChangesRequest()

Create request for operation 'getOrganizationConfigurationChanges'

protected getOrganizationConfigurationChangesRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : Request
Parameters
$organization_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days. (optional)

$per_page : int = null

The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (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)

$network_id : string = null

Filters on the given network (optional)

$admin_id : string = null

Filters on the given Admin (optional)

Tags
throws
InvalidArgumentException
Return values
Request

Search results