You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ We're always looking for more opinions on discussions in the issue tracker. It's
34
34
- This repo is [commitizen friendly](https://github.com/commitizen/cz-cli), so you can use the `cz` cli to help create your commits.
35
35
- Lint and test before submitting the pull request by running `$ npm test`
36
36
- Write a convincing description of why we should land your pull request. Answer _why_ it's needed and provide use-cases.
37
-
- Make the pull request from a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) (not main)
37
+
- Make the pull request from a [topic branch](https://alvinalexander.com/git/git-topic-branch-workflow-pattern-pro-git/) (not main)
38
38
- You might be asked to do changes to your pull request. There's never a need to open another pull request – [just update the existing one.](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
39
39
40
40
## [Finding contributions to work on](labels/help%20wanted)
@@ -46,12 +46,12 @@ Look at the existing issues for areas of contribution. Searching for issues labe
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,11 +47,11 @@ SmartApps are custom applications that execute outside of the SmartThings Platfo
47
47
48
48
There are two distinct options for hosting your SmartApp: AWS Lambda and Webhook.
49
49
50
-
-**Webhook** SmartApps are any publicly-accessible web server that will receive a POST request payload.
51
-
52
50
-**AWS Lambda** SmartApps are hosted in the Amazon Web Services cloud and are invoked by ARN instead of a public-DNS address.
53
51
54
-
To learn more about SmartApps, including choosing the best hosting solution for your SmartApp, visit the [SmartApp developer documentation](https://developer-preview.smartthings.com/docs/connected-services/smartapp-basics).
52
+
-**Webhook** SmartApps are any publicly-accessible web server that will receive a POST request payload.
53
+
54
+
To learn more about SmartApps, including choosing the best hosting solution for your SmartApp, visit the [SmartApp developer documentation](https://developer.smartthings.com/docs/connected-services/smartapp-basics).
55
55
56
56
## Installation
57
57
@@ -77,7 +77,7 @@ import SmartApp from '@smartthings/smartapp'
77
77
78
78
The example SmartApp below is the equivalent of a simple Rule (if contact sensor opens/closes, turn lights on/off) which is easily achieved via our Rules API. It is given here as a brief showcase of the SDK, and is not meant to be a good candidate for a SmartApp.
79
79
80
-
>Before hosting your own Automation, be sure to check out [Rules](https://developer-preview.smartthings.com/docs/automations/rules). When all services and Device features involved in a Rule are local, Rules execute locally on a Hub, allowing you to benefit from greater speed, stability, and security than cloud-reliant solutions.
80
+
>Before hosting your own Automation, be sure to check out [Rules](https://developer.smartthings.com/docs/automations/rules). When all services and Device features involved in a Rule are local, Rules execute locally on a Hub, allowing you to benefit from greater speed, stability, and security than cloud-reliant solutions.
81
81
82
82
### Running as a Web Service
83
83
@@ -220,12 +220,12 @@ See the full usage guide on the [project's GitHub repository](https://github.com
220
220
---
221
221
## More about SmartThings
222
222
223
-
Check out our complete developer documentation [here](https://developer-preview.smartthings.com/docs/getting-started/welcome/).
223
+
Check out our complete developer documentation [here](https://developer.smartthings.com/docs/getting-started/welcome).
224
224
225
225
To create and manage your services and devices on SmartThings, create an account in the
Copy file name to clipboardExpand all lines: docs/V2_RELEASE_NOTES.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,10 @@ Methods that return lists now return arrays rather that an object with the prope
11
11
is done automatically by the API. The 1.X version of the SDK does not support paging at all in these methods, which
12
12
can result in missed items, such as when a location has more than 200 devices.
13
13
14
-
This change was also made for consitency, since not all endpoints used the `items`
14
+
This change was also made for consistency, since not all endpoints used the `items`
15
15
object, and for convenience. Since the lists are of limited length and unordered,
16
16
paging is of limited practical use. Most applications, such as displaying a sorted display of items require all pages
17
-
to be retrieved. In the future methods with potentially unbounded numbers of items with inherient order, such as event
17
+
to be retrieved. In the future methods with potentially unbounded numbers of items with inherent order, such as event
18
18
history, will include a paging mechanism.
19
19
20
20
### REST API calls are now handled by a separate package
@@ -26,13 +26,13 @@ therefore don't need to use this SDK.
26
26
As a result of the switch to use the [@smartthings/core-sdk](https://www.npmjs.com/package/@smartthings/core-sdk)
27
27
for REST API calls, [Axios](https://www.npmjs.com/package/axios) is now used as the HTTP client rather than
28
28
[request-promise-native](https://www.npmjs.com/package/request-promise-native) (which has been deprecated). As a result, the error object has changed. It's now an instance of the
29
-
[AxiosError](https://github.com/axios/axios/blob/main/index.d.ts#L76-L92) class, so instead of accessing the
29
+
[AxiosError](https://github.com/axios/axios/blob/main/index.d.ts#L12-L41) class, so instead of accessing the
30
30
status of an error response with `.catch(error => {error.statusCode})` you'd do so with
31
31
`.catch(error => {error.response.status})`.
32
32
33
33
### All methods return a Promise
34
34
All methods now return a Promise. Before there were some methods that returned void. There was also inconsistency
35
-
in the response of methods that returned no data, with some returning an empty obhect`{}`, others returning an
35
+
in the response of methods that returned no data, with some returning an empty object`{}`, others returning an
36
36
empty string `"`, and still others returning a status value `{"status": "success"}`. Now all such methods return
Copy file name to clipboardExpand all lines: docs/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# SmartApp SDK Reference
2
2
3
-
The [SmartApp](classes/_smart_app_d_.smartapp.md) class handles all SmartApp [lifecycle events](https://developer-preview.smartthings.com/docs/connected-services/lifecycles) and callbacks. It is instantiated and configured with handlers where appropriate and is invoked in response to either web server HTTP requests, or in response to AWS Lambda function calls.
3
+
The [SmartApp](classes/_smart_app_d_.smartapp.md) class handles all SmartApp [lifecycle events](https://developer.smartthings.com/docs/connected-services/lifecycles) and callbacks. It is instantiated and configured with handlers where appropriate and is invoked in response to either web server HTTP requests, or in response to AWS Lambda function calls.
Copy file name to clipboardExpand all lines: docs/modules/_lifecycle_events_d_.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ The display mode of the operating system of the client.
51
51
52
52
• **language**: *string*
53
53
54
-
Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5)
54
+
Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://www.rfc-editor.org/rfc/rfc7231#section-5.3.5)
Copy file name to clipboardExpand all lines: lib/lifecycle-events.d.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -400,7 +400,7 @@ export namespace AppEvent {
400
400
*/
401
401
version: string
402
402
/**
403
-
* Language header representing the clients preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5)
403
+
* Language header representing the client's preferred language. The format of the `Accept-Language` header follows what is defined in [RFC 7231, section 5.3.5](https://www.rfc-editor.org/rfc/rfc7231#section-5.3.5)
0 commit comments