Documentation

NetSuiteService extends NetSuiteClient
in package

Table of Contents

$generated_from_endpoint  : mixed
$client  : SoapClient
$clientOptions  : array<string|int, mixed>
$config  : array<string|int, mixed>
$logger  : Logger
$soapHeaders  : array<string|int, mixed>
__construct()  : mixed
add()  : AddResponse
Service Call: add Parameter options: (AddRequest) parameters
addHeader()  : mixed
Add a header by name.
addList()  : AddListResponse
Service Call: addList Parameter options: (AddListRequest) parameters
asyncAddList()  : AsyncStatusResponse
Service Call: asyncAddList Parameter options: (AsyncAddListRequest) parameters
asyncDeleteList()  : AsyncStatusResponse
Service Call: asyncDeleteList Parameter options: (AsyncDeleteListRequest) parameters
asyncGetList()  : AsyncStatusResponse
Service Call: asyncGetList Parameter options: (AsyncGetListRequest) parameters
asyncInitializeList()  : AsyncStatusResponse
Service Call: asyncInitializeList Parameter options: (AsyncInitializeListRequest) parameters
asyncSearch()  : AsyncStatusResponse
Service Call: asyncSearch Parameter options: (AsyncSearchRequest) parameters
asyncUpdateList()  : AsyncStatusResponse
Service Call: asyncUpdateList Parameter options: (AsyncUpdateListRequest) parameters
asyncUpsertList()  : AsyncStatusResponse
Service Call: asyncUpsertList Parameter options: (AsyncUpsertListRequest) parameters
attach()  : AttachResponse
Service Call: attach Parameter options: (AttachRequest) parameters
changeEmail()  : ChangeEmailResponse
Service Call: changeEmail Parameter options: (ChangeEmailRequest) parameters
changePassword()  : ChangePasswordResponse
Service Call: changePassword Parameter options: (ChangePasswordRequest) parameters
checkAsyncStatus()  : AsyncStatusResponse
Service Call: checkAsyncStatus Parameter options: (CheckAsyncStatusRequest) parameters
clearHeader()  : mixed
Remove a header by name.
clearPreferences()  : mixed
Clear preferences header.
clearSearchPreferences()  : mixed
Clear the search preferences.
createFromEnv()  : NetSuiteClient
Alternate way to instantiate the NetSuiteClient. This method is superfluous now that the constructor will intelligently look for ENV configuration when it isn't given explicit configuration. This static method is retained for compatibility with those users who might currently be using this method.
delete()  : DeleteResponse
Service Call: delete Parameter options: (DeleteRequest) parameters
deleteList()  : DeleteListResponse
Service Call: deleteList Parameter options: (DeleteListRequest) parameters
detach()  : DetachResponse
Service Call: detach Parameter options: (DetachRequest) parameters
get()  : GetResponse
Service Call: get Parameter options: (GetRequest) parameters
getAccountGovernanceInfo()  : GetAccountGovernanceInfoResponse
Service Call: getAccountGovernanceInfo Parameter options: (GetAccountGovernanceInfoRequest) parameters
getAll()  : GetAllResponse
Service Call: getAll Parameter options: (GetAllRequest) parameters
getAsyncResult()  : GetAsyncResultResponse
Service Call: getAsyncResult Parameter options: (GetAsyncResultRequest) parameters
getBudgetExchangeRate()  : GetBudgetExchangeRateResponse
Service Call: getBudgetExchangeRate Parameter options: (GetBudgetExchangeRateRequest) parameters
getClient()  : SoapClient
Get the current soap client.
getCurrencyRate()  : GetCurrencyRateResponse
Service Call: getCurrencyRate Parameter options: (GetCurrencyRateRequest) parameters
getCustomizationId()  : GetCustomizationIdResponse
Service Call: getCustomizationId Parameter options: (GetCustomizationIdRequest) parameters
getDataCenterUrls()  : GetDataCenterUrlsResponse
Service Call: getDataCenterUrls Parameter options: (GetDataCenterUrlsRequest) parameters
getDeleted()  : GetDeletedResponse
Service Call: getDeleted Parameter options: (GetDeletedRequest) parameters
getEnvConfig()  : array<string|int, mixed>
Create a configuration array by inspecting the $_ENV superglobal.
getIntegrationGovernanceInfo()  : GetIntegrationGovernanceInfoResponse
Service Call: getIntegrationGovernanceInfo Parameter options: (GetIntegrationGovernanceInfoRequest) parameters
getItemAvailability()  : GetItemAvailabilityResponse
Service Call: getItemAvailability Parameter options: (GetItemAvailabilityRequest) parameters
getList()  : GetListResponse
Service Call: getList Parameter options: (GetListRequest) parameters
getPostingTransactionSummary()  : GetPostingTransactionSummaryResponse
Service Call: getPostingTransactionSummary Parameter options: (GetPostingTransactionSummaryRequest) parameters
getSavedSearch()  : GetSavedSearchResponse
Service Call: getSavedSearch Parameter options: (GetSavedSearchRequest) parameters
getSelectValue()  : getSelectValueResponse
Service Call: getSelectValue Parameter options: (getSelectValueRequest) parameters
getServerTime()  : GetServerTimeResponse
Service Call: getServerTime Parameter options: (GetServerTimeRequest) parameters
initialize()  : InitializeResponse
Service Call: initialize Parameter options: (InitializeRequest) parameters
initializeList()  : InitializeListResponse
Service Call: initializeList Parameter options: (InitializeListRequest) parameters
logRequests()  : mixed
Turn request logging on or off.
search()  : SearchResponse
Service Call: search Parameter options: (SearchRequest) parameters
searchMoreWithId()  : SearchMoreWithIdResponse
Service Call: searchMoreWithId Parameter options: (SearchMoreWithIdRequest) parameters
setApplicationInfo()  : mixed
Set the application id.
setDataCenterUrl()  : void
Set the data center URL for the configured NetSuite account
setLogPath()  : mixed
Set the logging path.
setPreferences()  : mixed
Set preferences header.
setSearchPreferences()  : mixed
Set the search preferences header.
update()  : UpdateResponse
Service Call: update Parameter options: (UpdateRequest) parameters
updateInviteeStatus()  : UpdateInviteeStatusResponse
Service Call: updateInviteeStatus Parameter options: (UpdateInviteeStatusRequest) parameters
updateInviteeStatusList()  : UpdateInviteeStatusListResponse
Service Call: updateInviteeStatusList Parameter options: (UpdateInviteeStatusListRequest) parameters
updateList()  : UpdateListResponse
Service Call: updateList Parameter options: (UpdateListRequest) parameters
upsert()  : UpsertResponse
Service Call: upsert Parameter options: (UpsertRequest) parameters
upsertList()  : UpsertListResponse
Service Call: upsertList Parameter options: (UpsertListRequest) parameters
validateConfig()  : void
Make sure that this client object has at least the basic required configuration values defined or else throw a runtime exception.
makeSoapCall()  : mixed
Make the SOAP call!
computeTokenPassportSignature()  : string
Compute TokenPassport signature
createOptions()  : array<string|int, mixed>
Create the options array.
createPassportFromConfig()  : Passport
Create the Passport.
createTokenPassportFromConfig()  : TokenPassport
Create the TokenPassport.
createWsdl()  : string
Build the WSDL address from the config.
fixWtfCookieBug()  : mixed
SoapClient apparently always sends the JSESSIONID cookie.
generateTokenPassportNonce()  : mixed
Generate random (or sufficiently enough so) string of characters
logSoapCall()  : mixed
Log the last SOAP call.

Properties

$generated_from_endpoint

public mixed $generated_from_endpoint = '2020_2'

$clientOptions

private array<string|int, mixed> $clientOptions = []

Methods

__construct()

public __construct([array<string|int, mixed> $config = null ][, array<string|int, mixed> $options = [] ][, SoapClient $client = null ]) : mixed
Parameters
$config : array<string|int, mixed> = null
$options : array<string|int, mixed> = []
$client : SoapClient = null
Return values
mixed —

addHeader()

Add a header by name.

public addHeader(string $header, mixed $value) : mixed
Parameters
$header : string
$value : mixed
Return values
mixed —

clearHeader()

Remove a header by name.

public clearHeader(string $header) : mixed
Parameters
$header : string
Return values
mixed —

clearPreferences()

Clear preferences header.

public clearPreferences() : mixed
Return values
mixed —

clearSearchPreferences()

Clear the search preferences.

public clearSearchPreferences() : mixed
Return values
mixed —

createFromEnv()

Alternate way to instantiate the NetSuiteClient. This method is superfluous now that the constructor will intelligently look for ENV configuration when it isn't given explicit configuration. This static method is retained for compatibility with those users who might currently be using this method.

public static createFromEnv([array<string|int, mixed> $options = [] ][, SoapClient $client = null ]) : NetSuiteClient

This method will be removed in some future version.

Parameters
$options : array<string|int, mixed> = []
$client : SoapClient = null
Tags
deprecated
Return values
NetSuiteClient —

getClient()

Get the current soap client.

public getClient() : SoapClient
Tags
throws
SoapFault
Return values
SoapClient —

getEnvConfig()

Create a configuration array by inspecting the $_ENV superglobal.

public static getEnvConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —

logRequests()

Turn request logging on or off.

public logRequests([bool $on = true ]) : mixed
Parameters
$on : bool = true
Return values
mixed —

setApplicationInfo()

Set the application id.

public setApplicationInfo([string $appId = null ]) : mixed
Parameters
$appId : string = null
Return values
mixed —

setDataCenterUrl()

Set the data center URL for the configured NetSuite account

public setDataCenterUrl(array<string|int, mixed> $config) : void
Parameters
$config : array<string|int, mixed>
Return values
void —

setLogPath()

Set the logging path.

public setLogPath(string $logPath) : mixed
Parameters
$logPath : string
Return values
mixed —

setPreferences()

Set preferences header.

public setPreferences([bool $warningAsError = false ][, bool $disableMandatoryCustomFieldValidation = false ][, bool $disableSystemNotesForCustomFields = false ][, bool $ignoreReadOnlyFields = false ]) : mixed
Parameters
$warningAsError : bool = false
$disableMandatoryCustomFieldValidation : bool = false
$disableSystemNotesForCustomFields : bool = false
$ignoreReadOnlyFields : bool = false
Return values
mixed —

setSearchPreferences()

Set the search preferences header.

public setSearchPreferences([bool $bodyFieldsOnly = true ][, int $pageSize = 50 ][, bool $returnSearchColumns = true ]) : mixed
Parameters
$bodyFieldsOnly : bool = true
$pageSize : int = 50
$returnSearchColumns : bool = true
Return values
mixed —

validateConfig()

Make sure that this client object has at least the basic required configuration values defined or else throw a runtime exception.

public validateConfig(array<string|int, mixed> $config) : void
Parameters
$config : array<string|int, mixed>
Return values
void —

makeSoapCall()

Make the SOAP call!

protected makeSoapCall(string $operation, mixed $parameter) : mixed
Parameters
$operation : string
$parameter : mixed
Return values
mixed —

computeTokenPassportSignature()

Compute TokenPassport signature

private computeTokenPassportSignature(int|string $account, string $consumerKey, mixed $consumerSecret, string $token, string $tokenSecret, string $nonce, int|string $timestamp, string $signatureAlgorithm) : string
Parameters
$account : int|string
$consumerKey : string
$consumerSecret : mixed
$token : string
$tokenSecret : string
$nonce : string
$timestamp : int|string
$signatureAlgorithm : string
Return values
string —

createOptions()

Create the options array.

private createOptions(array<string|int, mixed> $config[, array<string|int, mixed> $overrides = [] ]) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed>
$overrides : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

createPassportFromConfig()

Create the Passport.

private createPassportFromConfig(array<string|int, mixed> $config) : Passport
Parameters
$config : array<string|int, mixed>
Return values
Passport —

createTokenPassportFromConfig()

Create the TokenPassport.

private createTokenPassportFromConfig(array<string|int, mixed> $config) : TokenPassport
Parameters
$config : array<string|int, mixed>
Return values
TokenPassport —

createWsdl()

Build the WSDL address from the config.

private createWsdl(array<string|int, mixed> $config) : string
Parameters
$config : array<string|int, mixed>
Return values
string —

fixWtfCookieBug()

SoapClient apparently always sends the JSESSIONID cookie.

private fixWtfCookieBug() : mixed

So we'll just un-set it to prevent this.

Return values
mixed —

generateTokenPassportNonce()

Generate random (or sufficiently enough so) string of characters

private generateTokenPassportNonce([mixed $length = 32 ]) : mixed
Parameters
$length : mixed = 32
Return values
mixed —

logSoapCall()

Log the last SOAP call.

private logSoapCall(string $operation) : mixed
Parameters
$operation : string
Return values
mixed —

Search results