PHP Sigfox Client

ContractInfosList extends Request

Retrieve a list of contracts according to visibility permissions and request filters.

Table of Contents

GROUP_TYPE_BASIC  = 2
BASIC
GROUP_TYPE_CHANNEL  = 9
CHANNEL
PRICING_MODEL_PRICING_MODEL_V1  = 1
Pricing model v1
PRICING_MODEL_PRICING_MODEL_V2  = 2
Pricing model v2
PRICING_MODEL_PRICING_MODEL_V3  = 3
Pricing model v3
SUBSCRIPTION_PLAN_ACTIVATE  = 6
Activate
SUBSCRIPTION_PLAN_COMMITTED_VOLUME_PLAN  = 2
Committed Volume Plan (CVP)
SUBSCRIPTION_PLAN_DEVKIT  = 5
DevKit
SUBSCRIPTION_PLAN_FLEXIBLE_COMMITTED_VOLUME_PLAN  = 3
Flexible Committed Volume Plan (CVP Flex)
SUBSCRIPTION_PLAN_FREE_ORDER  = 0
Free order
SUBSCRIPTION_PLAN_PACK  = 4
PACK
SUBSCRIPTION_PLAN_PAY_AS_YOU_GROW  = 1
Pay As You Grow (PAYG)
$authorizations  : bool|null
if true, we return the list of actions and resources the user has access
$contractIds  : string|null
Searches for contracts IDs that have the listed external (BSS) contractId. The elements of the list are separated by comma.
$deep  : bool|null
Searches for contracts that are attached to the given group and its descendants
$fields  : string|null
Defines the other available fields to be returned in the response.
$fromTime  : int|null
Searches for contracts with communication end time superior or equal to given time (in milliseconds since Unix Epoch).
$geolocationMode  : int|null
Searches for contracts with the given geolocation mode (level) 1 (ATLAS) 2 (ATLAS_WIFI) 3 (N/A) 4 (ATLAS_POV) 5 (ATLAS_BUBBLE) 6 (ATLAS_WIFI_PRIVATEDB)
$groupId  : string|null
Searches for contracts who are attached to the given group
$groupType  : int|null
Searches for contracts that are attached to a specific group type.
$limit  : int|null
The maximum number of items to return
$name  : string|null
Searches for contracts containing the given text in their name
$offset  : int|null
The number of items to skip
$orderIds  : string|null
Searches for contracts with the listed orderIds. The elements of the list are separated by comma.
$pageId  : string|null
Token representing the page to retrieve
$pricingModel  : int|null
Searches for contracts with a given pricing model
$subscriptionPlan  : int|null
Searches for contracts with the given subscription plan:
$tokenDuration  : int|null
Searches for contracts with the given token duration in months.
$toTime  : int|null
Searches for contracts with start time inferior to given time (in milliseconds since Unix Epoch).
$up  : bool|null
Searches for contracts that are attached to the given group and its ancestors
from()  : static
Initializing a model from an array
jsonSerialize()  : array<string|int, mixed>
setAuthorizations()  : static
Setter for authorizations
setContractIds()  : static
Setter for contractIds
setDeep()  : static
Setter for deep
setFields()  : static
Setter for fields
setFromTime()  : static
Setter for fromTime
setGeolocationMode()  : static
Setter for geolocationMode
setGroupId()  : static
Setter for groupId
setGroupType()  : static
Setter for groupType
setLimit()  : static
Setter for limit
setName()  : static
Setter for name
setOffset()  : static
Setter for offset
setOrderIds()  : static
Setter for orderIds
setPageId()  : static
Setter for pageId
setPricingModel()  : static
Setter for pricingModel
setSubscriptionPlan()  : static
Setter for subscriptionPlan
setTokenDuration()  : static
Setter for tokenDuration
setToTime()  : static
Setter for toTime
setUp()  : static
Setter for up

Constants

PRICING_MODEL_PRICING_MODEL_V1

Pricing model v1

public mixed PRICING_MODEL_PRICING_MODEL_V1 = 1

PRICING_MODEL_PRICING_MODEL_V2

Pricing model v2

public mixed PRICING_MODEL_PRICING_MODEL_V2 = 2

PRICING_MODEL_PRICING_MODEL_V3

Pricing model v3

public mixed PRICING_MODEL_PRICING_MODEL_V3 = 3

SUBSCRIPTION_PLAN_ACTIVATE

Activate

public mixed SUBSCRIPTION_PLAN_ACTIVATE = 6

SUBSCRIPTION_PLAN_COMMITTED_VOLUME_PLAN

Committed Volume Plan (CVP)

public mixed SUBSCRIPTION_PLAN_COMMITTED_VOLUME_PLAN = 2

SUBSCRIPTION_PLAN_FLEXIBLE_COMMITTED_VOLUME_PLAN

Flexible Committed Volume Plan (CVP Flex)

public mixed SUBSCRIPTION_PLAN_FLEXIBLE_COMMITTED_VOLUME_PLAN = 3

SUBSCRIPTION_PLAN_FREE_ORDER

Free order

public mixed SUBSCRIPTION_PLAN_FREE_ORDER = 0

SUBSCRIPTION_PLAN_PAY_AS_YOU_GROW

Pay As You Grow (PAYG)

public mixed SUBSCRIPTION_PLAN_PAY_AS_YOU_GROW = 1

Properties

$authorizations

if true, we return the list of actions and resources the user has access

protected bool|null $authorizations = null

$contractIds

Searches for contracts IDs that have the listed external (BSS) contractId. The elements of the list are separated by comma.

protected string|null $contractIds = null

$deep

Searches for contracts that are attached to the given group and its descendants

protected bool|null $deep = null

$fields

Defines the other available fields to be returned in the response.

protected string|null $fields = null

$fromTime

Searches for contracts with communication end time superior or equal to given time (in milliseconds since Unix Epoch).

protected int|null $fromTime = null

$geolocationMode

Searches for contracts with the given geolocation mode (level) 1 (ATLAS) 2 (ATLAS_WIFI) 3 (N/A) 4 (ATLAS_POV) 5 (ATLAS_BUBBLE) 6 (ATLAS_WIFI_PRIVATEDB)

protected int|null $geolocationMode = null

$groupId

Searches for contracts who are attached to the given group

protected string|null $groupId = null

$limit

The maximum number of items to return

protected int|null $limit = null

$name

Searches for contracts containing the given text in their name

protected string|null $name = null

$orderIds

Searches for contracts with the listed orderIds. The elements of the list are separated by comma.

protected string|null $orderIds = null

$pageId

Token representing the page to retrieve

protected string|null $pageId = null

$subscriptionPlan

Searches for contracts with the given subscription plan:

protected int|null $subscriptionPlan = null

$tokenDuration

Searches for contracts with the given token duration in months.

protected int|null $tokenDuration = null

$toTime

Searches for contracts with start time inferior to given time (in milliseconds since Unix Epoch).

protected int|null $toTime = null

$up

Searches for contracts that are attached to the given group and its ancestors

protected bool|null $up = null

Methods

from()

Initializing a model from an array

public static from(array<string|int, mixed> $params) : static
Parameters
$params : array<string|int, mixed>

Pass this parameter if you want to initial property value from an array. See API reference for all property names and types

Tags
throws
DeserializeException

If provided an invalid type to a property

Return values
static

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed>

setAuthorizations()

Setter for authorizations

public setAuthorizations(bool $authorizations) : static
Parameters
$authorizations : bool

if true, we return the list of actions and resources the user has access

Return values
static

To use in method chains

setContractIds()

Setter for contractIds

public setContractIds(string $contractIds) : static
Parameters
$contractIds : string

Searches for contracts IDs that have the listed external (BSS) contractId. The elements of the list are separated by comma.

Return values
static

To use in method chains

setDeep()

Setter for deep

public setDeep(bool $deep) : static
Parameters
$deep : bool

Searches for contracts that are attached to the given group and its descendants

Return values
static

To use in method chains

setFields()

Setter for fields

public setFields(string $fields) : static
Parameters
$fields : string

Defines the other available fields to be returned in the response.

Return values
static

To use in method chains

setFromTime()

Setter for fromTime

public setFromTime(int $fromTime) : static
Parameters
$fromTime : int

Searches for contracts with communication end time superior or equal to given time (in milliseconds since Unix Epoch).

Return values
static

To use in method chains

setGeolocationMode()

Setter for geolocationMode

public setGeolocationMode(int $geolocationMode) : static
Parameters
$geolocationMode : int

Searches for contracts with the given geolocation mode (level) 1 (ATLAS) 2 (ATLAS_WIFI) 3 (N/A) 4 (ATLAS_POV) 5 (ATLAS_BUBBLE) 6 (ATLAS_WIFI_PRIVATEDB)

Return values
static

To use in method chains

setGroupId()

Setter for groupId

public setGroupId(string $groupId) : static
Parameters
$groupId : string

Searches for contracts who are attached to the given group

Return values
static

To use in method chains

setLimit()

Setter for limit

public setLimit(int $limit) : static
Parameters
$limit : int

The maximum number of items to return

Return values
static

To use in method chains

setName()

Setter for name

public setName(string $name) : static
Parameters
$name : string

Searches for contracts containing the given text in their name

Return values
static

To use in method chains

setOffset()

Setter for offset

public setOffset(int $offset) : static
Parameters
$offset : int

The number of items to skip

Return values
static

To use in method chains

setOrderIds()

Setter for orderIds

public setOrderIds(string $orderIds) : static
Parameters
$orderIds : string

Searches for contracts with the listed orderIds. The elements of the list are separated by comma.

Return values
static

To use in method chains

setPageId()

Setter for pageId

public setPageId(string $pageId) : static
Parameters
$pageId : string

Token representing the page to retrieve

Return values
static

To use in method chains

setSubscriptionPlan()

Setter for subscriptionPlan

public setSubscriptionPlan(int $subscriptionPlan) : static
Parameters
$subscriptionPlan : int

Searches for contracts with the given subscription plan:

Return values
static

To use in method chains

setTokenDuration()

Setter for tokenDuration

public setTokenDuration(int $tokenDuration) : static
Parameters
$tokenDuration : int

Searches for contracts with the given token duration in months.

Return values
static

To use in method chains

setToTime()

Setter for toTime

public setToTime(int $toTime) : static
Parameters
$toTime : int

Searches for contracts with start time inferior to given time (in milliseconds since Unix Epoch).

Return values
static

To use in method chains

setUp()

Setter for up

public setUp(bool $up) : static
Parameters
$up : bool

Searches for contracts that are attached to the given group and its ancestors

Return values
static

To use in method chains

Search results