cisco-spark-api 0.1.0.2 → 0.1.0.3
raw patch · 3 files changed
+17/−24 lines, 3 filesPVP ok
version bump matches the API change (PVP)
API changes (from Hackage documentation)
Files
- CHANGELOG.md +4/−0
- README.md +8/−8
- cisco-spark-api.cabal +5/−16
CHANGELOG.md view
@@ -1,3 +1,7 @@+## Cisco-spark-api 0.1.0.3++* Cisco Spark is now Cisco Webex Teams.+ ## Cisco-spark-api 0.1.0.2 * Catch up to conduit-1.3.0.
README.md view
@@ -6,16 +6,16 @@ [](http://stackage.org/nightly/package/cisco-spark-api) [](http://stackage.org/lts/package/cisco-spark-api) -A Haskell bindings for Cisco Spark API+A Haskell bindings for Cisco Webex Teams (formerly Cisco Spark) API -Cisco-spark-api package provides types and functions for accessing Cisco Spark REST API.-The detail of Spark API is available from [developer site of Cisco Spark](https://developer.ciscospark.com/)+Cisco-spark-api package provides types and functions for accessing Cisco Webex Teams REST API.+The detail of the API is available from [developer site of Cisco Webex](https://developer.webex.com/) This package is designed to improve type safety over the API. Each entity is separately typed. JSON messages contained in REST responses are decoded into appropriate type of Haskell record. JSON messages sent in REST requests are encoded only from correct type of record. -Some Spark REST API return list of objects. Those APIs require HTTP Link Header based pagination.+Some Webex Teams REST API return list of objects. Those APIs require HTTP Link Header based pagination. Haskell functions for those APIs automatically request subsequent pages as needed. Also those functions transform chunky response into seamless stream of elements. @@ -24,7 +24,7 @@ ### Sample Usage -Sending a message to a Spark Space (Room).+Sending a message to a Room. ```haskell let auth = Authorization "your authorization token"@@ -35,7 +35,7 @@ ``` Following example is calling List Membership API which returns membership between-Spark spaces (Room) and Spark users (Person). You can extract each Membership from+Rooms and users (Person). You can extract each Membership from Conduit pipe. The streamEntityWithFilter automatically performs pagenation when it is asked more element and last response indicated subsequent page in HTTP Link Header. @@ -49,7 +49,7 @@ ### Support for Lens -This package provides many of records representing objects communicated via Cisco Spark REST API.+This package provides many of records representing objects communicated via Webex Teams REST API. Those records are designed to allow create lenses by Control.Lens.TH.makeFields. Following example creates overloaded accessors for 'Person', 'Room' and 'Team'.@@ -73,5 +73,5 @@ ### Limitation -- WebHook API is not implemented.+- WebHook API is not yet implemented. - Relative reference in Link Header is not recognized as next page
cisco-spark-api.cabal view
@@ -1,19 +1,8 @@ name: cisco-spark-api-version: 0.1.0.2-synopsis: A Haskell bindings for Cisco Spark API-description: Cisco-spark-api package provides types and functions for accessing Cisco Spark REST API.-- This package is designed to improve type safety over the API. Each entity is separately typed.- JSON messages contained in REST responses are decoded into appropriate type of Haskell record.- JSON messages sent in REST requests are encoded only from correct type of record.-- Some Spark REST API returning list of objects require HTTP Link Header based pagination.- Haskell functions abstract it. They automatically request subsequent pages as needed and- seamlessly stream returned elements rather than just return a chunk of elements in a response.-- This package also provides some sample usage in command line application style.- See source under app directory of the source package.-homepage: https://github.com/nshimaza/cisco-spark-api#readme+version: 0.1.0.3+synopsis: A Haskell bindings for Webex Teams API+description: Please see the README on Github at <https://github.com/nshimaza/webex-teams-api#readme>+homepage: https://github.com/nshimaza/webex-teams-api#readme license: MIT license-file: LICENSE author: Naoto Shimazaki@@ -85,4 +74,4 @@ source-repository head type: git- location: https://github.com/nshimaza/cisco-spark-api+ location: https://github.com/nshimaza/webex-teams-api