Skip to content

docs(iot): revamp #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2023
Merged

docs(iot): revamp #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 52 additions & 27 deletions packages/clients/src/api/iot/v1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,9 @@ export class API extends ParentAPI {
)

/**
* List hubs.
* List hubs. List all Hubs in the specified zone. By default, returned Hubs
* are ordered by creation date in ascending order, though this can be
* modified via the `order_by` field.
*
* @param request - The request {@link ListHubsRequest}
* @returns A Promise of ListHubsResponse
Expand All @@ -143,7 +145,8 @@ export class API extends ParentAPI {
enrichForPagination('hubs', this.pageOfListHubs, request)

/**
* Create a hub.
* Create a hub. Create a new Hub in the targeted region, specifying its
* configuration including name and product plan.
*
* @param request - The request {@link CreateHubRequest}
* @returns A Promise of Hub
Expand All @@ -165,7 +168,9 @@ export class API extends ParentAPI {
)

/**
* Get a hub.
* Get a hub. Retrieve information about an existing IoT Hub, specified by its
* Hub ID. Its full details, including name, status and endpoint, are returned
* in the response object.
*
* @param request - The request {@link GetHubRequest}
* @returns A Promise of Hub
Expand Down Expand Up @@ -202,7 +207,8 @@ export class API extends ParentAPI {
)

/**
* Update a hub.
* Update a hub. Update the parameters of an existing IoT Hub, specified by
* its Hub ID.
*
* @param request - The request {@link UpdateHubRequest}
* @returns A Promise of Hub
Expand All @@ -224,7 +230,7 @@ export class API extends ParentAPI {
)

/**
* Enable a hub.
* Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
*
* @param request - The request {@link EnableHubRequest}
* @returns A Promise of Hub
Expand All @@ -244,7 +250,7 @@ export class API extends ParentAPI {
)

/**
* Disable a hub.
* Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
*
* @param request - The request {@link DisableHubRequest}
* @returns A Promise of Hub
Expand All @@ -264,7 +270,8 @@ export class API extends ParentAPI {
)

/**
* Delete a hub.
* Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
* a Hub is permanent, and cannot be undone.
*
* @param request - The request {@link DeleteHubRequest}
*/
Expand Down Expand Up @@ -299,7 +306,8 @@ export class API extends ParentAPI {
)

/**
* Set the certificate authority of a hub.
* Set the certificate authority of a hub. Set a particular PEM-encoded
* certificate, specified by the Hub ID.
*
* @param request - The request {@link SetHubCARequest}
* @returns A Promise of Hub
Expand All @@ -321,7 +329,8 @@ export class API extends ParentAPI {
)

/**
* Get the certificate authority of a hub.
* Get the certificate authority of a hub. Get information for a particular
* PEM-encoded certificate, specified by the Hub ID.
*
* @param request - The request {@link GetHubCARequest}
* @returns A Promise of GetHubCAResponse
Expand Down Expand Up @@ -363,7 +372,9 @@ export class API extends ParentAPI {
)

/**
* List devices.
* List devices. List all devices in the specified region. By default,
* returned devices are ordered by creation date in ascending order, though
* this can be modified via the `order_by` field.
*
* @param request - The request {@link ListDevicesRequest}
* @returns A Promise of ListDevicesResponse
Expand All @@ -372,7 +383,7 @@ export class API extends ParentAPI {
enrichForPagination('devices', this.pageOfListDevices, request)

/**
* Add a device.
* Add a device. Attach a device to a given Hub.
*
* @param request - The request {@link CreateDeviceRequest}
* @returns A Promise of CreateDeviceResponse
Expand All @@ -394,7 +405,9 @@ export class API extends ParentAPI {
)

/**
* Get a device.
* Get a device. Retrieve information about an existing device, specified by
* its device ID. Its full details, including name, status and ID, are
* returned in the response object.
*
* @param request - The request {@link GetDeviceRequest}
* @returns A Promise of Device
Expand All @@ -412,7 +425,8 @@ export class API extends ParentAPI {
)

/**
* Update a device.
* Update a device. Update the parameters of an existing device, specified by
* its device ID.
*
* @param request - The request {@link UpdateDeviceRequest}
* @returns A Promise of Device
Expand All @@ -434,7 +448,7 @@ export class API extends ParentAPI {
)

/**
* Enable a device.
* Enable a device. Enable a specific device, specified by its device ID.
*
* @param request - The request {@link EnableDeviceRequest}
* @returns A Promise of Device
Expand All @@ -454,7 +468,7 @@ export class API extends ParentAPI {
)

/**
* Disable a device.
* Disable a device. Disable an existing device, specified by its device ID.
*
* @param request - The request {@link DisableDeviceRequest}
* @returns A Promise of Device
Expand All @@ -474,7 +488,8 @@ export class API extends ParentAPI {
)

/**
* Renew a device certificate.
* Renew a device certificate. Renew the certificate of an existing device,
* specified by its device ID.
*
* @param request - The request {@link RenewDeviceCertificateRequest}
* @returns A Promise of RenewDeviceCertificateResponse
Expand All @@ -497,7 +512,8 @@ export class API extends ParentAPI {
)

/**
* Set a custom certificate on a device.
* Set a custom certificate on a device. Switch the existing certificate of a
* given device with an EM-encoded custom certificate.
*
* @param request - The request {@link SetDeviceCertificateRequest}
* @returns A Promise of SetDeviceCertificateResponse
Expand All @@ -522,7 +538,9 @@ export class API extends ParentAPI {
)

/**
* Get a device's certificate.
* Get a device's certificate. Get information for a particular PEM-encoded
* certificate, specified by the device ID. The response returns full details
* of the device, including its type of certificate.
*
* @param request - The request {@link GetDeviceCertificateRequest}
* @returns A Promise of GetDeviceCertificateResponse
Expand All @@ -543,7 +561,8 @@ export class API extends ParentAPI {
)

/**
* Remove a device.
* Remove a device. Remove a specific device from the specific Hub it is
* attached to.
*
* @param request - The request {@link DeleteDeviceRequest}
*/
Expand Down Expand Up @@ -599,7 +618,9 @@ export class API extends ParentAPI {
)

/**
* List routes.
* List routes. List all routes in the specified region. By default, returned
* routes are ordered by creation date in ascending order, though this can be
* modified via the `order_by` field.
*
* @param request - The request {@link ListRoutesRequest}
* @returns A Promise of ListRoutesResponse
Expand All @@ -608,15 +629,15 @@ export class API extends ParentAPI {
enrichForPagination('routes', this.pageOfListRoutes, request)

/**
* Create a route. Multiple route kinds can be created:
* Create a route. Multiple kinds of routes can be created, such as:
*
* - Database Route. Create a route that will record subscribed MQTT messages
* - Database Route Create a route that will record subscribed MQTT messages
* into your database. <b>You need to manage the database by yourself</b>.
* - REST Route. Create a route that will call a REST API on received subscribed
* MQTT messages.
* - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
* bucket. You need to create the bucket yourself and grant us write access.
* The grant can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
* bucket. You need to create the bucket yourself and grant write access.
* Granting can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
* --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
*
* @param request - The request {@link CreateRouteRequest}
Expand All @@ -639,7 +660,8 @@ export class API extends ParentAPI {
)

/**
* Update a route.
* Update a route. Update the parameters of an existing route, specified by
* its route ID.
*
* @param request - The request {@link UpdateRouteRequest}
* @returns A Promise of Route
Expand All @@ -661,7 +683,9 @@ export class API extends ParentAPI {
)

/**
* Get a route.
* Get a route. Get information for a particular route, specified by the route
* ID. The response returns full details of the route, including its type, the
* topic it subscribes to and its configuration.
*
* @param request - The request {@link GetRouteRequest}
* @returns A Promise of Route
Expand All @@ -679,7 +703,8 @@ export class API extends ParentAPI {
)

/**
* Delete a route.
* Delete a route. Delete an existing route, specified by its route ID.
* Deleting a route is permanent, and cannot be undone.
*
* @param request - The request {@link DeleteRouteRequest}
*/
Expand Down
Loading