Skip to content

Commit

Permalink
Merge pull request #506 from slackapi/rel-v4.0.1
Browse files Browse the repository at this point in the history
v4.0.1
  • Loading branch information
aoberoi authored Mar 15, 2018
2 parents 6902c4e + 8ce3b61 commit a206c3e
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 219 deletions.
12 changes: 12 additions & 0 deletions docs/_posts/2018-03-14-v4.0.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: changelog
---

- Fixes crash in projects where `"name"` or `"version"` were not defined in the `package.json` file (#478) - thanks @wilhelmklopp @clavin @aoberoi
- Fixes `IncomingWebhook.send()` to parse the response as text instead of JSON (#477) - thanks @aoberoi
- Allows `IncomingWebhook` to be initialized without defaults (#479) - thanks @aoberoi
- Allows `WebClient` to be initialized without a `token` in TypeScript (#482) - thanks @aoberoi
- Allows unspecificed arguments to be used with `WebClient` method aliases and `apiCall()` (#484) - thanks @clavin
- Exports method argument types as top level exports in the type declarations (#483) - thanks @aoberoi
- Fixes inaccurate property type for `as_user` in `ChatPostMessageArguments` (#475) - thanks @harveyr
- Improves the `OAuthAccessArguments` and `OAuthTokenArguments` types (#481) - thanks @aoberoi
23 changes: 12 additions & 11 deletions docs/_reference/WebClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@ A client for Slack's Web API
This client provides an alias for each [Web API method](https://api.slack.com/methods). Each method is
a convenience wrapper for calling the [WebClient#apiCall](WebClient#apiCall) method using the method name as the first parameter.

**Kind**: static class of [<code>@slack/client</code>](#module_@slack/client)
**Extends**: <code>EventEmitter</code>
**Kind**: static class of [<code>@slack/client</code>](#module_@slack/client)
**Extends**: <code>EventEmitter</code>
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| [token] | <code>string</code> | Authentication and authorization token for accessing Slack Web API (usually begins with `xoxp`, `xoxb`, or `xoxa`) |
| [slackApiUrl] | <code>string</code> | The base URL for reaching Slack's Web API. Consider changing this value for testing purposes. |


* [.WebClient](#module_@slack/client.WebClient) ⇐ <code>EventEmitter</code>
* [.apiCall(method, options)](#module_@slack/client.WebClient+apiCall)[<code>Promise.&lt;WebAPICallResult&gt;</code>](#module_@slack/client.WebAPICallResult)
* [.apiCall(method, options, callback)](#module_@slack/client.WebClient+apiCall)
Expand All @@ -27,7 +28,7 @@ a convenience wrapper for calling the [WebClient#apiCall](WebClient#apiCall) met
### webClient.apiCall(method, options) ⇒ [<code>Promise.&lt;WebAPICallResult&gt;</code>](#module_@slack/client.WebAPICallResult)
Generic method for calling a Web API method

**Kind**: instance method of [<code>WebClient</code>](#module_@slack/client.WebClient)
**Kind**: instance method of [<code>WebClient</code>](#module_@slack/client.WebClient)

| Param | Type | Description |
| --- | --- | --- |
Expand All @@ -37,22 +38,22 @@ Generic method for calling a Web API method
<a name="module_@slack/client.WebClient+apiCall"></a>

### webClient.apiCall(method, options, callback)
**Kind**: instance method of [<code>WebClient</code>](#module_@slack/client.WebClient)
**Kind**: instance method of [<code>WebClient</code>](#module_@slack/client.WebClient)

| Param | Type |
| --- | --- |
| method | <code>string</code> |
| options | [<code>WebAPICallOptions</code>](#module_@slack/client.WebAPICallOptions) |
| callback | [<code>WebAPIResultCallback</code>](#module_@slack/client.WebAPIResultCallback) |
| method | <code>string</code> |
| options | [<code>WebAPICallOptions</code>](#module_@slack/client.WebAPICallOptions) |
| callback | [<code>WebAPIResultCallback</code>](#module_@slack/client.WebAPIResultCallback) |

<a name="module_@slack/client.WebClient+apiCall"></a>

### webClient.apiCall(method, options, callback)
**Kind**: instance method of [<code>WebClient</code>](#module_@slack/client.WebClient)
**Kind**: instance method of [<code>WebClient</code>](#module_@slack/client.WebClient)

| Param | Type |
| --- | --- |
| method | <code>string</code> |
| options | [<code>WebAPICallOptions</code>](#module_@slack/client.WebAPICallOptions) |
| callback | [<code>WebAPIResultCallback</code>](#module_@slack/client.WebAPIResultCallback) |
| method | <code>string</code> |
| options | [<code>WebAPICallOptions</code>](#module_@slack/client.WebAPICallOptions) |
| callback | [<code>WebAPIResultCallback</code>](#module_@slack/client.WebAPIResultCallback) |

10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@slack/client",
"version": "4.0.0",
"version": "4.0.1",
"description": "Slack Developer Kit - official clients for the Web API, RTM API, and Incoming Webhooks",
"author": "Slack Technologies, Inc.",
"license": "MIT",
Expand Down
6 changes: 6 additions & 0 deletions support/jsdoc/@slack-client-dist-methods.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
* @module @slack/client/dist/methods
*/

/**
* @interface module:@slack/client/dist/methods.AuxiliaryArguments
*/
export class AuxiliaryArguments {
}

/**
* @interface module:@slack/client/dist/methods.CursorPaginationEnabled
* @property {number} [limit]
Expand Down
Loading

0 comments on commit a206c3e

Please sign in to comment.