Giter Club home page Giter Club logo

services_capsule's Introduction

Introduction

This is the PHP API Wrapper that allows developers to access the Capsule CRM api using PHP

Examples

Get a party by party id:

require_once 'Services/Capsule.php';

try {
    $capsule = new Services_Capsule('appName', 'token');
    $party   = $capsule->party->get('partyId');
} catch (Services_Capsule_Exception $e) {
    print_r($e);
}

print_r($party);

Get all party:

require_once 'Services/Capsule.php';

try {
    $capsule = new Services_Capsule('appName', 'token');
    $parties = $capsule->party->getList();
} catch (Services_Capsule_Exception $e) {
    print_r($e);
}

print_r($parties);

Get a list of people in a party:

require_once 'Services/Capsule.php';

try {
    $capsule = new Services_Capsule('appName', 'token');
    $people  = $capsule->party->people->getAll('partyId');
} catch (Services_Capsule_Exception $e) {
    print_r($e);
}

print_r($people);

Add a new history note to a party:

require_once 'Services/Capsule.php';

try {
    $capsule = new Services_Capsule('appName', 'token');
    $note  = $capsule->party->history->addNote(
        'partyId', 'This is a test note.'
    );
} catch (Services_Capsule_Exception $e) {
    print_r($e);
}

var_dump($note); // This will be true if success

Get a list of opportunity:

require_once 'Services/Capsule.php';

try {
    $capsule = new Services_Capsule('appName', 'token');
    $opps  = $capsule->opportunity->getList();
} catch (Services_Capsule_Exception $e) {
    print_r($e);
}

print_r($opps);

services_capsule's People

Contributors

akimapilot avatar beckskis avatar j3ffn0lan avatar patrickwire avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

services_capsule's Issues

API v2?

Is anyone looking at adapting this library to the v2 API? v1 expires in Jan.

I used this library for a lot of hacking with v1 and applied various local edits and fixes, but have never figured out how to collaborate on Github.

If no-one else steps forward, I think I am likely to have to hack together some adaptations to make it work with v2, keeping the current general approach and structure. I'd be happy to give the changes back to the community but I would probably need some pointers on how best to do that.

Search doesn't search by email address

In the Party module the search function fails a search by email address as Capsule's API requires a query of 'email=' for email searches not 'q='. My solution is below

$request = http_build_query($request);
if (strpos($term, '@') !== FALSE) {
$request = str_replace('q=', 'email=', $request);
}
$response = $this->sendRequest('?' . $request);

Example of Adding Custom Field

/**
* Add a new Custom field to a party
*
* This method is used to create a new custom field for a party.
*
* @link /api/party/{party-id}/customfield
* @throws Services_Capsule_RuntimeException
*
* @param double $partyId The party id to create the new field on.
* @param array $fields An assoc array of fields to add in the new
* customField
*
* @return mixed bool|stdClass A stdClass object containing the information from
* the json-decoded response from the server.
*/
According to documentation I have passed parameters such as:
$customfield_variable = array('tag'=>'Lead','label'=>'Email_Flag','text' => '77777','boolean'=>'true');
$capsule->customfield->add($partyId,$customfield_variable);
Output while debussing
echo '

';print_r($customField);echo '
';
Array
(
[customField] => Array
(
[tag] => Lead
[label] => Email_Flag
[text] => 77777
[boolean] => true
)

)
But not created that custom field in Lead Tag of that Person.

How to Update Custom Field

Hello Friends,
I have created one custom field such as Email_Status which applies to only people in Capsule Api with default value="INVALID"
I am trying to update that custom field value by replacing db value such as valid.

Below is my code:
We have Services_Capsule_party_Customfield class having method update();

I have called that method by passing respective parameters such as:
$arr[status] ='VALID';
$partyId='554545';
$capsule = new Services_Capsule($config['appName'], $config['token']);
$partyId = $row[contact_id];//Part Id...
$fieldId = 'Email_Status'; //Field Id
$fields = array('Email_Status' => $arr[status]);//Fields
$capsule->customfield->update($partyId,$fieldId,$fields);
//In Actual Call When I debug that api fn
public function update($partyId, $fieldId, $fields)
{
echo '
';
echo 'partyId='.$partyId;
echo 'fieldId='.$fieldId;
echo '

fields=';print_r($fields);
echo 'url='.$url = '/' . (double)$partyId . '/customfield/ ' . (double)$fieldId;
echo '
';
echo '================';
$customField = array('customField' => $fields);
$response = $this->sendRequest(
$url, HTTP_Request2::METHOD_PUT, json_encode($customField)
);
return $this->parseResponse($response);
}
such as :
partyId=71095317
fieldId=Email_Status
fields=Array
(
[Email_Status] => VALID
)
url=/71095317/customfield/ 0

But not able to update that custom field Email Status Text value of that party.

I am not where i am going wrong in passing parameters or else other issue.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.