Skrumble Client Library for PHP

This library requires a minimum PHP version of 5.6

This is the PHP client library to use of Skrumble's API. To use this, you'll need a Skrumble Developer Account. Sign up for an account at developers.skrumble.com. This is currently under a beta release, see contributing for more information.

• Installation
• Usage
• Coverage
• Contributing

Installation

To use the client library you'll need to have an account created on Skrumble Developer

To install the PHP client library using Composer

composer require skrumble/php-sdk

Usage

If you're using composer, make sure the autoloader is included in your project's bootstrap file:

require_once "vendor/autoload.php";

Create a client with your Client key and secret

$client = new Skrumble\Client(CLIENT_KEY, CLIENT_SECRET);

Coverage

Roadmap

• Teams
  • Create team
  • Update team info
• Users
  • Create user (add to team)
  • Update user info
  • Invite user
  • Invite guest
  • Get one
  • Get all
  • Check existing
  • User login
  • Guest login
  • Deactivate user
  • Register device for notification
  • Deregister device for notification
• Chat
  • Create
  • Get one
  • Get all
  • Update
  • Delete
  • Generate guest url
  • Mark as read
  • Add user to group
  • Remove user from group
  • Messages
    • Send/recieve messages
    • Send files
    • Translate message
    • Get unread
  • Links
    • Get links by chat
    • Get links for user
  • Files
    • Get files by chat
    • Get files for user
    • Send file
    • Get file info
• Integrations
  • Integration type support:
    • Google
    • Office365
    • Exchange
  • Create integration
  • Update integration
  • Delete integration
  • Contacts
    • Create contact
    • Update contact
    • Delete contact
    • Get one
    • Get all
  • Events
    • Add event
    • Update event
    • Delete event
    • Get all
    • Get one
• Billing
  • Add funds
  • Get overview
  • Get subscriptions
  • Add billing address
  • Get draft invoice PDF
  • Get invoice PDF
  • Credit Cards
    • Add card
    • Delete card
    • Get all

Contributing

To contribute to the library, docs, or examples, [create an issue][issues] or a pull request. Please only raise issues about features marked as working in the API coverage as the rest of the code is being updated.

License

This library is released under the [MIT License][license]