diff --git a/packages/clients/src/api/iot/v1/api.gen.ts b/packages/clients/src/api/iot/v1/api.gen.ts index 4bc5e2689..dbc3b0299 100644 --- a/packages/clients/src/api/iot/v1/api.gen.ts +++ b/packages/clients/src/api/iot/v1/api.gen.ts @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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} */ @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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} */ @@ -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 @@ -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. You need to manage the database by yourself. * - 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://<my-bucket> + * bucket. You need to create the bucket yourself and grant write access. + * Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`). * * @param request - The request {@link CreateRouteRequest} @@ -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 @@ -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 @@ -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} */ diff --git a/packages/clients/src/api/iot/v1/types.gen.ts b/packages/clients/src/api/iot/v1/types.gen.ts index db1d1e339..70e23eb37 100644 --- a/packages/clients/src/api/iot/v1/types.gen.ts +++ b/packages/clients/src/api/iot/v1/types.gen.ts @@ -89,7 +89,7 @@ export interface Certificate { /** Create device response. */ export interface CreateDeviceResponse { - /** Created device information. */ + /** Information related to the created device. */ device?: Device /** Device certificate. */ certificate?: Certificate @@ -97,7 +97,7 @@ export interface CreateDeviceResponse { /** Create network response. */ export interface CreateNetworkResponse { - /** Created network. */ + /** Information related to the created network. */ network?: Network /** Endpoint Key to keep secret. This cannot be retrieved later. */ secret: string @@ -128,7 +128,7 @@ export interface CreateRouteRequestS3Config { /** Device. */ export interface Device { - /** Device ID, also used as MQTT Client ID or Username. */ + /** Device ID, also used as MQTT Client ID or username. */ id: string /** Device name. */ name: string @@ -138,28 +138,31 @@ export interface Device { status: DeviceStatus /** Hub ID. */ hubId: string - /** Device last connection/activity date. */ + /** Last connection/activity date of a device. */ lastActivityAt?: Date - /** Whether the device is connected to the Hub or not. */ + /** Defines whether the device is connected to the Hub. */ isConnected: boolean - /** Whether to allow device to connect without TLS mutual authentication. */ + /** + * Defines whether to allow the device to connect to the Hub without TLS + * mutual authentication. + */ allowInsecure: boolean /** - * Whether to allow multiple physical devices to connect with this device's - * credentials. + * Defines whether to allow multiple physical devices to connect to the Hub + * with this device's credentials. */ allowMultipleConnections: boolean /** Filter-sets to restrict the topics the device can publish/subscribe to. */ messageFilters?: DeviceMessageFilters /** - * Whether the device was assigned a custom certificate. Assigning a custom - * certificate allows a device to authenticate using that specific certificate - * without checking the hub's CA certificate. + * Defines whether the device was assigned a custom certificate. Assigning a + * custom certificate allows a device to authenticate using that specific + * certificate without checking the Hub's CA certificate. */ hasCustomCertificate: boolean - /** Device add date. */ + /** Date at which the device was added. */ createdAt?: Date - /** Device last modification date. */ + /** Date at which the device was last modified. */ updatedAt?: Date } @@ -174,9 +177,10 @@ export interface DeviceMessageFilters { /** Device. message filters. rule. */ export interface DeviceMessageFiltersRule { /** - * How to use the topic list. If accept, the set will accept all topics in the - * topics list, but no other. If reject, the set will deny all topics in the - * topics list, but all others will be allowed. + * How to use the topic list. If set to `accept`, all topics in the topics + * list will be allowed, with all other topics being denied. If set to + * `reject`, all topics in the topics list will be denied, with all other + * topics being allowed. */ policy: DeviceMessageFiltersRulePolicy /** @@ -188,7 +192,7 @@ export interface DeviceMessageFiltersRule { /** Get device certificate response. */ export interface GetDeviceCertificateResponse { - /** Created device information. */ + /** Information related to the created device. */ device?: Device /** Device certificate. */ certificatePem: string @@ -206,7 +210,7 @@ export interface GetHubCAResponse { /** Get hub metrics response. */ export interface GetHubMetricsResponse { - /** Metrics for a hub over the requested period. */ + /** Metrics for a Hub over the requested period. */ metrics: TimeSeries[] } @@ -220,19 +224,19 @@ export interface Hub { status: HubStatus /** Hub feature set. */ productPlan: HubProductPlan - /** Whether the hub has been enabled. */ + /** Defines whether the hub has been enabled. */ enabled: boolean /** Number of registered devices. */ deviceCount: number /** Number of currently connected devices. */ connectedDeviceCount: number /** - * Host to connect your devices to. Devices should be connected to this host, - * port may be 1883 (MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or + * Host to connect your devices to. Devices should be connected to this host. + * Port may be 1883 (MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or * 443 (MQTT over Websocket over TLS). */ endpoint: string - /** Disable Hub events. */ + /** Defines whether to disable Hub events. */ disableEvents: boolean /** Hub events topic prefix. */ eventsTopicPrefix: string @@ -247,18 +251,19 @@ export interface Hub { /** Organization owning the resource. */ organizationId: string /** - * Enable device auto provisioning. When an unknown device connects to your - * hub using a valid certificate chain, it will be automatically provisioned - * inside your hub. The hub uses the common name of the device certifcate to - * find out if a device with the same name already exists. This setting can - * only be enabled on a hub with a custom certificate authority. + * Defines whether to enable device auto provisioning. When an unknown device + * connects to your hub using a valid certificate chain, it will be + * automatically provisioned inside your Hub. The Hub uses the common name of + * the device certifcate to find out if a device with the same name already + * exists. This setting can only be enabled on a hub with a custom certificate + * authority. */ enableDeviceAutoProvisioning: boolean /** - * Whether the hub is using a custom certificate authority. After creating a - * hub, this flag is set to False as the hub certificates are managed by - * Scaleway. Once a custom certificate authority is installed, this flag will - * be set to true. + * Defines whether the hub is using a custom certificate authority. Flag is + * automatically set to `false` after Hub creation, as Hub certificates are + * managed by Scaleway. Once a custom certificate authority is set, the flag + * will be set to `true`. */ hasCustomCa: boolean /** @@ -278,13 +283,13 @@ export interface HubTwinsGraphiteConfig { export interface ListDevicesResponse { /** Total number of devices. */ totalCount: number - /** A page of devices. */ + /** Page of devices. */ devices: Device[] } /** List hubs response. */ export interface ListHubsResponse { - /** Total number of hubs. */ + /** Total number of Hubs. */ totalCount: number /** A page of hubs. */ hubs: Hub[] @@ -294,7 +299,7 @@ export interface ListHubsResponse { export interface ListNetworksResponse { /** Total number of Networks. */ totalCount: number - /** A page of networks. */ + /** Page of networks. */ networks: Network[] } @@ -302,19 +307,19 @@ export interface ListNetworksResponse { export interface ListRoutesResponse { /** Total number of routes. */ totalCount: number - /** A page of routes. */ + /** Page of routes. */ routes: RouteSummary[] } /** List twin documents response. */ export interface ListTwinDocumentsResponse { - /** Twin's document list. */ + /** List of the twin document. */ documents: ListTwinDocumentsResponseDocumentSummary[] } /** List twin documents response. document summary. */ export interface ListTwinDocumentsResponseDocumentSummary { - /** Document's name. */ + /** Name of the document. */ documentName: string } @@ -330,7 +335,7 @@ export interface Network { endpoint: string /** Hub ID to connect the Network to. */ hubId: string - /** Network creation date. */ + /** Date at which the network was created. */ createdAt?: Date /** * Topic prefix for the Network. This prefix will be prepended to all topics @@ -341,7 +346,7 @@ export interface Network { /** Renew device certificate response. */ export interface RenewDeviceCertificateResponse { - /** Created device information. */ + /** Information related to the created device. */ device?: Device /** Device certificate. */ certificate?: Certificate @@ -353,7 +358,7 @@ export interface Route { id: string /** Route name. */ name: string - /** ID of the route's hub. */ + /** Hub ID of the route. */ hubId: string /** * Topic the route subscribes to. It must be a valid MQTT topic and up to @@ -362,7 +367,7 @@ export interface Route { topic: string /** Route type. */ type: RouteRouteType - /** Route creation date. */ + /** Date at which the route was created. */ createdAt?: Date /** * When using S3 Route, S3-specific configuration fields. @@ -385,15 +390,15 @@ export interface Route { * could be set. */ restConfig?: RouteRestConfig - /** Route last update date. */ + /** Date at which the route was last updated. */ updatedAt?: Date } /** Route. database config. */ export interface RouteDatabaseConfig { /** - * Database engine the route will connect to. If not specified, will default - * to 'PostgreSQL'. + * Database engine the route will connect to. If not specified, the default + * database will be 'PostgreSQL'. */ engine: RouteDatabaseConfigEngine /** Database host. */ @@ -415,7 +420,7 @@ export interface RouteDatabaseConfig { /** Route. rest config. */ export interface RouteRestConfig { - /** HTTP Verb used to call REST URI. */ + /** HTTP verb used to call REST URI. */ verb: RouteRestConfigHttpVerb /** URI of the REST endpoint. */ uri: string @@ -425,9 +430,9 @@ export interface RouteRestConfig { /** Route.s3 config. */ export interface RouteS3Config { - /** Region of the S3 route's destination bucket (eg 'fr-par'). */ + /** Region of the S3 route's destination bucket (e.g., 'fr-par'). */ bucketRegion: string - /** Name of the S3 route's destination bucket. */ + /** Destination bucket name of the S3 route. */ bucketName: string /** Optional string to prefix object names with. */ objectPrefix: string @@ -444,7 +449,7 @@ export interface RouteSummary { id: string /** Route name. */ name: string - /** ID of the route's hub. */ + /** Hub ID of the route. */ hubId: string /** * Topic the route subscribes to. It must be a valid MQTT topic and up to @@ -453,9 +458,9 @@ export interface RouteSummary { topic: string /** Route type. */ type: RouteRouteType - /** Route creation date. */ + /** Date at which the route was created. */ createdAt?: Date - /** Route last update date. */ + /** Date at which the route was last updated. */ updatedAt?: Date } @@ -466,13 +471,13 @@ export interface SetDeviceCertificateResponse { /** Twin document. */ export interface TwinDocument { - /** Document's parent twin ID. */ + /** Parent twin ID of the document. */ twinId: string - /** Document's name. */ + /** Name of the document. */ documentName: string - /** Document's new version. */ + /** New version of the document. */ version: number - /** Document's new data. */ + /** New data related to the document. */ data?: Record } @@ -505,17 +510,17 @@ export type ListHubsRequest = { * config. */ region?: Region - /** Page number. */ + /** Page number to return, from the paginated results. */ page?: number - /** Page size. The maximum value is 100. */ + /** Number of Hubs to return within a page. Maximum value is 100. */ pageSize?: number - /** Ordering of requested hub. */ + /** Sort order of Hubs in the response. */ orderBy?: ListHubsRequestOrderBy - /** Filter on project. */ + /** Only list Hubs of this Project ID. */ projectId?: string - /** Filter on the organization. */ + /** Only list Hubs of this Organization ID. */ organizationId?: string - /** Filter on the name. */ + /** Hub name. */ name?: string } @@ -527,13 +532,16 @@ export type CreateHubRequest = { region?: Region /** Hub name (up to 255 characters). */ name?: string - /** Organization/project owning the resource. */ + /** + * Project/Organization ID to filter for, only Hubs from this + * Project/Organization will be returned. + */ projectId?: string - /** Hub feature set. */ + /** Hub product plan. */ productPlan: HubProductPlan /** Disable Hub events. */ disableEvents?: boolean - /** Hub events topic prefix (default '$SCW/events'). */ + /** Topic prefix (default '$SCW/events') of Hub events. */ eventsTopicPrefix?: string /** * BETA - not implemented yet. @@ -560,15 +568,15 @@ export type UpdateHubRequest = { * config. */ region?: Region - /** Hub ID. */ + /** ID of the Hub you want to update. */ hubId: string /** Hub name (up to 255 characters). */ name?: string - /** Hub feature set. */ + /** Hub product plan. */ productPlan?: HubProductPlan /** Disable Hub events. */ disableEvents?: boolean - /** Hub events topic prefix. */ + /** Topic prefix of Hub events. */ eventsTopicPrefix?: string /** Enable device auto provisioning. */ enableDeviceAutoProvisioning?: boolean @@ -609,7 +617,10 @@ export type DeleteHubRequest = { region?: Region /** Hub ID. */ hubId: string - /** Force deletion of devices added to this hub instead of rejecting operation. */ + /** + * Defines whether to force the deletion of devices added to this Hub or + * reject the operation. + */ deleteDevices?: boolean } @@ -621,7 +632,7 @@ export type GetHubMetricsRequest = { region?: Region /** Hub ID. */ hubId: string - /** Start date used to compute the best scale for the returned metrics. */ + /** Start date used to compute the best scale for returned metrics. */ startDate: Date } @@ -633,12 +644,12 @@ export type SetHubCARequest = { region?: Region /** Hub ID. */ hubId: string - /** The CA's PEM-encoded certificate. */ + /** CA's PEM-encoded certificate. */ caCertPem: string /** - * Proof of possession PEM-encoded certificate. The challenge is a PEM-encoded - * certificate to prove the possession of the CA. It must be signed by the CA, - * and have a Common Name equal to the Hub ID. + * Proof of possession of PEM-encoded certificate. Challenge is a PEM-encoded + * certificate that acts as proof of possession of the CA. It must be signed + * by the CA, and have a Common Name equal to the Hub ID. */ challengeCertPem: string } @@ -658,17 +669,17 @@ export type ListDevicesRequest = { * config. */ region?: Region - /** Page number. */ + /** Page number to return, from the paginated results. */ page?: number - /** Page size. The maximum value is 100. */ + /** Number of devices to return within a page. Maximum value is 100. */ pageSize?: number /** Ordering of requested devices. */ orderBy?: ListDevicesRequestOrderBy - /** Filter on the name. */ + /** Name to filter for, only devices with this name will be returned. */ name?: string - /** Filter on the hub. */ + /** Hub ID to filter for, only devices attached to this Hub will be returned. */ hubId?: string - /** Filter on the allow_insecure flag. */ + /** Defines wheter to filter the allow_insecure flag. */ allowInsecure?: boolean /** Device status (enabled, disabled, etc.). */ status?: DeviceStatus @@ -682,14 +693,17 @@ export type CreateDeviceRequest = { region?: Region /** Device name. */ name?: string - /** ID of the device's hub. */ + /** Hub ID of the device. */ hubId: string /** - * Allow plain and server-authenticated SSL connections in addition to - * mutually-authenticated ones. + * Defines whether to allow plain and server-authenticated SSL connections in + * addition to mutually-authenticated ones. */ allowInsecure: boolean - /** Allow multiple physical devices to connect with this device's credentials. */ + /** + * Defines whether to allow multiple physical devices to connect with this + * device's credentials. + */ allowMultipleConnections: boolean /** * Filter-sets to authorize or deny the device to publish/subscribe to @@ -718,14 +732,17 @@ export type UpdateDeviceRequest = { region?: Region /** Device ID. */ deviceId: string - /** Device description. */ + /** Description for the device. */ description?: string /** - * Allow plain and server-authenticated SSL connections in addition to - * mutually-authenticated ones. + * Defines whether to allow plain and server-authenticated SSL connections in + * addition to mutually-authenticated ones. */ allowInsecure?: boolean - /** Allow multiple physical devices to connect with this device's credentials. */ + /** + * Defines whether to allow multiple physical devices to connect with this + * device's credentials. + */ allowMultipleConnections?: boolean /** Filter-sets to restrict the topics the device can publish/subscribe to. */ messageFilters?: DeviceMessageFilters @@ -771,7 +788,7 @@ export type SetDeviceCertificateRequest = { region?: Region /** Device ID. */ deviceId: string - /** The PEM-encoded custom certificate. */ + /** PEM-encoded custom certificate. */ certificatePem: string } @@ -813,15 +830,15 @@ export type ListRoutesRequest = { * config. */ region?: Region - /** Page number. */ + /** Page number to return, from the paginated results. */ page?: number - /** Page size. The maximum value is 100. */ + /** Number of routes to return within a page. Maximum value is 100. */ pageSize?: number /** Ordering of requested routes. */ orderBy?: ListRoutesRequestOrderBy - /** Filter on the hub. */ + /** Hub ID to filter for. */ hubId?: string - /** Filter on route's name. */ + /** Route name to filter for. */ name?: string } @@ -833,7 +850,7 @@ export type CreateRouteRequest = { region?: Region /** Route name. */ name?: string - /** ID of the route's hub. */ + /** Hub ID of the route. */ hubId: string /** * Topic the route subscribes to. It must be a valid MQTT topic and up to @@ -927,17 +944,17 @@ export type ListNetworksRequest = { * config. */ region?: Region - /** Page number. */ + /** Page number to return, from the paginated results. */ page?: number - /** Page size. The maximum value is 100. */ + /** Number of networks to return. The maximum value is 100. */ pageSize?: number /** Ordering of requested routes. */ orderBy?: ListNetworksRequestOrderBy - /** Filter on Network name. */ + /** Network name to filter for. */ name?: string - /** Filter on the hub. */ + /** Hub ID to filter for. */ hubId?: string - /** Filter on the topic prefix. */ + /** Topic prefix to filter for. */ topicPrefix?: string } @@ -985,7 +1002,7 @@ export type GetTwinDocumentRequest = { region?: Region /** Twin ID. */ twinId: string - /** Document name. */ + /** Name of the document. */ documentName: string } @@ -997,15 +1014,15 @@ export type PutTwinDocumentRequest = { region?: Region /** Twin ID. */ twinId: string - /** Document name. */ + /** Name of the document. */ documentName: string /** - * The version of the document to update. If set, ensures that the document's - * current version matches before persisting the update. + * Version of the document to update. If set, ensures that the current version + * of the document matches before persisting the update. */ version?: number /** - * New document data. The new data that will replace the contents of the + * Data of the new document. New data that will replace the contents of the * document. */ data?: Record @@ -1019,20 +1036,20 @@ export type PatchTwinDocumentRequest = { region?: Region /** Twin ID. */ twinId: string - /** Document name. */ + /** Name of the document. */ documentName: string /** - * The version of the document to update. If set, ensures that the document's - * current version matches before persisting the update. + * The version of the document to update. If set, ensures that the current + * version of the document matches before persisting the update. */ version?: number /** * Patch data. A json data that will be applied on the document's current * data. Patching rules: The patch goes recursively through the patch objects. - * If the patch object property is null, then it is removed from the final - * object. If the patch object property is a value (number, strings, bool, - * arrays), it is replaced. If the patch object property is an object, the - * previous rules will be applied recursively on it. + * If the patch object property is null, it is removed from the final object. + * If the patch object property is a value (number, strings, bool, arrays), it + * is replaced. If the patch object property is an object, the previous rules + * will be applied recursively on it. */ data?: Record } @@ -1045,7 +1062,7 @@ export type DeleteTwinDocumentRequest = { region?: Region /** Twin ID. */ twinId: string - /** Document name. */ + /** Name of the document. */ documentName: string }