feat(sc-57428): Support Opportunities API

[kamilpavlicko]

closes ticket: https://app.shortcut.com/chartmogul/story/57428/support-opportunities-resource-php-client

API Specs: https://www.notion.so/chartmogul/API-endpoints-for-Opportunities-a92323514bf44f89ad2f97ae30cee7f0#6f09cc7a71bc40e69ef65d8d0342d230

Customers

List Opportunities from a customer

$customer = ChartMogul\Customer::retrieve($uuid);
$opportunities = $customer->opportunities([
  'cursor' => 'aabbccdd...'
]);

Create an Opportunity from a customer

$customer = ChartMogul\Customer::retrieve($uuid);
$new_opportunity = $customer->createOpportunity([
  'owner' => '[email protected]',
  'pipeline' => 'Sales',
  'pipeline_stage' => 'Qualified',
  'estimated_close_date' => '2022-03-30',
  'currency' => 'USD',
  'amount_in_cents' => 10000,
  'type' => 'one-time',
  'forecast_category' => 'Best Case',
  'win_likelihood' => 80,
  'custom' => [{key: 'custom_key', value: 'custom_value'}]
]);

Opportunities

List Opportunities

$opportunities = ChartMogul\Opportunity::all([
    'cursor' => 'aabbccdd...'
])

Create an Opportunity

$opportunity = ChartMogul\Opportunity::create([
    'customer_uuid' => $uuid,
    'owner' => '[email protected]',
    'pipeline' => 'New business 1',
    'pipeline_stage' => 'Discovery',
    'estimated_close_date' => '2023-12-22',
    'currency' => 'USD',
    'amount_in_cents' => 100,
    'type' => 'recurring',
    'forecast_category' => 'pipeline',
    'win_likelihood' => 3,
    'custom' => [{ 'key': 'from_campaign', 'value': 'true' }]
])

Get an Opportunity

$opportunity = ChartMogul\Opportunity::retrieve($opportunity_uuid)

Update an Opportunity

$updated_opportunity = ChartMogul\Opportunity::update($opportunity_uuid, [
  'estimated_close_date' => '2024-12-22',
]);

Delete an Opportunity

$opportunity = ChartMogul\Opportunity::retrieve($opportunity_uuid)
$opportunity->destroy();

[shortcut-integration]

This pull request has been linked to Shortcut Story #57428: Support Opportunities resource - PHP client.

[SoeunSona]

LGTM and I left a question

[SoeunSona]

I think custom type is array in here but this type is object Ah please ignore this comment. I checked the api document

[kamilpavlicko]

Yes, good catch, but the data should be correct now 😊
I just added a new test for creating the opportunity from customer.

[codeclimate]

Code Climate has analyzed commit caad9bf and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 75.6%.

View more on Code Climate.