-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from basecrm/adding-resources
New resources support
- Loading branch information
Showing
16 changed files
with
1,201 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| <?php | ||
| // WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema | ||
| namespace BaseCRM; | ||
|
|
||
| /** | ||
| * BaseCRM\DealSourcesService | ||
| * | ||
| * Class used to make actions related to DealSource resource. | ||
| * | ||
| * @package BaseCRM | ||
| */ | ||
| class DealSourcesService | ||
| { | ||
| // @var array Allowed attribute names. | ||
| protected static $keysToPersist = ['name', 'resource_type']; | ||
|
|
||
| protected $httpClient; | ||
|
|
||
| /** | ||
| * Instantiate a new DealSourcesService instance. | ||
| * | ||
| * @param BaseCRM\HttpClient $httpClient Http client. | ||
| */ | ||
| public function __construct(HttpClient $httpClient) | ||
| { | ||
| $this->httpClient = $httpClient; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve all sources | ||
| * | ||
| * get '/deal_sources' | ||
| * | ||
| * Returns all deal sources available to the user according to the parameters provided | ||
| * | ||
| * @param array $options Search options | ||
| * | ||
| * @return array The list of DealSources for the first page, unless otherwise specified. | ||
| */ | ||
| public function all($options = []) | ||
| { | ||
| list($code, $deal_sources) = $this->httpClient->get("/deal_sources", $options); | ||
| return $deal_sources; | ||
| } | ||
|
|
||
| /** | ||
| * Create a new source | ||
| * | ||
| * post '/deal_sources' | ||
| * | ||
| * Creates a new source | ||
| * <figure class="notice"> | ||
| * Source's name **must** be unique | ||
| * </figure> | ||
| * | ||
| * @param array $dealSource This array's attributes describe the object to be created. | ||
| * | ||
| * @return array The resulting object representing created resource. | ||
| */ | ||
| public function create(array $dealSource) | ||
| { | ||
| $attributes = array_intersect_key($dealSource, array_flip(self::$keysToPersist)); | ||
|
|
||
| list($code, $createdDealSource) = $this->httpClient->post("/deal_sources", $attributes); | ||
| return $createdDealSource; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve a single source | ||
| * | ||
| * get '/deal_sources/{id}' | ||
| * | ||
| * Returns a single source available to the user by the provided id | ||
| * If a source with the supplied unique identifier does not exist it returns an error | ||
| * | ||
| * @param integer $id Unique identifier of a DealSource | ||
| * | ||
| * @return array Searched DealSource. | ||
| */ | ||
| public function get($id) | ||
| { | ||
| list($code, $deal_source) = $this->httpClient->get("/deal_sources/{$id}"); | ||
| return $deal_source; | ||
| } | ||
|
|
||
| /** | ||
| * Update a source | ||
| * | ||
| * put '/deal_sources/{id}' | ||
| * | ||
| * Updates source information | ||
| * If the specified source does not exist, the request will return an error | ||
| * <figure class="notice"> | ||
| * If you want to update a source, you **must** make sure source's name is unique | ||
| * </figure> | ||
| * | ||
| * @param integer $id Unique identifier of a DealSource | ||
| * @param array $dealSource This array's attributes describe the object to be updated. | ||
| * | ||
| * @return array The resulting object representing updated resource. | ||
| */ | ||
| public function update($id, array $dealSource) | ||
| { | ||
| $attributes = array_intersect_key($dealSource, array_flip(self::$keysToPersist)); | ||
|
|
||
| list($code, $updatedDealSource) = $this->httpClient->put("/deal_sources/{$id}", $attributes); | ||
| return $updatedDealSource; | ||
| } | ||
|
|
||
| /** | ||
| * Delete a source | ||
| * | ||
| * delete '/deal_sources/{id}' | ||
| * | ||
| * Delete an existing source | ||
| * If the specified source does not exist, the request will return an error | ||
| * This operation cannot be undone | ||
| * | ||
| * @param integer $id Unique identifier of a DealSource | ||
| * | ||
| * @return boolean Status of the operation. | ||
| */ | ||
| public function destroy($id) | ||
| { | ||
| list($code, $payload) = $this->httpClient->delete("/deal_sources/{$id}"); | ||
| return $code == 204; | ||
| } | ||
| } |
Oops, something went wrong.