Enhancement: Readability and sorted array keys (#334)

Author: OskarStark

README.md

@@ -93,15 +93,15 @@ This resource is only available in API Versions 2.0 and above
 ```php
 /** Create a contact */
 $client->contacts->create([
-    'type' => 'user',
+    'custom_attributes' => ['nickname' => 'Teddy'],
     'email' => '[email protected]',
-    'custom_attributes' => ['foo' => 'bar']
+    'type' => 'user',
 ]);
 
 /** Update a contact */
 $client->contacts->update('570680a8a1bcbca8a90001b9', [
+    'custom_attributes' => ['nickname' => 'Teddy'],
     'email' => '[email protected]',
-    'custom_attributes' => ['foo' => 'bar']
 ]);
 
 /** Permanently delete a contact */
@@ -113,9 +113,9 @@ $client->contacts->getContact('570680a8a1bcbca8a90001b9');
 /** Search for contacts */
 $query = ['field' => 'name', 'operator' => '=', 'value' => 'Alice'];
 $client->contacts->search([
+    'pagination' => ['per_page' => 10],
     'query' => $query,
     'sort' => ['field' => 'name', 'order' => 'ascending'],
-    'pagination' => ['per_page' => 10]
 ]);
 
 /** Get next page of conversation search results */
@@ -132,17 +132,17 @@ This resource is only available in API Versions 1.0 to 1.4. Newer versions use t
 ```php
 /** Create a user */
 $client->users->create([
+    'custom_attributes' => ['nickname' => 'Teddy'],
     'email' => '[email protected]',
-    'custom_attributes' => ['foo' => 'bar']
 ]);
 
 /**
  * Update a user (Note: This method is an alias to the create method. In practice you
  * can use create to update users if you wish)
  */
 $client->users->update([
+    'custom_attributes' => ['nickname' => 'Teddy'],
     'email' => '[email protected]',
-    'custom_attributes' => ['foo' => 'bar']
 ]);
 
 /** Archive a user by ID (i.e. soft delete) */
@@ -158,27 +158,29 @@ $client->users->getUser('570680a8a1bcbca8a90001b9');
 
 /** Add companies to a user */
 $client->users->create([
-    'email' => '[email protected]',
     'companies' => [
         [
-            'company_id' => '3'
+            'company_id' => '3',
         ]
-    ]
+    ],
+    'email' => '[email protected]',
 ]);
 
 /** Remove companies from a user */
 $client->users->create([
-    'email' => '[email protected]',
     'companies' => [
         [
             'company_id' => '3',
-            'remove' => true
+            'remove' => true,
         ]
-    ]
+    ],
+    'email' => '[email protected]',
 ]);
 
 /** Find a single user by email */
-$client->users->getUsers(['email' => '[email protected]']);
+$client->users->getUsers([
+    'email' => '[email protected]',
+]);
 
 /** List all users up to 10k records */
 $client->users->getUsers([]);
@@ -204,17 +206,17 @@ This resource is only available in API Versions 1.0 to 1.4. Newer versions use t
  * See more options here: https://developers.intercom.io/reference#create-lead
  */
 $client->leads->create([
+    'custom_attributes' => ['nickname' => 'Teddy'],
     'email' => '[email protected]',
-    'custom_attributes' => ['foo' => 'bar']
 ]);
 
 /**
  * Update a lead (Note: This method is an alias to the create method.
  * In practice you can use create to update leads if you wish)
  */
 $client->leads->update([
+    'custom_attributes' => ['nickname' => 'Teddy'],
     'email' => '[email protected]',
-    'custom_attributes' => ['foo' => 'bar']
 ]);
 
 /**
@@ -232,11 +234,11 @@ $client->leads->deleteLead('570680a8a1bcbca8a90000a9');
 /** Convert a Lead to a User */
 $client->leads->convertLead([
     'contact' => [
-        'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c'
+        'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c',
     ],
     'user' => [
-        'email' => '[email protected]'
-    ]
+        'email' => '[email protected]',
+    ],
 ]);
 
 /**
@@ -257,36 +259,38 @@ Retrieve `user_id` of a visitor via [the JavaScript API](https://developers.inte
 ```php
 /** Update a visitor */
 $client->visitors->update([
+    'custom_attributes' => ['nickname' => 'Teddy'],
     'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c',
-    'custom_attributes' => ['foo' => 'bar']
 ]);
 
 /** Find a visitor by ID */
 $client->visitors->getVisitor('570680a8a1bcbca8a90000a9');
 
 /** Find a visitor by User ID */
-$client->visitors->getVisitor('', ['user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c']);
+$client->visitors->getVisitor('', [
+    'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c',
+]);
 
 /** Delete a visitor by ID */
 $client->visitors->deleteVisitor('570680a8a1bcbca8a90000a9');
 
 /** Convert a Visitor to a Lead */
 $client->visitors->convertVisitor([
+    'type' => 'lead',
     'visitor' => [
-        'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c'
+        'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c',
     ],
-    'type' => 'lead'
 ]);
 
 /** Convert a Visitor to a User */
 $client->visitors->convertVisitor([
-    'visitor' => [
-        'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c'
-    ],
+    'type' => 'user',
     'user' => [
-        'email' => '[email protected]'
+        'email' => '[email protected]',
+    ],
+    'visitor' => [
+        'user_id' => '8a88a590-e1c3-41e2-a502-e0649dbf721c',
     ],
-    'type' => 'user'
 ]);
 ```
 
@@ -303,8 +307,8 @@ $client->tags->getTags();
 $client->tags->tag([
     'name' => 'Test',
     'users' => [
-        ['id' => '1234']
-    ]
+        ['id' => '1234'],
+    ],
 ]);
 ```
 
@@ -318,21 +322,23 @@ $client->segments->getSegments();
 $client->segments->getSegment('58a707924f6651b07b94376c');
 
 /** View a segment with count */
-$client->segments->getSegment('59c124f770e00fd819b9ce81', ['include_count' => 'true']);
+$client->segments->getSegment('59c124f770e00fd819b9ce81', [
+    'include_count' => 'true',
+]);
 ```
 
 ## Events
 
 ```php
 /** Create an event */
 $client->events->create([
-    'event_name' => 'testing',
     'created_at' => 1391691571,
     'email' => '[email protected]',
+    'event_name' => 'testing',
     'metadata' => [
         'order_date' => 1392036272,
-        'stripe_invoice' => 'inv_3434343434'
-    ]
+        'stripe_invoice' => 'inv_3434343434',
+    ],
 ]);
 
 /** View events for a user */
@@ -344,26 +350,25 @@ $client->events->getEvents(['email' => '[email protected]']);
 ```php
 /** Create a company */
 $client->companies->create([
+    'company_id' => '3',
     'name' => 'foocorp',
-    'company_id' => '3'
 ]);
 
 /**
  * Update a company
  */
 $client->companies->update([
+    'id' => '3',
     'name' => 'foocorp',
-    'id' => '3'
 ]);
 
 /** Create or update a company with custom attributes. */
 $client->companies->update([
-    'name' => 'foocorp',
-    'id' => '3',
     'custom_attributes' => [
-        'foo' => 'bar',
-        'baz' => 'qux'
-    ]
+        'short_name' => 'ABC Inc.',
+    ],
+    'id' => '3',
+    'name' => 'foocorp',
 ]);
 
 /** List Companies */
@@ -376,7 +381,10 @@ $client->companies->getCompany('531ee472cce572a6ec000006');
 $client->companies->getCompanyUsers('531ee472cce572a6ec000006');
 
 /** List users belonging to a company by company_id */
-$client->companies->getCompanies(['type' => 'user', 'company_id' => '3']);
+$client->companies->getCompanies([
+    'company_id' => '3',
+    'type' => 'user',
+]);
 
 /**
  * Add companies to a contact with IDs
@@ -407,17 +415,17 @@ $client->admins->getAdmins();
  * See more options here: https://developers.intercom.io/reference#conversations
  */
 $client->messages->create([
-    'message_type' => 'inapp',
-    'subject' => 'Hey',
     'body' => 'Ponies, cute small horses or something more sinister?',
     'from' => [
+        'id' => '1234',
         'type' => 'admin',
-        'id' => '1234'
     ],
+    'message_type' => 'inapp',
+    'subject' => 'Hey',
     'to' => [
+        'email' => '[email protected]',
         'type' => 'user',
-        'email' => '[email protected]'
-    ]
+    ],
 ]);
 ```
 
@@ -429,24 +437,24 @@ $client->messages->create([
  * See more options here: https://developers.intercom.io/reference#list-conversations
  */
 $client->conversations->getConversations([
+    'admin_id' => '25610',
     'type' => 'admin',
-    'admin_id' => '25610'
 ]);
 
 /** Get a single conversation */
-$client->conversations->getConversation('1234')
+$client->conversations->getConversation('1234');
 
 /** Get a single conversation with plaintext comments */
 $client->conversations->getConversation('1234', [
-    'display_as' => 'plaintext'
-])
+    'display_as' => 'plaintext',
+]);
 
 /** Search for conversations (API version >= 2.0) */
 $query = ['field' => 'updated_at', 'operator' => '>', 'value' => '1560436784'];
 $client->conversations->search([
+    'pagination' => ['per_page' => 10],
     'query' => $query,
     'sort' => ['field' => 'updated_at', 'order' => 'ascending'],
-    'pagination' => ['per_page' => 10]
 ]);
 
 /** Get next page of conversation search results (API version >= 2.0) */
@@ -457,21 +465,21 @@ $client->conversations->nextSearch($query, $response->pages);
  * See more options here: https://developers.intercom.io/reference#replying-to-a-conversation
  */
 $client->conversations->replyToConversation('5678', [
-    'email' => '[email protected]',
     'body' => 'Thanks :)',
+    'email' => '[email protected]',
+    'message_type' => 'comment',
     'type' => 'user',
-    'message_type' => 'comment'
 ]);
 
 /**
  * Reply to a user's last conversation
  * See more options here: https://developers.intercom.com/reference#replying-to-users-last-conversation
  */
 $client->conversations->replyToLastConversation([
-    'email' => '[email protected]',
     'body' => 'Thanks :)',
+    'email' => '[email protected]',
+    'message_type' => 'comment',
     'type' => 'user',
-    'message_type' => 'comment'
 ]);
 
 /**
@@ -488,7 +496,7 @@ $client->conversations->markConversationAsRead('7890');
  * List counts
  * See more options here: https://developers.intercom.io/reference#getting-counts
  */
-$client->counts->getCounts([])
+$client->counts->getCounts([]);
 ```
 
 ## Notes
@@ -499,13 +507,13 @@ $client->notes->create([
     'admin_id' => '21',
     'body' => 'Text for my note',
     'user' => [
-        'id' => '5310d8e8598c9a0b24000005'
+        'id' => '5310d8e8598c9a0b24000005',
     ]
 ]);
 
 /** List notes for a user */
 $client->notes->getNotes([
-  'user_id' => '25'
+  'user_id' => '25',
 ]);
 
 /** Get a single Note by id */
@@ -522,7 +530,6 @@ $client->teams->getTeams();
 $client->teams->getTeam('1188');
 ```
 
-
 ## Rate Limits
 
 Rate limit info is passed via the rate limit headers.