PHP Sigfox Client

ContractInfoCreate extends CommonContractInfo

Defines a contract's common properties for creation

Table of Contents

PRICING_MODEL_PRICING_MODEL_V1  = 1
Pricing model verion 1
PRICING_MODEL_PRICING_MODEL_V2  = 2
Pricing model verion 2
PRICING_MODEL_PRICING_MODEL_V3  = 3
Pricing model verion 3
SUBSCRIPTION_PLAN_ACTIVATE  = 5
Activate
SUBSCRIPTION_PLAN_CVP  = 2
Committed Volume Plan (CVP)
SUBSCRIPTION_PLAN_CVP_FLEX  = 3
Flexible Committed Volume Plan (CVP Flex)
SUBSCRIPTION_PLAN_DEVKIT  = 5
DevKit
SUBSCRIPTION_PLAN_FREE_ORDER  = 0
Free order
SUBSCRIPTION_PLAN_PACK  = 4
PACK
SUBSCRIPTION_PLAN_PAYG  = 1
Pay As You Grow (PAYG)
$activationEndTime  : int|null
The activation end time (in milliseconds) of the contract. 0 means no activation time limit.
$automaticRenewal  : bool|null
True if automatic renewal is allowed.
$bidir  : bool|null
True if the contract info is bidirectional.
$blacklistedTerritories  : array<string|int, mixed>|null
The list of "blacklisted" territories, as an array of NIP group IDs.
$communicationEndTime  : int|null
The end time (in milliseconds) of the communication. 0 means no communication time limit.
$contractId  : string|null
The contract external ID. It's used to identify the contract in EDRs.
$groupId  : string|null
ID of group associated with the contact
$highPriorityDownlink  : bool|null
True if all downlinks are high priority.
$maxDownlinkFrames  : int|null
The maximum number of downlink frames.
$maxTokens  : int|null
The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.
$maxUplinkFrames  : int|null
The maximum number of uplink frames.
$name  : string|null
The contract name
$options  : array<string|int, mixed>|null
The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.
$orderId  : string|null
The order ID (hex), if any.
$orderName  : string|null
The order name, if any
$pricingModel  : int|null
The pricing model used by this contract info.
$renewalDuration  : int|null
The renewal duration in months.
$startTime  : int|null
The start time (in milliseconds) of the contract
$subscriptionPlan  : int|null
The contract info subscription plan.
$timezone  : string|null
The contract timezone name as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica").
$tokenDuration  : int|null
The token duration in months. Must be >= 0, if 0 unlimited token duration.
$userId  : string|null
The ID of the user who created the contract in BSS.
from()  : static
Initializing a model from an array
getActivationEndTime()  : int
Getter for activationEndTime
getAutomaticRenewal()  : bool
Getter for automaticRenewal
getBidir()  : bool
Getter for bidir
getBlacklistedTerritories()  : array<string|int, string>
Getter for blacklistedTerritories
getCommunicationEndTime()  : int
Getter for communicationEndTime
getContractId()  : string
Getter for contractId
getGroupId()  : string
Getter for groupId
getHighPriorityDownlink()  : bool
Getter for highPriorityDownlink
getMaxDownlinkFrames()  : int
Getter for maxDownlinkFrames
getMaxTokens()  : int
Getter for maxTokens
getMaxUplinkFrames()  : int
Getter for maxUplinkFrames
getName()  : string
Getter for name
getOptions()  : array<string|int, OptionsItem>
Getter for options
getOrderId()  : string
Getter for orderId
getOrderName()  : string
Getter for orderName
getPricingModel()  : int
Getter for pricingModel
getRenewalDuration()  : int
Getter for renewalDuration
getStartTime()  : int
Getter for startTime
getSubscriptionPlan()  : int
Getter for subscriptionPlan
getTimezone()  : string
Getter for timezone
getTokenDuration()  : int
Getter for tokenDuration
getUserId()  : string
Getter for userId
jsonSerialize()  : array<string|int, mixed>
setActivationEndTime()  : static
Setter for activationEndTime
setAutomaticRenewal()  : static
Setter for automaticRenewal
setBidir()  : static
Setter for bidir
setBlacklistedTerritories()  : static
Setter for blacklistedTerritories
setCommunicationEndTime()  : static
Setter for communicationEndTime
setContractId()  : static
Setter for contractId
setGroupId()  : static
Setter for groupId
setHighPriorityDownlink()  : static
Setter for highPriorityDownlink
setMaxDownlinkFrames()  : static
Setter for maxDownlinkFrames
setMaxTokens()  : static
Setter for maxTokens
setMaxUplinkFrames()  : static
Setter for maxUplinkFrames
setName()  : static
Setter for name
setOptions()  : static
Setter for options
setOrderId()  : static
Setter for orderId
setOrderName()  : static
Setter for orderName
setPricingModel()  : static
Setter for pricingModel
setRenewalDuration()  : static
Setter for renewalDuration
setStartTime()  : static
Setter for startTime
setSubscriptionPlan()  : static
Setter for subscriptionPlan
setTimezone()  : static
Setter for timezone
setTokenDuration()  : static
Setter for tokenDuration
setUserId()  : static
Setter for userId

Constants

PRICING_MODEL_PRICING_MODEL_V1

Pricing model verion 1

public mixed PRICING_MODEL_PRICING_MODEL_V1 = 1

PRICING_MODEL_PRICING_MODEL_V2

Pricing model verion 2

public mixed PRICING_MODEL_PRICING_MODEL_V2 = 2

PRICING_MODEL_PRICING_MODEL_V3

Pricing model verion 3

public mixed PRICING_MODEL_PRICING_MODEL_V3 = 3

SUBSCRIPTION_PLAN_CVP

Committed Volume Plan (CVP)

public mixed SUBSCRIPTION_PLAN_CVP = 2

SUBSCRIPTION_PLAN_CVP_FLEX

Flexible Committed Volume Plan (CVP Flex)

public mixed SUBSCRIPTION_PLAN_CVP_FLEX = 3

SUBSCRIPTION_PLAN_FREE_ORDER

Free order

public mixed SUBSCRIPTION_PLAN_FREE_ORDER = 0

SUBSCRIPTION_PLAN_PAYG

Pay As You Grow (PAYG)

public mixed SUBSCRIPTION_PLAN_PAYG = 1

Properties

$activationEndTime

The activation end time (in milliseconds) of the contract. 0 means no activation time limit.

protected int|null $activationEndTime = null

$automaticRenewal

True if automatic renewal is allowed.

protected bool|null $automaticRenewal = null

$bidir

True if the contract info is bidirectional.

protected bool|null $bidir = null

$blacklistedTerritories

The list of "blacklisted" territories, as an array of NIP group IDs.

protected array<string|int, mixed>|null $blacklistedTerritories = null

$communicationEndTime

The end time (in milliseconds) of the communication. 0 means no communication time limit.

protected int|null $communicationEndTime = null

$contractId

The contract external ID. It's used to identify the contract in EDRs.

protected string|null $contractId = null

$groupId

ID of group associated with the contact

protected string|null $groupId = null

$highPriorityDownlink

True if all downlinks are high priority.

protected bool|null $highPriorityDownlink = null

$maxDownlinkFrames

The maximum number of downlink frames.

protected int|null $maxDownlinkFrames = null

$maxTokens

The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.

protected int|null $maxTokens = null

$maxUplinkFrames

The maximum number of uplink frames.

protected int|null $maxUplinkFrames = null

$options

The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.

protected array<string|int, mixed>|null $options = null

$renewalDuration

The renewal duration in months.

protected int|null $renewalDuration = null

$startTime

The start time (in milliseconds) of the contract

protected int|null $startTime = null

$timezone

The contract timezone name as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica").

protected string|null $timezone = null

$tokenDuration

The token duration in months. Must be >= 0, if 0 unlimited token duration.

protected int|null $tokenDuration = null

$userId

The ID of the user who created the contract in BSS.

protected string|null $userId = 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 —

getActivationEndTime()

Getter for activationEndTime

public getActivationEndTime() : int
Return values
int —

The activation end time (in milliseconds) of the contract. 0 means no activation time limit.

getAutomaticRenewal()

Getter for automaticRenewal

public getAutomaticRenewal() : bool
Return values
bool —

True if automatic renewal is allowed.

getBidir()

Getter for bidir

public getBidir() : bool
Return values
bool —

True if the contract info is bidirectional.

getBlacklistedTerritories()

Getter for blacklistedTerritories

public getBlacklistedTerritories() : array<string|int, string>
Return values
array<string|int, string> —

The list of "blacklisted" territories, as an array of NIP group IDs.

getCommunicationEndTime()

Getter for communicationEndTime

public getCommunicationEndTime() : int
Return values
int —

The end time (in milliseconds) of the communication. 0 means no communication time limit.

getContractId()

Getter for contractId

public getContractId() : string
Return values
string —

The contract external ID. It's used to identify the contract in EDRs.

getGroupId()

Getter for groupId

public getGroupId() : string
Return values
string —

ID of group associated with the contact

getHighPriorityDownlink()

Getter for highPriorityDownlink

public getHighPriorityDownlink() : bool
Return values
bool —

True if all downlinks are high priority.

getMaxDownlinkFrames()

Getter for maxDownlinkFrames

public getMaxDownlinkFrames() : int
Return values
int —

The maximum number of downlink frames.

getMaxTokens()

Getter for maxTokens

public getMaxTokens() : int
Return values
int —

The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.

getMaxUplinkFrames()

Getter for maxUplinkFrames

public getMaxUplinkFrames() : int
Return values
int —

The maximum number of uplink frames.

getName()

Getter for name

public getName() : string
Return values
string —

The contract name

getOptions()

Getter for options

public getOptions() : array<string|int, OptionsItem>
Return values
array<string|int, OptionsItem> —

The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.

getOrderId()

Getter for orderId

public getOrderId() : string
Return values
string —

The order ID (hex), if any.

getOrderName()

Getter for orderName

public getOrderName() : string
Return values
string —

The order name, if any

getRenewalDuration()

Getter for renewalDuration

public getRenewalDuration() : int
Return values
int —

The renewal duration in months.

getStartTime()

Getter for startTime

public getStartTime() : int
Return values
int —

The start time (in milliseconds) of the contract

getTimezone()

Getter for timezone

public getTimezone() : string
Return values
string —

The contract timezone name as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica").

getTokenDuration()

Getter for tokenDuration

public getTokenDuration() : int
Return values
int —

The token duration in months. Must be >= 0, if 0 unlimited token duration.

getUserId()

Getter for userId

public getUserId() : string
Return values
string —

The ID of the user who created the contract in BSS.

jsonSerialize()

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

setActivationEndTime()

Setter for activationEndTime

public setActivationEndTime(int $activationEndTime) : static
Parameters
$activationEndTime : int

The activation end time (in milliseconds) of the contract. 0 means no activation time limit.

Return values
static —

To use in method chains

setAutomaticRenewal()

Setter for automaticRenewal

public setAutomaticRenewal(bool $automaticRenewal) : static
Parameters
$automaticRenewal : bool

True if automatic renewal is allowed.

Return values
static —

To use in method chains

setBidir()

Setter for bidir

public setBidir(bool $bidir) : static
Parameters
$bidir : bool

True if the contract info is bidirectional.

Return values
static —

To use in method chains

setBlacklistedTerritories()

Setter for blacklistedTerritories

public setBlacklistedTerritories(array<string|int, string> $blacklistedTerritories) : static
Parameters
$blacklistedTerritories : array<string|int, string>

The list of "blacklisted" territories, as an array of NIP group IDs.

Return values
static —

To use in method chains

setCommunicationEndTime()

Setter for communicationEndTime

public setCommunicationEndTime(int $communicationEndTime) : static
Parameters
$communicationEndTime : int

The end time (in milliseconds) of the communication. 0 means no communication time limit.

Return values
static —

To use in method chains

setContractId()

Setter for contractId

public setContractId(string $contractId) : static
Parameters
$contractId : string

The contract external ID. It's used to identify the contract in EDRs.

Return values
static —

To use in method chains

setGroupId()

Setter for groupId

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

ID of group associated with the contact

Return values
static —

To use in method chains

setHighPriorityDownlink()

Setter for highPriorityDownlink

public setHighPriorityDownlink(bool $highPriorityDownlink) : static
Parameters
$highPriorityDownlink : bool

True if all downlinks are high priority.

Return values
static —

To use in method chains

setMaxDownlinkFrames()

Setter for maxDownlinkFrames

public setMaxDownlinkFrames(int $maxDownlinkFrames) : static
Parameters
$maxDownlinkFrames : int

The maximum number of downlink frames.

Return values
static —

To use in method chains

setMaxTokens()

Setter for maxTokens

public setMaxTokens(int $maxTokens) : static
Parameters
$maxTokens : int

The maximum number of tokens for this contract. Either 0 (unlimited) or a positive number.

Return values
static —

To use in method chains

setMaxUplinkFrames()

Setter for maxUplinkFrames

public setMaxUplinkFrames(int $maxUplinkFrames) : static
Parameters
$maxUplinkFrames : int

The maximum number of uplink frames.

Return values
static —

To use in method chains

setName()

Setter for name

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

The contract name

Return values
static —

To use in method chains

setOptions()

Setter for options

public setOptions(array<string|int, OptionsItem> $options) : static
Parameters
$options : array<string|int, OptionsItem>

The activated premium options. Given options will be merged with existing options in contract. In order to delete a single option use "/{id}/options" API.

Return values
static —

To use in method chains

setOrderId()

Setter for orderId

public setOrderId(string $orderId) : static
Parameters
$orderId : string

The order ID (hex), if any.

Return values
static —

To use in method chains

setOrderName()

Setter for orderName

public setOrderName(string $orderName) : static
Parameters
$orderName : string

The order name, if any

Return values
static —

To use in method chains

setRenewalDuration()

Setter for renewalDuration

public setRenewalDuration(int $renewalDuration) : static
Parameters
$renewalDuration : int

The renewal duration in months.

Return values
static —

To use in method chains

setStartTime()

Setter for startTime

public setStartTime(int $startTime) : static
Parameters
$startTime : int

The start time (in milliseconds) of the contract

Return values
static —

To use in method chains

setSubscriptionPlan()

Setter for subscriptionPlan

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

The contract info subscription plan.

Return values
static —

To use in method chains

setTimezone()

Setter for timezone

public setTimezone(string $timezone) : static
Parameters
$timezone : string

The contract timezone name as a Java TimeZone ID ("full name" version only, like "America/Costa_Rica").

Return values
static —

To use in method chains

setTokenDuration()

Setter for tokenDuration

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

The token duration in months. Must be >= 0, if 0 unlimited token duration.

Return values
static —

To use in method chains

setUserId()

Setter for userId

public setUserId(string $userId) : static
Parameters
$userId : string

The ID of the user who created the contract in BSS.

Return values
static —

To use in method chains

Search results