SternerStuff\InsightlyPHP\OpportunityProductsApi

All URIs are relative to https://api.insightly.com/v3.1

Method	HTTP request	Description
deleteImageField	DELETE /OpportunityLineItem/{id}/ImageField/{fieldName}	Deletes an Opportunity Product's Custom Image Field
getEntities	GET /OpportunityLineItem	Gets a list of Opportunity Products
getEntitiesBySearch	GET /OpportunityLineItem/Search	Gets a filtered list of Opportunity Products
getEntity	GET /OpportunityLineItem/{id}	Gets an Opportunity Product
getImageField	GET /OpportunityLineItem/{id}/ImageField/{fieldName}	Gets an Opportunity Product's Custom Image Field
updateImageField	PUT /OpportunityLineItem/{id}/ImageField/{fieldName}/{fileName}	Updates an Opportunity Product's Custom Image Field

deleteImageField

deleteImageField($id, $field_name, $authorization)

Deletes an Opportunity Product's Custom Image Field

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SternerStuff\InsightlyPHP\Api\OpportunityProductsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteImageField($id, $field_name, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling OpportunityProductsApi->deleteImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
field_name	string	An image field name
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntities

object[] getEntities($authorization, $brief, $skip, $top, $count_total)

Gets a list of Opportunity Products

Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SternerStuff\InsightlyPHP\Api\OpportunityProductsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional,true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getEntities($authorization, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunityProductsApi->getEntities: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
brief	bool	Optional, true if response should only contain top level properties of the record.	[optional] [default to false]
skip	int	Optional, number of records to skip.	[optional]
top	int	Optional, maximum number of records to return in the response.	[optional]
count_total	bool	Optional,true if total number of records should be returned in the response headers.	[optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntitiesBySearch

object[] getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total)

Gets a filtered list of Opportunity Products

To filter with a field name and value, both field_name and field_value parameters must be provided.
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SternerStuff\InsightlyPHP\Api\OpportunityProductsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_name = "field_name_example"; // string | Optional, field name for object
$field_value = "field_value_example"; // string | Optional, field value of the record
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when a record was last updated.
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunityProductsApi->getEntitiesBySearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
field_name	string	Optional, field name for object	[optional]
field_value	string	Optional, field value of the record	[optional]
updated_after_utc	\DateTime	Optional, earliest date when a record was last updated.	[optional]
brief	bool	Optional, true if response should only contain top level properties of the record.	[optional] [default to false]
skip	int	Optional, number of records to skip.	[optional]
top	int	Optional, maximum number of records to return in the response.	[optional]
count_total	bool	Optional, true if total number of records should be returned in the response headers.	[optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntity

object getEntity($id, $authorization)

Gets an Opportunity Product

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SternerStuff\InsightlyPHP\Api\OpportunityProductsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getEntity($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunityProductsApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getImageField

getImageField($id, $field_name, $authorization)

Gets an Opportunity Product's Custom Image Field

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SternerStuff\InsightlyPHP\Api\OpportunityProductsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->getImageField($id, $field_name, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling OpportunityProductsApi->getImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
field_name	string	An image field name
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateImageField

object[] updateImageField($id, $field_name, $file_name, $authorization, $file)

Updates an Opportunity Product's Custom Image Field

This action will replace any existing Image attached to the Opportunity Product's image field. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is done.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SternerStuff\InsightlyPHP\Api\OpportunityProductsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$file_name = "file_name_example"; // string | An image file name
$authorization = "{{Authorization}}"; // string | Authorization
$file = "B"; // string | File to upload

try {
    $result = $apiInstance->updateImageField($id, $field_name, $file_name, $authorization, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunityProductsApi->updateImageField: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
field_name	string	An image field name
file_name	string	An image file name
authorization	string	Authorization	[default to {{Authorization}}]
file	string	File to upload

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/octet-stream
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

OpportunityProductsApi.md

Latest commit

History

OpportunityProductsApi.md

File metadata and controls

SternerStuff\InsightlyPHP\OpportunityProductsApi

deleteImageField

Example

Parameters

Return type

Authorization

HTTP request headers

getEntities

Example

Parameters

Return type

Authorization

HTTP request headers

getEntitiesBySearch

Example

Parameters

Return type

Authorization

HTTP request headers

getEntity

Example

Parameters

Return type

Authorization

HTTP request headers

getImageField

Example

Parameters

Return type

Authorization

HTTP request headers

updateImageField

Example

Parameters

Return type

Authorization

HTTP request headers