Skip to content

Documentation is completely out of date #383

Description

@blackjak231

Since the release of 5.x, the intercom-php documentation/readme has been completely useless. Going from the client initialisation (#381) to the request building, a lot of things have been type hinted and documentation not updated at all.

A migration guide would actually be amazing considering it's very painful to migrate going from one endpoint to another and manually looking for the types.

Simple example :
The contacts()->create() method now accept any of these objects instead of an array :

  • CreateContactRequestWithExternalId
  • CreateContactRequestWithEmail
  • CreateContactRequestWithRole

So instead of

contacts()->create([
    'email' => 'test@example.com',
    'last_seen_at' => now()
])

you need to do the following :

contacts()->create(new CreateContactRequestWithEmail[
    'email' => 'test@example.com',
    'lastSeenAt' => now()
]))

Note that attribute names have also been changed from snake case to camelCase.

Any update is greatly appreciated.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions