Overview
  • Namespace
  • Class
  • Tree

Namespaces

  • OpenDNS
    • MES
      • Recurring
      • Reporting
      • Trident

Classes

  • Create
  • Delete
  • RecurringDetailRequest
  • Request
  • Update

Class Request

Abstract for CUD operations on Recurring billing Profiles.

OpenDNS\MES\Request
Extended by OpenDNS\MES\Recurring\Request

Direct known subclasses

OpenDNS\MES\Recurring\Delete, OpenDNS\MES\Recurring\RecurringDetailRequest

Indirect known subclasses

OpenDNS\MES\Recurring\Create, OpenDNS\MES\Recurring\Update

Abstract
Namespace: OpenDNS\MES\Recurring
Located at Recurring/Request.php

Methods summary

public OpenDNS\MES\Recurring\Request
# setAuthenticationInfo( integer $profileId, integer|string $userId, integer|string $password )

Sets authentication info.

Sets authentication info.

Parameters

$profileId
$userId
$password

Returns

OpenDNS\MES\Recurring\Request
public OpenDNS\MES\Recurring\Request
# setCustomerId( integer|string $customerId )

Sets a Unique ID for the customer.

Sets a Unique ID for the customer.

Parameters

$customerId

Returns

OpenDNS\MES\Recurring\Request

Methods inherited from OpenDNS\MES\Request

__construct(), execute(), factory(), getApiUrl(), getClient(), processResponse(), removeField(), setDefaults(), setField()

Magic methods summary

Constants summary

string FREQUENCY_MONTHLY
# 'MONTHLY'
string FREQUENCY_QUARTERLY
# 'QUARTERLY'
string FREQUENCY_ANNUALLY
# 'ANNUALLY'

Constants inherited from OpenDNS\MES\Request

ENV_CERT, ENV_PROD, ENV_TEST

Properties summary

protected string $apiBasePath

$apiBasePath

$apiBasePath

# '/srv/api'
protected string $httpMethod

HTTP Method to use for the request

HTTP Method to use for the request

# 'GET'

Properties inherited from OpenDNS\MES\Request

$apiBaseDomain, $apiEndpointPath, $apiEnvironment, $defaultFieldValues

API documentation generated by ApiGen