From 879e8dd4adeee018f3b6680c187002245a3f462d Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Mon, 6 Apr 2026 10:25:24 -0300 Subject: [PATCH 1/2] fix: regenerate API docs from updated OpenAPI spec Regenerate all API docs using docusaurus-plugin-openapi-docs to ensure the authorization_token parameter fix is reflected in the rendered page. --- docs/api/add-entity-data.ParamsDetails.json | 1 + docs/api/add-entity-data.RequestSchema.json | 1 + docs/api/add-entity-data.StatusCodes.json | 1 + docs/api/add-entity-data.api.mdx | 83 ++-- ...nfigure-profile-service.ParamsDetails.json | 1 + ...nfigure-profile-service.RequestSchema.json | 1 + ...configure-profile-service.StatusCodes.json | 1 + docs/api/configure-profile-service.api.mdx | 254 ++--------- .../convert-device-type.ParamsDetails.json | 1 + .../convert-device-type.RequestSchema.json | 1 + docs/api/convert-device-type.StatusCodes.json | 1 + docs/api/convert-device-type.api.mdx | 94 ++-- ...-and-edit-device-params.ParamsDetails.json | 1 + ...-and-edit-device-params.RequestSchema.json | 1 + ...te-and-edit-device-params.StatusCodes.json | 1 + .../api/create-and-edit-device-params.api.mdx | 87 ++-- ...create-dashboard-widget.ParamsDetails.json | 1 + ...create-dashboard-widget.RequestSchema.json | 1 + .../create-dashboard-widget.StatusCodes.json | 1 + docs/api/create-dashboard-widget.api.mdx | 110 ++--- docs/api/create-dashboard.RequestSchema.json | 1 + docs/api/create-dashboard.StatusCodes.json | 1 + docs/api/create-dashboard.api.mdx | 150 ++----- docs/api/create-dictionary.RequestSchema.json | 1 + docs/api/create-dictionary.StatusCodes.json | 1 + docs/api/create-dictionary.api.mdx | 103 ++--- docs/api/create-entity.RequestSchema.json | 1 + docs/api/create-entity.StatusCodes.json | 1 + docs/api/create-entity.api.mdx | 133 ++---- docs/api/create-new-device.RequestSchema.json | 1 + docs/api/create-new-device.StatusCodes.json | 1 + docs/api/create-new-device.api.mdx | 233 ++-------- .../create-notification.RequestSchema.json | 1 + docs/api/create-notification.StatusCodes.json | 1 + docs/api/create-notification.api.mdx | 121 ++---- docs/api/create-policy.RequestSchema.json | 1 + docs/api/create-policy.StatusCodes.json | 1 + docs/api/create-policy.api.mdx | 255 ++--------- .../create-profile-backup.ParamsDetails.json | 1 + .../create-profile-backup.RequestSchema.json | 1 + .../create-profile-backup.StatusCodes.json | 1 + docs/api/create-profile-backup.api.mdx | 98 ++--- docs/api/create-token.RequestSchema.json | 1 + docs/api/create-token.StatusCodes.json | 1 + docs/api/create-token.api.mdx | 104 ++--- docs/api/create-user.RequestSchema.json | 1 + docs/api/create-user.StatusCodes.json | 1 + docs/api/create-user.api.mdx | 82 ++-- ...rent-device-information.RequestSchema.json | 1 + ...urrent-device-information.StatusCodes.json | 1 + docs/api/current-device-information.api.mdx | 78 ++-- docs/api/delete-a-file.RequestSchema.json | 1 + docs/api/delete-a-file.StatusCodes.json | 1 + docs/api/delete-a-file.api.mdx | 57 ++- docs/api/delete-chunk.ParamsDetails.json | 1 + docs/api/delete-chunk.RequestSchema.json | 1 + docs/api/delete-chunk.StatusCodes.json | 1 + docs/api/delete-chunk.api.mdx | 79 ++-- docs/api/delete-dashboard.ParamsDetails.json | 1 + docs/api/delete-dashboard.RequestSchema.json | 1 + docs/api/delete-dashboard.StatusCodes.json | 1 + docs/api/delete-dashboard.api.mdx | 68 +-- docs/api/delete-data.ParamsDetails.json | 1 + docs/api/delete-data.RequestSchema.json | 1 + docs/api/delete-data.StatusCodes.json | 1 + docs/api/delete-data.api.mdx | 109 ++--- .../api/delete-device-data.ParamsDetails.json | 1 + .../api/delete-device-data.RequestSchema.json | 1 + docs/api/delete-device-data.StatusCodes.json | 1 + docs/api/delete-device-data.api.mdx | 115 ++--- .../delete-device-param.ParamsDetails.json | 1 + .../delete-device-param.RequestSchema.json | 1 + docs/api/delete-device-param.StatusCodes.json | 1 + docs/api/delete-device-param.api.mdx | 68 +-- docs/api/delete-device.ParamsDetails.json | 1 + docs/api/delete-device.RequestSchema.json | 1 + docs/api/delete-device.StatusCodes.json | 1 + docs/api/delete-device.api.mdx | 67 +-- docs/api/delete-dictionary.ParamsDetails.json | 1 + docs/api/delete-dictionary.RequestSchema.json | 1 + docs/api/delete-dictionary.StatusCodes.json | 1 + docs/api/delete-dictionary.api.mdx | 74 ++-- .../api/delete-entity-data.ParamsDetails.json | 1 + .../api/delete-entity-data.RequestSchema.json | 1 + docs/api/delete-entity-data.StatusCodes.json | 1 + docs/api/delete-entity-data.api.mdx | 67 +-- docs/api/delete-entity.ParamsDetails.json | 1 + docs/api/delete-entity.RequestSchema.json | 1 + docs/api/delete-entity.StatusCodes.json | 1 + docs/api/delete-entity.api.mdx | 67 +-- .../delete-notification.ParamsDetails.json | 1 + .../delete-notification.RequestSchema.json | 1 + docs/api/delete-notification.StatusCodes.json | 1 + docs/api/delete-notification.api.mdx | 74 ++-- docs/api/delete-policy.ParamsDetails.json | 1 + docs/api/delete-policy.RequestSchema.json | 1 + docs/api/delete-policy.StatusCodes.json | 1 + docs/api/delete-policy.api.mdx | 73 ++-- .../delete-profile-backup.ParamsDetails.json | 1 + .../delete-profile-backup.RequestSchema.json | 1 + .../delete-profile-backup.StatusCodes.json | 1 + docs/api/delete-profile-backup.api.mdx | 135 ++---- docs/api/delete-token.ParamsDetails.json | 1 + docs/api/delete-token.RequestSchema.json | 1 + docs/api/delete-token.StatusCodes.json | 1 + docs/api/delete-token.api.mdx | 74 ++-- docs/api/delete-user.ParamsDetails.json | 1 + docs/api/delete-user.RequestSchema.json | 1 + docs/api/delete-user.StatusCodes.json | 1 + docs/api/delete-user.api.mdx | 67 +-- docs/api/delete-widget.ParamsDetails.json | 1 + docs/api/delete-widget.RequestSchema.json | 1 + docs/api/delete-widget.StatusCodes.json | 1 + docs/api/delete-widget.api.mdx | 69 +-- .../api/device-data-amount.ParamsDetails.json | 1 + .../api/device-data-amount.RequestSchema.json | 1 + docs/api/device-data-amount.StatusCodes.json | 1 + docs/api/device-data-amount.api.mdx | 63 ++- .../api/device-information.ParamsDetails.json | 1 + .../api/device-information.RequestSchema.json | 1 + docs/api/device-information.StatusCodes.json | 1 + docs/api/device-information.api.mdx | 101 ++--- ...download-profile-backup.ParamsDetails.json | 1 + ...download-profile-backup.RequestSchema.json | 1 + .../download-profile-backup.StatusCodes.json | 1 + docs/api/download-profile-backup.api.mdx | 162 ++----- .../duplicate-dashboard.ParamsDetails.json | 1 + .../duplicate-dashboard.RequestSchema.json | 1 + docs/api/duplicate-dashboard.StatusCodes.json | 1 + docs/api/duplicate-dashboard.api.mdx | 132 ++---- docs/api/edit-a-file.RequestSchema.json | 1 + docs/api/edit-a-file.StatusCodes.json | 1 + docs/api/edit-a-file.api.mdx | 83 ++-- docs/api/edit-account.RequestSchema.json | 1 + docs/api/edit-account.StatusCodes.json | 1 + docs/api/edit-account.api.mdx | 120 ++--- docs/api/edit-dashboard.ParamsDetails.json | 1 + docs/api/edit-dashboard.RequestSchema.json | 1 + docs/api/edit-dashboard.StatusCodes.json | 1 + docs/api/edit-dashboard.api.mdx | 224 ++-------- docs/api/edit-data.RequestSchema.json | 1 + docs/api/edit-data.StatusCodes.json | 1 + docs/api/edit-data.api.mdx | 93 ++-- ...configuration-parameter.ParamsDetails.json | 1 + ...configuration-parameter.RequestSchema.json | 1 + ...e-configuration-parameter.StatusCodes.json | 1 + ...dit-device-configuration-parameter.api.mdx | 97 ++--- docs/api/edit-device-data.ParamsDetails.json | 1 + docs/api/edit-device-data.RequestSchema.json | 1 + docs/api/edit-device-data.StatusCodes.json | 1 + docs/api/edit-device-data.api.mdx | 87 ++-- docs/api/edit-device.ParamsDetails.json | 1 + docs/api/edit-device.RequestSchema.json | 1 + docs/api/edit-device.StatusCodes.json | 1 + docs/api/edit-device.api.mdx | 114 ++--- docs/api/edit-entity-data.ParamsDetails.json | 1 + docs/api/edit-entity-data.RequestSchema.json | 1 + docs/api/edit-entity-data.StatusCodes.json | 1 + docs/api/edit-entity-data.api.mdx | 81 ++-- docs/api/edit-notification.ParamsDetails.json | 1 + docs/api/edit-notification.RequestSchema.json | 1 + docs/api/edit-notification.StatusCodes.json | 1 + docs/api/edit-notification.api.mdx | 87 ++-- docs/api/edit-permission.RequestSchema.json | 1 + docs/api/edit-permission.StatusCodes.json | 1 + docs/api/edit-permission.api.mdx | 83 ++-- docs/api/edit-settings.RequestSchema.json | 1 + docs/api/edit-settings.StatusCodes.json | 1 + docs/api/edit-settings.api.mdx | 80 ++-- docs/api/edit-user.ParamsDetails.json | 1 + docs/api/edit-user.RequestSchema.json | 1 + docs/api/edit-user.StatusCodes.json | 1 + docs/api/edit-user.api.mdx | 105 ++--- docs/api/edit-widget.ParamsDetails.json | 1 + docs/api/edit-widget.RequestSchema.json | 1 + docs/api/edit-widget.StatusCodes.json | 1 + docs/api/edit-widget.api.mdx | 145 ++----- .../empty-a-device-s-data.ParamsDetails.json | 1 + .../empty-a-device-s-data.RequestSchema.json | 1 + .../empty-a-device-s-data.StatusCodes.json | 1 + docs/api/empty-a-device-s-data.api.mdx | 66 +-- ...a-chunk-as-csv-to-files.ParamsDetails.json | 1 + ...a-chunk-as-csv-to-files.RequestSchema.json | 1 + ...t-a-chunk-as-csv-to-files.StatusCodes.json | 1 + .../export-a-chunk-as-csv-to-files.api.mdx | 94 ++-- ...rt-data-to-csv-in-files.ParamsDetails.json | 1 + ...rt-data-to-csv-in-files.RequestSchema.json | 1 + ...port-data-to-csv-in-files.StatusCodes.json | 1 + docs/api/export-data-to-csv-in-files.api.mdx | 93 ++-- .../api/export-entity-data.ParamsDetails.json | 1 + .../api/export-entity-data.RequestSchema.json | 1 + docs/api/export-entity-data.StatusCodes.json | 1 + docs/api/export-entity-data.api.mdx | 86 ++-- docs/api/file-copy.RequestSchema.json | 1 + docs/api/file-copy.StatusCodes.json | 1 + docs/api/file-copy.api.mdx | 83 ++-- .../generate-profile-token.RequestSchema.json | 1 + .../generate-profile-token.StatusCodes.json | 1 + docs/api/generate-profile-token.api.mdx | 100 ++--- .../generate-public-token.ParamsDetails.json | 1 + .../generate-public-token.RequestSchema.json | 1 + .../generate-public-token.StatusCodes.json | 1 + docs/api/generate-public-token.api.mdx | 86 ++-- docs/api/generate-token.ParamsDetails.json | 1 + docs/api/generate-token.RequestSchema.json | 1 + docs/api/generate-token.StatusCodes.json | 1 + docs/api/generate-token.api.mdx | 80 ++-- .../get-a-profile-details.ParamsDetails.json | 1 + .../get-a-profile-details.RequestSchema.json | 1 + .../get-a-profile-details.StatusCodes.json | 1 + docs/api/get-a-profile-details.api.mdx | 121 ++---- ...et-a-profile-statistics.ParamsDetails.json | 1 + ...et-a-profile-statistics.RequestSchema.json | 1 + .../get-a-profile-statistics.StatusCodes.json | 1 + docs/api/get-a-profile-statistics.api.mdx | 331 ++------------ .../get-a-profile-summary.ParamsDetails.json | 1 + .../get-a-profile-summary.RequestSchema.json | 1 + .../get-a-profile-summary.StatusCodes.json | 1 + docs/api/get-a-profile-summary.api.mdx | 191 ++------ ...get-account-information.RequestSchema.json | 1 + .../get-account-information.StatusCodes.json | 1 + docs/api/get-account-information.api.mdx | 121 ++---- ...nt-resources-allocation.RequestSchema.json | 1 + ...ount-resources-allocation.StatusCodes.json | 1 + .../get-account-resources-allocation.api.mdx | 163 ++----- ...onfiguration-parameters.ParamsDetails.json | 1 + ...onfiguration-parameters.RequestSchema.json | 1 + ...-configuration-parameters.StatusCodes.json | 1 + docs/api/get-configuration-parameters.api.mdx | 83 ++-- docs/api/get-data.ParamsDetails.json | 1 + docs/api/get-data.RequestSchema.json | 1 + docs/api/get-data.StatusCodes.json | 1 + docs/api/get-data.api.mdx | 173 ++------ docs/api/get-device-data.ParamsDetails.json | 1 + docs/api/get-device-data.RequestSchema.json | 1 + docs/api/get-device-data.StatusCodes.json | 1 + docs/api/get-device-data.api.mdx | 385 ++-------------- ...al-number-authorization.ParamsDetails.json | 1 + ...al-number-authorization.RequestSchema.json | 1 + ...rial-number-authorization.StatusCodes.json | 1 + ...n-with-serial-number-authorization.api.mdx | 75 ++-- ...oken-with-serial-number.ParamsDetails.json | 1 + ...oken-with-serial-number.RequestSchema.json | 1 + ...-token-with-serial-number.StatusCodes.json | 1 + ...et-device-token-with-serial-number.api.mdx | 65 +-- .../get-dictionary-details.ParamsDetails.json | 1 + .../get-dictionary-details.RequestSchema.json | 1 + .../get-dictionary-details.StatusCodes.json | 1 + docs/api/get-dictionary-details.api.mdx | 96 ++-- ...ionary-language-details.ParamsDetails.json | 1 + ...ionary-language-details.RequestSchema.json | 1 + ...ctionary-language-details.StatusCodes.json | 1 + .../get-dictionary-language-details.api.mdx | 75 ++-- .../get-dictionary-list.RequestSchema.json | 1 + docs/api/get-dictionary-list.StatusCodes.json | 1 + docs/api/get-dictionary-list.api.mdx | 99 ++--- .../get-entity-data-amount.ParamsDetails.json | 1 + .../get-entity-data-amount.RequestSchema.json | 1 + .../get-entity-data-amount.StatusCodes.json | 1 + docs/api/get-entity-data-amount.api.mdx | 64 +-- docs/api/get-entity-data.ParamsDetails.json | 1 + docs/api/get-entity-data.RequestSchema.json | 1 + docs/api/get-entity-data.StatusCodes.json | 1 + docs/api/get-entity-data.api.mdx | 172 ++------ docs/api/get-entity-info.ParamsDetails.json | 1 + docs/api/get-entity-info.RequestSchema.json | 1 + docs/api/get-entity-info.StatusCodes.json | 1 + docs/api/get-entity-info.api.mdx | 207 ++------- docs/api/get-information.ParamsDetails.json | 1 + docs/api/get-information.RequestSchema.json | 1 + docs/api/get-information.StatusCodes.json | 1 + docs/api/get-information.api.mdx | 232 ++-------- docs/api/get-policy-list.ParamsDetails.json | 1 + docs/api/get-policy-list.RequestSchema.json | 1 + docs/api/get-policy-list.StatusCodes.json | 1 + docs/api/get-policy-list.api.mdx | 81 ++-- .../get-profile-file-list.ParamsDetails.json | 1 + .../get-profile-file-list.RequestSchema.json | 1 + .../get-profile-file-list.StatusCodes.json | 1 + docs/api/get-profile-file-list.api.mdx | 119 ++--- docs/api/get-run-settings.RequestSchema.json | 1 + docs/api/get-run-settings.StatusCodes.json | 1 + docs/api/get-run-settings.api.mdx | 410 ++---------------- docs/api/get-tags.ParamsDetails.json | 1 + docs/api/get-tags.RequestSchema.json | 1 + docs/api/get-tags.StatusCodes.json | 1 + docs/api/get-tags.api.mdx | 90 ++-- .../get-the-account-plan.RequestSchema.json | 1 + .../api/get-the-account-plan.StatusCodes.json | 1 + docs/api/get-the-account-plan.api.mdx | 57 ++- docs/api/get-widget-data.ParamsDetails.json | 1 + docs/api/get-widget-data.RequestSchema.json | 1 + docs/api/get-widget-data.StatusCodes.json | 1 + docs/api/get-widget-data.api.mdx | 290 ++----------- .../get-widget-information.ParamsDetails.json | 1 + .../get-widget-information.RequestSchema.json | 1 + .../get-widget-information.StatusCodes.json | 1 + docs/api/get-widget-information.api.mdx | 171 ++------ ...ata-from-a-csv-in-files.ParamsDetails.json | 1 + ...ata-from-a-csv-in-files.RequestSchema.json | 1 + ...-data-from-a-csv-in-files.StatusCodes.json | 1 + .../import-data-from-a-csv-in-files.api.mdx | 77 ++-- ...is-related-to-dashboard.ParamsDetails.json | 1 + ...is-related-to-dashboard.RequestSchema.json | 1 + ...ysis-related-to-dashboard.StatusCodes.json | 1 + ...list-analysis-related-to-dashboard.api.mdx | 85 ++-- docs/api/list-dashboards.ParamsDetails.json | 1 + docs/api/list-dashboards.RequestSchema.json | 1 + docs/api/list-dashboards.StatusCodes.json | 1 + docs/api/list-dashboards.api.mdx | 157 ++----- .../api/list-device-params.ParamsDetails.json | 1 + .../api/list-device-params.RequestSchema.json | 1 + docs/api/list-device-params.StatusCodes.json | 1 + docs/api/list-device-params.api.mdx | 88 ++-- ...es-related-to-dashboard.ParamsDetails.json | 1 + ...es-related-to-dashboard.RequestSchema.json | 1 + ...ices-related-to-dashboard.StatusCodes.json | 1 + .../list-devices-related-to-dashboard.api.mdx | 100 ++--- docs/api/list-entities.ParamsDetails.json | 1 + docs/api/list-entities.RequestSchema.json | 1 + docs/api/list-entities.StatusCodes.json | 1 + docs/api/list-entities.api.mdx | 121 ++---- docs/api/list-of-chunks.ParamsDetails.json | 1 + docs/api/list-of-chunks.RequestSchema.json | 1 + docs/api/list-of-chunks.StatusCodes.json | 1 + docs/api/list-of-chunks.api.mdx | 109 ++--- docs/api/list-of-devices.ParamsDetails.json | 1 + docs/api/list-of-devices.RequestSchema.json | 1 + docs/api/list-of-devices.StatusCodes.json | 1 + docs/api/list-of-devices.api.mdx | 191 ++------ .../list-of-notifications.ParamsDetails.json | 1 + .../list-of-notifications.RequestSchema.json | 1 + .../list-of-notifications.StatusCodes.json | 1 + docs/api/list-of-notifications.api.mdx | 104 ++--- docs/api/list-of-tokens.ParamsDetails.json | 1 + docs/api/list-of-tokens.RequestSchema.json | 1 + docs/api/list-of-tokens.StatusCodes.json | 1 + docs/api/list-of-tokens.api.mdx | 48 +- .../list-profile-backups.ParamsDetails.json | 1 + .../list-profile-backups.RequestSchema.json | 1 + .../api/list-profile-backups.StatusCodes.json | 1 + docs/api/list-profile-backups.api.mdx | 139 ++---- docs/api/list-users.ParamsDetails.json | 1 + docs/api/list-users.RequestSchema.json | 1 + docs/api/list-users.StatusCodes.json | 1 + docs/api/list-users.api.mdx | 210 ++------- docs/api/login-as-user.ParamsDetails.json | 1 + docs/api/login-as-user.RequestSchema.json | 1 + docs/api/login-as-user.StatusCodes.json | 1 + docs/api/login-as-user.api.mdx | 81 ++-- docs/api/login-to-account.RequestSchema.json | 1 + docs/api/login-to-account.StatusCodes.json | 1 + docs/api/login-to-account.api.mdx | 110 ++--- ...ation-parameter-as-read.ParamsDetails.json | 1 + ...ation-parameter-as-read.RequestSchema.json | 1 + ...uration-parameter-as-read.StatusCodes.json | 1 + ...-a-configuration-parameter-as-read.api.mdx | 69 +-- .../send-data-to-device.ParamsDetails.json | 1 + .../send-data-to-device.RequestSchema.json | 1 + docs/api/send-data-to-device.StatusCodes.json | 1 + docs/api/send-data-to-device.api.mdx | 193 ++------- ...send-data-using-network.ParamsDetails.json | 1 + ...send-data-using-network.RequestSchema.json | 1 + .../send-data-using-network.StatusCodes.json | 1 + docs/api/send-data-using-network.api.mdx | 121 ++---- docs/api/send-data.RequestSchema.json | 1 + docs/api/send-data.StatusCodes.json | 1 + docs/api/send-data.api.mdx | 185 ++------ docs/api/tagoio-api.info.mdx | 33 +- .../test-profile-service.ParamsDetails.json | 1 + .../test-profile-service.RequestSchema.json | 1 + .../api/test-profile-service.StatusCodes.json | 1 + docs/api/test-profile-service.api.mdx | 173 ++------ ...ate-dictionary-language.ParamsDetails.json | 1 + ...ate-dictionary-language.RequestSchema.json | 1 + ...pdate-dictionary-language.StatusCodes.json | 1 + docs/api/update-dictionary-language.api.mdx | 90 ++-- docs/api/update-dictionary.ParamsDetails.json | 1 + docs/api/update-dictionary.RequestSchema.json | 1 + docs/api/update-dictionary.StatusCodes.json | 1 + docs/api/update-dictionary.api.mdx | 110 ++--- .../update-entity-schema.ParamsDetails.json | 1 + .../update-entity-schema.RequestSchema.json | 1 + .../api/update-entity-schema.StatusCodes.json | 1 + docs/api/update-entity-schema.api.mdx | 87 ++-- docs/api/update-entity.ParamsDetails.json | 1 + docs/api/update-entity.RequestSchema.json | 1 + docs/api/update-entity.StatusCodes.json | 1 + docs/api/update-entity.api.mdx | 95 ++-- docs/api/update-policy.ParamsDetails.json | 1 + docs/api/update-policy.RequestSchema.json | 1 + docs/api/update-policy.StatusCodes.json | 1 + docs/api/update-policy.api.mdx | 135 ++---- ...nt-resources-allocation.RequestSchema.json | 1 + ...ount-resources-allocation.StatusCodes.json | 1 + ...e-the-account-resources-allocation.api.mdx | 174 ++------ docs/api/upload-file-part.RequestSchema.json | 1 + docs/api/upload-file-part.StatusCodes.json | 1 + docs/api/upload-file-part.api.mdx | 196 ++------- docs/api/user-information.ParamsDetails.json | 1 + docs/api/user-information.RequestSchema.json | 1 + docs/api/user-information.StatusCodes.json | 1 + docs/api/user-information.api.mdx | 132 ++---- 403 files changed, 4469 insertions(+), 8903 deletions(-) create mode 100644 docs/api/add-entity-data.ParamsDetails.json create mode 100644 docs/api/add-entity-data.RequestSchema.json create mode 100644 docs/api/add-entity-data.StatusCodes.json create mode 100644 docs/api/configure-profile-service.ParamsDetails.json create mode 100644 docs/api/configure-profile-service.RequestSchema.json create mode 100644 docs/api/configure-profile-service.StatusCodes.json create mode 100644 docs/api/convert-device-type.ParamsDetails.json create mode 100644 docs/api/convert-device-type.RequestSchema.json create mode 100644 docs/api/convert-device-type.StatusCodes.json create mode 100644 docs/api/create-and-edit-device-params.ParamsDetails.json create mode 100644 docs/api/create-and-edit-device-params.RequestSchema.json create mode 100644 docs/api/create-and-edit-device-params.StatusCodes.json create mode 100644 docs/api/create-dashboard-widget.ParamsDetails.json create mode 100644 docs/api/create-dashboard-widget.RequestSchema.json create mode 100644 docs/api/create-dashboard-widget.StatusCodes.json create mode 100644 docs/api/create-dashboard.RequestSchema.json create mode 100644 docs/api/create-dashboard.StatusCodes.json create mode 100644 docs/api/create-dictionary.RequestSchema.json create mode 100644 docs/api/create-dictionary.StatusCodes.json create mode 100644 docs/api/create-entity.RequestSchema.json create mode 100644 docs/api/create-entity.StatusCodes.json create mode 100644 docs/api/create-new-device.RequestSchema.json create mode 100644 docs/api/create-new-device.StatusCodes.json create mode 100644 docs/api/create-notification.RequestSchema.json create mode 100644 docs/api/create-notification.StatusCodes.json create mode 100644 docs/api/create-policy.RequestSchema.json create mode 100644 docs/api/create-policy.StatusCodes.json create mode 100644 docs/api/create-profile-backup.ParamsDetails.json create mode 100644 docs/api/create-profile-backup.RequestSchema.json create mode 100644 docs/api/create-profile-backup.StatusCodes.json create mode 100644 docs/api/create-token.RequestSchema.json create mode 100644 docs/api/create-token.StatusCodes.json create mode 100644 docs/api/create-user.RequestSchema.json create mode 100644 docs/api/create-user.StatusCodes.json create mode 100644 docs/api/current-device-information.RequestSchema.json create mode 100644 docs/api/current-device-information.StatusCodes.json create mode 100644 docs/api/delete-a-file.RequestSchema.json create mode 100644 docs/api/delete-a-file.StatusCodes.json create mode 100644 docs/api/delete-chunk.ParamsDetails.json create mode 100644 docs/api/delete-chunk.RequestSchema.json create mode 100644 docs/api/delete-chunk.StatusCodes.json create mode 100644 docs/api/delete-dashboard.ParamsDetails.json create mode 100644 docs/api/delete-dashboard.RequestSchema.json create mode 100644 docs/api/delete-dashboard.StatusCodes.json create mode 100644 docs/api/delete-data.ParamsDetails.json create mode 100644 docs/api/delete-data.RequestSchema.json create mode 100644 docs/api/delete-data.StatusCodes.json create mode 100644 docs/api/delete-device-data.ParamsDetails.json create mode 100644 docs/api/delete-device-data.RequestSchema.json create mode 100644 docs/api/delete-device-data.StatusCodes.json create mode 100644 docs/api/delete-device-param.ParamsDetails.json create mode 100644 docs/api/delete-device-param.RequestSchema.json create mode 100644 docs/api/delete-device-param.StatusCodes.json create mode 100644 docs/api/delete-device.ParamsDetails.json create mode 100644 docs/api/delete-device.RequestSchema.json create mode 100644 docs/api/delete-device.StatusCodes.json create mode 100644 docs/api/delete-dictionary.ParamsDetails.json create mode 100644 docs/api/delete-dictionary.RequestSchema.json create mode 100644 docs/api/delete-dictionary.StatusCodes.json create mode 100644 docs/api/delete-entity-data.ParamsDetails.json create mode 100644 docs/api/delete-entity-data.RequestSchema.json create mode 100644 docs/api/delete-entity-data.StatusCodes.json create mode 100644 docs/api/delete-entity.ParamsDetails.json create mode 100644 docs/api/delete-entity.RequestSchema.json create mode 100644 docs/api/delete-entity.StatusCodes.json create mode 100644 docs/api/delete-notification.ParamsDetails.json create mode 100644 docs/api/delete-notification.RequestSchema.json create mode 100644 docs/api/delete-notification.StatusCodes.json create mode 100644 docs/api/delete-policy.ParamsDetails.json create mode 100644 docs/api/delete-policy.RequestSchema.json create mode 100644 docs/api/delete-policy.StatusCodes.json create mode 100644 docs/api/delete-profile-backup.ParamsDetails.json create mode 100644 docs/api/delete-profile-backup.RequestSchema.json create mode 100644 docs/api/delete-profile-backup.StatusCodes.json create mode 100644 docs/api/delete-token.ParamsDetails.json create mode 100644 docs/api/delete-token.RequestSchema.json create mode 100644 docs/api/delete-token.StatusCodes.json create mode 100644 docs/api/delete-user.ParamsDetails.json create mode 100644 docs/api/delete-user.RequestSchema.json create mode 100644 docs/api/delete-user.StatusCodes.json create mode 100644 docs/api/delete-widget.ParamsDetails.json create mode 100644 docs/api/delete-widget.RequestSchema.json create mode 100644 docs/api/delete-widget.StatusCodes.json create mode 100644 docs/api/device-data-amount.ParamsDetails.json create mode 100644 docs/api/device-data-amount.RequestSchema.json create mode 100644 docs/api/device-data-amount.StatusCodes.json create mode 100644 docs/api/device-information.ParamsDetails.json create mode 100644 docs/api/device-information.RequestSchema.json create mode 100644 docs/api/device-information.StatusCodes.json create mode 100644 docs/api/download-profile-backup.ParamsDetails.json create mode 100644 docs/api/download-profile-backup.RequestSchema.json create mode 100644 docs/api/download-profile-backup.StatusCodes.json create mode 100644 docs/api/duplicate-dashboard.ParamsDetails.json create mode 100644 docs/api/duplicate-dashboard.RequestSchema.json create mode 100644 docs/api/duplicate-dashboard.StatusCodes.json create mode 100644 docs/api/edit-a-file.RequestSchema.json create mode 100644 docs/api/edit-a-file.StatusCodes.json create mode 100644 docs/api/edit-account.RequestSchema.json create mode 100644 docs/api/edit-account.StatusCodes.json create mode 100644 docs/api/edit-dashboard.ParamsDetails.json create mode 100644 docs/api/edit-dashboard.RequestSchema.json create mode 100644 docs/api/edit-dashboard.StatusCodes.json create mode 100644 docs/api/edit-data.RequestSchema.json create mode 100644 docs/api/edit-data.StatusCodes.json create mode 100644 docs/api/edit-device-configuration-parameter.ParamsDetails.json create mode 100644 docs/api/edit-device-configuration-parameter.RequestSchema.json create mode 100644 docs/api/edit-device-configuration-parameter.StatusCodes.json create mode 100644 docs/api/edit-device-data.ParamsDetails.json create mode 100644 docs/api/edit-device-data.RequestSchema.json create mode 100644 docs/api/edit-device-data.StatusCodes.json create mode 100644 docs/api/edit-device.ParamsDetails.json create mode 100644 docs/api/edit-device.RequestSchema.json create mode 100644 docs/api/edit-device.StatusCodes.json create mode 100644 docs/api/edit-entity-data.ParamsDetails.json create mode 100644 docs/api/edit-entity-data.RequestSchema.json create mode 100644 docs/api/edit-entity-data.StatusCodes.json create mode 100644 docs/api/edit-notification.ParamsDetails.json create mode 100644 docs/api/edit-notification.RequestSchema.json create mode 100644 docs/api/edit-notification.StatusCodes.json create mode 100644 docs/api/edit-permission.RequestSchema.json create mode 100644 docs/api/edit-permission.StatusCodes.json create mode 100644 docs/api/edit-settings.RequestSchema.json create mode 100644 docs/api/edit-settings.StatusCodes.json create mode 100644 docs/api/edit-user.ParamsDetails.json create mode 100644 docs/api/edit-user.RequestSchema.json create mode 100644 docs/api/edit-user.StatusCodes.json create mode 100644 docs/api/edit-widget.ParamsDetails.json create mode 100644 docs/api/edit-widget.RequestSchema.json create mode 100644 docs/api/edit-widget.StatusCodes.json create mode 100644 docs/api/empty-a-device-s-data.ParamsDetails.json create mode 100644 docs/api/empty-a-device-s-data.RequestSchema.json create mode 100644 docs/api/empty-a-device-s-data.StatusCodes.json create mode 100644 docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json create mode 100644 docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json create mode 100644 docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json create mode 100644 docs/api/export-data-to-csv-in-files.ParamsDetails.json create mode 100644 docs/api/export-data-to-csv-in-files.RequestSchema.json create mode 100644 docs/api/export-data-to-csv-in-files.StatusCodes.json create mode 100644 docs/api/export-entity-data.ParamsDetails.json create mode 100644 docs/api/export-entity-data.RequestSchema.json create mode 100644 docs/api/export-entity-data.StatusCodes.json create mode 100644 docs/api/file-copy.RequestSchema.json create mode 100644 docs/api/file-copy.StatusCodes.json create mode 100644 docs/api/generate-profile-token.RequestSchema.json create mode 100644 docs/api/generate-profile-token.StatusCodes.json create mode 100644 docs/api/generate-public-token.ParamsDetails.json create mode 100644 docs/api/generate-public-token.RequestSchema.json create mode 100644 docs/api/generate-public-token.StatusCodes.json create mode 100644 docs/api/generate-token.ParamsDetails.json create mode 100644 docs/api/generate-token.RequestSchema.json create mode 100644 docs/api/generate-token.StatusCodes.json create mode 100644 docs/api/get-a-profile-details.ParamsDetails.json create mode 100644 docs/api/get-a-profile-details.RequestSchema.json create mode 100644 docs/api/get-a-profile-details.StatusCodes.json create mode 100644 docs/api/get-a-profile-statistics.ParamsDetails.json create mode 100644 docs/api/get-a-profile-statistics.RequestSchema.json create mode 100644 docs/api/get-a-profile-statistics.StatusCodes.json create mode 100644 docs/api/get-a-profile-summary.ParamsDetails.json create mode 100644 docs/api/get-a-profile-summary.RequestSchema.json create mode 100644 docs/api/get-a-profile-summary.StatusCodes.json create mode 100644 docs/api/get-account-information.RequestSchema.json create mode 100644 docs/api/get-account-information.StatusCodes.json create mode 100644 docs/api/get-account-resources-allocation.RequestSchema.json create mode 100644 docs/api/get-account-resources-allocation.StatusCodes.json create mode 100644 docs/api/get-configuration-parameters.ParamsDetails.json create mode 100644 docs/api/get-configuration-parameters.RequestSchema.json create mode 100644 docs/api/get-configuration-parameters.StatusCodes.json create mode 100644 docs/api/get-data.ParamsDetails.json create mode 100644 docs/api/get-data.RequestSchema.json create mode 100644 docs/api/get-data.StatusCodes.json create mode 100644 docs/api/get-device-data.ParamsDetails.json create mode 100644 docs/api/get-device-data.RequestSchema.json create mode 100644 docs/api/get-device-data.StatusCodes.json create mode 100644 docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json create mode 100644 docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json create mode 100644 docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json create mode 100644 docs/api/get-device-token-with-serial-number.ParamsDetails.json create mode 100644 docs/api/get-device-token-with-serial-number.RequestSchema.json create mode 100644 docs/api/get-device-token-with-serial-number.StatusCodes.json create mode 100644 docs/api/get-dictionary-details.ParamsDetails.json create mode 100644 docs/api/get-dictionary-details.RequestSchema.json create mode 100644 docs/api/get-dictionary-details.StatusCodes.json create mode 100644 docs/api/get-dictionary-language-details.ParamsDetails.json create mode 100644 docs/api/get-dictionary-language-details.RequestSchema.json create mode 100644 docs/api/get-dictionary-language-details.StatusCodes.json create mode 100644 docs/api/get-dictionary-list.RequestSchema.json create mode 100644 docs/api/get-dictionary-list.StatusCodes.json create mode 100644 docs/api/get-entity-data-amount.ParamsDetails.json create mode 100644 docs/api/get-entity-data-amount.RequestSchema.json create mode 100644 docs/api/get-entity-data-amount.StatusCodes.json create mode 100644 docs/api/get-entity-data.ParamsDetails.json create mode 100644 docs/api/get-entity-data.RequestSchema.json create mode 100644 docs/api/get-entity-data.StatusCodes.json create mode 100644 docs/api/get-entity-info.ParamsDetails.json create mode 100644 docs/api/get-entity-info.RequestSchema.json create mode 100644 docs/api/get-entity-info.StatusCodes.json create mode 100644 docs/api/get-information.ParamsDetails.json create mode 100644 docs/api/get-information.RequestSchema.json create mode 100644 docs/api/get-information.StatusCodes.json create mode 100644 docs/api/get-policy-list.ParamsDetails.json create mode 100644 docs/api/get-policy-list.RequestSchema.json create mode 100644 docs/api/get-policy-list.StatusCodes.json create mode 100644 docs/api/get-profile-file-list.ParamsDetails.json create mode 100644 docs/api/get-profile-file-list.RequestSchema.json create mode 100644 docs/api/get-profile-file-list.StatusCodes.json create mode 100644 docs/api/get-run-settings.RequestSchema.json create mode 100644 docs/api/get-run-settings.StatusCodes.json create mode 100644 docs/api/get-tags.ParamsDetails.json create mode 100644 docs/api/get-tags.RequestSchema.json create mode 100644 docs/api/get-tags.StatusCodes.json create mode 100644 docs/api/get-the-account-plan.RequestSchema.json create mode 100644 docs/api/get-the-account-plan.StatusCodes.json create mode 100644 docs/api/get-widget-data.ParamsDetails.json create mode 100644 docs/api/get-widget-data.RequestSchema.json create mode 100644 docs/api/get-widget-data.StatusCodes.json create mode 100644 docs/api/get-widget-information.ParamsDetails.json create mode 100644 docs/api/get-widget-information.RequestSchema.json create mode 100644 docs/api/get-widget-information.StatusCodes.json create mode 100644 docs/api/import-data-from-a-csv-in-files.ParamsDetails.json create mode 100644 docs/api/import-data-from-a-csv-in-files.RequestSchema.json create mode 100644 docs/api/import-data-from-a-csv-in-files.StatusCodes.json create mode 100644 docs/api/list-analysis-related-to-dashboard.ParamsDetails.json create mode 100644 docs/api/list-analysis-related-to-dashboard.RequestSchema.json create mode 100644 docs/api/list-analysis-related-to-dashboard.StatusCodes.json create mode 100644 docs/api/list-dashboards.ParamsDetails.json create mode 100644 docs/api/list-dashboards.RequestSchema.json create mode 100644 docs/api/list-dashboards.StatusCodes.json create mode 100644 docs/api/list-device-params.ParamsDetails.json create mode 100644 docs/api/list-device-params.RequestSchema.json create mode 100644 docs/api/list-device-params.StatusCodes.json create mode 100644 docs/api/list-devices-related-to-dashboard.ParamsDetails.json create mode 100644 docs/api/list-devices-related-to-dashboard.RequestSchema.json create mode 100644 docs/api/list-devices-related-to-dashboard.StatusCodes.json create mode 100644 docs/api/list-entities.ParamsDetails.json create mode 100644 docs/api/list-entities.RequestSchema.json create mode 100644 docs/api/list-entities.StatusCodes.json create mode 100644 docs/api/list-of-chunks.ParamsDetails.json create mode 100644 docs/api/list-of-chunks.RequestSchema.json create mode 100644 docs/api/list-of-chunks.StatusCodes.json create mode 100644 docs/api/list-of-devices.ParamsDetails.json create mode 100644 docs/api/list-of-devices.RequestSchema.json create mode 100644 docs/api/list-of-devices.StatusCodes.json create mode 100644 docs/api/list-of-notifications.ParamsDetails.json create mode 100644 docs/api/list-of-notifications.RequestSchema.json create mode 100644 docs/api/list-of-notifications.StatusCodes.json create mode 100644 docs/api/list-of-tokens.ParamsDetails.json create mode 100644 docs/api/list-of-tokens.RequestSchema.json create mode 100644 docs/api/list-of-tokens.StatusCodes.json create mode 100644 docs/api/list-profile-backups.ParamsDetails.json create mode 100644 docs/api/list-profile-backups.RequestSchema.json create mode 100644 docs/api/list-profile-backups.StatusCodes.json create mode 100644 docs/api/list-users.ParamsDetails.json create mode 100644 docs/api/list-users.RequestSchema.json create mode 100644 docs/api/list-users.StatusCodes.json create mode 100644 docs/api/login-as-user.ParamsDetails.json create mode 100644 docs/api/login-as-user.RequestSchema.json create mode 100644 docs/api/login-as-user.StatusCodes.json create mode 100644 docs/api/login-to-account.RequestSchema.json create mode 100644 docs/api/login-to-account.StatusCodes.json create mode 100644 docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json create mode 100644 docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json create mode 100644 docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json create mode 100644 docs/api/send-data-to-device.ParamsDetails.json create mode 100644 docs/api/send-data-to-device.RequestSchema.json create mode 100644 docs/api/send-data-to-device.StatusCodes.json create mode 100644 docs/api/send-data-using-network.ParamsDetails.json create mode 100644 docs/api/send-data-using-network.RequestSchema.json create mode 100644 docs/api/send-data-using-network.StatusCodes.json create mode 100644 docs/api/send-data.RequestSchema.json create mode 100644 docs/api/send-data.StatusCodes.json create mode 100644 docs/api/test-profile-service.ParamsDetails.json create mode 100644 docs/api/test-profile-service.RequestSchema.json create mode 100644 docs/api/test-profile-service.StatusCodes.json create mode 100644 docs/api/update-dictionary-language.ParamsDetails.json create mode 100644 docs/api/update-dictionary-language.RequestSchema.json create mode 100644 docs/api/update-dictionary-language.StatusCodes.json create mode 100644 docs/api/update-dictionary.ParamsDetails.json create mode 100644 docs/api/update-dictionary.RequestSchema.json create mode 100644 docs/api/update-dictionary.StatusCodes.json create mode 100644 docs/api/update-entity-schema.ParamsDetails.json create mode 100644 docs/api/update-entity-schema.RequestSchema.json create mode 100644 docs/api/update-entity-schema.StatusCodes.json create mode 100644 docs/api/update-entity.ParamsDetails.json create mode 100644 docs/api/update-entity.RequestSchema.json create mode 100644 docs/api/update-entity.StatusCodes.json create mode 100644 docs/api/update-policy.ParamsDetails.json create mode 100644 docs/api/update-policy.RequestSchema.json create mode 100644 docs/api/update-policy.StatusCodes.json create mode 100644 docs/api/update-the-account-resources-allocation.RequestSchema.json create mode 100644 docs/api/update-the-account-resources-allocation.StatusCodes.json create mode 100644 docs/api/upload-file-part.RequestSchema.json create mode 100644 docs/api/upload-file-part.StatusCodes.json create mode 100644 docs/api/user-information.ParamsDetails.json create mode 100644 docs/api/user-information.RequestSchema.json create mode 100644 docs/api/user-information.StatusCodes.json diff --git a/docs/api/add-entity-data.ParamsDetails.json b/docs/api/add-entity-data.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/add-entity-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/add-entity-data.RequestSchema.json b/docs/api/add-entity-data.RequestSchema.json new file mode 100644 index 00000000..77f95745 --- /dev/null +++ b/docs/api/add-entity-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"monthly_revenue":{"type":"number","example":2345.34},"update_date":{"type":"string","example":"2024-11-01T03:00:00.000Z"}}},"examples":{"Add Entity Data":{"value":{"monthly_revenue":2345.34,"update_date":"2024-11-01T03:00:00.000Z"}}}}}}} \ No newline at end of file diff --git a/docs/api/add-entity-data.StatusCodes.json b/docs/api/add-entity-data.StatusCodes.json new file mode 100644 index 00000000..c5349a3e --- /dev/null +++ b/docs/api/add-entity-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Add Entity Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Added"},"status":{"type":"boolean","example":true}}},"examples":{"Add Entity Data":{"value":{"result":"1 Data Added","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/add-entity-data.api.mdx b/docs/api/add-entity-data.api.mdx index 5ed86d83..312623a7 100644 --- a/docs/api/add-entity-data.api.mdx +++ b/docs/api/add-entity-data.api.mdx @@ -18,59 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Add Entity Data - + + Request + + {...require("./add-entity-data.ParamsDetails.json")} +> + + + {...require("./add-entity-data.RequestSchema.json")} +> + + + {...require("./add-entity-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/configure-profile-service.ParamsDetails.json b/docs/api/configure-profile-service.ParamsDetails.json new file mode 100644 index 00000000..ec34447e --- /dev/null +++ b/docs/api/configure-profile-service.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"}]} \ No newline at end of file diff --git a/docs/api/configure-profile-service.RequestSchema.json b/docs/api/configure-profile-service.RequestSchema.json new file mode 100644 index 00000000..00540cb0 --- /dev/null +++ b/docs/api/configure-profile-service.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"object","description":"Email service configuration","properties":{"provider":{"type":"string","enum":["sendgrid","ses","smtp"],"description":"The email provider to use","example":"smtp"},"from":{"type":"string","description":"Sender email address","example":"noreply@example.com"},"secrets":{"type":"object","description":"Secret IDs for provider credentials","properties":{"data":{"type":"string","description":"Secret ID containing SMTP configuration (required for SMTP provider) or AWS SQS Secret (required for SES provider)","example":"68c9977a28079e0010aaf399"},"api_key":{"type":"string","description":"Secret ID containing SendGrid API Key (required for SendGrid provider)","example":"68c9977a28079e0010aaf399"}}}}},"sms":{"type":"object","description":"SMS service configuration","properties":{"provider":{"type":"string","enum":["twilio","sns"],"description":"The SMS provider to use","example":"twilio"},"from":{"type":"string","description":"Sender phone number in E.164 format (required for Twilio, optional for SNS)","example":"+15551234567"},"secrets":{"type":"object","description":"Secret IDs for provider credentials","properties":{"twilio_sid":{"type":"string","description":"Secret ID containing Twilio Account SID (required for Twilio provider)","example":"674f1740f9ccd2000aaa4551"},"twilio_token":{"type":"string","description":"Secret ID containing Twilio Auth Token (required for Twilio provider)","example":"674f1736f9ccd2000aaa4550"},"data":{"type":"string","description":"Secret ID containing AWS SQS Secret (required for SNS provider)","example":"68c9977a28079e0010aaf399"}}}}}}},"examples":{"Configure SMS and Email":{"value":{"email":{"provider":"smtp","from":"noreply@example.com","secrets":{"data":"68c9977a28079e0010aaf399"}},"sms":{"provider":"twilio","from":"+15551234567","secrets":{"twilio_sid":"674f1740f9ccd2000aaa4551","twilio_token":"674f1736f9ccd2000aaa4550"}}}},"Configure SMS only":{"value":{"sms":{"provider":"twilio","from":"+15551234567","secrets":{"twilio_sid":"674f1740f9ccd2000aaa4551","twilio_token":"674f1736f9ccd2000aaa4550"}}}},"Configure Email with SendGrid":{"value":{"email":{"provider":"sendgrid","from":"noreply@example.com","secrets":{"api_key":"68c9977a28079e0010aaf399"}}}},"Configure Email with SMTP":{"value":{"email":{"provider":"smtp","from":"noreply@example.com","secrets":{"data":"68c9977a28079e0010aaf399"}}}},"Configure Email with SES":{"value":{"email":{"provider":"ses","from":"noreply@example.com","secrets":{"data":"68c9977a28079e0010aaf399"}}}},"Configure SMS with SNS":{"value":{"sms":{"provider":"sns","secrets":{"data":"68c9977a28079e0010aaf399"}}}}}}}}} \ No newline at end of file diff --git a/docs/api/configure-profile-service.StatusCodes.json b/docs/api/configure-profile-service.StatusCodes.json new file mode 100644 index 00000000..5ccadb6a --- /dev/null +++ b/docs/api/configure-profile-service.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Service provider configured successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Service provider configured successfully"},"status":{"type":"boolean","example":true}}}}}},"400":{"description":"Bad request - Invalid configuration","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid credentials format for the selected provider"}}}}}},"401":{"description":"Unauthorized - Invalid or missing token","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Unauthorized"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"You do not have permission to configure services for this profile"}}}}}}}} \ No newline at end of file diff --git a/docs/api/configure-profile-service.api.mdx b/docs/api/configure-profile-service.api.mdx index 0498a16b..e409d708 100644 --- a/docs/api/configure-profile-service.api.mdx +++ b/docs/api/configure-profile-service.api.mdx @@ -18,237 +18,75 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Configure external service providers for your profile. This allows you to set up integrations with third-party services for SMS and Email messaging. **Available service providers:** -| Service Type | Provider | Description | -| ------------ | -------- | ---------------------------------- | -| `sms` | Twilio | Send SMS messages via Twilio | -| `sms` | SNS | Send SMS messages via Amazon SNS | -| `email` | SendGrid | Send emails via SendGrid API | -| `email` | SES | Send emails via Amazon SES | -| `email` | SMTP | Send emails via custom SMTP server | +| Service Type | Provider | Description | +|--------------|----------|-------------| +| `sms` | Twilio | Send SMS messages via Twilio | +| `sms` | SNS | Send SMS messages via Amazon SNS | +| `email` | SendGrid | Send emails via SendGrid API | +| `email` | SES | Send emails via Amazon SES | +| `email` | SMTP | Send emails via custom SMTP server | **Important notes:** - - Credentials are securely stored using [TagoIO Secrets](/docs/tagoio/getting-started/secrets). You must create the appropriate secrets before configuring a service provider. - Each service type can only have one active provider configuration at a time - Use the test endpoint to verify your configuration before using it in production **Required secrets by provider:** - - **Twilio SMS**: Create two Text secrets containing your Twilio SID and Auth Token - **SNS SMS**: Create an AWS SQS Secret with your AWS credentials (region, access key, secret key) - **SendGrid Email**: Create a Text secret containing your SendGrid API Key - **SES Email**: Create an AWS SQS Secret with your AWS credentials (region, access key, secret key) - **SMTP Email**: Create an SMTP Secret with your server configuration - + + + Request + + {...require("./configure-profile-service.ParamsDetails.json")} +> + + + {...require("./configure-profile-service.RequestSchema.json")} +> + + + {...require("./configure-profile-service.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/convert-device-type.ParamsDetails.json b/docs/api/convert-device-type.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/convert-device-type.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/convert-device-type.RequestSchema.json b/docs/api/convert-device-type.RequestSchema.json new file mode 100644 index 00000000..4d8fb574 --- /dev/null +++ b/docs/api/convert-device-type.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","title":"ConvertDeviceTypeRequest","properties":{"type":{"type":"string","example":"immutable"},"chunk_period":{"type":"string","example":"quarter","description":"Only required when converting to immutable. Defines the period for data chunking (e.g., quarter, month, year)."},"chunk_retention":{"type":"number","example":4,"description":"Only required when converting to immutable. Number of chunk periods to retain."}}},"examples":{"Convert to Immutable":{"value":{"type":"immutable","chunk_period":"quarter","chunk_retention":4}},"Convert to Mutable":{"value":{"type":"mutable"}}}}}}} \ No newline at end of file diff --git a/docs/api/convert-device-type.StatusCodes.json b/docs/api/convert-device-type.StatusCodes.json new file mode 100644 index 00000000..b18b678b --- /dev/null +++ b/docs/api/convert-device-type.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Converting a device type","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Device type/chunk was converted"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/convert-device-type.api.mdx b/docs/api/convert-device-type.api.mdx index 74df3d1f..15ca71fa 100644 --- a/docs/api/convert-device-type.api.mdx +++ b/docs/api/convert-device-type.api.mdx @@ -18,73 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Convert the device immutable or mutable. The device must be empty before being converted. You can empty your device through your device's page. The Device-Token is preserved when converting using this route. The device must be disabled before being converted. You can disable the device by going to the device's page and turn off the active switch. - + + Request + + {...require("./convert-device-type.ParamsDetails.json")} +> + + + {...require("./convert-device-type.RequestSchema.json")} +> + + + {...require("./convert-device-type.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-and-edit-device-params.ParamsDetails.json b/docs/api/create-and-edit-device-params.ParamsDetails.json new file mode 100644 index 00000000..e4d00ef5 --- /dev/null +++ b/docs/api/create-and-edit-device-params.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"(Type your device ID)"}}]} \ No newline at end of file diff --git a/docs/api/create-and-edit-device-params.RequestSchema.json b/docs/api/create-and-edit-device-params.RequestSchema.json new file mode 100644 index 00000000..9b359aa6 --- /dev/null +++ b/docs/api/create-and-edit-device-params.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"62aba74d84acd30011ac593f"},"key":{"type":"string","example":"updatedKey"},"sent":{"type":"boolean","example":false},"value":{"type":"string","example":"updatedValue"}}},"examples":{"Create and Edit Device Params":{"value":{"id":"62aba74d84acd30011ac593f","key":"updatedKey","sent":false,"value":"updatedValue"}}}}}}} \ No newline at end of file diff --git a/docs/api/create-and-edit-device-params.StatusCodes.json b/docs/api/create-and-edit-device-params.StatusCodes.json new file mode 100644 index 00000000..454d169e --- /dev/null +++ b/docs/api/create-and-edit-device-params.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Creating or editing device parameters","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Params Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-and-edit-device-params.api.mdx b/docs/api/create-and-edit-device-params.api.mdx index df6c6607..c90f99aa 100644 --- a/docs/api/create-and-edit-device-params.api.mdx +++ b/docs/api/create-and-edit-device-params.api.mdx @@ -18,62 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create and edit params for the device - + + + Request + + {...require("./create-and-edit-device-params.ParamsDetails.json")} +> + + + {...require("./create-and-edit-device-params.RequestSchema.json")} +> + + + {...require("./create-and-edit-device-params.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-dashboard-widget.ParamsDetails.json b/docs/api/create-dashboard-widget.ParamsDetails.json new file mode 100644 index 00000000..ad79fd90 --- /dev/null +++ b/docs/api/create-dashboard-widget.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file diff --git a/docs/api/create-dashboard-widget.RequestSchema.json b/docs/api/create-dashboard-widget.RequestSchema.json new file mode 100644 index 00000000..91cf3e0e --- /dev/null +++ b/docs/api/create-dashboard-widget.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"analysis_run":{"type":"string","example":"Analysis to trigger when a button is pressed. Used by Form and Dynamic Table widgets."},"dashboard":{"type":"string","description":"Your Dashboard ID"},"data":{"type":"array","items":{"type":"object"},"description":"Data that will be available to your widget."},"display":{"type":"object","description":"The display property of your widget. Each widget has it's unique properties."},"id":{"type":"string"},"label":{"type":"string","example":"Title Label of the Widget"},"realtime":{"type":"boolean","example":true},"type":{"type":"string","example":"The widget unique type."}}},"examples":{"Card Widget Example":{"value":{"analysis_run":null,"display":{"alias":"Ice Cream","header_buttons":[{"color":null,"icon":"","text":"","trigger":"widget","widget":null}],"help":"You can edit this widget to add a message here","frame_settings":{"shadow":{"hide":false},"header_visibility":"show_always"},"theme":{"color":{"background":"hsl(210, 12%, 12%)","header":"hsl(210, 65%, 60%)","text":"hsl(210, 20%, 92%)"}},"show_variables":true,"formula":{"enable":false,"unit_type":"origin","fixed_unit":"","apply_all_matching_formulas":false},"number_format":{"decimals":-1,"show_thousand":false},"max_points":10,"show_chart":true,"show_unit":true,"url":"","variable":"temperature"},"data":[{"qty":10,"origin":"68c9baabb24379000ab1c8cc","variables":["temperature"]}],"resource":[],"id":"68c9bab8fe8818000a7ec597","label":"Temperature","realtime":null,"type":"card","cache":null}}}}}}} \ No newline at end of file diff --git a/docs/api/create-dashboard-widget.StatusCodes.json b/docs/api/create-dashboard-widget.StatusCodes.json new file mode 100644 index 00000000..b57cc020 --- /dev/null +++ b/docs/api/create-dashboard-widget.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":""}}} \ No newline at end of file diff --git a/docs/api/create-dashboard-widget.api.mdx b/docs/api/create-dashboard-widget.api.mdx index c72a6f02..af068d11 100644 --- a/docs/api/create-dashboard-widget.api.mdx +++ b/docs/api/create-dashboard-widget.api.mdx @@ -18,10 +18,24 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create a widget within a specific dashboard in your profile. Each widget has unique properties. To ensure accuracy, we recommend opening your Admin Developer Panel, navigating to the desired Dashboard, and copying the Widget's JSON structure directly. @@ -29,76 +43,32 @@ Each widget has unique properties. To ensure accuracy, we recommend opening your After you create a widget, it is not automatically added to the dashboard's Arrangement parameter. You must manually edit the dashboard arrangement to include the widget's position in the grid. ::: - + + + Request + + {...require("./create-dashboard-widget.ParamsDetails.json")} +> + + + {...require("./create-dashboard-widget.RequestSchema.json")} +> + + + + + + + - + \ No newline at end of file diff --git a/docs/api/create-dashboard.RequestSchema.json b/docs/api/create-dashboard.RequestSchema.json new file mode 100644 index 00000000..ee78d7c7 --- /dev/null +++ b/docs/api/create-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["label","type"],"properties":{"group_by":{"type":"array","items":{},"description":"List of tags to group in the sidebar","example":[]},"icon":{"type":"object","properties":{"color":{"type":"string","example":"hsl(328, 89%, 47%)"},"url":{"type":"string","example":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"}}},"label":{"type":"string","example":"Tracker dashboard"},"tabs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"1648142133869"},"link":{"type":"string","example":""},"value":{"type":"string","example":"tab test"}}},"example":[{"key":"1648142133869","link":"","value":"tab test"},{"key":"1648142564354","link":"","value":"tab 2 "},{"key":"1648142571171","link":"","value":"tab 3 "}]},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"vehicle"},"value":{"type":"string","example":"gas"}}},"example":[{"key":"vehicle","value":"gas"},{"key":"speed","value":"mph"}]},"type":{"type":"string","enum":["dashboard","blueprint"],"example":"blueprint","description":"The type of dashboard. Can be \"dashboard\" or \"blueprint\"."},"visible":{"type":"boolean","example":true,"default":true}}},"examples":{"Create Dashboard":{"value":{"group_by":[],"icon":{"color":"hsl(328, 89%, 47%)","url":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"},"label":"Tracker dashboard","profile":"612ea05e3cc0780012715111","tabs":[{"key":"1648142133869","link":"","value":"tab test"},{"key":"1648142564354","link":"","value":"tab 2 "},{"key":"1648142571171","link":"","value":"tab 3 "}],"tags":[{"key":"vehicle","value":"gas"},{"key":"speed","value":"mph"}],"type":"dashboard","visible":true}}}}}}} \ No newline at end of file diff --git a/docs/api/create-dashboard.StatusCodes.json b/docs/api/create-dashboard.StatusCodes.json new file mode 100644 index 00000000..672affce --- /dev/null +++ b/docs/api/create-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Creating a dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"dashboard":{"type":"string","example":"614e0aa36f480300126652f9a38"}}},"status":{"type":"boolean","example":true}}},"examples":{"Creating a dashboard":{"value":{"result":{"dashboard":"614e0aa36f480300126652f9a38"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-dashboard.api.mdx b/docs/api/create-dashboard.api.mdx index ae336e9b..40da06a6 100644 --- a/docs/api/create-dashboard.api.mdx +++ b/docs/api/create-dashboard.api.mdx @@ -18,125 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Creates a dashboard of type Blueprint or Normal Dashboard into your profile. It's recommended to access your Admin Developer panel and Copy the Dashboard JSON Structure to see all available fields. - - + + Request + + + + + + {...require("./create-dashboard.RequestSchema.json")} +> + + + {...require("./create-dashboard.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-dictionary.RequestSchema.json b/docs/api/create-dictionary.RequestSchema.json new file mode 100644 index 00000000..cd6a73f8 --- /dev/null +++ b/docs/api/create-dictionary.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["name","slug"],"properties":{"name":{"type":"string","example":"dic.DICT"},"slug":{"type":"string","example":"DIC"},"fallback":{"type":"string","example":"fr-FR"},"languages":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"fr-FR"},"message":{"type":"string","example":"true"}}},"example":[{"code":"fr-FR","message":"true"}]}}},"examples":{"Create Dictionary":{"value":{"fallback":"fr-FR","languages":[{"code":"fr-FR","message":"true"}],"name":"dic.DICT","slug":"DIC"}}}}}}} \ No newline at end of file diff --git a/docs/api/create-dictionary.StatusCodes.json b/docs/api/create-dictionary.StatusCodes.json new file mode 100644 index 00000000..b20bda4e --- /dev/null +++ b/docs/api/create-dictionary.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Creating a dictionary","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"dictionary":{"type":"string","example":"654bdc4449769c00097fee32"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-dictionary.api.mdx b/docs/api/create-dictionary.api.mdx index cc3a2c86..78504d7e 100644 --- a/docs/api/create-dictionary.api.mdx +++ b/docs/api/create-dictionary.api.mdx @@ -18,77 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create Dictionary - + + Request + - + + + + {...require("./create-dictionary.RequestSchema.json")} +> + + + {...require("./create-dictionary.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-entity.RequestSchema.json b/docs/api/create-entity.RequestSchema.json new file mode 100644 index 00000000..4ea6fa4a --- /dev/null +++ b/docs/api/create-entity.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"2938924293"},"index":{"type":"object","properties":{"index_charge_amount":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"charge_amount"},"example":["charge_amount"]}}}}},"name":{"type":"string","example":"Control Entity"},"schema":{"type":"object","properties":{"charge_amount":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"int"}}},"update_date":{"type":"object","properties":{"required":{"type":"boolean","example":true},"type":{"type":"string","example":"timestamp"}}}}},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"yes"}}},"example":[{"key":"active","value":"yes"}]}}},"examples":{"Create Entity":{"value":{"id":"2938924293","index":{"index_charge_amount":{"fields":["charge_amount"]}},"name":"Control Entity","schema":{"charge_amount":{"required":false,"type":"int"},"update_date":{"required":true,"type":"timestamp"}},"tags":[{"key":"active","value":"yes"}]}}}}}}} \ No newline at end of file diff --git a/docs/api/create-entity.StatusCodes.json b/docs/api/create-entity.StatusCodes.json new file mode 100644 index 00000000..a4bfb869 --- /dev/null +++ b/docs/api/create-entity.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Creating an entity","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","example":"672a64b91807cd7008bae4d5"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-entity.api.mdx b/docs/api/create-entity.api.mdx index 809af8bc..a4b17874 100644 --- a/docs/api/create-entity.api.mdx +++ b/docs/api/create-entity.api.mdx @@ -18,107 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create Entity - + + Request + - + + + + {...require("./create-entity.RequestSchema.json")} +> + + + {...require("./create-entity.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-new-device.RequestSchema.json b/docs/api/create-new-device.RequestSchema.json new file mode 100644 index 00000000..140ce74f --- /dev/null +++ b/docs/api/create-new-device.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"oneOf":[{"title":"Immutable Device Creation","type":"object","required":["name","type","network","connector","chunk_period","chunk_retention"],"properties":{"name":{"type":"string","description":"Device name","example":"My first immutable device"},"type":{"type":"string","enum":["immutable"],"description":"Device type - must be 'immutable' for immutable devices","example":"immutable"},"network":{"type":"string","description":"Network ID where the device will be created","example":"5bbd0d144051a50034cd19fb"},"connector":{"type":"string","description":"Connector ID for the device","example":"5f5a8f3351d4db99c40dece5"},"chunk_period":{"type":"string","enum":["day","week","month","quarter"],"description":"Chunk period for data storage - one of day, week, month, quarter","example":"quarter"},"chunk_retention":{"type":"number","minimum":0,"maximum":36,"description":"Number of chunks to retain (0-36)","example":36},"serie_number":{"type":"string","description":"Serial number - only required if specified by the network","example":"AB87392C17CA"},"tags":{"type":"array","description":"Device tags as key-value string pairs","items":{"type":"object","properties":{"key":{"type":"string","description":"Tag key","example":"tagKey1"},"value":{"type":"string","description":"Tag value","example":"value1"}}},"example":[{"key":"tagKey1","value":"value1"},{"key":"tagKey2","value":"value2"}]}}},{"title":"Mutable Device Creation","type":"object","required":["name","type","network","connector"],"properties":{"name":{"type":"string","description":"Device name","example":"My first device"},"type":{"type":"string","enum":["mutable"],"description":"Device type - must be 'mutable' for mutable devices","example":"mutable"},"network":{"type":"string","description":"Network ID where the device will be created","example":"5bbd0d144051a50034cd19fb"},"connector":{"type":"string","description":"Connector ID for the device","example":"5f5a8f3351d4db99c40dece5"},"serie_number":{"type":"string","description":"Serial number - only required if specified by the network","example":"AB87392C12CA"},"active":{"type":"boolean","description":"Device active status","example":true},"payload_decoder":{"type":"string","description":"Base64 encoded payload decoder function"},"tags":{"type":"array","description":"Device tags","items":{"type":"object","properties":{"key":{"type":"string","example":"tagKey1"},"value":{"type":"string","example":"value1"}}},"example":[{"key":"tagKey1","value":"value1"},{"key":"tagKey2","value":"value2"}]},"visible":{"type":"boolean","description":"Device visibility status","example":true}}}]},"examples":{"Create Immutable Device":{"value":{"name":"My first immutable device","type":"immutable","network":"5bbd0d144051a50034cd19fb","connector":"5f5a8f3351d4db99c40dece5","chunk_period":"quarter","chunk_retention":36,"serie_number":"AB87392C17CA"}},"Create Mutable Device":{"value":{"name":"My first device","type":"mutable","network":"5bbd0d144051a50034cd19fb","connector":"5f5a8f3351d4db99c40dece5","serie_number":"AB87392C12CA"}},"Create Mutable Device with Parse Function":{"value":{"name":"Mutable device","type":"mutable","network":"5bbd0d144051a50034cd19fb","connector":"5f5a8f3351d4db99c40dece5","action":true,"active":true,"visible":true,"tags":[{"key":"tagKey1","value":"value1"},{"key":"tagKey2","value":"value2"}]}}}},"text/plain":{"examples":{"Create Immutable Device":{"value":"{\r\n \"name\": \"My first immutable device\",\r\n \"type\": \"immutable\",\r\n \"network\": \"5bbd0d144051a50034cd19fb\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"chunk_period\": \"quarter\", //define a chunk period by \"day\",\"week\", \"month\", \"quarter\"\r\n \"chunk_retention\": 36, //acceptable range between 0-36\r\n \"serie_number\": \"AB87392C17CA\" //only if required by network (optional)\r\n }"},"Create Mutable Device":{"value":"{\r\n \"name\": \"My first device\",\r\n \"type\": \"mutable\",\r\n \"network\": \"5bbd0d144051a50034cd19fb\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"serie_number\": \"AB87392C12CA\" //only if required by network (optional)\r\n }"}}}}}} \ No newline at end of file diff --git a/docs/api/create-new-device.StatusCodes.json b/docs/api/create-new-device.StatusCodes.json new file mode 100644 index 00000000..94c6c6d3 --- /dev/null +++ b/docs/api/create-new-device.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Mutable device created / Mutable device created with parse function / Immutable device created","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"deviceID":{"type":"string","example":"5dcad1c216174c001ca23ab9"},"token":{"type":"string","example":"5a16405f-b32c-4c91-ae39-cbb2caba18d8"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-new-device.api.mdx b/docs/api/create-new-device.api.mdx index 4e217893..7deac22e 100644 --- a/docs/api/create-new-device.api.mdx +++ b/docs/api/create-new-device.api.mdx @@ -18,207 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings. - + + Request + - + + + + {...require("./create-new-device.RequestSchema.json")} +> + + + {...require("./create-new-device.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-notification.RequestSchema.json b/docs/api/create-notification.RequestSchema.json new file mode 100644 index 00000000..139289f3 --- /dev/null +++ b/docs/api/create-notification.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"buttons":{"type":"array","items":{"type":"object","properties":{"analysis":{"type":"string","example":"5515de2676ab4e3211109e41c"},"color":{"type":"string","example":"green"},"id":{"type":"string","example":"btn_1249384"},"label":{"type":"string","example":"Acknowledge"}}},"example":[{"analysis":"5515de2676ab4e3211109e41c","color":"green","id":"btn_1249384","label":"Acknowledge"}]},"buttons_autodisable":{"type":"boolean","example":true},"buttons_enabled":{"type":"boolean","example":true},"message":{"type":"string","example":"The temperature is lower than 18ºC."},"run_user":{"type":"string","example":"614edef8749df6a30280012a3caef"},"title":{"type":"string","example":"Low Temperature"}}},"examples":{"Create Notification":{"value":{"buttons":[{"analysis":"5515de2676ab4e3211109e41c","color":"green","id":"btn_1249384","label":"Acknowledge"}],"buttons_autodisable":true,"buttons_enabled":true,"message":"The temperature is lower than 18ºC.","run_user":"614edef8749df6a30280012a3caef","title":"Low Temperature"}}}},"text/plain":{"examples":{"Create Notification":{"value":"{\r\n \"run_user\": \"\",\r\n \"title\": \"notification title\",\r\n \"message\": \"message to be read\",\r\n \"buttons\": [ // optional\r\n {\r\n \"label\": \"label of the button\",\r\n \"id\": \"id_of_the_button\", // no space allowed\r\n \"color\": \"color of the button\", //hexadecimal allowed\r\n \"url\": \"url to redirect the user\", //optional\r\n \"analysis\": \"analysis to run when clicked\" //optional\r\n }\r\n ],\r\n \"buttons_enabled\": true, // optional\r\n \"buttons_autodisable\": true // optional\r\n}"}}}}}} \ No newline at end of file diff --git a/docs/api/create-notification.StatusCodes.json b/docs/api/create-notification.StatusCodes.json new file mode 100644 index 00000000..4db324f0 --- /dev/null +++ b/docs/api/create-notification.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Creating a RUN notification","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","example":"3415de2676ff4e2001109e63b"}}},"status":{"type":"boolean","example":true}}},"examples":{"Creating a RUN notification":{"value":{"result":{"id":"3415de2676ff4e2001109e63b"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-notification.api.mdx b/docs/api/create-notification.api.mdx index b9643c2c..3bde6e8e 100644 --- a/docs/api/create-notification.api.mdx +++ b/docs/api/create-notification.api.mdx @@ -18,94 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create Notification for an user - - + + Request + + + + + ",\r\n "title": "notification title",\r\n "message": "message to be read",\r\n "buttons": [ // optional\r\n {\r\n "label": "label of the button",\r\n "id": "id_of_the_button", // no space allowed\r\n "color": "color of the button", //hexadecimal allowed\r\n "url": "url to redirect the user", //optional\r\n "analysis": "analysis to run when clicked" //optional\r\n }\r\n ],\r\n "buttons_enabled": true, // optional\r\n "buttons_autodisable": true // optional\r\n}', - }, - }, - }, - }, - }} -> + {...require("./create-notification.RequestSchema.json")} +> + + + {...require("./create-notification.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-policy.RequestSchema.json b/docs/api/create-policy.RequestSchema.json new file mode 100644 index 00000000..a69b5b51 --- /dev/null +++ b/docs/api/create-policy.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"User Policy","required":["name","permissions","targets","active"],"properties":{"name":{"type":"string","description":"Name of the policy","example":"User permissions"},"permissions":{"type":"array","description":"Array of permission objects","items":{"type":"object","properties":{"effect":{"type":"string","enum":["allow","deny"],"description":"Allow or deny the permission","example":"allow"},"action":{"type":"array","items":{"type":"string"},"description":"Actions allowed: access, edit, delete, create","example":["access"]},"resource":{"type":"array","items":{"type":"string"},"description":"Resources: device, dashboard, analysis, run_user, etc.","example":["device"]}}}},"targets":{"type":"array","description":"Global: [\"run_user\"]. Specific: [\"run_user\", \"id\", \"user_id\"]. Tag-based: [\"run_user\", \"tag_match\", \"tag_key\"]","items":{"type":"array","items":{"type":"string"},"example":["run_user"]},"example":[["run_user"]]},"tags":{"type":"array","description":"Optional tags for targeting specific users/analysis","items":{"type":"object","properties":{"key":{"type":"string","description":"Tag key","example":"user"},"value":{"type":"string","description":"Tag value","example":"admin"}}},"example":[{"key":"user","value":"admin"}]},"active":{"type":"boolean","description":"Whether the policy is active","example":true}}},{"type":"object","title":"Analysis Policy","required":["name","permissions","targets","active"],"properties":{"name":{"type":"string","description":"Name of the policy","example":"Policy"},"permissions":{"type":"array","description":"Array of permission objects","items":{"type":"object","properties":{"effect":{"type":"string","enum":["allow","deny"],"description":"Allow or deny the permission","example":"allow"},"action":{"type":"array","items":{"type":"string"},"description":"Actions allowed: access, edit, delete, create","example":["edit","delete","create","access"]},"resource":{"type":"array","items":{"type":"string"},"description":"Resources: device, dashboard, analysis, run_user, etc.","example":["device"]}}}},"targets":{"type":"array","description":"Global: [\"analysis\"]. Specific: [\"analysis\", \"id\", \"analysis_id\"]. Tag-based: [\"analysis\", \"tag_match\", \"tag_key\"]","items":{"type":"array","items":{"type":"string"},"example":["analysis"]},"example":[["analysis"]]},"tags":{"type":"array","description":"Optional tags for targeting specific users/analysis","items":{"type":"object","properties":{"key":{"type":"string","description":"Tag key","example":"user"},"value":{"type":"string","description":"Tag value","example":"admin"}}},"example":[{"key":"user","value":"admin"}]},"active":{"type":"boolean","description":"Whether the policy is active","example":true}}}]},"examples":{"Create Policy - Run User (Global)":{"value":{"name":"User permissions","permissions":[{"effect":"allow","action":["access"],"resource":["device"]}],"targets":[["run_user"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Run User (Specific ID)":{"value":{"name":"User permissions","permissions":[{"effect":"allow","action":["access"],"resource":["device"]}],"targets":[["run_user","id","68b5dd292ee817000af854dc"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Run User (Tag Match)":{"value":{"name":"User permissions","permissions":[{"effect":"allow","action":["access"],"resource":["device"]}],"targets":[["run_user","tag_match","account_token"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Analysis (Global)":{"value":{"name":"Policy","permissions":[{"effect":"allow","action":["edit","delete","create","access"],"resource":["device"]}],"targets":[["analysis"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Analysis (Specific ID)":{"value":{"name":"Policy","permissions":[{"effect":"allow","action":["edit","delete","create","access"],"resource":["device"]}],"targets":[["analysis","id","68b5dd292ee817000af854dc"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Analysis (Tag Match)":{"value":{"name":"Policy","permissions":[{"effect":"allow","action":["edit","delete","create","access"],"resource":["device"]}],"targets":[["analysis","tag_match","account_token"]],"tags":[{"key":"user","value":"admin"}],"active":true}}}},"text/plain":{"examples":{"Create Policy - Run User (Global)":{"value":"{\n \"name\": \"User permissions\",\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\"access\"],\n \"resource\": [\"device\"]\n }\n ],\n \"targets\": [[\"run_user\"]],\n \"tags\": [{\"key\": \"user\", \"value\": \"admin\"}],\n \"active\": true\n}"},"Create Policy - Analysis (Global)":{"value":"{\n \"name\": \"Policy\",\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\"edit\", \"delete\", \"create\", \"access\"],\n \"resource\": [\"device\"]\n }\n ],\n \"targets\": [[\"analysis\"]],\n \"tags\": [{\"key\": \"user\", \"value\": \"admin\"}],\n \"active\": true\n}"}}}}}} \ No newline at end of file diff --git a/docs/api/create-policy.StatusCodes.json b/docs/api/create-policy.StatusCodes.json new file mode 100644 index 00000000..b7fad655 --- /dev/null +++ b/docs/api/create-policy.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Create Policy - Run User / Create Policy - Analysis","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"am_id":{"type":"string","example":"654a8bf3fefe2f00099a16a2"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-policy.api.mdx b/docs/api/create-policy.api.mdx index bcfd0aa2..55f5e3ef 100644 --- a/docs/api/create-policy.api.mdx +++ b/docs/api/create-policy.api.mdx @@ -18,229 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create a policy that targets either Run User or Analysis - + + Request + - + + + + {...require("./create-policy.RequestSchema.json")} +> + + + {...require("./create-policy.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-profile-backup.ParamsDetails.json b/docs/api/create-profile-backup.ParamsDetails.json new file mode 100644 index 00000000..22d63f83 --- /dev/null +++ b/docs/api/create-profile-backup.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"}]} \ No newline at end of file diff --git a/docs/api/create-profile-backup.RequestSchema.json b/docs/api/create-profile-backup.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/create-profile-backup.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/create-profile-backup.StatusCodes.json b/docs/api/create-profile-backup.StatusCodes.json new file mode 100644 index 00000000..b0cab8d9 --- /dev/null +++ b/docs/api/create-profile-backup.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Backup creation initiated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Backup generation has been queued and will be processed shortly. You can check the status using the list backups endpoint."},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"backup_id":{"type":"string","example":"678abc123def456789012345"}}}}}},"403":{"description":"Forbidden - Free plan or rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Daily backup limit reached (1 backups per day). Please try again in 8 hours or contact support to increase your limit."}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-profile-backup.api.mdx b/docs/api/create-profile-backup.api.mdx index e4ea6ddc..fc4faa6f 100644 --- a/docs/api/create-profile-backup.api.mdx +++ b/docs/api/create-profile-backup.api.mdx @@ -18,83 +18,65 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Initiates a new backup generation for the specified profile. The backup is processed asynchronously in a background queue. **What's included in the backup:** - - User storage files (uploaded via `/files` route) - Dashboard version history - Analysis script versions - All resource configurations as JSON files (devices, actions, dashboards, analysis, access management, networks, connectors, secrets, dictionaries, run users, etc.) **Important notes:** - - Backups are rate-limited (1 per day based on your account timezone) - Free plan users do not have access to backup features - Backup generation may take several minutes depending on profile size - Restoration is manual - you can write scripts to parse the JSON files and recreate resources via API, or contact TagoIO support - + + + Request + + {...require("./create-profile-backup.ParamsDetails.json")} +> + + - + + + + {...require("./create-profile-backup.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-token.RequestSchema.json b/docs/api/create-token.RequestSchema.json new file mode 100644 index 00000000..ef299341 --- /dev/null +++ b/docs/api/create-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"string","example":"6243321z80d789a05800143075a4"},"expire_time":{"type":"string","example":"3 hours"},"name":{"type":"string","example":"TestToken"},"serie_number":{"type":"string","example":359881234567890,"description":"If applicable for the selected Network. Can be an IMEI, EUI, or unique serial number."}}},"examples":{"Create token":{"value":{"device":"6243321z80d789a05800143075a4","expire_time":"3 hours","name":"TestToken"}}}},"text/plain":{"examples":{"Create token":{"value":"{\r\n \"expire_time\": \"never\", // ISO-8601 or relative date, e.g 1 day\r\n \"name\": \"Token #2\",\r\n \"permission\": \"full\", // full, read or write\r\n \"serie_number\": \"\", //Optional\r\n \"device\": \"6298fcc3e0b6840012b6abfa\"\r\n}"}}}}}} \ No newline at end of file diff --git a/docs/api/create-token.StatusCodes.json b/docs/api/create-token.StatusCodes.json new file mode 100644 index 00000000..dd340225 --- /dev/null +++ b/docs/api/create-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Token created","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"expire_time":{"type":"string","example":"2022-03-30T01:15:14.914Z"},"permission":{"type":"string","example":"full"},"token":{"type":"string","example":"f2ba4b46-3c57-44ce-810f-98e1271ea602"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-token.api.mdx b/docs/api/create-token.api.mdx index 204cd745..8e00ca53 100644 --- a/docs/api/create-token.api.mdx +++ b/docs/api/create-token.api.mdx @@ -18,77 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Generate and retrieve a new token - - + + Request + + + + + + {...require("./create-token.RequestSchema.json")} +> + + + {...require("./create-token.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/create-user.RequestSchema.json b/docs/api/create-user.RequestSchema.json new file mode 100644 index 00000000..d1671a6d --- /dev/null +++ b/docs/api/create-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["name","email","password"],"properties":{"active":{"type":"boolean","example":true},"email":{"type":"string","example":"janedoe@mail.com"},"name":{"type":"string","example":"Jane Doe"},"password":{"type":"string","example":"Testing_01"},"timezone":{"type":"string","example":"New_York/America"}}}}}}} \ No newline at end of file diff --git a/docs/api/create-user.StatusCodes.json b/docs/api/create-user.StatusCodes.json new file mode 100644 index 00000000..e01ff346 --- /dev/null +++ b/docs/api/create-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Creating a RUN user","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"user":{"type":"string","example":"62b086df27ce4d0012be6bac"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/create-user.api.mdx b/docs/api/create-user.api.mdx index 3b48cc50..1a9c0836 100644 --- a/docs/api/create-user.api.mdx +++ b/docs/api/create-user.api.mdx @@ -18,55 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Create user on Run - - + + Request + + + + + + {...require("./create-user.RequestSchema.json")} +> + + + {...require("./create-user.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/current-device-information.RequestSchema.json b/docs/api/current-device-information.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/current-device-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/current-device-information.StatusCodes.json b/docs/api/current-device-information.StatusCodes.json new file mode 100644 index 00000000..6e5a78c5 --- /dev/null +++ b/docs/api/current-device-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get information about current device successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"connector":{"type":"string","example":"62333bd36977fc001a2990c8"},"created_at":{"type":"string","example":"2022-06-02T18:09:07.135Z"},"id":{"type":"string","example":"6298fcc3e0b6840012b6abfa"},"last_input":{"type":"string","example":"2022-06-02T19:40:54.517Z"},"name":{"type":"string","example":"TagoIO Device"},"network":{"type":"string","example":"62336c32ab6e0d0012e06c04"},"payload_decoder":{"type":"string","example":"LyogVGhpcyBpcyBhIGRlZmF1bHQgZXhhbXBsZSBmb3IgcGF5bG9hZCBwYXJzZXIuCioqIFRoZSBpZ25vcmVfdmFycyB2YXJpYWJsZSBpbiB0aGlzIGNvZGUgc2hvdWxkIGJlIHVzZWQgdG8gaWdub3JlIHZhcmlhYmxlcwoqKiBmcm9tIHRoZSBkZXZpY2UgdGhhdCB5b3UgZG9uJ3Qgd2FudC4KKioKKiogVGVzdGluZzoKKiogWW91IGNhbiBkbyBtYW51YWwgdGVzdHMgdG8gdGhpcyBwYXJzZSBieSB1c2luZyB0aGUgRGV2aWNlIEVtdWxhdG9yLiBDb3B5IGFuZCBQYXN0ZSB0aGUgZm9sbG93aW5nIGNvZGU6CioqIFt7ICJ2YXJpYWJsZSI6ICJwYXlsb2FkIiwgInZhbHVlIjogIjAxMDk2MTEzOTUiIH1dCioqCiovCi8vIEFkZCBpZ25vcmFibGUgdmFyaWFibGVzIGluIHRoaXMgYXJyYXkuCmNvbnN0IGlnbm9yZV92YXJzID0gWydyZl9jaGFpbicsICdjaGFubmVsJywgJ21vZHVsYXRpb24nLCAnYXBwX2lkJywgJ2Rldl9pZCcsICd0aW1lJywgJ2d0d190cnVzdGVkJywgJ3BvcnQnXTsKCi8vIFJlbW92ZSB1bndhbnRlZCB2YXJpYWJsZXMuCnBheWxvYWQgPSBwYXlsb2FkLmZpbHRlcih4ID0+ICFpZ25vcmVfdmFycy5pbmNsdWRlcyh4LnZhcmlhYmxlKSk7CgovLyBZb3UgY2FuIGVkaXQgYW55IHZhcmlhYmxlIHRoYXQncyBiZWluZyBhZGRlZCB0byB5b3VyIGRldmljZS4KLy8gRm9yIGV4YW1wbGUsIGlmIHlvdSBuZWVkIHRvIGNvbnZlcnQgYSB2YXJpYWJsZSBmcm9tIEZhaHJlaW50aCB0byBDZWxzaXVzLCB1bmNvbW1lbnQgdGhlIGZvbGxvd2luZyBjb2RlOgovLyBjb25zdCB0ZW1wZXJhdHVyZSA9IHBheWxvYWQuZmluZCh4ID0+IHgudmFyaWFibGUgPT09ICJ0ZW1wZXJhdHVyZSIpOwovLyBpZiAodGVtcGVyYXR1cmUpIHsKLy8gICB0ZW1wZXJhdHVyZS52YWx1ZSA9ICg1IC8gOSkgKiAodGVtcGVyYXR1cmUudmFsdWUgLSAzMik7Ci8vICAgdGVtcGVyYXR1cmUudW5pdCA9ICJDIjsKLy8gfQ=="},"profile":{"type":"string","example":"5e1e192a06fbee00265ccfb0"},"tags":{"type":"array","items":{},"example":[]},"type":{"type":"string","example":"mutable"},"updated_at":{"type":"string","example":"2022-06-10T20:22:59.405Z"},"visible":{"type":"boolean","example":true}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/current-device-information.api.mdx b/docs/api/current-device-information.api.mdx index 312c5f39..47523f10 100644 --- a/docs/api/current-device-information.api.mdx +++ b/docs/api/current-device-information.api.mdx @@ -18,55 +18,45 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get information about the current device - - + + + + + + + + {...require("./current-device-information.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-a-file.RequestSchema.json b/docs/api/delete-a-file.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-a-file.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-a-file.StatusCodes.json b/docs/api/delete-a-file.StatusCodes.json new file mode 100644 index 00000000..a7b53110 --- /dev/null +++ b/docs/api/delete-a-file.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting a file","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting a file":{"value":{"result":"Successfully Removed","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-a-file.api.mdx b/docs/api/delete-a-file.api.mdx index 790ba44f..b180bfb7 100644 --- a/docs/api/delete-a-file.api.mdx +++ b/docs/api/delete-a-file.api.mdx @@ -18,35 +18,44 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete a file - + + + - + + + + {...require("./delete-a-file.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-chunk.ParamsDetails.json b/docs/api/delete-chunk.ParamsDetails.json new file mode 100644 index 00000000..b6f85ab9 --- /dev/null +++ b/docs/api/delete-chunk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"},{"name":"chunkID","in":"path","required":true,"schema":{"type":"string","example":"(Type a chunk ID)"},"description":"Chunk ID"}]} \ No newline at end of file diff --git a/docs/api/delete-chunk.RequestSchema.json b/docs/api/delete-chunk.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-chunk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-chunk.StatusCodes.json b/docs/api/delete-chunk.StatusCodes.json new file mode 100644 index 00000000..8704732d --- /dev/null +++ b/docs/api/delete-chunk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Chunk deleted from device","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Chunk 1657497600_1658102399 deleted"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-chunk.api.mdx b/docs/api/delete-chunk.api.mdx index b45bc22a..a321a40f 100644 --- a/docs/api/delete-chunk.api.mdx +++ b/docs/api/delete-chunk.api.mdx @@ -18,53 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete chunk - + + Request + + {...require("./delete-chunk.ParamsDetails.json")} +> + + - + + + + {...require("./delete-chunk.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-dashboard.ParamsDetails.json b/docs/api/delete-dashboard.ParamsDetails.json new file mode 100644 index 00000000..ad79fd90 --- /dev/null +++ b/docs/api/delete-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file diff --git a/docs/api/delete-dashboard.RequestSchema.json b/docs/api/delete-dashboard.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-dashboard.StatusCodes.json b/docs/api/delete-dashboard.StatusCodes.json new file mode 100644 index 00000000..c2ae39af --- /dev/null +++ b/docs/api/delete-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting a dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting a dashboard":{"value":{"result":"Successfully Removed","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-dashboard.api.mdx b/docs/api/delete-dashboard.api.mdx index 0d9e5a76..c7b92b0e 100644 --- a/docs/api/delete-dashboard.api.mdx +++ b/docs/api/delete-dashboard.api.mdx @@ -18,41 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete the dashboard - + + + Request + + {...require("./delete-dashboard.ParamsDetails.json")} +> + + - + + + + {...require("./delete-dashboard.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-data.ParamsDetails.json b/docs/api/delete-data.ParamsDetails.json new file mode 100644 index 00000000..cbd26e30 --- /dev/null +++ b/docs/api/delete-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"qty","in":"query","description":"Quantity of data records to delete. Default is 15.","schema":{"type":"integer","minimum":1,"default":15,"example":20}},{"name":"ordination","in":"query","description":"Sort direction. Default is descending.","schema":{"type":"string","enum":["ascending","descending"],"default":"descending","example":"descending"}},{"name":"skip","in":"query","description":"Number of items to skip (pagination).","schema":{"type":"integer","minimum":0,"example":15}},{"name":"variables","in":"query","description":"Filter data by variable.","schema":{"type":"string","example":"temperature"}},{"name":"values","in":"query","description":"Filter data by value. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"12"}},{"name":"ids","in":"query","description":"Filter data by id. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"6144a25e280ad80019688e689"}},{"name":"groups","in":"query","description":"Filter data by group. Accepts single or multiple values.\nFor multiple, send `groups[0]=foo&groups[1]=bar`.\n","schema":{"type":"string","items":{"type":"string"},"example":"16731887966346"}}]} \ No newline at end of file diff --git a/docs/api/delete-data.RequestSchema.json b/docs/api/delete-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-data.StatusCodes.json b/docs/api/delete-data.StatusCodes.json new file mode 100644 index 00000000..c2e96cf9 --- /dev/null +++ b/docs/api/delete-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting data using params","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-data.api.mdx b/docs/api/delete-data.api.mdx index 234e3492..4785e8f5 100644 --- a/docs/api/delete-data.api.mdx +++ b/docs/api/delete-data.api.mdx @@ -18,85 +18,56 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete data from the device. :::info This request is only available when using Mutable Storage on Devices. ::: - + + + Request + + {...require("./delete-data.ParamsDetails.json")} +> + + - + + + + {...require("./delete-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-device-data.ParamsDetails.json b/docs/api/delete-device-data.ParamsDetails.json new file mode 100644 index 00000000..748f244f --- /dev/null +++ b/docs/api/delete-device-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"qty","in":"query","description":"Quantity of data records to delete. Default is 15.","schema":{"type":"integer","minimum":1,"default":15,"example":20}},{"name":"ordination","in":"query","description":"Sort direction. Default is descending.","schema":{"type":"string","enum":["ascending","descending"],"default":"descending","example":"descending"}},{"name":"skip","in":"query","description":"Number of items to skip (pagination).","schema":{"type":"integer","minimum":0,"example":15}},{"name":"variables","in":"query","description":"Filter data by variable.","schema":{"type":"string","example":"temperature"}},{"name":"values","in":"query","description":"Filter data by value. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"12"}},{"name":"ids","in":"query","description":"Filter data by id. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"6144a25e280ad80019688e689"}},{"name":"groups","in":"query","description":"Filter data by group. Accepts single or multiple values.\nFor multiple, send `groups[0]=foo&groups[1]=bar`.\n","schema":{"type":"string","items":{"type":"string"},"example":"16731887966346"}},{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file diff --git a/docs/api/delete-device-data.RequestSchema.json b/docs/api/delete-device-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-device-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-device-data.StatusCodes.json b/docs/api/delete-device-data.StatusCodes.json new file mode 100644 index 00000000..78198470 --- /dev/null +++ b/docs/api/delete-device-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Delete Device Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-device-data.api.mdx b/docs/api/delete-device-data.api.mdx index e865a07b..a84f4587 100644 --- a/docs/api/delete-device-data.api.mdx +++ b/docs/api/delete-device-data.api.mdx @@ -18,92 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete specific data stored in the device. :::info This request is only available when using Mutable Storage on Devices ::: - + + Request + + {...require("./delete-device-data.ParamsDetails.json")} +> + + - + + + + {...require("./delete-device-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-device-param.ParamsDetails.json b/docs/api/delete-device-param.ParamsDetails.json new file mode 100644 index 00000000..0db0eff4 --- /dev/null +++ b/docs/api/delete-device-param.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"(Type your device ID)"}},{"name":"paramID","in":"path","required":true,"schema":{"type":"string","example":"(Type your param ID)"}}]} \ No newline at end of file diff --git a/docs/api/delete-device-param.RequestSchema.json b/docs/api/delete-device-param.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-device-param.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-device-param.StatusCodes.json b/docs/api/delete-device-param.StatusCodes.json new file mode 100644 index 00000000..b10fa8e9 --- /dev/null +++ b/docs/api/delete-device-param.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting a Device Param by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-device-param.api.mdx b/docs/api/delete-device-param.api.mdx index 65a5c918..a081a2dd 100644 --- a/docs/api/delete-device-param.api.mdx +++ b/docs/api/delete-device-param.api.mdx @@ -18,41 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete param from the device - + + + Request + + {...require("./delete-device-param.ParamsDetails.json")} +> + + - + + + + {...require("./delete-device-param.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-device.ParamsDetails.json b/docs/api/delete-device.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/delete-device.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/delete-device.RequestSchema.json b/docs/api/delete-device.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-device.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-device.StatusCodes.json b/docs/api/delete-device.StatusCodes.json new file mode 100644 index 00000000..1f381d0b --- /dev/null +++ b/docs/api/delete-device.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting a device by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-device.api.mdx b/docs/api/delete-device.api.mdx index bc128e7b..2a33c425 100644 --- a/docs/api/delete-device.api.mdx +++ b/docs/api/delete-device.api.mdx @@ -18,40 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Deletes a device from the profile - + + + Request + + {...require("./delete-device.ParamsDetails.json")} +> + + - + + + + {...require("./delete-device.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-dictionary.ParamsDetails.json b/docs/api/delete-dictionary.ParamsDetails.json new file mode 100644 index 00000000..b8515d71 --- /dev/null +++ b/docs/api/delete-dictionary.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"}]} \ No newline at end of file diff --git a/docs/api/delete-dictionary.RequestSchema.json b/docs/api/delete-dictionary.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-dictionary.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-dictionary.StatusCodes.json b/docs/api/delete-dictionary.StatusCodes.json new file mode 100644 index 00000000..04f0ac3e --- /dev/null +++ b/docs/api/delete-dictionary.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Delete Dictionary","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-dictionary.api.mdx b/docs/api/delete-dictionary.api.mdx index c9585c0b..f1c367c6 100644 --- a/docs/api/delete-dictionary.api.mdx +++ b/docs/api/delete-dictionary.api.mdx @@ -18,46 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete Dictionary - + + Request + - - + {...require("./delete-dictionary.ParamsDetails.json")} +> + + + + + + + {...require("./delete-dictionary.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-entity-data.ParamsDetails.json b/docs/api/delete-entity-data.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/delete-entity-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/delete-entity-data.RequestSchema.json b/docs/api/delete-entity-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-entity-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-entity-data.StatusCodes.json b/docs/api/delete-entity-data.StatusCodes.json new file mode 100644 index 00000000..5883f9df --- /dev/null +++ b/docs/api/delete-entity-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Delete Entity Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"2 item(s) deleted"},"status":{"type":"boolean","example":true}}},"examples":{"Delete Entity Data":{"value":{"result":"2 item(s) deleted","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-entity-data.api.mdx b/docs/api/delete-entity-data.api.mdx index 77547f7b..4bcd3020 100644 --- a/docs/api/delete-entity-data.api.mdx +++ b/docs/api/delete-entity-data.api.mdx @@ -18,41 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete Entity Data - + + Request + + {...require("./delete-entity-data.ParamsDetails.json")} +> + + - + + + + {...require("./delete-entity-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-entity.ParamsDetails.json b/docs/api/delete-entity.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/delete-entity.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/delete-entity.RequestSchema.json b/docs/api/delete-entity.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-entity.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-entity.StatusCodes.json b/docs/api/delete-entity.StatusCodes.json new file mode 100644 index 00000000..48e4d428 --- /dev/null +++ b/docs/api/delete-entity.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting an entity","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Entity Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting an entity":{"value":{"result":"Entity Successfully Removed","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-entity.api.mdx b/docs/api/delete-entity.api.mdx index a59cbd24..5b32052c 100644 --- a/docs/api/delete-entity.api.mdx +++ b/docs/api/delete-entity.api.mdx @@ -18,41 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete Entity - + + Request + + {...require("./delete-entity.ParamsDetails.json")} +> + + - + + + + {...require("./delete-entity.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-notification.ParamsDetails.json b/docs/api/delete-notification.ParamsDetails.json new file mode 100644 index 00000000..a1e9f650 --- /dev/null +++ b/docs/api/delete-notification.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"notificationID","in":"path","required":true,"schema":{"type":"string","example":"(Type your RUN notification ID)"}}]} \ No newline at end of file diff --git a/docs/api/delete-notification.RequestSchema.json b/docs/api/delete-notification.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-notification.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-notification.StatusCodes.json b/docs/api/delete-notification.StatusCodes.json new file mode 100644 index 00000000..c58cad09 --- /dev/null +++ b/docs/api/delete-notification.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting a RUN user notification","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-notification.api.mdx b/docs/api/delete-notification.api.mdx index 285fb8b7..d3672f4f 100644 --- a/docs/api/delete-notification.api.mdx +++ b/docs/api/delete-notification.api.mdx @@ -18,45 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete notification on Run - + + + Request + - - + {...require("./delete-notification.ParamsDetails.json")} +> + + + + + + + {...require("./delete-notification.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-policy.ParamsDetails.json b/docs/api/delete-policy.ParamsDetails.json new file mode 100644 index 00000000..4e945104 --- /dev/null +++ b/docs/api/delete-policy.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"am_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an Access Management/Policy ID)"},"description":"Can be obtained in the GET Policy request response"}]} \ No newline at end of file diff --git a/docs/api/delete-policy.RequestSchema.json b/docs/api/delete-policy.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-policy.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-policy.StatusCodes.json b/docs/api/delete-policy.StatusCodes.json new file mode 100644 index 00000000..a148ae44 --- /dev/null +++ b/docs/api/delete-policy.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Delete policy","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Access Management Successfully Deleted"},"status":{"type":"boolean","example":true}}},"examples":{"Delete policy":{"value":{"result":"Access Management Successfully Deleted","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-policy.api.mdx b/docs/api/delete-policy.api.mdx index 63bf36ff..afc9c143 100644 --- a/docs/api/delete-policy.api.mdx +++ b/docs/api/delete-policy.api.mdx @@ -18,47 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete Policy - + + Request + + {...require("./delete-policy.ParamsDetails.json")} +> + + - + + + + {...require("./delete-policy.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-profile-backup.ParamsDetails.json b/docs/api/delete-profile-backup.ParamsDetails.json new file mode 100644 index 00000000..5b8b893b --- /dev/null +++ b/docs/api/delete-profile-backup.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"},{"name":"backup_id","in":"path","required":true,"schema":{"type":"string","example":"678abc123def456789012345"},"description":"The ID of the backup to delete"}]} \ No newline at end of file diff --git a/docs/api/delete-profile-backup.RequestSchema.json b/docs/api/delete-profile-backup.RequestSchema.json new file mode 100644 index 00000000..8cf58e9a --- /dev/null +++ b/docs/api/delete-profile-backup.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"password":{"type":"string","description":"Your account password for verification","example":"your_account_password"},"otp_type":{"type":"string","enum":["authenticator","sms","email"],"description":"Type of OTP if 2FA is enabled (optional)","example":"authenticator"},"pin_code":{"type":"string","description":"OTP code if 2FA is enabled (optional)","example":"123456"}}},"examples":{"Without 2FA":{"value":{"password":"your_account_password"}},"With 2FA enabled":{"value":{"password":"your_account_password","otp_type":"authenticator","pin_code":"123456"}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-profile-backup.StatusCodes.json b/docs/api/delete-profile-backup.StatusCodes.json new file mode 100644 index 00000000..f6b06c5c --- /dev/null +++ b/docs/api/delete-profile-backup.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Backup deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Backup successfully removed"},"status":{"type":"boolean","example":true}}}}}},"401":{"description":"Unauthorized - Invalid password or OTP","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid password"}}}}}},"404":{"description":"Not found - Backup does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup not found or you don't have permission to delete it."}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-profile-backup.api.mdx b/docs/api/delete-profile-backup.api.mdx index 58b6734a..8275f59a 100644 --- a/docs/api/delete-profile-backup.api.mdx +++ b/docs/api/delete-profile-backup.api.mdx @@ -18,120 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Permanently removes a backup from storage. This action is irreversible. **Security:** This endpoint requires account password verification to prevent accidental or unauthorized deletion. If you have Two-Factor Authentication (2FA) enabled, you must also provide the OTP code. - + + + Request + + {...require("./delete-profile-backup.ParamsDetails.json")} +> + + + {...require("./delete-profile-backup.RequestSchema.json")} +> + + + {...require("./delete-profile-backup.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-token.ParamsDetails.json b/docs/api/delete-token.ParamsDetails.json new file mode 100644 index 00000000..38366912 --- /dev/null +++ b/docs/api/delete-token.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"tokenID","in":"path","required":true,"schema":{"type":"string","example":"(Type a token ID to be deleted)"}}]} \ No newline at end of file diff --git a/docs/api/delete-token.RequestSchema.json b/docs/api/delete-token.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-token.StatusCodes.json b/docs/api/delete-token.StatusCodes.json new file mode 100644 index 00000000..b4d19333 --- /dev/null +++ b/docs/api/delete-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Delete Token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Token Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-token.api.mdx b/docs/api/delete-token.api.mdx index 1cb42b8c..9a541674 100644 --- a/docs/api/delete-token.api.mdx +++ b/docs/api/delete-token.api.mdx @@ -18,45 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete a token - + + + Request + - - + {...require("./delete-token.ParamsDetails.json")} +> + + + + + + + {...require("./delete-token.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-user.ParamsDetails.json b/docs/api/delete-user.ParamsDetails.json new file mode 100644 index 00000000..25da7410 --- /dev/null +++ b/docs/api/delete-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file diff --git a/docs/api/delete-user.RequestSchema.json b/docs/api/delete-user.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-user.StatusCodes.json b/docs/api/delete-user.StatusCodes.json new file mode 100644 index 00000000..8352775e --- /dev/null +++ b/docs/api/delete-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting a RUN user by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-user.api.mdx b/docs/api/delete-user.api.mdx index 8dedea10..06be5771 100644 --- a/docs/api/delete-user.api.mdx +++ b/docs/api/delete-user.api.mdx @@ -18,40 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Delete user from Run using userID - + + + Request + + {...require("./delete-user.ParamsDetails.json")} +> + + - + + + + {...require("./delete-user.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/delete-widget.ParamsDetails.json b/docs/api/delete-widget.ParamsDetails.json new file mode 100644 index 00000000..c53ccfe7 --- /dev/null +++ b/docs/api/delete-widget.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file diff --git a/docs/api/delete-widget.RequestSchema.json b/docs/api/delete-widget.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/delete-widget.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/delete-widget.StatusCodes.json b/docs/api/delete-widget.StatusCodes.json new file mode 100644 index 00000000..5d7f7469 --- /dev/null +++ b/docs/api/delete-widget.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Deleting a Widget","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting a Widget":{"value":{"result":"Successfully Removed","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/delete-widget.api.mdx b/docs/api/delete-widget.api.mdx index fb637a43..caa66579 100644 --- a/docs/api/delete-widget.api.mdx +++ b/docs/api/delete-widget.api.mdx @@ -18,52 +18,59 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Delete a widget from the dashboard. -:::warning +:::warning -Deleting a widget does not automatically remove it from the dashboard arrangement. You must manually edit the dashboard arrangement to remove the deleted widget. +Deleting a widget does not automatically remove it from the dashboard arrangement. You must manually edit the dashboard arrangement to remove the deleted widget. ::: - + + + Request + + {...require("./delete-widget.ParamsDetails.json")} +> + + - + + + + {...require("./delete-widget.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/device-data-amount.ParamsDetails.json b/docs/api/device-data-amount.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/device-data-amount.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/device-data-amount.RequestSchema.json b/docs/api/device-data-amount.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/device-data-amount.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/device-data-amount.StatusCodes.json b/docs/api/device-data-amount.StatusCodes.json new file mode 100644 index 00000000..672f7165 --- /dev/null +++ b/docs/api/device-data-amount.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a device data amount","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"number","example":529},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/device-data-amount.api.mdx b/docs/api/device-data-amount.api.mdx index e4743308..a0619c5c 100644 --- a/docs/api/device-data-amount.api.mdx +++ b/docs/api/device-data-amount.api.mdx @@ -18,37 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get the total number of data items stored within the device. - + + Request + + {...require("./device-data-amount.ParamsDetails.json")} +> + + - + + + + {...require("./device-data-amount.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/device-information.ParamsDetails.json b/docs/api/device-information.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/device-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/device-information.RequestSchema.json b/docs/api/device-information.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/device-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/device-information.StatusCodes.json b/docs/api/device-information.StatusCodes.json new file mode 100644 index 00000000..25140f78 --- /dev/null +++ b/docs/api/device-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a device information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"connector":{"type":"string","example":"60f19bda2889a60012d34167"},"created_at":{"type":"string","example":"2022-06-09T21:21:51.877Z"},"data_retention":{"type":"string","example":"forever"},"description":{"type":"string","example":"Simulates a Extrusion machine with temperature, speed and pressure"},"id":{"type":"string","example":"62a2646ffdea2f0013b1bfe7"},"last_input":{"type":"string","example":"2022-06-23T11:19:54.369Z"},"name":{"type":"string","example":"Test Chunk Monthly"},"network":{"type":"string","example":"6073cdfec79ed00011228e47"},"payload_decoder":{"example":null},"profile":{"type":"string","example":"612ea05e3cc0780012715111"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"maxTemp"},"value":{"type":"string","example":"20"}}},"example":[{"key":"maxTemp","value":"20"},{"key":"minTemp","value":"0"}]},"type":{"type":"string","example":"mutable"},"updated_at":{"type":"string","example":"2022-06-09T21:53:22.752Z"},"visible":{"type":"boolean","example":true}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/device-information.api.mdx b/docs/api/device-information.api.mdx index 5e30b18d..2aff7ff2 100644 --- a/docs/api/device-information.api.mdx +++ b/docs/api/device-information.api.mdx @@ -18,75 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Device information - + + Request + + {...require("./device-information.ParamsDetails.json")} +> + + - + + + + {...require("./device-information.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/download-profile-backup.ParamsDetails.json b/docs/api/download-profile-backup.ParamsDetails.json new file mode 100644 index 00000000..48bfa133 --- /dev/null +++ b/docs/api/download-profile-backup.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"},{"name":"backup_id","in":"path","required":true,"schema":{"type":"string","example":"678abc123def456789012345"},"description":"The ID of the backup to download"}]} \ No newline at end of file diff --git a/docs/api/download-profile-backup.RequestSchema.json b/docs/api/download-profile-backup.RequestSchema.json new file mode 100644 index 00000000..8cf58e9a --- /dev/null +++ b/docs/api/download-profile-backup.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"password":{"type":"string","description":"Your account password for verification","example":"your_account_password"},"otp_type":{"type":"string","enum":["authenticator","sms","email"],"description":"Type of OTP if 2FA is enabled (optional)","example":"authenticator"},"pin_code":{"type":"string","description":"OTP code if 2FA is enabled (optional)","example":"123456"}}},"examples":{"Without 2FA":{"value":{"password":"your_account_password"}},"With 2FA enabled":{"value":{"password":"your_account_password","otp_type":"authenticator","pin_code":"123456"}}}}}}} \ No newline at end of file diff --git a/docs/api/download-profile-backup.StatusCodes.json b/docs/api/download-profile-backup.StatusCodes.json new file mode 100644 index 00000000..2ea3373b --- /dev/null +++ b/docs/api/download-profile-backup.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Download URL generated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","example":"https://s3.amazonaws.com/tago-io/...?X-Amz-Algorithm=...","description":"Pre-signed S3 URL for downloading the backup (valid for 2 hours)"},"size":{"type":"number","example":15728640,"description":"File size in bytes"},"size_unit":{"type":"string","example":"bytes"},"file_size_mb":{"type":"string","example":"15.00","description":"File size in megabytes (formatted)"},"expire_at":{"type":"string","example":"2025-01-07T16:30:00.000Z","description":"When the download URL expires"},"backup_id":{"type":"string","example":"678abc123def456789012345"},"created_at":{"type":"string","example":"2025-01-07T14:30:00.000Z"}}}}}},"400":{"description":"Bad request - Backup not ready or invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup is not ready for download. Current status: processing"}}}}}},"401":{"description":"Unauthorized - Invalid password or OTP","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid password"}}}}}},"404":{"description":"Not found - Backup does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup not found or you don't have permission to access it."}}}}}}}} \ No newline at end of file diff --git a/docs/api/download-profile-backup.api.mdx b/docs/api/download-profile-backup.api.mdx index 95dc0f9b..19987da6 100644 --- a/docs/api/download-profile-backup.api.mdx +++ b/docs/api/download-profile-backup.api.mdx @@ -18,14 +18,24 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Generates a secure, time-limited download URL for a specific backup. The download URL is valid for **2 hours**. @@ -33,134 +43,32 @@ Generates a secure, time-limited download URL for a specific backup. The downloa **Important:** Only backups with status `completed` can be downloaded. - + + + Request + + {...require("./download-profile-backup.ParamsDetails.json")} +> + + + {...require("./download-profile-backup.RequestSchema.json")} +> + + + {...require("./download-profile-backup.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/duplicate-dashboard.ParamsDetails.json b/docs/api/duplicate-dashboard.ParamsDetails.json new file mode 100644 index 00000000..ad79fd90 --- /dev/null +++ b/docs/api/duplicate-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file diff --git a/docs/api/duplicate-dashboard.RequestSchema.json b/docs/api/duplicate-dashboard.RequestSchema.json new file mode 100644 index 00000000..fdb6c054 --- /dev/null +++ b/docs/api/duplicate-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"new_label":{"type":"string","description":"New label for the duplicated dashboard.","example":"Ice Cream Machine and Freezer - Copy"},"setup":{"type":"object","description":"Setup configuration for the duplicated dashboard.","properties":{"is_configured":{"type":"boolean","description":"Indicates if the dashboard is configured.","example":true},"config":{"type":"array","description":"List of configuration objects for the dashboard.","items":{"type":"object","properties":{"id":{"type":"string","description":"Analysis ID, Device ID, Blueprint Device/Entity ID.","example":"68c9baabb24379000ab1c8cc"},"name":{"type":"string","description":"Reference name that will be displayed when setting up the copy.","example":"Freezer Simulator"}}}}}}}},"examples":{"Duplicate dashboard":{"value":{"setup":{"is_configured":true,"config":[{"id":"68c9baabb24379000ab1c8cc","name":"Freezer Simulator"}]},"new_label":"Ice Cream Machine and Freezer - Copy"}}}}}}} \ No newline at end of file diff --git a/docs/api/duplicate-dashboard.StatusCodes.json b/docs/api/duplicate-dashboard.StatusCodes.json new file mode 100644 index 00000000..ffcb4883 --- /dev/null +++ b/docs/api/duplicate-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Dashboard duplicated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"dashboard_id":{"type":"string","example":"62b0df7927ce4d0012cf3c10"},"message":{"type":"string","example":"Copy sent"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/duplicate-dashboard.api.mdx b/docs/api/duplicate-dashboard.api.mdx index 2cd34913..9f7bd479 100644 --- a/docs/api/duplicate-dashboard.api.mdx +++ b/docs/api/duplicate-dashboard.api.mdx @@ -5,7 +5,7 @@ description: "Duplicate an existing dashboard, including its configuration, widg sidebar_label: "Duplicate Dashboard" hide_title: true hide_table_of_contents: true -api: eJztWFlvGzkS/isF5mFmhG5ZkiUfehjAE2d3hc0mgQ8MFraRochqieMW2SHZVnoE/fdFsW8fcQYYzNPqxXJ3sc6vil9pxzxfOTa/YefcrZeGW+nYXcQkOmFV5pXRbM7O8yxVgnsErgG/KueVXoGsT0SgtEhzSQ+VdyCMTtQqt5yOR7BVcoXeRcC1BIeeDrshwK3+GAzwNC0iegEcNG4h5UtMITEW/BpB1rZlazBoyqx5UBLpYJ5Bxi3foEfrwBsQufNmo/7AoEKYrAj2bvW1o0fKAWqZGaU9SX/JlbhPCxCp0dhaccEHi7lDMBaS3Po12kZ3iG4IpJdFzGRYxruQbM4ap5ussohZ/JKj878YWbD5LvyrLEo2T3jqMGLCaI/a0zueleeV0Qe/O6rBjjmxxg2nb77IkM2ZWf6OwrOIZZase4WO3mrcfg4p7Ig6b5Vescd1/fBd2R6yiOFXvslSUrUQCG8t8g38h4u10hiK8Q+L+AdaiOGtyQq2j1goy3Pe9l24DNXrIeZVZ/rxKve5Pk7JbAwujUmR6ycWF1oGpQ5UUpppYKVa7GI/bG9z3IcSJWrVMcKt5cUTE++V82CSR2GVGXBteN2YlMeNe724Sr5e1TPN08IpB4vzCM7xQQkMX39Jc8wsYb58ePBOe+ULWJz3K3x0Ik6XnC+Xk+nh8eloNOLLsTgRgqqq+QZf9+ACE7SoBQLJg19zD1uVprBEkMplKS9QwnaNup4HkGdtq/a8qZF1qTZ5yr2xbF99GqmQmXZGNXmlxw88zYPHDR4f4YUq2xb2pkzxyzmoU/CcX3eUoLb7vrNVqlgsusxoVwYzGY3pz6Mp3OC00xguFwKdS/I0JRz+RTPEostT/7pck+rPzwOzA6rJciST49PJscCpHI3GE5EcivGIQLVB5/jqWVy1CihZ4Ci2kC7nuc/ds+3eb9o6v+0FEapcVbEJYHFOTUhpzrhfV9NadRDyJHXP+PjjVZEh8M5EWZz/xPb7O4rRrw0hKzMu5JGszNlBI3qw6/iyP2hKzGiU2ofa79wSstbeZ25+cMAzNcxdjOOh5yszVIbto+dkMI+3HZk70ilyq3wRlH6yJlEpXpl71Gx+c9cVuKS4qxYLYyOuxNoZmKl/49MheAZd+XIIKAe5Vl9ypGu3MLkFGWSG8E/UdIFS9nyQXxbAA7RpOgTRUt0PDjK+wmHbiT23qiKukUu0LGJf47Y8MxxPDqczHsvjEY+nOJHx8uRQxjMxCi+Ojk9OCY8f0G+Nvf/+QKsD8M1IK6EhnIWwYKE9rsqrwcHPjY6fSy2BxqweJ4Wujp6yNgsvhX9eztsPpVQ/tH56EjmbnnI5iU/GhyKeyqOjeJkcT+LZ6ARny9MTnuAhpadCy/enpzpQxfBCelB7ZZFYHcl2AKF0KcCFMLn2LYNsY+979C0I8PEM+Qx5LOVExlNxdBifnE5n8elkOZtKPj0+nnBG44Im5kVL2N7VGnZ/fsJHf8/ds6e4ExMKonyI9oqvzOIjnH1aPKnKmzdv3sBg8C+zpQrkNS2WRuQb1D7AcjC41VdEVLoPqXQuS5WnDt2ulVhXdS1M/oNFqOdmrVbpcLFX5DfQ8MqtisA7mIJUSWAMvtTl5rc6hsGg29mDwRzImaoRrNl0B0hUuVKYHATXsEJfygSi1RsctxoCaScDPeCQhbPUGbjXZgvcUaMS4sq3Q/ivyVu9wXYF1gaSTw30+o0MLFxw6XEUzXD4qNMC+ANXKV+mSBS1yqvZarREKum4roZF3RuqO0ueOFETwtKL+WDwbCJ5JRV1zZfFq1/VquM4vtUBQZcVfSOps08LeFevVRe4Ukbf6l+J5G34PQnxGgWEDTrR4jMKldvkzgOnErgMhUqK0npGpMMqGgY2qOVps78N4e3aGNrQNNbZSUyami1ZrKUcLLlDCabK1wrNyvJsrQRPK51zWg8pW9daEbG69GFHeMedhzHlDMqUPt0gA48tU9hSLmqT0maVQ+TOo9XQUz+stQ4G1xfvycpvL17tB791a/ouJyIGv+Jf4B4pIddKna/41KMS5FPpD5USzjFLTdF4Qw3j1iZPZZgEwQez1QEo1xfvm5ugh7fyqjcbrrQDh6JcnZIGL6UNGv7EicphNh6OhqOK/XJBvDUwPuP8hocbqmYKzY7Q3ct7g3HXUuj//+zx+s8e1dXv8as/yFKuNBGEwD93FcW9aTk2i9i8T7hblnsXsTUx4/kN2+0Imdc23e/p8ZccLdHUu4g9cKsIJ+GulMrR9/b3kxfr+ONFdSf9BC+5XFMYTdd1tTMyFrF7LB5tCWHLq7gFuVFKvC2NxbQAdDQ82cGInpcniAVm/puy3bXh08fLKxaxZfXj0cZIOmP5llYVvi29NSH4coOjZzuWcr3Kw27FSp30+R96tt36 +api: eJztWFlvGzkS/isF5mFmhG5ZkiUfehjAE2d3hc0mgQ8MFraRochqieMW2SHZVnoE/fdFsW8fcQYYzNPqxXJ3sc6vil9pxzxfOTa/YefcrZeGW+nYXcQkOmFV5pXRbM7O8yxVgnsErgG/KueVXoGsT0SgtEhzSQ+VdyCMTtQqt5yOR7BVcoXeRcC1BIeeDrshwK3+GAzwNC0iegEcNG4h5UtMITEW/BpB1rZlazBoyqx5UBLpYJ5Bxi3foEfrwBsQufNmo/7AoEKYrAj2bvW1o0fKAWqZGaU9SX/JlbhPCxCp0dhaccEHi7lDMBaS3Po12kZ3iG54q1nETIZlsAvJ5qzxuEkpi5jFLzk6/4uRBZvvwr/KomTzhKcOIyaM9qg9veNZeV4ZffC7owLsmBNr3HD65osM2ZyZ5e8oPItYZsm6V+jorcbt55C/jqjzVukVe1zUD9+V6iGLGH7lmywlVQuB8NYi38B/uFgrjaES/7CIf6CFGN6arGD7iIWaPOdt34XLULoeXF51ph+vcp/r45TMxuDSmBS5fmJxoWVQ6kAlpZkGU6oFLvbD9jbHfShRolYdI9xaXjwx8V45DyZ5FFaZAdeG141Jedy414ur5OtVPdM8LZxysDiP4BwflMDw9Zc0x8wS4MuHB++0V76AxXm/wkcn4nTJ+XI5mR4en45GI74cixMhqKqab/B1Dy4wQYtaIJA8+DX3sFVpCksEqVyW8gIlbNeo62EAedb2ac+bGlmXapOn3BvL9tWnkQqZaQdUk1d6/MDTPHjc4PERXqiybWFvyhS/nIM6Bc/5dUcJarvvO1ulisWiy4x2ZTCT0Zj+PBrBDU47jeFyIdC5JE9TwuFfNEMsujz1r8s1qf78PDA7oJosRzI5Pp0cC5zK0Wg8EcmhGI8IVBt0jq+exVWrgJIFjmIL6XKe+9w92+79pq3z294OocpVFZsAFufUhJTmjPt1Na1VByFPUveMjz9eFRkC70yUxflPbL+/oxj92hCyMuNCHsnKnB00oge7ji/7g6bEjEapfaj9zi0ha+195uYHBzxTw9zFOB56vjJDZdg+ek4G83jbkbkjnSK3yhdB6SdrEpXilblHzeY3d12BS4q7arEwNuJKrJ2Bmfo3Ph2CZ9CVL4eAcpBr9SVHunMLk1uQQWYI/0RNFyhlzwf5ZQE8QJumQxAt1f3gIOMrHLad2HOrKuIauUTLIvY1bsszw/HkcDrjsTwe8XiKExkvTw5lPBOj8OLo+OSU8PgB/dbY++8PtDoA34y0EhrCWQgLFtrjqrwaHPzc6Pi51BI4zOpxUujq6Clrs/BS+OflvP1QSvVD66cnkbPpKZeT+GR8KOKpPDqKl8nxJJ6NTnC2PD3hCR5Seiq0fH96qgNVDC+kB7VXFonSkWwHEEqXAlwIk2vf0sc29r5H34IAH8+Qz5DHUk5kPBVHh/HJ6XQWn06Ws6nk0+PjCWc0LmhiXrSE7V2tYffnJ3z099w9e4o7MaEgyodor/jKLD7C2afFk6q8efPmDQwG/zJbqkBec2JpRL5B7QMsB4NbfUVEpfuQSueyVHnq0O1aiXVV18LkP1iEem7WapUOF3tFfgMHr9yq2LuDKUiVBMbgS11ufqtjGAy6nT0YzIGcqRrBmk13gESVK4XJQXANK/SlTCBavcFxqwHICzLQAw5ZOEudgXtttsAdNSohrnw7hP+avNUbbFdgbSD51ECv38jAwgWXHkfRDIePOi2AP3CV8mWKRFGrvJqtRkukko7raljUvaG6s+SJEzUhLL2YDwbPJpJXUlHXfFm8+lWtOo7jWx0QdFnRN5I6+7SAd/VOdYErZfSt/pVI3obfkxCvUUDYoBMtPqNQuU3uPHAqgctQqKQorWdEOqyiYWCDWp42y9sQ3q6NofVMY52dxKSp2ZLFWsrBkjuUYKp8rdCsLM/WSvC00jmn3ZCyda0VEatLH3aEd9x5GFPOoEzp0/Ux8NgyhS3lojYpbVY5RO48Wg099cNa62BwffGerPz24tV+8Fu3pu9yImLwK/4F7pEScq3U+YpPPSpBPpX+UCnhHLPUFI031DBubfJUhkkQfDBbHYByffG+uQl6eCuverPhSjtwKMrVKWnwUtqg4U+cqBxm4+FoOKrYLxfEWwPjM85veLihaqbQ7Ajdvbw3GHcthf7/bx6v/OZR3fsev/qDLOVKEzsI5HNX8dublmCziM37bLuluHcRWxMtnt+w3Y5geW3T/Z4ef8nREke9i9gDt4pAEi5KqRx9b388ebGIP15UF9JP8JLLNX/RdFdXCyNjEbvH4tGKEFa8iliQG6XE29JYTOy/o+HJAkbcvDxBFDDz35Tt7gyfPl5esYgtq1+ONkbSGcu3tKfwbemtCcGX6xs927GU61UeFitW6qTP/wCSDN06 sidebar_class_name: "post api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -18,106 +18,56 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Duplicate an existing dashboard, including its configuration, widgets, and settings. -Optionally, set a new label for the duplicated dashboard and provide setup parameters to customize the copy. +Optionally, set a new label for the duplicated dashboard and provide setup parameters to customize the copy. Use this endpoint to quickly clone dashboards for reuse or further customization. - + + + Request + + {...require("./duplicate-dashboard.ParamsDetails.json")} +> + + + {...require("./duplicate-dashboard.RequestSchema.json")} +> + + + {...require("./duplicate-dashboard.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-a-file.RequestSchema.json b/docs/api/edit-a-file.RequestSchema.json new file mode 100644 index 00000000..4470d7cc --- /dev/null +++ b/docs/api/edit-a-file.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","example":"/layer05.png"},"to":{"type":"string","example":"/images/layer05.png"}}},"example":[{"from":"/layer05.png","to":"/images/layer05.png"}]},"examples":{"Edit a file":{"value":[{"from":"/layer05.png","to":"/images/layer05.png"}]}}}}}} \ No newline at end of file diff --git a/docs/api/edit-a-file.StatusCodes.json b/docs/api/edit-a-file.StatusCodes.json new file mode 100644 index 00000000..68ae3d50 --- /dev/null +++ b/docs/api/edit-a-file.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Edit a file","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Edit a file":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-a-file.api.mdx b/docs/api/edit-a-file.api.mdx index 28b9a240..82916013 100644 --- a/docs/api/edit-a-file.api.mdx +++ b/docs/api/edit-a-file.api.mdx @@ -18,57 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Move file location within your profile - + + Request + - + + + + {...require("./edit-a-file.RequestSchema.json")} +> + + + {...require("./edit-a-file.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-account.RequestSchema.json b/docs/api/edit-account.RequestSchema.json new file mode 100644 index 00000000..c27f756a --- /dev/null +++ b/docs/api/edit-account.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"string","example":"TagoIO"},"language":{"type":"string","example":"en"},"name":{"type":"string","example":"John Doee"},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"YYYY-MM-DD"},"decimal_separator":{"type":"string","example":"."},"show_last_updated_at":{"type":"string","example":"footer"},"thousand_separator":{"type":"string","example":","},"time_format":{"type":"string","example":"24"}}},"phone":{"type":"string","example":"+00000000000"},"timezone":{"type":"string","example":"America/Glace_Bay"}}},"examples":{"Edit Account":{"value":{"company":"TagoIO","language":"en","name":"John Doee","options":{"date_format":"YYYY-MM-DD","decimal_separator":".","show_last_updated_at":"footer","thousand_separator":",","time_format":"24"},"phone":"+00000000000","timezone":"America/Glace_Bay"}}}},"text/plain":{"examples":{"Edit Account":{"value":"{\n \"language\": \"en\",\n \"name\": \"Account Name\",\n \"options\": {\n \"date_format\": \"YYYY-MM-DD\", //\"YYYY-MM-DD\", \"DD-MM-YYYY\", or \"MM-DD-YYYY\"\n \"time_format\": \"12\", //\"12\" or \"24\"\n \"decimal_separator\": \".\", //must be the oposite of the \"thousand_separator value\"\n \"thousand_separator\": \",\", //must be the oposite of the \"decimal_separator value\"\n \"show_last_updated_at\": \"footer\" //widget \"footer\" or \"menu\"\n },\n \"phone\": \"+00000000000\", //type the country code plus the phone number\n \"timezone\": \"America/Glace_Bay\",\n \"company\": \"TagoIO\"\n}"}}}}}} \ No newline at end of file diff --git a/docs/api/edit-account.StatusCodes.json b/docs/api/edit-account.StatusCodes.json new file mode 100644 index 00000000..66f9928f --- /dev/null +++ b/docs/api/edit-account.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Account edited successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Account Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Account edited successfuly":{"value":{"result":"Account Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-account.api.mdx b/docs/api/edit-account.api.mdx index 840c46b5..56614804 100644 --- a/docs/api/edit-account.api.mdx +++ b/docs/api/edit-account.api.mdx @@ -18,93 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit current account - - + + Request + + + + + + {...require("./edit-account.RequestSchema.json")} +> + + + {...require("./edit-account.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-dashboard.ParamsDetails.json b/docs/api/edit-dashboard.ParamsDetails.json new file mode 100644 index 00000000..ad79fd90 --- /dev/null +++ b/docs/api/edit-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file diff --git a/docs/api/edit-dashboard.RequestSchema.json b/docs/api/edit-dashboard.RequestSchema.json new file mode 100644 index 00000000..fa734f0c --- /dev/null +++ b/docs/api/edit-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The Dashboard Label"},"type":{"type":"string","enum":["dashboard","blueprint"],"example":"blueprint","description":"The type of dashboard. Can be \"dashboard\" or \"blueprint\"."},"group_by":{"type":"array","items":{}},"visible":{"type":"boolean","example":true,"description":"Determines if the dashboard is visible in the sidebar. If set to false, the dashboard remains accessible from the Dashboard list."},"icon":{"type":"object","properties":{"color":{"type":"string","example":"hsl(328, 89%, 47%)"},"url":{"type":"string","example":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"}}},"tabs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"1648142133869"},"link":{"type":"string","example":""},"value":{"type":"string","example":"new tab test"}}},"example":[{"key":"1648142133869","link":"","value":"new tab test"},{"key":"1648142564354","link":"","value":"new tab 2 "},{"key":"1648142571171","link":"","value":"new tab 3 "}]},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"updatedkey"},"value":{"type":"string","example":"updatedvalue"}}},"example":[{"key":"updatedkey","value":"updatedvalue"},{"key":"updatedkey","value":"updatedvalue"}]},"blueprint_devices":{"type":"array","description":"Only present for dashboards of type \"blueprint\".\nDefines the list of devices associated with a blueprint dashboard. Each device entry describes a device type, its conditions, and optional filter conditions.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the blueprint device.","example":"68d2f3e0a6343f0009318e4c"},"name":{"type":"string","description":"The name of the blueprint.","example":"sensor"},"type":{"type":"string","description":"The type of the blueprint.","enum":["device","entity"],"example":"device"},"conditions":{"type":"array","description":"List of tag conditions that define this blueprint's characteristics.","items":{"type":"object","properties":{"key":{"type":"string","description":"The condition key.","example":"is_sensor"},"value":{"type":"string","description":"The condition value.","example":"true"}}},"example":[{"key":"is_sensor","value":"true"}]},"filter_conditions":{"type":"array","description":"Optional filter conditions for the device.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of filter condition.","example":"tag_match"},"tag_key":{"type":"string","description":"The tag key to match.","example":"location"},"blueprint_device":{"type":"string","description":"The name of the blueprint device to match against.","example":"customer"}}},"example":[{"type":"tag_match","tag_key":"location","blueprint_device":"customer"}]}}},"example":[{"id":"68d2f3e0a6343f0009318e4c","name":"sensor","type":"device","conditions":[{"key":"is_sensor","value":"true"}],"filter_conditions":[]},{"id":"68d2f3e0a6343f0009318e4d","name":"customer","type":"device","conditions":[{"key":"company","value":"JohnDoe"}],"filter_conditions":[]}]},"arrangement":{"type":"array","description":"The arrangement property defines the layout and positioning of widgets within the dashboard grid.\n","items":{"type":"object","properties":{"height":{"type":"number","example":3,"description":"The height of the widget in grid units."},"tab":{"description":"The tab identifier if the widget is placed in a tab, or null.","example":null},"widget_id":{"type":"string","example":"6230e740f5772600124c81e1","description":"The ID of the widget."},"width":{"type":"number","example":1,"description":"The width of the widget in grid units."},"x":{"type":"number","example":0,"description":"The X (column) position of the widget in the grid."},"y":{"type":"number","example":0,"description":"The Y (row) position of the widget in the grid."}}},"example":[{"height":3,"tab":null,"widget_id":"6230e740f5772600124c81e1","width":1,"x":0,"y":0},{"height":3,"tab":null,"widget_id":"6230e75df5772600124c81e2","width":1,"x":1,"y":0},{"height":3,"tab":null,"widget_id":"6230e44cf5772600124c81de","width":1,"x":2,"y":0},{"height":3,"tab":null,"widget_id":"6230e84df5772600124c81e7","width":2.33,"x":0.33,"y":7},{"height":5,"tab":null,"widget_id":"62750cf1253eb800126aefc0","width":2,"x":2.67,"y":7}]}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-dashboard.StatusCodes.json b/docs/api/edit-dashboard.StatusCodes.json new file mode 100644 index 00000000..b8ed6663 --- /dev/null +++ b/docs/api/edit-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updating a dashboard information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Updating a dashboard information":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-dashboard.api.mdx b/docs/api/edit-dashboard.api.mdx index 36f880b4..ef0f007f 100644 --- a/docs/api/edit-dashboard.api.mdx +++ b/docs/api/edit-dashboard.api.mdx @@ -18,10 +18,24 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Modify any property of the dashboard @@ -32,192 +46,32 @@ After creating a widget, you **must manually edit the arrangement field** to inc Each item in the arrangement array represents a widget's placement and sizing. - + + + Request + + {...require("./edit-dashboard.ParamsDetails.json")} +> + + + {...require("./edit-dashboard.RequestSchema.json")} +> + + + {...require("./edit-dashboard.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-data.RequestSchema.json b/docs/api/edit-data.RequestSchema.json new file mode 100644 index 00000000..a6d96134 --- /dev/null +++ b/docs/api/edit-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"6298fcc3e0b6840012bb6abfa"},"metadata":{"type":"object","properties":{"color":{"type":"string","example":"blue"}}},"value":{"type":"string","example":"27"}}},"example":[{"id":"6298fcc3e0b6840012bb6abfa","metadata":{"color":"blue"},"value":"27"}]}},"text/plain":{"examples":{"Edit data":{"value":"[\n {\n \"id\": \"6298fcc3e0b6840012bb6abfa\",\n \"value\": \"27\", // edit the value field\n \"metadata\": { // edit the metadata field\n \"color\": \"blue\"\n }\n }\n]"}}}}}} \ No newline at end of file diff --git a/docs/api/edit-data.StatusCodes.json b/docs/api/edit-data.StatusCodes.json new file mode 100644 index 00000000..b489dd36 --- /dev/null +++ b/docs/api/edit-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing data register by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 item(s) updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-data.api.mdx b/docs/api/edit-data.api.mdx index e7f616a0..cc0dd17e 100644 --- a/docs/api/edit-data.api.mdx +++ b/docs/api/edit-data.api.mdx @@ -5,7 +5,7 @@ description: "Edit specific data stored in the device. Same properties as the Cr sidebar_label: "Edit Data" hide_title: true hide_table_of_contents: true -api: eJzlV1tv47gV/isHnIdtDclxHDsXPSyQToI26HZ3MEmwKGIDeywe29zIpIak4jEM/ffikJItTSZpF2ifmodEIc/9+nEvPK6cyJ7EDb2onOAGPYp5IiS53KrSK6NFJm6l8uBKytVS5SDRIzhvLElQGvyaQAbuIdzjhqC0piTrFTlAF64/WkIfhYNygHlOpSeZALFgS18qZSmS3t3AUlEhwSyjZObxBhYUiEkOZzrLMqWXBmCmH9bKBQHkPIs2utgBvqAqcFEQbNekoXJKr+AflQ9H995YXBEYDdFnx3KyLAMQiWDLkb2+kyITrDFEJBGO8soqvxPZ074JVvpgnkmL7GlezxPRGPEXI3ci24vcaE/a8yeWZaHyIPXkd8cB3QuXr2mD/OV3JYlMoLW4E4lQnjauc24Wv1PuRZSvLElOlpKco2OcmV7JDpfzVumVSAR9xU1Z8NH5+OpymednNFqcX05Go9PxYnGOiyWKOhEb8siR/p7ivprcFMa+r2lRVCTquk7EC/Lnu8Tji0h6OHmKrrxjb9/cxqBG60FnEDxnyZ6++pOyQBUC3+gJvoSybuW0fE8zDQCwj3/4ZyaUnIkMZm/bNBNJlz7Iiizji5lI4OQkljpXdLiMRd7laX1itn2Pob35lifyBf+jrkXQeiSo42c903MOMgfDkiuNdtH/8WjEf173OvdL0GhppZwnC4sd3N2I5A+X9RtVZMlVhX+/Mk6Be+FP7s9QlRI9Sc6u8+irbn8sjCkIdZfT24rqunF4Q35tuJ7KKpiBfi0ycSLbrrYvZF2ousoWIhNr70uXnZxgqYaVS+l06HFlhsqIOvkeDVXptkMzP06Ke45FdLc/L449X6q/Ezd9PwPX0KUHv8Yw2iqtvlTEs3BnKnsYuX8lzSOLgMck0y92YcC6MPUCaRT3g4MSVzQUidC4Yf09sxLBDSLWhJKsSMTX9JiKKZ2OzyZTTOXFCNMJjWW6uDyT6TQfhYvzi8srzs7P5LfGPv/njjYM8K6nDdEQroNbcKc9reKUdvDjQcaPUYpjvtW3QVka2xd2jMJb7t8oVxa4+zlS9V3rh2cpp5MrlOP08vQsTyfy/DxdLC/G6XR0SdPF1SUu6YzD88mapSr+QB00DI0Pb4SHtFc2bF2m7RSE0pEA89xU2oMjz53tOr73LXqvBPB0SjglTKUcy3SSn5+ll1eTaXo1XkwnEicXF2MU3HA8Cj4fd+Ht/2Sus6VLE0KofLDvAVfm7he4/nT3Ko4fPnz4AIPB38yWY1Y5As+oQZq82pD2oZAGA8YS1D/kYLuyUJ57artW+brJxM5UP1hqgYtsxTZgqEECw4BPolmlNS9KkoMJSLVckiXtoyyXzXQKg0G3FweDDNiYpnSt2XRbPmlM2ZkKctSwIh9pjkCsbfU4/6OCXqpZw3XhDDxrs2WUdh1rJN4O4Z+mOsoNupvyOhTRawW9DmEFdxHRfevFoZ1/6WM1tWzjaraabAsAddPebTWrbve/MuJaY7FzykUrssHgu4HEhirpqo/Ja69a0WmaznSooPvoeaC6/nQHt1qWRmkPn2mljJ7pXxlsbvCZifAASr0JHMf6TELmNpXzgJyCiKt3UXvJe9Iqbl8bxGIB1Cgawse1MY6hK7XRWZqiMFvW2FI5WKAjyfg2+Lois7JYrlWORSMzm+kYrUfNiBruPXpycIvOwynHDGJIH9tWaWVHPB1DeNz+3CZRZxNDQsYMGnrih63UweDx80+s5bc3d+3Jb92c3laMHeBX+i+Yx0LYtCjz39jU2+1sU7SHUwk3VBZmd7CGG8atTVXIMAmCDWarQ6E8fv7pMLt79RaXs9mg0g4c5cHaJrGsJOrgcc0gJQ6z0+FoOGqAGOYMoXjolsb5DYad0kz2gG2bt0tvHHaeJv9H77pm03beAnUS0dy+wYRPQjZv37Vxnv/f77lsHm1R13z8pSLLz7857yKrWGl4+yXtwuQV90w7kYmPMcLpA2s9rq5XiJkhZeS4DqF7l3beAbOfHh9EIhbNW3NjJLNY3PI7EbciE+EpG2ZkgNt8thcF6lWFK6aNIrl0sGLvu1jkOWCR5oOdaq/0rmPgN+AxusG/2anvcuz3EejU9YE+Xr3JcUAikZqzNq/r+l/QppZn +api: eJzlV1tv47gV/isHnIdtDclxHDsXPSyQToI26HZ3MEmwKGIDeywe29zIpIak4jEM/ffikJItTSZpF2ifmodEIc/9+nEvPK6cyJ7EDb2onOAGPYp5IiS53KrSK6NFJm6l8uBKytVS5SDRIzhvLElQGvyaQAbuIdzjhqC0piTrFTlAF64/WkIfhYNygHlOpSeZALFgS18qZSmS3t3AUlEhwSyjZObxBhYUiEkOZzrLMqWXBmCmH9bKBQHkPIs2utgBvqAqcFEQbNekoXJKr+AflQ9H995YXBEYDdFnx3KyLBOJYLuRfb6TIhOsL8QjEY7yyiq/E9nTvglV+mCeSYvsaV7PE9GY8BcjdyLbi9xoT9rzJ5ZlofIg9eR3x+HcC5evaYP85XcliUygtbgTiVCeNq5zbha/U+5FlK8sSU6VkpyhY5SZXskOl/NW6ZVIBH3FTVnw0fn46nKZ52c0WpxfTkaj0/FicY6LJYo6ERvyyHH+nuK+mtwUxr6vaVFUJOq6TsQL8ue7xOOLSHo4eYquvGNv39zGoEbrQWcQPGfJnr76k7JAFQLf6Am+hKJu5bR8TzMNALCPf/hnJpSciQxmb9s0E0mXPsiKLOOLmUjg5CQWOtdzuIwl3uVpfWK2fY+hvfmWJ/IF/6OuRdB6JKjjZz3Tcw4yB8OSK4120f/xaMR/Xnc6d0vQaGmlnCcLix3c3YjkD5f1G1VkyVWFf78yToF74U/uz1CVEj1Jzq7z6KtufyyMKQh1l9Pbiuq6cXhDfm24nsoqmIF+LTJxItuuti9kXai6yhYiE2vvS5ednGCphpVL6XTocWWGyog6+R4NVem2QzM/Top7jkV0tz8vjj1fqr8TN30/A9fQpQe/xjDYKq2+VMSTcGcqexi4fyXNI4uAhyTTL3ZhvLow8wJpFPeDgxJXNBSJ0Lhh/T2zEsENItaEkqxIxNf0mIopnY7PJlNM5cUI0wmNZbq4PJPpNB+Fi/OLyyvOzs/kt8Y+/+eONgzwrqcN0RCug1twpz2t4pR28ONBxo9RimO+1bdBWRrbF3aMwlvu3yhXFrj7OVL1XeuHZymnkyuU4/Ty9CxPJ/L8PF0sL8bpdHRJ08XVJS7pjMPzyZqlKv5AHTQMjQ9vhIe0VzbsXKbtFITSkQDz3FTagyPPne06vvcteq8E8HRKOCVMpRzLdJKfn6WXV5NpejVeTCcSJxcXYxTccDwKPh934e3/ZK6zpUsTQqh8sO8BV+buF7j+dPcqjh8+fPgAg8HfzJZjVjkCz5hBmrzakPahkAYDRhLUP+Rgu7JQnntqu1b5usnEzlQ/WGphi2zFNlCoQQLDgE6iWaU1L0qSgwlItVySJe2jLJfNdAqDQbcXB4MM2JimdK3ZdFs+aUzZmQpy1LAiH2mOMKxt9Tj/o4JeqlnDdeEMPGuzZYx2HWsk3g7hn6Y6yg26m/I6FNFrBb0OYQV3Ec9968WhnX/pIzW1bONqtppsC/90095tNatu978y4lpjsXPKRSuyweC7gcSGKumqj8lrr1rRaZrOdKig++h5oLr+dAe3WpZGaQ+faaWMnulfGWpu8JmJ8ABJvQkcx/pMQuY2lfOAnIKIqndRe8l70ipuXxvEYgHUKBrCx7UxjoErtdFZmqIwW9bYUjlYoCPJ6Db4uiKzsliuVY5FIzOb6RitR814Gu49enJwi87DKccMYkgf21ZpZUc0HUN43P7cJlFnE0NCxgwaeuKHrdTB4PHzT6zltzd37clv3ZzeVowd4Ff6L5jHQti0KPPf2NTb7WxTtIdTCTdUFmZ3sIYbxq1NVcgwCYINZqtDoTx+/ukwu3v1Fpez2aDSDhzlwdomsawk6uBxzSAlDrPT4Wg4aoAY5gyheOiWxvkNhp3STPaAbZu3S28cdp4m/zevumbPdl4CdRKx3L5BhE9CNu/etXGe/9/vuWgebVHXfPylIsuPvzlvIqtYZXj5Je265AX3TDuRiY8xvukDaz0urld4mQFl5LgOgXuXdt6Bsp8eH0QiFs1Lc2Mks1jc8isRtyIT4SEbJmQA23y2FwXqVYUrpo0iuXCwYu+7SOQ5IJHmg51qr/SuY+A30DG6wb/Zqe9y7PcR5tT1gT5evclxwCGRmrM2r+v6X70Plec= sidebar_class_name: "put api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -18,68 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit specific data stored in the device. Same properties as the Create Data is accepted, edit requires the ID field of the data to be edited. :::info This request is only available when using Mutable Storage on Devices ::: - + + Request + - + + + + {...require("./edit-data.RequestSchema.json")} +> + + + {...require("./edit-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-device-configuration-parameter.ParamsDetails.json b/docs/api/edit-device-configuration-parameter.ParamsDetails.json new file mode 100644 index 00000000..74a0abb9 --- /dev/null +++ b/docs/api/edit-device-configuration-parameter.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/edit-device-configuration-parameter.RequestSchema.json b/docs/api/edit-device-configuration-parameter.RequestSchema.json new file mode 100644 index 00000000..58708864 --- /dev/null +++ b/docs/api/edit-device-configuration-parameter.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6114b901cd09d0fa0013636afcc"},"key":{"type":"string","example":"downlink_url"},"sent":{"type":"boolean","example":true},"value":{"type":"string","example":"https://mydownlink.url.io"}}},"example":[{"id":"6114b901cd09d0fa0013636afcc","key":"downlink_url","sent":true,"value":"https://mydownlink.url.io"}]},"examples":{"Edit Device Configuration Parameter":{"value":[{"id":"6114b901cd09d0fa0013636afcc","key":"downlink_url","sent":true,"value":"https://mydownlink.url.io"}]}}}}}} \ No newline at end of file diff --git a/docs/api/edit-device-configuration-parameter.StatusCodes.json b/docs/api/edit-device-configuration-parameter.StatusCodes.json new file mode 100644 index 00000000..58624a78 --- /dev/null +++ b/docs/api/edit-device-configuration-parameter.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Edit the configuration parameter","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Device Configuration Parameter Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-device-configuration-parameter.api.mdx b/docs/api/edit-device-configuration-parameter.api.mdx index 5673aebb..1723163e 100644 --- a/docs/api/edit-device-configuration-parameter.api.mdx +++ b/docs/api/edit-device-configuration-parameter.api.mdx @@ -18,10 +18,24 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit a device configuration parameter using the Network-token. You must already have the device ID to use this endpoint. This is useful when your Network integration requires configuration parameters for performing downlinks, or if your decoder benefits from configuration parameters for parsing data. @@ -29,66 +43,31 @@ This is useful when your Network integration requires configuration parameters f To obtain the **Device ID**, first resolve the device-token, then use the [Device Information](/docs/api/current-device-information) endpoint to retrieve detailed information about the device. ::: - + + Request + + {...require("./edit-device-configuration-parameter.ParamsDetails.json")} +> + + + {...require("./edit-device-configuration-parameter.RequestSchema.json")} +> + + + {...require("./edit-device-configuration-parameter.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-device-data.ParamsDetails.json b/docs/api/edit-device-data.ParamsDetails.json new file mode 100644 index 00000000..4af8f8f6 --- /dev/null +++ b/docs/api/edit-device-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file diff --git a/docs/api/edit-device-data.RequestSchema.json b/docs/api/edit-device-data.RequestSchema.json new file mode 100644 index 00000000..b62bd070 --- /dev/null +++ b/docs/api/edit-device-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"653aa3ab617c10000990718f"},"value":{"type":"number","example":20}}},"examples":{"Edit Device Data":{"value":{"id":"653aa3ab617c10000990718f","value":20}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-device-data.StatusCodes.json b/docs/api/edit-device-data.StatusCodes.json new file mode 100644 index 00000000..4862e0a8 --- /dev/null +++ b/docs/api/edit-device-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing a device data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 item(s) updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing a device data":{"value":{"result":"1 item(s) updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-device-data.api.mdx b/docs/api/edit-device-data.api.mdx index 49c24ebc..3839d829 100644 --- a/docs/api/edit-device-data.api.mdx +++ b/docs/api/edit-device-data.api.mdx @@ -18,66 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit specific data stored in the device. :::info This request is only available when using Mutable Storage on Devices ::: - + + Request + + {...require("./edit-device-data.ParamsDetails.json")} +> + + + {...require("./edit-device-data.RequestSchema.json")} +> + + + {...require("./edit-device-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-device.ParamsDetails.json b/docs/api/edit-device.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/edit-device.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/edit-device.RequestSchema.json b/docs/api/edit-device.RequestSchema.json new file mode 100644 index 00000000..34ee9f95 --- /dev/null +++ b/docs/api/edit-device.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":false},"connector":{"type":"string","example":"6148de43683cae0018940d0c"},"name":{"type":"string","example":"Device #2"},"network":{"type":"string","example":"5bbd120d4051a50034cd1a05"},"payload_decoder":{"type":"string","description":"Base64 formatted javascript code"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"my_tag_key"},"value":{"type":"string","example":"my_tag_value"}}},"example":[{"key":"my_tag_key","value":"my_tag_value"}]},"visible":{"type":"boolean","example":false}}},"examples":{"Edit device":{"value":{"active":false,"connector":"6148de43683cae0018940d0c","name":"Device #2","network":"5bbd120d4051a50034cd1a05","payload_decoder":"LyogVGhpcyBpcyBhIGRlZmF1bHQgZXhhbXBsZSBmb3IgcGF5bG9hZCBwYXJzZXIuCioqIFRoZSBpZ25vcmVfdmFycyB2YXJpYWJsZSBpbiB0aGlzIGNvZGUgc2hvdWxkIGJlIHVzZWQgdG8gaWdub3JlIHZhcmlhYmxlcwoqKiBmcm9tIHRoZSBkZXZpY2UgdGhhdCB5b3UgZG9uJ3Qgd2FudC4KKioKKiogVGVzdGluZzoKKiogWW91IGNhbiBkbyBtYW51YWwgdGVzdHMgdG8gdGhpcyBwYXJzZSBieSB1c2luZyB0aGUgRGV2aWNlIEVtdWxhdG9yLiBDb3B5IGFuZCBQYXN0ZSB0aGUgZm9sbG93aW5nIGNvZGU6CioqIFt7ICJ2YXJpYWJsZSI6ICJwYXlsb2FkIiwgInZhbHVlIjogIjAxMDk2MTEzOTUiIH1dCioqCiovCi8vIEFkZCBpZ25vcmFibGUgdmFyaWFibGVzIGluIHRoaXMgYXJyYXkuCmNvbnN0IGlnbm9yZV92YXJzID0gWydyZl9jaGFpbicsICdjaGFubmVsJywgJ21vZHVsYXRpb24nLCAnYXBwX2lkJywgJ2Rldl9pZCcsICd0aW1lJywgJ2d0d190cnVzdGVkJywgJ3BvcnQnXTsKCi8vIFJlbW92ZSB1bndhbnRlZCB2YXJpYWJsZXMuCnBheWxvYWQgPSBwYXlsb2FkLmZpbHRlcih4ID0+ICFpZ25vcmVfdmFycy5pbmNsdWRlcyh4LnZhcmlhYmxlKSk7CgovLyBZb3UgY2FuIGVkaXQgYW55IHZhcmlhYmxlIHRoYXQncyBiZWluZyBhZGRlZCB0byB5b3VyIGRldmljZS4KLy8gRm9yIGV4YW1wbGUsIGlmIHlvdSBuZWVkIHRvIGNvbnZlcnQgYSB2YXJpYWJsZSBmcm9tIEZhaHJlaW50aCB0byBDZWxzaXVzLCB1bmNvbW1lbnQgdGhlIGZvbGxvd2luZyBjb2RlOgovLyBjb25zdCB0ZW1wZXJhdHVyZSA9IHBheWxvYWQuZmluZCh4ID0+IHgudmFyaWFibGUgPT09ICJ0ZW1wZXJhdHVyZSIpOwovLyBpZiAodGVtcGVyYXR1cmUpIHsKLy8gICB0ZW1wZXJhdHVyZS52YWx1ZSA9ICg1IC8gOSkgKiAodGVtcGVyYXR1cmUudmFsdWUgLSAzMik7Ci8vICAgdGVtcGVyYXR1cmUudW5pdCA9ICJDIjsKLy8gfQ==","tags":[{"key":"my_tag_key","value":"my_tag_value"}],"visible":false,"chunk_retention":20}},"Immutable Chunk retention":{"value":"{\r\n \"chunk_retention\": 20 // acceptable range by period: day(0-31), week(0-26), month(0-36), quarter(0-36)\r\n}"}}}}}} \ No newline at end of file diff --git a/docs/api/edit-device.StatusCodes.json b/docs/api/edit-device.StatusCodes.json new file mode 100644 index 00000000..841b2016 --- /dev/null +++ b/docs/api/edit-device.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updating device settings","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-device.api.mdx b/docs/api/edit-device.api.mdx index 2b8451f5..ef82f52a 100644 --- a/docs/api/edit-device.api.mdx +++ b/docs/api/edit-device.api.mdx @@ -18,10 +18,24 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Modify any property of the device. @@ -29,82 +43,32 @@ You're only required to send the parameters you want to edit. If changing network/connector, make sure you've deleted all tokens in the device first. Is also required to send both network and connector to edit any of both fields. - + + + Request + + {...require("./edit-device.ParamsDetails.json")} +> + + + {...require("./edit-device.RequestSchema.json")} +> + + + {...require("./edit-device.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-entity-data.ParamsDetails.json b/docs/api/edit-entity-data.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/edit-entity-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/edit-entity-data.RequestSchema.json b/docs/api/edit-entity-data.RequestSchema.json new file mode 100644 index 00000000..b9f7f124 --- /dev/null +++ b/docs/api/edit-entity-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"672b5449dbac110009ce878f"},"monthly_revenue":{"type":"number","example":1239.45}}},"examples":{"Edit Entity Data":{"value":{"id":"672b5449dbac110009ce878f","monthly_revenue":1239.45}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-entity-data.StatusCodes.json b/docs/api/edit-entity-data.StatusCodes.json new file mode 100644 index 00000000..451438c5 --- /dev/null +++ b/docs/api/edit-entity-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing an entity data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 item(s) updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing an entity data":{"value":{"result":"1 item(s) updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-entity-data.api.mdx b/docs/api/edit-entity-data.api.mdx index 87f39934..6f2e7403 100644 --- a/docs/api/edit-entity-data.api.mdx +++ b/docs/api/edit-entity-data.api.mdx @@ -18,57 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit Entity Data - + + Request + + {...require("./edit-entity-data.ParamsDetails.json")} +> + + + {...require("./edit-entity-data.RequestSchema.json")} +> + + + {...require("./edit-entity-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-notification.ParamsDetails.json b/docs/api/edit-notification.ParamsDetails.json new file mode 100644 index 00000000..a1e9f650 --- /dev/null +++ b/docs/api/edit-notification.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"notificationID","in":"path","required":true,"schema":{"type":"string","example":"(Type your RUN notification ID)"}}]} \ No newline at end of file diff --git a/docs/api/edit-notification.RequestSchema.json b/docs/api/edit-notification.RequestSchema.json new file mode 100644 index 00000000..8137d7c5 --- /dev/null +++ b/docs/api/edit-notification.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"buttons_enabled":{"type":"boolean","example":true},"message":{"type":"string","example":"new notification message"},"read":{"type":"boolean","example":true},"title":{"type":"string","example":"new notification title"}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-notification.StatusCodes.json b/docs/api/edit-notification.StatusCodes.json new file mode 100644 index 00000000..dadbf30c --- /dev/null +++ b/docs/api/edit-notification.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing a RUN user notification","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"TagoIO Notification User Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-notification.api.mdx b/docs/api/edit-notification.api.mdx index bd1ecfc8..9515fc7d 100644 --- a/docs/api/edit-notification.api.mdx +++ b/docs/api/edit-notification.api.mdx @@ -18,62 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit notification on Run - + + + Request + + {...require("./edit-notification.ParamsDetails.json")} +> + + + {...require("./edit-notification.RequestSchema.json")} +> + + + {...require("./edit-notification.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-permission.RequestSchema.json b/docs/api/edit-permission.RequestSchema.json new file mode 100644 index 00000000..d0aac6a6 --- /dev/null +++ b/docs/api/edit-permission.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string","example":"/layer05.png"},"public":{"type":"boolean","example":true}}},"example":[{"file":"/layer05.png","public":true}]},"examples":{"Edit Permission":{"value":[{"file":"/layer05.png","public":true}]}}}}}} \ No newline at end of file diff --git a/docs/api/edit-permission.StatusCodes.json b/docs/api/edit-permission.StatusCodes.json new file mode 100644 index 00000000..4ef313f9 --- /dev/null +++ b/docs/api/edit-permission.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing file to be public","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing file to be public":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-permission.api.mdx b/docs/api/edit-permission.api.mdx index 2fa1001c..c86d5c40 100644 --- a/docs/api/edit-permission.api.mdx +++ b/docs/api/edit-permission.api.mdx @@ -18,57 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit Permission - + + Request + - + + + + {...require("./edit-permission.RequestSchema.json")} +> + + + {...require("./edit-permission.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-settings.RequestSchema.json b/docs/api/edit-settings.RequestSchema.json new file mode 100644 index 00000000..a6a3e143 --- /dev/null +++ b/docs/api/edit-settings.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":true},"name":{"type":"string","example":"My new RUN name"},"profile":{"type":"string","example":"612ea05e3cc07803480127151133"},"url":{"type":"string","example":"612ea05e3cc07803480127151133.run.tago.io"}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-settings.StatusCodes.json b/docs/api/edit-settings.StatusCodes.json new file mode 100644 index 00000000..7c749c88 --- /dev/null +++ b/docs/api/edit-settings.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing RUN information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"TagoIO Run Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-settings.api.mdx b/docs/api/edit-settings.api.mdx index 906b5f1d..45f7512f 100644 --- a/docs/api/edit-settings.api.mdx +++ b/docs/api/edit-settings.api.mdx @@ -18,53 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit information about TagoRUN - - + + Request + + + + + + {...require("./edit-settings.RequestSchema.json")} +> + + + {...require("./edit-settings.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-user.ParamsDetails.json b/docs/api/edit-user.ParamsDetails.json new file mode 100644 index 00000000..25da7410 --- /dev/null +++ b/docs/api/edit-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file diff --git a/docs/api/edit-user.RequestSchema.json b/docs/api/edit-user.RequestSchema.json new file mode 100644 index 00000000..7e6b8ff3 --- /dev/null +++ b/docs/api/edit-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":true},"company":{"type":"string","example":"Companyname"},"language":{"type":"string","example":"en"},"name":{"type":"string","example":"runusername"},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"MM/DD/YYYY"},"time_format":{"type":"string","example":"12"}}},"phone":{"type":"string","example":"+010001010011"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"user_type"},"value":{"type":"string","example":"enduser"}}},"example":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}]},"timezone":{"type":"string","example":"America/New_York"}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-user.StatusCodes.json b/docs/api/edit-user.StatusCodes.json new file mode 100644 index 00000000..78a05ba2 --- /dev/null +++ b/docs/api/edit-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing a RUN user information by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"TagoIO Run User Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-user.api.mdx b/docs/api/edit-user.api.mdx index 707f61c6..da1182b9 100644 --- a/docs/api/edit-user.api.mdx +++ b/docs/api/edit-user.api.mdx @@ -18,80 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Edit information about an user using userID - + + + Request + + {...require("./edit-user.ParamsDetails.json")} +> + + + {...require("./edit-user.RequestSchema.json")} +> + + + {...require("./edit-user.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/edit-widget.ParamsDetails.json b/docs/api/edit-widget.ParamsDetails.json new file mode 100644 index 00000000..c53ccfe7 --- /dev/null +++ b/docs/api/edit-widget.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file diff --git a/docs/api/edit-widget.RequestSchema.json b/docs/api/edit-widget.RequestSchema.json new file mode 100644 index 00000000..489a1322 --- /dev/null +++ b/docs/api/edit-widget.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"dashboard":{"type":"string","example":"623c74a15a13360011803f3e"},"display":{"type":"object","properties":{"header_buttons":{"type":"array","items":{}},"show_units":{"type":"boolean","example":true},"show_variables":{"type":"boolean","example":true},"theme":{"type":"object","properties":{"color":{"type":"object","properties":{"background":{"type":"string","example":"hsla(332, 33%, 73%, 1)"},"button":{"type":"string","example":"hsla(112, 91%, 58%, 1)"},"dot":{"type":"string","example":"hsla(0, 97%, 48%, 1)"},"header":{"type":"string","example":"hsla(336, 81%, 51%, 1)"}}}}},"variables":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"variable":{"type":"string","example":"temperature"}}},"example":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]}}},"label":{"type":"string","example":"Display #1"},"realtime":{"type":"boolean","example":true},"type":{"type":"string","example":"display"}}},"examples":{"Card Widget Example":{"value":{"display":{"alias":"Ice Cream Widget","header_buttons":[{"color":null,"icon":"","text":"","trigger":"widget","widget":null}],"frame_settings":{"shadow":{"hide":false},"header_visibility":"show_always"},"theme":{"color":{"background":"hsl(210, 12%, 12%)","header":"hsl(210, 65%, 60%)","text":"hsl(210, 20%, 92%)"}},"show_variables":true,"formula":{"enable":false,"unit_type":"origin","fixed_unit":"","apply_all_matching_formulas":false},"number_format":{"decimals":-1,"show_thousand":false},"max_points":10,"show_chart":true,"show_unit":true,"url":"","variable":"temperature"},"data":[{"qty":10,"origin":"68c9baabb24379000ab1c8cc","variables":["temperature"]}],"resource":[],"id":"68c9bab8fe8818000a7ec597","label":"Temperature","realtime":null,"type":"card","cache":null}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-widget.StatusCodes.json b/docs/api/edit-widget.StatusCodes.json new file mode 100644 index 00000000..967d788e --- /dev/null +++ b/docs/api/edit-widget.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Editing a widget","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing a widget":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/edit-widget.api.mdx b/docs/api/edit-widget.api.mdx index f5329beb..c9b50fad 100644 --- a/docs/api/edit-widget.api.mdx +++ b/docs/api/edit-widget.api.mdx @@ -18,128 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Edit properties of a JSON within a dashboard of your profile. - + + + Request + + {...require("./edit-widget.ParamsDetails.json")} +> + + + {...require("./edit-widget.RequestSchema.json")} +> + + + {...require("./edit-widget.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/empty-a-device-s-data.ParamsDetails.json b/docs/api/empty-a-device-s-data.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/empty-a-device-s-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/empty-a-device-s-data.RequestSchema.json b/docs/api/empty-a-device-s-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/empty-a-device-s-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/empty-a-device-s-data.StatusCodes.json b/docs/api/empty-a-device-s-data.StatusCodes.json new file mode 100644 index 00000000..78d5854a --- /dev/null +++ b/docs/api/empty-a-device-s-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Device's Data empty","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Data Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/empty-a-device-s-data.api.mdx b/docs/api/empty-a-device-s-data.api.mdx index 7ae1a6d7..91a31b2b 100644 --- a/docs/api/empty-a-device-s-data.api.mdx +++ b/docs/api/empty-a-device-s-data.api.mdx @@ -18,40 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Empty a Device's Data - + + Request + + {...require("./empty-a-device-s-data.ParamsDetails.json")} +> + + - + + + + {...require("./empty-a-device-s-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json b/docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json new file mode 100644 index 00000000..10f9e29d --- /dev/null +++ b/docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":false,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json b/docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json new file mode 100644 index 00000000..96f9cd62 --- /dev/null +++ b/docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"chunk_id":{"type":"string","example":"1657497600_1658102399"},"file_address":{"type":"string","example":"/device/$DEVICE$/$FROM$_$TO$"},"headers":{"type":"boolean","example":true}}},"examples":{"Export a chunk as CSV to Files":{"value":{"chunk_id":"1657497600_1658102399","file_address":"/device/$DEVICE$/$FROM$_$TO$","headers":true}}}}}}} \ No newline at end of file diff --git a/docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json b/docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json new file mode 100644 index 00000000..76a05063 --- /dev/null +++ b/docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Chunk exported to Files","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"chunk_id":{"type":"string","example":"1657497600_1658102399"},"file_address":{"type":"string","example":"device/62a2643dcc8dd60012eb4838/2022-07-11_2022-07-17.csv"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/export-a-chunk-as-csv-to-files.api.mdx b/docs/api/export-a-chunk-as-csv-to-files.api.mdx index 49fa4ce9..3207b939 100644 --- a/docs/api/export-a-chunk-as-csv-to-files.api.mdx +++ b/docs/api/export-a-chunk-as-csv-to-files.api.mdx @@ -18,70 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Export a chunk as CSV to your TagoIO Files - + + Request + + {...require("./export-a-chunk-as-csv-to-files.ParamsDetails.json")} +> + + + {...require("./export-a-chunk-as-csv-to-files.RequestSchema.json")} +> + + + {...require("./export-a-chunk-as-csv-to-files.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/export-data-to-csv-in-files.ParamsDetails.json b/docs/api/export-data-to-csv-in-files.ParamsDetails.json new file mode 100644 index 00000000..4af8f8f6 --- /dev/null +++ b/docs/api/export-data-to-csv-in-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file diff --git a/docs/api/export-data-to-csv-in-files.RequestSchema.json b/docs/api/export-data-to-csv-in-files.RequestSchema.json new file mode 100644 index 00000000..6c42387c --- /dev/null +++ b/docs/api/export-data-to-csv-in-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_address":{"type":"string","example":"/device/$DEVICE$/$TIMESTAMP$"},"headers":{"type":"boolean","example":true}}},"examples":{"Export data to CSV in Files":{"value":{"file_address":"/device/$DEVICE$/$TIMESTAMP$","headers":true}}}}}}} \ No newline at end of file diff --git a/docs/api/export-data-to-csv-in-files.StatusCodes.json b/docs/api/export-data-to-csv-in-files.StatusCodes.json new file mode 100644 index 00000000..796dd4d9 --- /dev/null +++ b/docs/api/export-data-to-csv-in-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Exporting data to Files","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"file_address":{"type":"string","example":"device/66db45b6552d1d00097956de/1732039901282.csv"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/export-data-to-csv-in-files.api.mdx b/docs/api/export-data-to-csv-in-files.api.mdx index bdd14c98..5db3f05e 100644 --- a/docs/api/export-data-to-csv-in-files.api.mdx +++ b/docs/api/export-data-to-csv-in-files.api.mdx @@ -18,69 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Export data to CSV in Files - + + Request + + {...require("./export-data-to-csv-in-files.ParamsDetails.json")} +> + + + {...require("./export-data-to-csv-in-files.RequestSchema.json")} +> + + + {...require("./export-data-to-csv-in-files.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/export-entity-data.ParamsDetails.json b/docs/api/export-entity-data.ParamsDetails.json new file mode 100644 index 00000000..6ee13853 --- /dev/null +++ b/docs/api/export-entity-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"},"description":"Entity ID"}]} \ No newline at end of file diff --git a/docs/api/export-entity-data.RequestSchema.json b/docs/api/export-entity-data.RequestSchema.json new file mode 100644 index 00000000..73d31903 --- /dev/null +++ b/docs/api/export-entity-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_address":{"type":"string","example":"/my_data/export.csv","description":"Path in the Files to save the export."},"headers":{"type":"boolean","example":true,"description":"Whether to include headers in the export."}},"required":["file_address"]}}}}} \ No newline at end of file diff --git a/docs/api/export-entity-data.StatusCodes.json b/docs/api/export-entity-data.StatusCodes.json new file mode 100644 index 00000000..97ad019b --- /dev/null +++ b/docs/api/export-entity-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Exporting data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"file_address":{"type":"string","example":"/my_data/export.csv"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/export-entity-data.api.mdx b/docs/api/export-entity-data.api.mdx index b207a04a..882614b1 100644 --- a/docs/api/export-entity-data.api.mdx +++ b/docs/api/export-entity-data.api.mdx @@ -18,61 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Export data from the entity to a file in the Files. - + + + Request + + {...require("./export-entity-data.ParamsDetails.json")} +> + + + {...require("./export-entity-data.RequestSchema.json")} +> + + + {...require("./export-entity-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/file-copy.RequestSchema.json b/docs/api/file-copy.RequestSchema.json new file mode 100644 index 00000000..9dc9c84d --- /dev/null +++ b/docs/api/file-copy.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","example":"/layer05.png"},"to":{"type":"string","example":"/layer05 - Copy.png"}}},"example":[{"from":"/layer05.png","to":"/layer05 - Copy.png"}]},"examples":{"File Copy":{"value":[{"from":"/layer05.png","to":"/layer05 - Copy.png"}]}}}}}} \ No newline at end of file diff --git a/docs/api/file-copy.StatusCodes.json b/docs/api/file-copy.StatusCodes.json new file mode 100644 index 00000000..8127825d --- /dev/null +++ b/docs/api/file-copy.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Making a file copy","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Making a file copy":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/file-copy.api.mdx b/docs/api/file-copy.api.mdx index 609b5f1d..c164e415 100644 --- a/docs/api/file-copy.api.mdx +++ b/docs/api/file-copy.api.mdx @@ -18,57 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - File Copy - + + Request + - + + + + {...require("./file-copy.RequestSchema.json")} +> + + + {...require("./file-copy.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/generate-profile-token.RequestSchema.json b/docs/api/generate-profile-token.RequestSchema.json new file mode 100644 index 00000000..931667a1 --- /dev/null +++ b/docs/api/generate-profile-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["email","name","password","profile_id"],"properties":{"email":{"type":"string","example":"example@mail.com"},"name":{"type":"string","example":"Token name"},"password":{"type":"string","example":"yourpassword"},"profile_id":{"type":"string","example":"712ea05e3cc07800127151111"}}},"examples":{"Generate Profile-Token":{"value":{"email":"example@mail.com","name":"newtoken","password":"yourpassword","profile_id":"712ea05e3cc07800127151111"}}}}}}} \ No newline at end of file diff --git a/docs/api/generate-profile-token.StatusCodes.json b/docs/api/generate-profile-token.StatusCodes.json new file mode 100644 index 00000000..1a16cec8 --- /dev/null +++ b/docs/api/generate-profile-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"token created successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"created_by":{"type":"string","example":"712ea05e3cc07800127151110"},"name":{"type":"string","example":"your name"},"permission":{"type":"string","example":"full"},"profile":{"type":"string","example":"712ea05e3cc07800127151111"},"token":{"type":"string","example":"ecjkfc55e-229e-4083-9667-d868h79a41e9"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/generate-profile-token.api.mdx b/docs/api/generate-profile-token.api.mdx index bd8313d0..2ec8232f 100644 --- a/docs/api/generate-profile-token.api.mdx +++ b/docs/api/generate-profile-token.api.mdx @@ -18,73 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Generates and retrieves a new token for the account - - + + Request + + + + + + {...require("./generate-profile-token.RequestSchema.json")} +> + + + {...require("./generate-profile-token.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/generate-public-token.ParamsDetails.json b/docs/api/generate-public-token.ParamsDetails.json new file mode 100644 index 00000000..f83ca487 --- /dev/null +++ b/docs/api/generate-public-token.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"expire_time","in":"query","required":true,"schema":{"type":"string","example":"1 day"},"description":"Time given in hours,days,weeks,months"},{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file diff --git a/docs/api/generate-public-token.RequestSchema.json b/docs/api/generate-public-token.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/generate-public-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/generate-public-token.StatusCodes.json b/docs/api/generate-public-token.StatusCodes.json new file mode 100644 index 00000000..98606662 --- /dev/null +++ b/docs/api/generate-public-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Generating a Public Token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"expire_time":{"type":"string","example":"2022-06-20T23:10:59.285Z"},"token":{"type":"string","example":"026b43fb-b33e-477a-bf17-70d1a0498562"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/generate-public-token.api.mdx b/docs/api/generate-public-token.api.mdx index 0f2460c0..45f94ec9 100644 --- a/docs/api/generate-public-token.api.mdx +++ b/docs/api/generate-public-token.api.mdx @@ -18,58 +18,58 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + - + + + -Make your dashboard accessible to anyone by generating a public access token. -Public dashboards allow you to share live data and visualizations with users who do not have a TagoIO/TagoRUN account. -You control the expiration and can revoke access at any time. + +Make your dashboard accessible to anyone by generating a public access token. + +Public dashboards allow you to share live data and visualizations with users who do not have a TagoIO/TagoRUN account. +You control the expiration and can revoke access at any time. [Learn more about sharing dashboards and public access](/docs/tagoio/dashboards/sharing-dashboards) - + + + Request + + {...require("./generate-public-token.ParamsDetails.json")} +> + + - + + + + {...require("./generate-public-token.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/generate-token.ParamsDetails.json b/docs/api/generate-token.ParamsDetails.json new file mode 100644 index 00000000..c53ccfe7 --- /dev/null +++ b/docs/api/generate-token.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file diff --git a/docs/api/generate-token.RequestSchema.json b/docs/api/generate-token.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/generate-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/generate-token.StatusCodes.json b/docs/api/generate-token.StatusCodes.json new file mode 100644 index 00000000..9f8c84e0 --- /dev/null +++ b/docs/api/generate-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Generating a token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"widget_token":{"type":"string","example":"ebe71a39-8f9f-4114-8bf3-6b3dcc19ad72"}}},"status":{"type":"boolean","example":true}}},"examples":{"Generating a token":{"value":{"result":{"widget_token":"ebe71a39-8f9f-4114-8bf3-6b3dcc19ad72"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/generate-token.api.mdx b/docs/api/generate-token.api.mdx index bdfdbe62..2c409f0c 100644 --- a/docs/api/generate-token.api.mdx +++ b/docs/api/generate-token.api.mdx @@ -5,7 +5,7 @@ description: "Generates a secure, public token for [embedding](/docs/tagoio/widg sidebar_label: "Generate Token" hide_title: true hide_table_of_contents: true -api: eJztV1tv47YS/isDLtDuGpIdO3YuAk4Ltza2Rns2i2yCRbEJztLiyGIjk1qSitcw/N8PhpQUOcleHoo+9cmGOJzrNzMfd8zxlWXJB/ZeihU6y24jJtCmRpZOasUS9hoVGu7QAgeLaWUwgrJaFjIFp+9QQaYNfMD1EoWQanX7ciB0ageOr7TUg01QO1h5LcWglYvrk9jpeKsrE29waaXDV2SmxFRmMoUgA5nRa+AguM2XmhvRB7hR1xbB5dLWXjgNQtqy4FtwOTY3pQL87NAoXgAvy0KmnMKyoA3UBi3cS+7vXPGVXlyAdxEsmnuZojd1o+af+bossD67vvwjCd8/5s6VNhmEuPqX89eLizd9ir0v9c/Bif/8eXF9Gb9fzF7Pr+LF7Ic2jHAwm7777ZeL6eWMznws4fv8v7/MZ/HVxe/zNx+DsSuKFpUotVQOpAWpHCqBwpfApqi4kdrCJkeDsNUVbLhylBmbc4MUc5Mi3iRIV85KgaCzbgrKgrtMmzVsclkgrLlUjksl1Qp4mqK1kGrljC58eljEdEkYkVotBEvYqobMFUXDImbQllpZtCzZsdHREf08CzJvIBSURYxsoHIk3and4C9LV3bMpjmuOf1z2xJZwvTyL0wdi1hpyB8ng0GDtirct+VCRv4XrD9IW2ekWrGIYcAASxgu8XTIj8/js+w8i8fD4Tg+W2bH8cnyWKTp8JyL0xHb7/cRs467yna0LbUukKuuOmcq9ML1Fy/+TEKSHbvnRYWHMR16/Z2uPThWG997B0pu+BodGpoIO6b4mlxu8bqYsYhJslJyl/u6fqqkQRHURE8r8kzuXl5tS+w2Myxmr9h+H7X2QkR/q7Ea7MHSbcTW6HIdkOpxQBYSNmh9Guw6Qe/rITbYNZ7tBw1EaUo06apMwRLWDAReyn5lYxw204BRiE9lsIo3HZlb0plWRrqtV/rW6EwWdSclH267Au8oAwEuM6RhFV89wi4v5e+4ZY9H+hS68uBy7sdJpeSnCmle0EAGgWEANgugASIst/UUIHR60aDuRwslX2GfRU0pD9yqy5kjF2hYxD7HD4Wa4HB0PJ7wWJwe8XiMIxEvz45FPEmP/MHJ6dk5wfYNuo02d98faH0BvhppLdSHaRhuC+VwZepN8VOr46eghTYOrB4nhUbwgbKHLHwp/FkYxm+C1GFoh+nJxGR8zsUoPhsep/FYnJzEy+x0FE+OznCyPD/jGR5Temq0fH966gvNDn0+PaicNAhlkO0AQqogwNNUV8qBRUcTy3ZiP/ToaxDgwwnyCfJYiJGIx+nJcXx2Pp7E56PlZCz4+PR0xGlOMKky7WOTzl+sd9b07eJJgC9evHgBvd5vekPBVA1jEDqt1qicr3CvR5sVDz9SFmxZSEdg3+QyzesUbXX1o0FohlGjViq/PukzWue3YrNKjb6XAi2MQcgsQ4N+JROOkhsVQ6/XbZJeLwFypsYU8Z5OL0a1K7TaU66g5UZkWxz04I0CIC/IwEENyMK0sBrulN4At4R5Kl447cOfunrQ623XdW+r+9TAAXTJwMJ6lx5H0fbZhSq2wO+5LPiyQJBZk1e9UWgaMqLqvmtgJrtt+cSJqeLF1kobvEh6vWcTyWupqGs+FK85alTHcXyjPILehci91PTtAuYNB7vEldTqRr3PUcGa34V1XaOAsNHhVNO3i8hXbl1ZB5xKEHhuIKy8JDZiJPWV8Wp50ZK9Pvyaa20RtGqpWqaLQm/IYiNlYcktCtB1vlaoV4aXuUx5UetMiEdStq6VdCjgnfPMfs6tgyHlDEJKW3Ld0s1Njk23P3AxapNgs84hcktsGw7U9xutvR4x514PPn5xSw4+dms6r4ihwXv8G9wjJeRa0PkNnw62MvkU/KFSwgzLQm9bb6hhbK6rQvhJ4H3QG+WBcn35RztUD/AWtqYmYm3pVeW97XDwYIPmKNGLMMyG/aP+UU2LeUrkz3M2bd2a+2Ffj9x2PDcz92Am7h5o9b9Pu3+fdt9+2tUUwuFnNygLLhURDc9jdzVx/vDwRGARSw7fC8EZ+t7h9YE+30Ys19aRgt2O+vTaFPs9ff5UoSH+exuxe24kdY1nw0Ja+i9YkvHC4leg/fKy3tCv4EsxNNxIETGqX1aMRewOt49ePcTc/0HTbaL2t/uoIUsUfjgmklq6zsUnj+ODJ87r+RXb7/8POWIfQg== +api: eJztV1tv47YS/isDLtDuGpIdO3YuAk4Ltza2Rns2i2yCRbEJztLiyGIjk1qSitcw/N8PhpQUOcleHoo+9cmGOJzrNzMfd8zxlWXJB/ZeihU6y24jJtCmRpZOasUS9hoVGu7QAgeLaWUwgrJaFjIFp+9QQaYNfMD1EoWQanX7ciB0ageOr7TUg01QO1h5LcWglYvrk9jpeKsrE29waaXDV2SmxFRmMoUgA5nRa+AguM2XmhvRB7hR1xbB5dLWXjgNQtqy4FtwOTY3pQL87NAoXgAvy0KmnMKyoA3UBi3cS+7vXPGVXlyAdxEsmnuZojd1o+af+bossD67vvwjCd8/5s6VNhmEuPqX89eLizd9ir0v9c/Bif/8eXF9Gb9fzF7Pr+LF7Ic2jHAwm7777ZeL6eWMznws4fv8v7/MZ/HVxe/zNx+DsSuKFpUotVQOpAWpHCqBwpfApqi4kdrCJkeDsNUVbLhylBmbc4MUc5Mi3iRIV85KgaCzbgrKgrtMmzVsclkgrLlUjksl1Qp4mqK1kGrljC76N4pFTJeEEKnVQrCErWrAXFEsLGIGbamVRcuSHRsdHdHPsxDz6kM5WcTIAipH0p3KDf6ydGXHbJrjmtM/ty2RJUwv/8LUsYiVhvxxMhg0aKvCfVsu5ON/wfqDtHVGqhWLGAYEsIThEk+H/Pg8PsvOs3g8HI7js2V2HJ8sj0WaDs+5OB2x/X4fMeu4q2xH21LrArnqqnOmQi9cf/HizyQk2bF7XlR4GNOh19/p2oNjtfG9d6Dkhq/RoaF5sGOKr8nlFq2LGYuYJCsld7mv66dKGhRBTfS0Is/k7uXVtsRuK8Ni9ort91FrL0T0txqroR4s3UZsjS7XAakeB2QhYYPWp8GuE/S+HmGDXePZftBAlGZEk67KFCxhzTjgpexXNsZhMwsYhfhUBqt405G5JZ1pZaTbeqVvjc5kUXdS8uG2K/COMhDgMkMaVfHVI+zyUv6OW/Z4oE+hKw8u536YVEp+qpCmBY1jEBjGXzP+GyDCclvPAEKnFw3qfrRQ8hX2WdSU8sCtupw5coGGRexz/FCoCQ5Hx+MJj8XpEY/HOBLx8uxYxJP0yB+cnJ6dE2zfoNtoc/f9gdYX4KuR1kJ9mIbRtlAOV6beEz+1On4KWmjfwOpxUmgAHyh7yMKXwp+FUfwmSB2GdpieTEzG51yM4rPhcRqPxclJvMxOR/Hk6Awny/MznuExpadGy/enp77QbNDn04PKSYNQBtkOIKQKAjxNdaUcWHQ0sWwn9kOPvgYBPpwgnyCPhRiJeJyeHMdn5+NJfD5aTsaCj09PR5zmBJMq0z426fzFemNN3y6eBPjixYsX0Ov9pjcUTNXwBaHTao3K+Qr3erRX8fAjZcGWhXQE9k0u07xO0VZXPxqEZhg1aqXyy5M+o3WeMjSL1Oh7KdDCGITMMjToFzLhKLlRMfR63Sbp9RIgZ2pMEevp9GJUu0KLPeUKWmZEtsVBD94oAPKCDBzUgCxMC6vhTukNcEuYp+KF0z78qasHvd52Xfe2uk8NHECXDCysd+lxFG2fXahiC/yey4IvCwSZNXnVG4WmoSKq7rsGZrLblk+cmCpebK20wYuk13s2kbyWirrmQ/Gao0Z1HMc3yiPoXYjcS03fLmDeMLBLXEmtbtT7HBWs+V1Y1zUKCBsdRjV9u4h85daVdcCpBIHlBrrKS2IjRlJfGa+WFy3V68OvudYWQauWqGW6KPSGLDZSFpbcogBd52uFemV4mcuUF7XOhFgkZetaSYcC3jnP6+fcOhhSziCktKXWLdnc5Nh0+wMXozYJNuscIrfEteFAfb/R2usRb+714OMXt+TgY7em84oYGrzHv8E9UkKuBZ3f8OlgK5NPwR8qJcywLPS29YYaxua6KoSfBN4HvVEeKNeXf7RD9QBvYWtqotWW3lTe2w4DDzZojhK9CMNs2D/qH9W0mKdE/jxn09atuR/29chtx3Mzcw9m4u6BVv/7sPv3Yfeth11NIBx+doOy4FIRzfAsdlfT5g8PDwQWseTwtRBcoe8dVh/I823Ecm0dKdjtqEuvTbHf0+dPFRpiv7cRu+dGUs94Liykpf+CJRkvLH4F2C8v6/38Cr4UQ8OMFNGi+l3FWMTucPvozUO8/R803SZqf7uPGqpE4Ydjoqil61x88jQ+eOC8nl+x/f7/NRsewg== sidebar_class_name: "get api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -18,60 +18,60 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Generates a secure, public token for [embedding](/docs/tagoio/widgets/general/embedding-widgets-to-your-website) a specific widget from a dashboard. -Use this token to display the widget in external applications or websites via the TagoIO embed service. +Use this token to display the widget in external applications or websites via the TagoIO embed service. -Example embed URL: +Example embed URL: -`https://embed.REGION.tago.io?widget=YOUR-WIDGET-ID&dashboard=YOUR-DASHBOARD-ID&token=YOUR-EMBED-TOKEN` +`https://embed.REGION.tago.io?widget=YOUR-WIDGET-ID&dashboard=YOUR-DASHBOARD-ID&token=YOUR-EMBED-TOKEN` This endpoint is intended for scenarios where you want to share or display a widget outside of the TagoIO platform while maintaining access control. - + + + Request + + {...require("./generate-token.ParamsDetails.json")} +> + + - + + + + {...require("./generate-token.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-a-profile-details.ParamsDetails.json b/docs/api/get-a-profile-details.ParamsDetails.json new file mode 100644 index 00000000..44cb40c7 --- /dev/null +++ b/docs/api/get-a-profile-details.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"Type a profile ID"},"description":"Can be found in the profile's information tab \"More\""}]} \ No newline at end of file diff --git a/docs/api/get-a-profile-details.RequestSchema.json b/docs/api/get-a-profile-details.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-a-profile-details.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-a-profile-details.StatusCodes.json b/docs/api/get-a-profile-details.StatusCodes.json new file mode 100644 index 00000000..ded31a2a --- /dev/null +++ b/docs/api/get-a-profile-details.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get a Profile Details","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"account_plan":{"type":"string","example":"starter"},"addons":{"type":"object","properties":{"control_tower":{"type":"boolean","example":true},"custom_dns":{"type":"boolean","example":false},"mobile":{"type":"boolean","example":false},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"updated_at":{"type":"string","example":"2023-09-06T13:47:08.192Z"}}},"allocation":{"type":"object","properties":{"analysis":{"type":"number","example":5},"data_records":{"type":"number","example":250000},"email":{"type":"number","example":10},"file_storage":{"type":"number","example":132},"input":{"type":"number","example":350000},"output":{"type":"number","example":342153},"push_notification":{"type":"number","example":58},"run_users":{"type":"number","example":5},"sms":{"type":"number","example":60}}},"info":{"type":"object","properties":{"account":{"type":"string","example":"612ea05e3cc07800127153892"},"banner_url":{"example":null},"created_at":{"type":"string","example":"2022-02-02T16:44:09.134Z"},"id":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"logo_url":{"type":"string","example":""},"name":{"type":"string","example":"Test Profile"},"region":{"type":"string","example":"us-1"},"rpm":{"type":"object","properties":{"data_input":{"type":"number","example":98283293},"data_output":{"type":"number","example":10}}},"updated_at":{"type":"string","example":"2023-10-13T11:54:20.081Z"}}}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-a-profile-details.api.mdx b/docs/api/get-a-profile-details.api.mdx index 7dc35964..dd007b58 100644 --- a/docs/api/get-a-profile-details.api.mdx +++ b/docs/api/get-a-profile-details.api.mdx @@ -18,95 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get your profile settings - + + Request + + {...require("./get-a-profile-details.ParamsDetails.json")} +> + + - + + + + {...require("./get-a-profile-details.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-a-profile-statistics.ParamsDetails.json b/docs/api/get-a-profile-statistics.ParamsDetails.json new file mode 100644 index 00000000..7b70d0b1 --- /dev/null +++ b/docs/api/get-a-profile-statistics.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"date","in":"query","schema":{"type":"string","example":"YYYY-MM-DD"},"description":"Filter the statistics by specific date"},{"name":"timezone","in":"query","schema":{"type":"string","example":"Your account's timezone"},"description":"Filter the statiscs with the timezone applied if not it returns the UTC time"},{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"Type a Profile ID"},"description":"Can be found in the profile's information tab \"More\""}]} \ No newline at end of file diff --git a/docs/api/get-a-profile-statistics.RequestSchema.json b/docs/api/get-a-profile-statistics.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-a-profile-statistics.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-a-profile-statistics.StatusCodes.json b/docs/api/get-a-profile-statistics.StatusCodes.json new file mode 100644 index 00000000..7db724a1 --- /dev/null +++ b/docs/api/get-a-profile-statistics.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a profile statistics","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"data_records":{"type":"number","example":151611},"file_storage":{"type":"number","example":49.89},"input":{"type":"number","example":39933},"output":{"type":"number","example":1272},"time":{"type":"string","example":"2023-11-08T04:01:36.124Z"}}},"example":[{"data_records":151611,"file_storage":49.89,"input":39933,"output":1272,"time":"2023-11-08T04:01:36.124Z"},{"data_records":151691,"file_storage":49.89,"input":40165,"output":1272,"time":"2023-11-08T05:01:35.986Z"},{"data_records":151863,"file_storage":49.89,"input":40397,"output":1272,"time":"2023-11-08T06:01:35.963Z"},{"data_records":152389,"file_storage":49.89,"input":40629,"output":1272,"time":"2023-11-08T07:01:36.021Z"},{"data_records":152497,"file_storage":49.89,"input":40861,"output":1272,"time":"2023-11-08T08:01:36.019Z"},{"data_records":152609,"file_storage":49.89,"input":41093,"output":1272,"time":"2023-11-08T09:01:35.908Z"},{"data_records":152981,"file_storage":49.89,"input":41325,"output":1272,"time":"2023-11-08T10:01:36.052Z"},{"data_records":153105,"file_storage":49.89,"input":41566,"output":1272,"time":"2023-11-08T11:01:36.155Z"},{"data_records":153373,"file_storage":49.89,"input":41789,"output":1272,"time":"2023-11-08T12:01:35.906Z"},{"data_records":153517,"file_storage":49.89,"input":42030,"output":1272,"time":"2023-11-08T13:01:35.873Z"},{"data_records":150262,"file_storage":49.89,"input":42253,"output":1272,"time":"2023-11-08T14:01:35.967Z"},{"data_records":150422,"file_storage":49.89,"input":42485,"output":1272,"time":"2023-11-08T15:01:35.992Z"},{"data_records":150422,"file_storage":49.89,"input":42717,"output":1272,"time":"2023-11-08T16:01:35.825Z"},{"data_records":151054,"file_storage":49.89,"input":42949,"output":1272,"time":"2023-11-08T17:01:35.903Z"},{"data_records":151242,"file_storage":49.89,"input":43181,"output":1272,"time":"2023-11-08T18:01:35.995Z"},{"data_records":151242,"file_storage":49.89,"input":43413,"output":1272,"time":"2023-11-08T19:01:35.946Z"}]},"status":{"type":"boolean","example":true}}},"examples":{"Getting a profile statistics":{"value":{"result":[{"data_records":151611,"file_storage":49.89,"input":39933,"output":1272,"time":"2023-11-08T04:01:36.124Z"},{"data_records":151691,"file_storage":49.89,"input":40165,"output":1272,"time":"2023-11-08T05:01:35.986Z"},{"data_records":151863,"file_storage":49.89,"input":40397,"output":1272,"time":"2023-11-08T06:01:35.963Z"},{"data_records":152389,"file_storage":49.89,"input":40629,"output":1272,"time":"2023-11-08T07:01:36.021Z"},{"data_records":152497,"file_storage":49.89,"input":40861,"output":1272,"time":"2023-11-08T08:01:36.019Z"},{"data_records":152609,"file_storage":49.89,"input":41093,"output":1272,"time":"2023-11-08T09:01:35.908Z"},{"data_records":152981,"file_storage":49.89,"input":41325,"output":1272,"time":"2023-11-08T10:01:36.052Z"},{"data_records":153105,"file_storage":49.89,"input":41566,"output":1272,"time":"2023-11-08T11:01:36.155Z"},{"data_records":153373,"file_storage":49.89,"input":41789,"output":1272,"time":"2023-11-08T12:01:35.906Z"},{"data_records":153517,"file_storage":49.89,"input":42030,"output":1272,"time":"2023-11-08T13:01:35.873Z"},{"data_records":150262,"file_storage":49.89,"input":42253,"output":1272,"time":"2023-11-08T14:01:35.967Z"},{"data_records":150422,"file_storage":49.89,"input":42485,"output":1272,"time":"2023-11-08T15:01:35.992Z"},{"data_records":150422,"file_storage":49.89,"input":42717,"output":1272,"time":"2023-11-08T16:01:35.825Z"},{"data_records":151054,"file_storage":49.89,"input":42949,"output":1272,"time":"2023-11-08T17:01:35.903Z"},{"data_records":151242,"file_storage":49.89,"input":43181,"output":1272,"time":"2023-11-08T18:01:35.995Z"},{"data_records":151242,"file_storage":49.89,"input":43413,"output":1272,"time":"2023-11-08T19:01:35.946Z"}],"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-a-profile-statistics.api.mdx b/docs/api/get-a-profile-statistics.api.mdx index 01ce1f22..acc1d5c1 100644 --- a/docs/api/get-a-profile-statistics.api.mdx +++ b/docs/api/get-a-profile-statistics.api.mdx @@ -18,305 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get your Profile Statistics - + + Request + + {...require("./get-a-profile-statistics.ParamsDetails.json")} +> + + - + + + + {...require("./get-a-profile-statistics.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-a-profile-summary.ParamsDetails.json b/docs/api/get-a-profile-summary.ParamsDetails.json new file mode 100644 index 00000000..44cb40c7 --- /dev/null +++ b/docs/api/get-a-profile-summary.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"Type a profile ID"},"description":"Can be found in the profile's information tab \"More\""}]} \ No newline at end of file diff --git a/docs/api/get-a-profile-summary.RequestSchema.json b/docs/api/get-a-profile-summary.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-a-profile-summary.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-a-profile-summary.StatusCodes.json b/docs/api/get-a-profile-summary.StatusCodes.json new file mode 100644 index 00000000..3ba86b7d --- /dev/null +++ b/docs/api/get-a-profile-summary.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get a general summary of your profile resources","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"addons":{"type":"object","properties":{"control_tower":{"type":"boolean","example":true},"custom_dns":{"type":"boolean","example":false},"mobile":{"type":"boolean","example":false},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"updated_at":{"type":"string","example":"2023-09-06T13:47:08.192Z"}}},"amount":{"type":"object","properties":{"action":{"type":"number","example":37},"am":{"type":"number","example":5},"analysis":{"type":"number","example":18},"connectors":{"type":"number","example":32},"dashboard":{"type":"number","example":231},"device":{"type":"number","example":79},"dictionary":{"type":"number","example":7},"networks":{"type":"number","example":9},"run_users":{"type":"number","example":5},"tcore":{"type":"number","example":2},"tcore_cluster":{"type":"number","example":2}}},"limit":{"type":"object","properties":{"analysis":{"type":"number","example":5},"data_records":{"type":"number","example":250000},"email":{"type":"number","example":10},"file_storage":{"type":"number","example":132},"input":{"type":"number","example":350000},"output":{"type":"number","example":342153},"push_notification":{"type":"number","example":58},"run_users":{"type":"number","example":5},"sms":{"type":"number","example":60},"tcore":{"type":"number","example":1}}},"limit_used":{"type":"object","properties":{"analysis":{"type":"number","example":0},"dashboard_output":{"type":"number","example":65},"data_records":{"type":"number","example":151242},"email":{"type":"number","example":0},"file_storage":{"type":"number","example":49.89},"input":{"type":"number","example":43463},"output":{"type":"number","example":1272},"push_notification":{"type":"number","example":0},"run_users":{"type":"number","example":5},"sms":{"type":"number","example":0},"tcore":{"type":"number","example":3},"tcore_cluster":{"type":"number","example":2}}},"tago_run":{"type":"string","example":"johndoee.tago.run"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting a profile summary":{"value":{"result":{"addons":{"control_tower":true,"custom_dns":false,"mobile":false,"profile":"61fac4d9a5c9f40012a5ff92","updated_at":"2023-09-06T13:47:08.192Z"},"amount":{"action":37,"am":5,"analysis":18,"connectors":32,"dashboard":231,"device":79,"dictionary":7,"networks":9,"run_users":5,"tcore":2,"tcore_cluster":2},"limit":{"analysis":5,"data_records":250000,"email":10,"file_storage":132,"input":350000,"output":342153,"push_notification":58,"run_users":5,"sms":60,"tcore":1},"limit_used":{"analysis":0,"dashboard_output":65,"data_records":151242,"email":0,"file_storage":49.89,"input":43463,"output":1272,"push_notification":0,"run_users":5,"sms":0,"tcore":3,"tcore_cluster":2},"tago_run":"johndoee.tago.run"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-a-profile-summary.api.mdx b/docs/api/get-a-profile-summary.api.mdx index 3d457186..7f5bd159 100644 --- a/docs/api/get-a-profile-summary.api.mdx +++ b/docs/api/get-a-profile-summary.api.mdx @@ -18,165 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get your Profile Summary - + + Request + + {...require("./get-a-profile-summary.ParamsDetails.json")} +> + + - + + + + {...require("./get-a-profile-summary.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-account-information.RequestSchema.json b/docs/api/get-account-information.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-account-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-account-information.StatusCodes.json b/docs/api/get-account-information.StatusCodes.json new file mode 100644 index 00000000..fc4267b7 --- /dev/null +++ b/docs/api/get-account-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get information about account","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"blocked":{"type":"boolean","example":false},"company":{"type":"string","example":"companyname"},"created_at":{"type":"string","example":"2021-08-31T21:34:22.107Z"},"email":{"type":"string","example":"example@email.com"},"id":{"type":"string","example":"612ea05e3cc07800127152207"},"language":{"type":"string","example":"en"},"last_login":{"type":"string","example":"2021-09-13T17:59:30.983Z"},"name":{"type":"string","example":"Account Name"},"newsletter":{"type":"boolean","example":true},"options":{"type":"object","properties":{"decimal_separator":{"type":"string","example":","},"last_whats_new":{"type":"string","example":"2021-08-02T18:00:00.000Z"},"thousand_separator":{"type":"string","example":"."},"user_view_welcome":{"type":"boolean","example":true}}},"otp":{"type":"object","properties":{}},"phone":{"example":null},"plan":{"type":"string","example":"free"},"send_invoice":{"type":"boolean","example":false},"stripe_id":{"example":null},"timezone":{"type":"string","example":"America/Sao_Paulo"},"type":{"type":"string","example":"user"},"updated_at":{"type":"string","example":"2021-09-09T19:21:52.049Z"}}},"status":{"type":"boolean","example":true}}},"examples":{"Get information about account":{"value":{"result":{"active":true,"blocked":false,"company":"companyname","created_at":"2021-08-31T21:34:22.107Z","email":"example@email.com","id":"612ea05e3cc07800127152207","language":"en","last_login":"2021-09-13T17:59:30.983Z","name":"Account Name","newsletter":true,"options":{"decimal_separator":",","last_whats_new":"2021-08-02T18:00:00.000Z","thousand_separator":".","user_view_welcome":true},"otp":{},"phone":null,"plan":"free","send_invoice":false,"stripe_id":null,"timezone":"America/Sao_Paulo","type":"user","updated_at":"2021-09-09T19:21:52.049Z"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-account-information.api.mdx b/docs/api/get-account-information.api.mdx index d29b615f..eb7db449 100644 --- a/docs/api/get-account-information.api.mdx +++ b/docs/api/get-account-information.api.mdx @@ -18,98 +18,45 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get all information from current account - - + + + + + + + + {...require("./get-account-information.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-account-resources-allocation.RequestSchema.json b/docs/api/get-account-resources-allocation.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-account-resources-allocation.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-account-resources-allocation.StatusCodes.json b/docs/api/get-account-resources-allocation.StatusCodes.json new file mode 100644 index 00000000..a1827189 --- /dev/null +++ b/docs/api/get-account-resources-allocation.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get account resources' allocation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"analysis":{"type":"number","example":200},"data_records":{"type":"number","example":6667},"email":{"type":"number","example":17},"file_storage":{"type":"number","example":80},"input":{"type":"number","example":33334},"output":{"type":"number","example":100000},"profile":{"type":"string","example":"62cdb70512b7320012dc2880"},"push_notification":{"type":"number","example":4},"run_users":{"type":"number","example":0},"sms":{"type":"number","example":5},"updated_at":{"type":"string","example":"2022-07-15T12:11:07.521Z"}}},"example":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc2880","push_notification":4,"run_users":0,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc0780012715111","push_notification":83,"run_users":8,"sms":0,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1200,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5ff93","push_notification":13,"run_users":2,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"}]},"status":{"type":"boolean","example":true}}},"examples":{"Get account resources' allocation":{"value":{"result":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc2880","push_notification":4,"run_users":0,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc0780012715111","push_notification":83,"run_users":8,"sms":0,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1200,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5ff93","push_notification":13,"run_users":2,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"}],"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-account-resources-allocation.api.mdx b/docs/api/get-account-resources-allocation.api.mdx index 482f0cc1..89901a09 100644 --- a/docs/api/get-account-resources-allocation.api.mdx +++ b/docs/api/get-account-resources-allocation.api.mdx @@ -18,141 +18,44 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get account resources allocation - + + + - + + + + {...require("./get-account-resources-allocation.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-configuration-parameters.ParamsDetails.json b/docs/api/get-configuration-parameters.ParamsDetails.json new file mode 100644 index 00000000..2497d49d --- /dev/null +++ b/docs/api/get-configuration-parameters.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sent_status","in":"query","schema":{"type":"string","example":"true"},"description":"Filter by `sent` status."}]} \ No newline at end of file diff --git a/docs/api/get-configuration-parameters.RequestSchema.json b/docs/api/get-configuration-parameters.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-configuration-parameters.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-configuration-parameters.StatusCodes.json b/docs/api/get-configuration-parameters.StatusCodes.json new file mode 100644 index 00000000..b115e9b7 --- /dev/null +++ b/docs/api/get-configuration-parameters.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of configuration parameters returned","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6244401fe689b90014f9b299"},"key":{"type":"string","example":"param_key"},"sent":{"type":"boolean","example":false},"value":{"type":"string","example":"param_value"}}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-configuration-parameters.api.mdx b/docs/api/get-configuration-parameters.api.mdx index 26310762..06f833e4 100644 --- a/docs/api/get-configuration-parameters.api.mdx +++ b/docs/api/get-configuration-parameters.api.mdx @@ -18,58 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Retrieve configuration parameters for the current device. This is useful for delivering settings or instructions that your device can periodically check for updates. [Configuration Parameters](/docs/tagoio/devices/configuration-parameters-for-devices) can be used to provide URLs (such as for firmware updates) or any other settings needed to control device behavior. - + + + Request + + {...require("./get-configuration-parameters.ParamsDetails.json")} +> + + - + + + + {...require("./get-configuration-parameters.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-data.ParamsDetails.json b/docs/api/get-data.ParamsDetails.json new file mode 100644 index 00000000..483e3f61 --- /dev/null +++ b/docs/api/get-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"query","in":"query","schema":{"type":"string","enum":["count","min","max","avg","sum","last_item","last_location","aggregate","conditional"]},"description":"Select the query mode."},{"name":"qty","in":"query","schema":{"type":"integer","minimum":1,"example":20},"description":"Total quantity of data to retrieve."},{"name":"details","in":"query","schema":{"type":"boolean","example":true},"description":"Include additional fields (e.g., created_at)."},{"name":"ordination","in":"query","schema":{"type":"string","enum":["ascending","descending"],"example":"descending"},"description":"Sort order."},{"name":"skip","in":"query","schema":{"type":"integer","minimum":0,"example":15},"description":"Number of items to skip."},{"name":"variables","in":"query","schema":{"type":"string","example":"temperature"},"description":"Filter data by variable."},{"name":"values","in":"query","schema":{"type":"string","example":"25"},"description":"Filter data by value."},{"name":"groups","in":"query","schema":{"type":"string","example":"0923092039"},"description":"Filter by group identifier."},{"name":"start_date","in":"query","schema":{"type":"string","format":"date-time","example":"2022-09-09T10:28:44Z"},"description":"Start timestamp or relative date."},{"name":"end_date","in":"query","schema":{"type":"string","format":"date-time","example":"2022-09-10T10:28:44Z"},"description":"End timestamp or relative date."},{"name":"function","in":"query","schema":{"type":"string","enum":["avg","sum","min","max","gt","gte","lt","lte","eq","ne"],"example":"avg"},"description":"Allowed values depend on query mode: aggregate → avg,sum,min,max; conditional → gt,gte,lt,lte,eq,ne."}]} \ No newline at end of file diff --git a/docs/api/get-data.RequestSchema.json b/docs/api/get-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-data.StatusCodes.json b/docs/api/get-data.StatusCodes.json new file mode 100644 index 00000000..ec1646f3 --- /dev/null +++ b/docs/api/get-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Success Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2021-09-16T17:51:43.672Z"},"device":{"type":"string","example":"612ea1694035dd0012f6d238"},"group":{"type":"string","example":"1631814703672"},"id":{"type":"string","example":"6143842f561c4e00199f517b"},"location":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"number","example":-78.677328},"example":[-78.677328,35.770723]},"type":{"type":"string","example":"point"}}},"time":{"type":"string","example":"2021-09-16T17:51:43.672Z"},"unit":{"type":"string","example":"°C"},"value":{"type":"number","example":-12.67},"variable":{"type":"string","example":"temperature"}}},"example":[{"created_at":"2021-09-16T17:51:43.672Z","device":"612ea1694035dd0012f6d238","group":"1631814703672","id":"6143842f561c4e00199f517b","location":{"coordinates":[-78.677328,35.770723],"type":"point"},"time":"2021-09-16T17:51:43.672Z","unit":"°C","value":-12.67,"variable":"temperature"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-data.api.mdx b/docs/api/get-data.api.mdx index 4be8bd7e..52113169 100644 --- a/docs/api/get-data.api.mdx +++ b/docs/api/get-data.api.mdx @@ -18,147 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get data from the device. - + + Request + + {...require("./get-data.ParamsDetails.json")} +> + + - + + + + {...require("./get-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-device-data.ParamsDetails.json b/docs/api/get-device-data.ParamsDetails.json new file mode 100644 index 00000000..a4eed4cf --- /dev/null +++ b/docs/api/get-device-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"qty","in":"query","schema":{"type":"string","example":"10"},"description":"Numeric quantity of data to be returned"},{"name":"end_date","in":"query","schema":{"type":"string","example":"2023-10-10T13:17:16.290Z"},"description":"Final date to get the data returned in ISO timestamp format (Not Required)"},{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file diff --git a/docs/api/get-device-data.RequestSchema.json b/docs/api/get-device-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-device-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-device-data.StatusCodes.json b/docs/api/get-device-data.StatusCodes.json new file mode 100644 index 00000000..267b2c2e --- /dev/null +++ b/docs/api/get-device-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get Device Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2023-09-20T14:26:44.918Z"},"device":{"type":"string","example":"6307b0b1b41f1b001a45c7e3"},"group":{"type":"string","example":"63956cf0000a19e44210b056"},"id":{"type":"string","example":"650b01244e91a0000fc65937"},"location":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"number","example":-77.757328},"example":[-77.757328,36.68072299999999]},"type":{"type":"string","example":"Point"}}},"time":{"type":"string","example":"2023-09-20T14:26:44.918Z"},"unit":{"type":"string","example":"C"},"value":{"type":"string","example":"16"},"variable":{"type":"string","example":"temperature"}}},"example":[{"created_at":"2023-09-20T14:26:44.918Z","device":"6307b0b1b41f1b001a45c7e3","group":"63956cf0000a19e44210b056","id":"650b01244e91a0000fc65937","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:44.918Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:38.015Z","device":"6307b0b1b41f1b001a45c7e3","group":"f863379000439d95e110b056","id":"650b011e59d9340009733690","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:38.015Z","unit":"C","value":"86","variable":"temperature"},{"created_at":"2023-09-20T14:26:25.477Z","device":"6307b0b1b41f1b001a45c7e3","group":"aa756cf0000a19e41110b056","id":"650b01114e91a0000fc657ab","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:25.477Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:14.180Z","device":"6307b0b1b41f1b001a45c7e3","group":"b0ee2101006e7e786010b056","id":"650b010687e7e6001012ee0c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:14.180Z","unit":"C","value":"58","variable":"temperature"},{"created_at":"2023-09-20T14:26:03.199Z","device":"6307b0b1b41f1b001a45c7e3","group":"5b33379000439d95bf00b056","id":"650b00fb59d93400097333b6","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:03.199Z","unit":"C","value":"11","variable":"temperature"},{"created_at":"2023-09-20T14:25:53.034Z","device":"6307b0b1b41f1b001a45c7e3","group":"e2456cf0000a19e41f00b056","id":"650b00f14e91a0000fc6542f","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:53.034Z","unit":"C","value":"3","variable":"temperature"},{"created_at":"2023-09-20T14:25:43.099Z","device":"6307b0b1b41f1b001a45c7e3","group":"6f40e7f0001ad1107e00b056","id":"650b00e7011da1000f7e04f7","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:43.099Z","unit":"C","value":"10","variable":"test"},{"created_at":"2023-09-20T14:25:33.027Z","device":"6307b0b1b41f1b001a45c7e3","group":"b77fbff000c901bddd00b056","id":"650b00dddb109c000ffbf77c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:33.027Z","unit":"C","value":"7","variable":"temperature"},{"created_at":"2023-09-20T14:25:23.020Z","device":"6307b0b1b41f1b001a45c7e3","group":"b7e298900029919a3d00b056","id":"650b00d3a919920009892e7c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:23.020Z","unit":"C","value":"1","variable":"temperature"},{"created_at":"2023-09-20T14:25:13.079Z","device":"6307b0b1b41f1b001a45c7e3","group":"7320e7f0001ad1109c00b056","id":"650b00c9011da1000f7e0238","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:13.079Z","unit":"C","value":"12","variable":"temperature"},{"created_at":"2023-09-20T14:25:03.133Z","device":"6307b0b1b41f1b001a45c7e3","group":"c14fbff000c901bdfb00b056","id":"650b00bfdb109c000ffbf41d","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:03.133Z","unit":"C","value":"66","variable":"temperature"},{"created_at":"2023-09-20T14:24:53.135Z","device":"6307b0b1b41f1b001a45c7e3","group":"64a2379000439d955b00b056","id":"650b00b559d9340009732a47","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:24:53.134Z","unit":"C","value":"19","variable":"temperature"}]},"status":{"type":"boolean","example":true}}},"examples":{"Get Device Data":{"value":{"result":[{"created_at":"2023-09-20T14:26:44.918Z","device":"6307b0b1b41f1b001a45c7e3","group":"63956cf0000a19e44210b056","id":"650b01244e91a0000fc65937","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:44.918Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:38.015Z","device":"6307b0b1b41f1b001a45c7e3","group":"f863379000439d95e110b056","id":"650b011e59d9340009733690","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:38.015Z","unit":"C","value":"86","variable":"temperature"},{"created_at":"2023-09-20T14:26:25.477Z","device":"6307b0b1b41f1b001a45c7e3","group":"aa756cf0000a19e41110b056","id":"650b01114e91a0000fc657ab","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:25.477Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:14.180Z","device":"6307b0b1b41f1b001a45c7e3","group":"b0ee2101006e7e786010b056","id":"650b010687e7e6001012ee0c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:14.180Z","unit":"C","value":"58","variable":"temperature"},{"created_at":"2023-09-20T14:26:03.199Z","device":"6307b0b1b41f1b001a45c7e3","group":"5b33379000439d95bf00b056","id":"650b00fb59d93400097333b6","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:03.199Z","unit":"C","value":"11","variable":"temperature"},{"created_at":"2023-09-20T14:25:53.034Z","device":"6307b0b1b41f1b001a45c7e3","group":"e2456cf0000a19e41f00b056","id":"650b00f14e91a0000fc6542f","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:53.034Z","unit":"C","value":"3","variable":"temperature"},{"created_at":"2023-09-20T14:25:43.099Z","device":"6307b0b1b41f1b001a45c7e3","group":"6f40e7f0001ad1107e00b056","id":"650b00e7011da1000f7e04f7","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:43.099Z","unit":"C","value":"10","variable":"test"},{"created_at":"2023-09-20T14:25:33.027Z","device":"6307b0b1b41f1b001a45c7e3","group":"b77fbff000c901bddd00b056","id":"650b00dddb109c000ffbf77c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:33.027Z","unit":"C","value":"7","variable":"temperature"},{"created_at":"2023-09-20T14:25:23.020Z","device":"6307b0b1b41f1b001a45c7e3","group":"b7e298900029919a3d00b056","id":"650b00d3a919920009892e7c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:23.020Z","unit":"C","value":"1","variable":"temperature"},{"created_at":"2023-09-20T14:25:13.079Z","device":"6307b0b1b41f1b001a45c7e3","group":"7320e7f0001ad1109c00b056","id":"650b00c9011da1000f7e0238","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:13.079Z","unit":"C","value":"12","variable":"temperature"},{"created_at":"2023-09-20T14:25:03.133Z","device":"6307b0b1b41f1b001a45c7e3","group":"c14fbff000c901bdfb00b056","id":"650b00bfdb109c000ffbf41d","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:03.133Z","unit":"C","value":"66","variable":"temperature"},{"created_at":"2023-09-20T14:24:53.135Z","device":"6307b0b1b41f1b001a45c7e3","group":"64a2379000439d955b00b056","id":"650b00b559d9340009732a47","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:24:53.134Z","unit":"C","value":"19","variable":"temperature"}],"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-device-data.api.mdx b/docs/api/get-device-data.api.mdx index 6354f0a7..6c68fd11 100644 --- a/docs/api/get-device-data.api.mdx +++ b/docs/api/get-device-data.api.mdx @@ -18,359 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get Device Data for a specific Device within your profile - + + Request + + {...require("./get-device-data.ParamsDetails.json")} +> + + - + + + + {...require("./get-device-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json b/docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json new file mode 100644 index 00000000..708834ab --- /dev/null +++ b/docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"serieNumber","in":"path","required":true,"schema":{"type":"string"},"description":"Device Serial Number registered at TagoIO"},{"name":"AuthorizationKey","in":"path","required":true,"schema":{"type":"string"},"description":"Authorization key for the profile, used to resolve the device token when multiple profiles may have the same serial number."}]} \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json b/docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json b/docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json new file mode 100644 index 00000000..0a2ed955 --- /dev/null +++ b/docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successfully Token Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":""},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number-authorization.api.mdx b/docs/api/get-device-token-with-serial-number-authorization.api.mdx index 8f24f774..bc9eb00e 100644 --- a/docs/api/get-device-token-with-serial-number-authorization.api.mdx +++ b/docs/api/get-device-token-with-serial-number-authorization.api.mdx @@ -5,7 +5,7 @@ description: "Retrieve a valid device token using the device's serial number and sidebar_label: "Find Device by Serial & Authorization Key" hide_title: true hide_table_of_contents: true -api: eJztV21v2zYQ/isHFlg3Q7LzYudFGAoES9cFK9oiaVAMSYCepbPFRiZVkrLrGf7vw5GSI9lNWxTF9mX5kDjy8V6ee+74aCUcTq1IbsQrcgtt7uFCTck6cReJjGxqZOmkViIRl+SMpDkBwhwLmUFGc5kSOH1PCior1RRcTvXjpxYsGYkFqGo2JgOoMkAojZ7IggArl2sj/0Z2Dve07APcqre5tEAqK7VUDqQFQ6mezUhllMEiJwVLXYEiygCzTPJZLMBSWhnplqANyAmbGGiKkRZwjrLAccGZwqwqnCwLahKxEaAF6QCLQi+2crZ8YkyQVWUhU3QcNjXaWsjkZEKGlNv48fn/pSuYVdZBjnOCsXY54CaVAED9X/zWo+Y0VJbAtevuA4hI6JKMB+ciE4mYkjv3sPpj76TLr3yir3yeZ20wRSQaQERysxKdgCK5uVvfRcKQLbWyZEWyEgd7e/yn2+2rKk3J2klVFEsIyV7Wh0QkUq0cKcfHsAzgSK0GHyyfXQmb5jRD/uSWJYlE6PEHSp2IRGm4MCdDZEO2KlzLzjoj1VREgj7hrCz40a/h2TOxjoR16Crbsh9rXRCq9gFnKlqHn0iUaHBGjoz1WCic+ShkJAXoRCQkl1uiywXj8rGShrLgJtotpE5wvT0coTsQugLBNxiaSuvIMG8cvMWpvngt1tEmj07f/qTlj0rmbHu4YKKNn82arRGzLmP2GbK6mFNrcOt59tO2My0ww2UgNx+wOKPuxPQFs2tGLtc1bbnnXE4iBlI5mgZSD1Rg5aCOP1i1erIerLaRWXtWm3nTyMoUIhG5c6VNBgMsZb+yMe33HU51X2oP8q4NVfGiZXP3MClXDG3gZOhkMy4brLGUoUNbUEPbHlyOfm9VSn6s/MLx2ygg24cXpHiqeYUGlMdLQD9nvDy96XmzPUucUl9EDVc6adU8yQkzT+FP8cO8jGj/4HA4wjg73sN4SAdZPD45zOJRuue/ODo+OWXKbO2Frxfa7LEvVlob9eHMlwUXDz238Gzj41nw4hfsdBsUJmvH2QMKj5V/Lm1Z4PJVsOqW1oVnko2Gp5gdxCf7h2k8zI6O4vHk+CAe7Z3QaHx6ghM6ZHjeBMZ/Ozz1gbqGR+Ah5aTZjFOLEFIFA0xTXSkHlpyTampbtXcz+hIFcH9EOCKMs+wgi4fp0WF8cjocxacH49Eww+Hx8QEKXo9STbSvTTp/MKwoOHtzsVPgkydPnkCv94dedC6tTKfVjJTzHe71+Aqn7kNGwZaFdEz2RS7TvIZoqaunhqDZco1bqfxu4cdkXZAFIa3S6LnMyMKwdf96Xza5VTH0eu0h6fUS4GRqThk9a89iVKfCeiJFBVNywaajYPwM3ioAzoIDdHrAEc4Kq+Fe6QXLiLPQvPBtH1gNbPz62I36abq7G6BDXQ5wYX1K21Vs5uy1KpYtiRP0D+OqF4oM6Ik/rho5VNNMtsdyJ4kzhcXSShuySHq9zwKJtVXUDh+a13zVuI7j+FZ5Bl2Fyr3V2ZsLeN6IvUuaSq1u1Tt/7+A9G2HDAuYGn3jgZ+Q757UWcgtsSamcLEP0klWGkTxXxrvFoqWufsu1tgRaUYPORLP444iNlYUx8g2pa7ympKcGy1ymWNQ+k1sV0LpWkpXhlUNHFp6jdbDPmEGA9Hpb322ErIGWduIxCTFrDAlZOijouO83Xnu968uXHOX9o5fg4H27p88rVl7wjn5AeuyEUws+v5JT59LlnEI+3Eo4p7LQy002PDA211WR+U3gc9AL5Ylyfflys1Q7fAu3pp6hVCzfU59t3VgOEmLwHmX1EJbZfn+vv1fLWExZgHqxqK2boV/29cr9XaqsvpF5e9Xq7ifoCqzP3AerB4X8/3vTv/reVF/Tjj65QVmgVHyZeym4qoXojWhtP75eg2cvuL0YFZFIuq8IyY5Sv4tErq1jb6sVD8a1KdZrfvyxIsNvXneRmKORDKCXrJm0/DkTyQQLS18gzM+X9ZX4C3z7a8UjlTeqRTFF51hU/J+IxD0tt16EWDJ/V47/5dvGd1W908z13TpqlBS3qjZLUypdy8HOm27nXefF87ciEjyfXbV477dD/YG9fza5RtSF0Pyb+/FZ09UqaND1emMfvnr0xEYkBmvG6G69Xv8D1rI6HQ== +api: eJztV21v2zYQ/isHFlg3Q7LzYudFGAoES9cFK9oiaVAMSYCepbPFRiZVkrLrGf7vw5GSI9lNWxTF9mX5kDjy8V6ee+74aCUcTq1IbsQrcgtt7uFCTck6cReJjGxqZOmkViIRl+SMpDkBwhwLmUFGc5kSOH1PCior1RRcTvXjpxYsGYkFqGo2JgOoMkAojZ7IggArl2sj/0Z2Dve07APcqre5tEAqK7VUDqQFQ6mezUhllMEiJwVLXYEiygCzTPJZLMBSWhnplqANyAmbGGiKkRZwjrLAccGZwqwqnCwLahKxEaAF6QCLQi+2crZ8YkyQVWUhU3QcNjXaWsjkZEKGlNv48fn/pSuYVdZBjnOCsXY54CaVAED9X/zWo+Y0VJbAtevui0jokoyH5iITiZiSO/eg+kPvpMuvfJqvfJZnbShFJBo4RHKzEp1wIrm5W99FwpAttbJkRbISB3t7/Kfb66sqTcnaSVUUSwipXtaHRCRSrRwpx8ewDNBIrQYfLJ9dCZvmNEP+5JYliUTo8QdKnYhEabgwJ0NkQ7YqXMvOOiPVVESCPuGsLPjRr+HZM7GOhHXoKtuyH2tdEKr2AWcqWoefSJRocEaOjPVYKJz5KGQkBehEJCSXW6LLBePysZKGsuAm2i2kTnC9PRqhOxC6AsE3GJpK68gwaxy8xam+eC3W0SaPTt/+pOWPSuZse7Rgoo2fzJqrEXMuY+4ZsrqYU2ts62n2s7YzKzDDZaA2H7A4o+689AWza0Yu1zVtuedcTiIGUjmaBlIPVGDloI4/WLV6sh6stpFZe1abedPIyhQiEblzpU0GAyxlv7Ix7fcdTnVfag/yrg1V8aJlc/cwKVcMbeBk6GQzLhussZShQ1tQQ9seXI5+a1VKfqz8uvG7KCDbhxekeKp5gQaUx0tAP2e8Or3pebM7S5wSL4KaK520ap7khJmn8Kf4YV5GtH9wOBxhnB3vYTykgywenxxm8Sjd818cHZ+cMmW29sLXC2222BcrrY36cObLgouHnlt4tvHxLHjx63W6DQqTtePsAYXHyj+Xtixw+SpYdUvrwjPJRsNTzA7ik/3DNB5mR0fxeHJ8EI/2Tmg0Pj3BCR0yPG8C478dnvpAXcMj8JBy0mzGqUUIqYIBpqmulANLzkk1ta3auxl9iQK4PyIcEcZZdpDFw/ToMD45HY7i04PxaJjh8Pj4AAWvR6km2tcmnT8YVhScvbnYKfDJkydPoNf7Qy86V1am02pGyvkO93p8gVP3IaNgy0I6Jvsil2leQ7TU1VND0Gy5xq1UfrfwY7IuiIKQVmn0XGZkYdi6fb0vm9yqGHq99pD0eglwMjWnjJ61ZzGqU2E1kaKCKblg09EvfgZvFQBnwQE6PeAIZ4XVcK/0gkXEWWhe+LYPrAU2fn3sRvs03d0N0KEuB7iwPqXtKjZz9loVy5bACeqHcdULRQb0xB9XjRiqaSbbY7mTxJnCYmmlDVkkvd5ngcTaKmqHD81rvmpcx3F8qzyDrkLl3urszQU8b6TeJU2lVrfqnb938J6NsGEBc4NPPPAz8p3zSgu5BbakVE6WIXrJKsNInivj3WLxoK3gt1xrS6AVNehMNEs/jthYWRgj35C6xmtKemqwzGWKRe0zuVUBrWslWRdeOXRk4TlaB/uMGQRIr7fV3UbGGmhpJx6TELPGkJClg4KO+37jtde7vnzJUd4/egkO3rd7+rxi5QXv6Aekx044teDzKzl1Ll3OKeTDrYRzKgu93GTDA2NzXRWZ3wQ+B71QnijXly83S7XDt3Br6hlKxeI99dnWjeUgIQbvUVYPYZnt9/f6e7WMxZQFqBeL2roZ+mVfr9zfpcrqG5m3V63ufoKuwPrMfbB6UMj/vzX9i29N9SXt6JMblAVKxVe5F4KrWobeiNbu48s1+PVy20tREYmk+4KQ7Oj0u0jk2jr2tlrxWFybYr3mxx8rMvzedReJORrJ8HnBmknLnzORTLCw9AW6/HxZX4i/wLe/VDxSeaNZFBN0jkXF/4lI3NNy6zWIBfN35fhfvmt8V9U7zVzfraNGR3GrarM0pdK1HOy853bedF48fysiwdPZ1Yr3fjfUH9j7Z5NrJF0Izb+5H581Xa2CAl2vN/bhq0dPbCRisGaM7tbr9T+DJjmd sidebar_class_name: "get api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -18,57 +18,54 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Retrieve a valid device token using the device's serial number and a profile authorization key. This endpoint is recommended when you need additional security or if your Network is available to multiple profiles, as it allows serial numbers to be duplicated across different profiles. You must have both a Network and a Network-Token to use this endpoint. - + + Request + + {...require("./get-device-token-with-serial-number-authorization.ParamsDetails.json")} +> + + - + + + " }, status: { type: "boolean", example: true } }, - }, - }, - }, - }, - }} -> + {...require("./get-device-token-with-serial-number-authorization.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number.ParamsDetails.json b/docs/api/get-device-token-with-serial-number.ParamsDetails.json new file mode 100644 index 00000000..c40eb5e3 --- /dev/null +++ b/docs/api/get-device-token-with-serial-number.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"serieNumber","in":"path","required":true,"schema":{"type":"string"},"description":"Device Serial Number registered at TagoIO"}]} \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number.RequestSchema.json b/docs/api/get-device-token-with-serial-number.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-device-token-with-serial-number.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number.StatusCodes.json b/docs/api/get-device-token-with-serial-number.StatusCodes.json new file mode 100644 index 00000000..eea3d57a --- /dev/null +++ b/docs/api/get-device-token-with-serial-number.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"got a valid token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":""},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-device-token-with-serial-number.api.mdx b/docs/api/get-device-token-with-serial-number.api.mdx index 557f0185..44ca5834 100644 --- a/docs/api/get-device-token-with-serial-number.api.mdx +++ b/docs/api/get-device-token-with-serial-number.api.mdx @@ -18,14 +18,24 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Get a valid device-token using token serial number only. It will match the serial in any profile. :::warning @@ -33,36 +43,31 @@ If the serial number is duplicated between different profiles, you will get the ::: You must have a Network and a Network-Token to use this query. - + + Request + + {...require("./get-device-token-with-serial-number.ParamsDetails.json")} +> + + - + + + " }, status: { type: "boolean", example: true } }, - }, - }, - }, - }, - }} -> + {...require("./get-device-token-with-serial-number.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-dictionary-details.ParamsDetails.json b/docs/api/get-dictionary-details.ParamsDetails.json new file mode 100644 index 00000000..b8515d71 --- /dev/null +++ b/docs/api/get-dictionary-details.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"}]} \ No newline at end of file diff --git a/docs/api/get-dictionary-details.RequestSchema.json b/docs/api/get-dictionary-details.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-dictionary-details.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-dictionary-details.StatusCodes.json b/docs/api/get-dictionary-details.StatusCodes.json new file mode 100644 index 00000000..8b91f84a --- /dev/null +++ b/docs/api/get-dictionary-details.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting the Dictionary details","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"created_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"},"fallback":{"type":"string","example":"en-US"},"languages":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"code":{"type":"string","example":"en-US"}}},"example":[{"active":true,"code":"en-US"},{"active":true,"code":"es-ES"},{"active":true,"code":"pt-BR"}]},"name":{"type":"string","example":"Admin Dashboard"},"slug":{"type":"string","example":"ADM"},"updated_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-dictionary-details.api.mdx b/docs/api/get-dictionary-details.api.mdx index 1c5eb1af..85552869 100644 --- a/docs/api/get-dictionary-details.api.mdx +++ b/docs/api/get-dictionary-details.api.mdx @@ -18,70 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get Dictionary Details - + + Request + + {...require("./get-dictionary-details.ParamsDetails.json")} +> + + - + + + + {...require("./get-dictionary-details.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-dictionary-language-details.ParamsDetails.json b/docs/api/get-dictionary-language-details.ParamsDetails.json new file mode 100644 index 00000000..ac38cd4a --- /dev/null +++ b/docs/api/get-dictionary-language-details.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"slug_or_dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Slug or Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"},{"name":"language","in":"path","required":true,"schema":{"type":"string","example":"Language Code"},"description":"Language that will be returned keys"}]} \ No newline at end of file diff --git a/docs/api/get-dictionary-language-details.RequestSchema.json b/docs/api/get-dictionary-language-details.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-dictionary-language-details.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-dictionary-language-details.StatusCodes.json b/docs/api/get-dictionary-language-details.StatusCodes.json new file mode 100644 index 00000000..1967e5d1 --- /dev/null +++ b/docs/api/get-dictionary-language-details.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a dictionary language details","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"key":{"type":"string","example":"value"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-dictionary-language-details.api.mdx b/docs/api/get-dictionary-language-details.api.mdx index 323de357..0d0c8c8f 100644 --- a/docs/api/get-dictionary-language-details.api.mdx +++ b/docs/api/get-dictionary-language-details.api.mdx @@ -18,57 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Get Dictionary Language Details - + + Request + + {...require("./get-dictionary-language-details.ParamsDetails.json")} +> + + - + + + + {...require("./get-dictionary-language-details.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-dictionary-list.RequestSchema.json b/docs/api/get-dictionary-list.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-dictionary-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-dictionary-list.StatusCodes.json b/docs/api/get-dictionary-list.StatusCodes.json new file mode 100644 index 00000000..6fea8078 --- /dev/null +++ b/docs/api/get-dictionary-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting the dictionary list","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"},"fallback":{"type":"string","example":"en-US"},"id":{"type":"string","example":"63ea6bd581db210009ff8f1d"},"languages":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"code":{"type":"string","example":"en-US"}}},"example":[{"active":true,"code":"en-US"},{"active":true,"code":"es-ES"},{"active":true,"code":"pt-BR"}]},"name":{"type":"string","example":"Admin Dashboard"},"slug":{"type":"string","example":"ADM"},"updated_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"}}},"example":[{"created_at":"2023-02-13T16:56:53.086Z","fallback":"en-US","id":"63ea6bd581db210009ff8f1d","languages":[{"active":true,"code":"en-US"},{"active":true,"code":"es-ES"},{"active":true,"code":"pt-BR"}],"name":"Admin Dashboard","slug":"ADM","updated_at":"2023-02-13T16:56:53.086Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-dictionary-list.api.mdx b/docs/api/get-dictionary-list.api.mdx index 57a9fa65..cd2d5ae2 100644 --- a/docs/api/get-dictionary-list.api.mdx +++ b/docs/api/get-dictionary-list.api.mdx @@ -18,77 +18,44 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List of Dictionaries - + + + - + + + + {...require("./get-dictionary-list.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-entity-data-amount.ParamsDetails.json b/docs/api/get-entity-data-amount.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/get-entity-data-amount.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/get-entity-data-amount.RequestSchema.json b/docs/api/get-entity-data-amount.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-entity-data-amount.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-entity-data-amount.StatusCodes.json b/docs/api/get-entity-data-amount.StatusCodes.json new file mode 100644 index 00000000..e40e333d --- /dev/null +++ b/docs/api/get-entity-data-amount.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting entity data amount","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"number","example":100},"status":{"type":"boolean","example":true}}},"examples":{"Getting entity data amount":{"value":{"result":100,"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-entity-data-amount.api.mdx b/docs/api/get-entity-data-amount.api.mdx index 996d9ab1..0f9289d9 100644 --- a/docs/api/get-entity-data-amount.api.mdx +++ b/docs/api/get-entity-data-amount.api.mdx @@ -18,38 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get Entity Data Amount - + + Request + + {...require("./get-entity-data-amount.ParamsDetails.json")} +> + + - + + + + {...require("./get-entity-data-amount.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-entity-data.ParamsDetails.json b/docs/api/get-entity-data.ParamsDetails.json new file mode 100644 index 00000000..80da24d9 --- /dev/null +++ b/docs/api/get-entity-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"number"},"description":"(default 1)"},{"name":"amount","in":"query","schema":{"type":"string","example":"number"},"description":"(default: 20, max: 1000)"},{"name":"fields","in":"query","schema":{"type":"string","example":""},"description":"comma-separated list of fields to return"},{"name":"order_by","in":"query","schema":{"type":"string","example":"asc/desc"}},{"name":"filter","in":"query","schema":{"type":"string","example":""},"description":"JSON object. Filter by an entity field. Requires the index paramenter"},{"name":"index","in":"query","required":true,"schema":{"type":"string"},"description":"First index searchable field from the entity field added to the filter parameter"},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/get-entity-data.RequestSchema.json b/docs/api/get-entity-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-entity-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-entity-data.StatusCodes.json b/docs/api/get-entity-data.StatusCodes.json new file mode 100644 index 00000000..1dbd03b6 --- /dev/null +++ b/docs/api/get-entity-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting entity data by filter","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"charge_amount":{"example":null},"created_at":{"type":"string","example":"2024-11-06T11:32:36.467Z"},"id":{"type":"string","example":"672b53d43bc47400095f3831"},"int_field":{"example":null},"monthly_revenue":{"type":"number","example":2345.34},"update_date":{"type":"string","example":"2024-11-01T03:00:00.000Z"},"updated_at":{"type":"string","example":"2024-11-06T11:32:36.467Z"}}},"example":[{"charge_amount":null,"created_at":"2024-11-06T11:32:36.467Z","id":"672b53d43bc47400095f3831","int_field":null,"monthly_revenue":2345.34,"update_date":"2024-11-01T03:00:00.000Z","updated_at":"2024-11-06T11:32:36.467Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:33.380Z","id":"672b5449dbac110009ce878f","int_field":null,"monthly_revenue":2193.43,"update_date":"2024-10-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:33.380Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:47.772Z","id":"672b54573bc47400095f4634","int_field":null,"monthly_revenue":2889.23,"update_date":"2024-09-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:47.772Z"}]},"status":{"type":"boolean","example":true}}},"examples":{"Getting entity data by filter":{"value":{"result":[{"charge_amount":null,"created_at":"2024-11-06T11:32:36.467Z","id":"672b53d43bc47400095f3831","int_field":null,"monthly_revenue":2345.34,"update_date":"2024-11-01T03:00:00.000Z","updated_at":"2024-11-06T11:32:36.467Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:33.380Z","id":"672b5449dbac110009ce878f","int_field":null,"monthly_revenue":2193.43,"update_date":"2024-10-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:33.380Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:47.772Z","id":"672b54573bc47400095f4634","int_field":null,"monthly_revenue":2889.23,"update_date":"2024-09-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:47.772Z"}],"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-entity-data.api.mdx b/docs/api/get-entity-data.api.mdx index 8b1486e0..1805706d 100644 --- a/docs/api/get-entity-data.api.mdx +++ b/docs/api/get-entity-data.api.mdx @@ -18,146 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get Entity Data - + + Request + + {...require("./get-entity-data.ParamsDetails.json")} +> + + - + + + + {...require("./get-entity-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-entity-info.ParamsDetails.json b/docs/api/get-entity-info.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/get-entity-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/get-entity-info.RequestSchema.json b/docs/api/get-entity-info.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-entity-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-entity-info.StatusCodes.json b/docs/api/get-entity-info.StatusCodes.json new file mode 100644 index 00000000..587364ad --- /dev/null +++ b/docs/api/get-entity-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting an entity information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"created_at":{"type":"string","example":"2024-11-05T18:32:25.522Z"},"database":{"type":"string","example":"6229032d0620c89169acbdc0"},"id":{"type":"string","example":"672a64b91807cd0008baa4d5"},"index":{"type":"object","properties":{"id_created_at_idx":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"id"},"example":["id","created_at"]}}},"id_idx":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"id"},"example":["id"]}}},"id_updated_at_idx":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"id"},"example":["id","updated_at"]}}},"index_charge_amount":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"charge_amount"},"example":["charge_amount"]}}}}},"name":{"type":"string","example":"Control Entity"},"payload_decoder":{"example":null},"profile":{"type":"string","example":"63c82c9e6a7fb4000a1f95a0"},"schema":{"type":"object","properties":{"charge_amount":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"int"}}},"created_at":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"timestamp"}}},"id":{"type":"object","properties":{"required":{"type":"boolean","example":true},"type":{"type":"string","example":"uuid"}}},"int_field":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"int"}}},"update_date":{"type":"object","properties":{"required":{"type":"boolean","example":true},"type":{"type":"string","example":"timestamp"}}},"updated_at":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"timestamp"}}}}},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"yes"}}},"example":[{"key":"active","value":"yes"}]},"updated_at":{"type":"string","example":"2024-11-05T20:21:40.797Z"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting an entity information":{"value":{"result":{"created_at":"2024-11-05T18:32:25.522Z","database":"6229032d0620c89169acbdc0","id":"672a64b91807cd0008baa4d5","index":{"id_created_at_idx":{"fields":["id","created_at"]},"id_idx":{"fields":["id"]},"id_updated_at_idx":{"fields":["id","updated_at"]},"index_charge_amount":{"fields":["charge_amount"]}},"name":"Control Entity","payload_decoder":null,"profile":"63c82c9e6a7fb4000a1f95a0","schema":{"charge_amount":{"required":false,"type":"int"},"created_at":{"required":false,"type":"timestamp"},"id":{"required":true,"type":"uuid"},"int_field":{"required":false,"type":"int"},"update_date":{"required":true,"type":"timestamp"},"updated_at":{"required":false,"type":"timestamp"}},"tags":[{"key":"active","value":"yes"}],"updated_at":"2024-11-05T20:21:40.797Z"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-entity-info.api.mdx b/docs/api/get-entity-info.api.mdx index 95f0b7ec..f89ca4b0 100644 --- a/docs/api/get-entity-info.api.mdx +++ b/docs/api/get-entity-info.api.mdx @@ -18,181 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get Entity Details - + + Request + + {...require("./get-entity-info.ParamsDetails.json")} +> + + - + + + + {...require("./get-entity-info.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-information.ParamsDetails.json b/docs/api/get-information.ParamsDetails.json new file mode 100644 index 00000000..ad79fd90 --- /dev/null +++ b/docs/api/get-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file diff --git a/docs/api/get-information.RequestSchema.json b/docs/api/get-information.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-information.StatusCodes.json b/docs/api/get-information.StatusCodes.json new file mode 100644 index 00000000..ed105b47 --- /dev/null +++ b/docs/api/get-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a dashboard information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"arrangement":{"type":"array","items":{"type":"object","properties":{"height":{"type":"number","example":3},"tab":{"example":null},"widget_id":{"type":"string","example":"6230e740f5772600124c81e1"},"width":{"type":"number","example":1},"x":{"type":"number","example":0},"y":{"type":"number","example":0}}},"example":[{"height":3,"tab":null,"widget_id":"6230e740f5772600124c81e1","width":1,"x":0,"y":0},{"height":3,"tab":null,"widget_id":"6230e75df5772600124c81e2","width":1,"x":1,"y":0},{"height":3,"tab":null,"widget_id":"6230e44cf5772600124c81de","width":1,"x":2,"y":0},{"height":3,"tab":null,"widget_id":"6230e84df5772600124c81e7","width":2.3333333333333335,"x":0.3333333333333333,"y":7},{"height":5,"tab":null,"widget_id":"62750cf1253eb800126aefc0","width":2,"x":2.666666666666667,"y":7}]},"background":{"type":"object","properties":{}},"blueprint_device_behavior":{"example":null},"blueprint_devices":{"type":"array","items":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"kmutable"},"value":{"type":"string","example":"vmutable"}}},"example":[{"key":"kmutable","value":"vmutable"}]},"filter_conditions":{"type":"array","items":{},"example":[]},"id":{"type":"string","example":"6230e392f5772600124c81db"},"name":{"type":"string","example":"mutable_device"}}},"example":[{"conditions":[{"key":"kmutable","value":"vmutable"}],"filter_conditions":[],"id":"6230e392f5772600124c81db","name":"mutable_device"},{"conditions":[{"key":"kimmutable","value":"vimmutable"}],"filter_conditions":[],"id":"6230e42af5772600124c81dc","name":"immutable_device"},{"conditions":[{"key":"klegacy","value":"vlegacy"}],"filter_conditions":[],"id":"6230e42af5772600124c81dd","name":"legacy_device"}]},"blueprint_selector_behavior":{"example":null},"created_at":{"type":"string","example":"2022-03-15T19:05:54.839Z"},"group_by":{"type":"array","items":{},"example":[]},"icon":{"type":"object","properties":{}},"id":{"type":"string","example":"6230e392f5772600124c81da"},"label":{"type":"string","example":"Device Types Blueprint"},"last_access":{"type":"string","example":"2022-06-21T11:51:07.642Z"},"setup":{"type":"object","properties":{}},"tabs":{"type":"array","items":{},"example":[]},"tags":{"type":"array","items":{},"example":[]},"theme":{"example":null},"type":{"type":"string","example":"blueprint"},"updated_at":{"type":"string","example":"2022-06-21T11:51:07.642Z"},"visible":{"type":"boolean","example":true}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting a dashboard information":{"value":{"result":{"arrangement":[{"height":3,"tab":null,"widget_id":"6230e740f5772600124c81e1","width":1,"x":0,"y":0},{"height":3,"tab":null,"widget_id":"6230e75df5772600124c81e2","width":1,"x":1,"y":0},{"height":3,"tab":null,"widget_id":"6230e44cf5772600124c81de","width":1,"x":2,"y":0},{"height":3,"tab":null,"widget_id":"6230e84df5772600124c81e7","width":2.3333333333333335,"x":0.3333333333333333,"y":7},{"height":5,"tab":null,"widget_id":"62750cf1253eb800126aefc0","width":2,"x":2.666666666666667,"y":7}],"background":{},"blueprint_device_behavior":null,"blueprint_devices":[{"conditions":[{"key":"kmutable","value":"vmutable"}],"filter_conditions":[],"id":"6230e392f5772600124c81db","name":"mutable_device"},{"conditions":[{"key":"kimmutable","value":"vimmutable"}],"filter_conditions":[],"id":"6230e42af5772600124c81dc","name":"immutable_device"},{"conditions":[{"key":"klegacy","value":"vlegacy"}],"filter_conditions":[],"id":"6230e42af5772600124c81dd","name":"legacy_device"}],"blueprint_selector_behavior":null,"created_at":"2022-03-15T19:05:54.839Z","group_by":[],"icon":{},"id":"6230e392f5772600124c81da","label":"Device Types Blueprint","last_access":"2022-06-21T11:51:07.642Z","setup":{},"tabs":[],"tags":[],"theme":null,"type":"blueprint","updated_at":"2022-06-21T11:51:07.642Z","visible":true},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-information.api.mdx b/docs/api/get-information.api.mdx index e79e61b8..0bef1754 100644 --- a/docs/api/get-information.api.mdx +++ b/docs/api/get-information.api.mdx @@ -5,7 +5,7 @@ description: "Get settings information of the dashboard." sidebar_label: "Dashboard Information" hide_title: true hide_table_of_contents: true -api: eJztWVtv47YS/isE96GtITmSbNmOHgqkzWIbtGgXuwmK002QUtLYYiOTWpKK1wj83w94kSU58SXb83BQNC9JpOE33wznRuoJK7KQOPmEL4ksUk5ELvGdh3OQmaCVopzhBL8DhSQoRdlCIsrmXCyJfoX4HKkCUN6sHaJbhj3MKxBG4CrHCV6AumrXYA8LkBVnEiROnnAUBPrXM4VaGSItdFcv9nDGmQKm9FJSVSXNzIuzv6Re/4RlVsCS6L/UugKcYJ7+BZnCHq6EZqeo1S5A1qU6LkeEIGwBS6fSCeuna+xhqmApj4MUQBdFdz2rlykI7GH4QpZVCTgZbTysSKplts9YXZYbD69ovgB1T/MOgFSCskUXAE+iUQDTcTCPp9NoEgRhNM5mIYTYQqjioP5w4+EvByWCjYfXRyQ2m86/n1rDR844bVHPoP2st6RDQywwyoONdzponO+ARrug4atBx+OsD5rDLmj0atDZeJfptAWNhqP+T2z9sft4ZNROu2rjA2qncZDNwygeQTrTaicE5lnQUWttGU56P1On5G7j4ZRkDwvBa5YfTQAdFmlZQyUoU/c5PNIM7lMoyCPl4qWQ3xWWX597GWc51SXib2A8wPpw7j0sa0XSEnSuPZKyhsPij1vx3YQxmlq4LVpnifb9nJYKxP1JtvU06MUnFZLRebQT6Kk2jpHlEdscT7dxzy3scj7R4Bft/XRnLdlPt2H7jJK3jwVdvsCjfXgSk3FEdphkLZMt1nEuJSxItu4ScU++kkXesrBAWwp3vYSTUEKmuDiYn5kAoiC/J+pwMERBFPnByA/j6/A8CeIkHg9no/M/dCjp2lHdp+tXhW5mu/zRavOVMU40sZKkUB5efmlch67XFUj0Q+M7u1iqe5JlIOUprpn4UXgdhkkcJsF0OBlHxjUSVF2dZKci6aty3w59r5AvwCb8bgRYgEMGpl231FX+ioB52SuPVFKdhi1AynkJhHURlKjB1BypiKrlicLuiRE/NoImT22Jb6fI3pz47+Tzz518dgafw5ON1f/CNPNvI/x/bIRH+qDdzW7v29/guv3NMLKda3N4rwjetp99PWanxeyvmG0b2fYJTcQd+++2td1a1RTJjp5uzT6kZluXTTltK6+rrhtTYSsiyBIUCLu3bgO2FfbqUnchfQNQEVWYq4LPNRWQWxjv+bn+hebxrfZVr25fXX6HN3pfl6AK7u4kdB/VShJ8tpU8e+pQ2RjficeGbC30fhRKVTI5OyMVHdbSh3CoyIIPKTex+1wGan/VkbnTmFktqFob0PeCz2kJ1/wBmGm2HYGP2ljbjWwU+E6sbdwV/Rl0UvSvTy5QVx6pgihEJaoZ/VwDUhyteS2QjfchegdMX9dolykjn66RjSvd/4yohftGooosYNhmTo+W27kCSG4uBL747Z7EEEajcUz8fBoQfwxR7qezUe7HWWBeTKazc93cfwW14uLhdEPdAnTQUic0RBfGLHTFFCzsDZVE328xvrcoUq9b7DplzkUfrPXCPvMvqaxKsv7VSvVN67tnnsfjc5JH/iwcZf44n0z8dD6N/DiYQZyez8gcRto9LlpOd49b4GzY4x5gigpAlZXtBARlVoBkGa9ZewfYsb3P6FAIkDAGEgPx8zzK/XE2Gfmz83Hsn0dpPM7JeDqNCDZDO5tzYxtVZuE1WfCr39DF+6tnBr558+YNGgx+4ittTC0BqYJKlPOs1iOY2eHB4JZd60vK7kPtBVmVVOlgXxU0K5yL1rz+RgBq6k4DS5m56NSPQaohQrfM0aoEf6Q5SDRGOZ3PQQBTFksmt8xHg0E3SQaDBGkyLqYEX3Zz0XNU1rxGGWFoAcrKmEvWXg7eMoQ0C62gtwdaw0UpOXpgfIWI1DGvN8++HaL/8LrFNbrdvrc3vM8U9EJXK7iShtKuFds8+42Va0QeCS11c0d03viVrxiI5tqYubxrwox20/IZiQtGyrWk0rJIBoMXHUmclNdVbzevedVA+75/y0wEfXSzvpa6eH+F3rK84pQp9AEWlLNb9nsBDC3Jgz0QuCjQsaFXtPHpmZ1b1lIhordAVpDR+dpqr/SpTVCdV8LAkhKBUzREPxacS0CcQeOdOS9LvtIaGymJUiIhR9z5awF8IUhV0IyUDjO5ZdZbN4wqyNFHRRRI9JZIhULtM2RdetOkSoONVgU02d7ep+s0sTqdD4FIBYKhHvywQR0Mbj78orX8ubdLnv3Z3dO3tT7Jot/hf0BPg2hqFvMIp15X1pwsH72V6BKqkq+3bHTCyILXZW4qgeHAV8wEys2HX7ZFtRdvtmvyJaFMIglZ92uJVmJ16DqqxwtbzMJhMAzcpw2SKXe0r7hUS2KKfdN027mm90mkVxqf2i8kr/5845qKgi/qrCoJZeboLsxliB2ZPrUjG/Zw0p3f7jxccKlPv/jpSW/OjSg3G/34cw3CjcGPRFBzhNAjUE6l/jvHyZyUEg4Y8u0HV5a/Q/toNg2RdY8K2HOniC5Rc+HlOlV7ztATQqU6a599XerNke/eXuPN5r8dPOtm +api: eJztWVtv47YS/isE96GtITmSbNmOHgqkzWIbtGgXuwmK002QUtLYYiOTWpKK1wj83w94kSU58SXb83BQNC9JpOE33wznRuoJK7KQOPmEL4ksUk5ELvGdh3OQmaCVopzhBL8DhSQoRdlCIsrmXCyJfoX4HKkCUN6sHd4y7GFegTDvr3Kc4AWoq3YJ9rAAWXEmQeLkCUdBoH8906d1IdIid9ViD2ecKWBKLyVVVdLMvDj7S+r1T1hmBSyJ/kutK8AJ5ulfkCns4Upodopa7QJkXarjckQIwhawdCqdsH66xh6mCpbyOEgBdFF017N6mYLAHoYvZFmVgJPRxsOKpFpm+4zVZbnx8IrmC1D3NO8ASCUoW3QB8CQaBTAdB/N4Oo0mQRBG42wWQogthCoO6g83Hv5yUCLYeHh9RGKz6fz7qTV85IzTFvUM2s96Szo0xAKjPNh4p4PG+Q5otAsavhp0PM76oDnsgkavBp2Nd5lOW9BoOOr/xNYfu49HRu20qzY+oHYaB9k8jOIRpDOtdkJgngUdtdaW4aT3M3VK7jYeTkn2sBC8ZvnRBNBhkZY1VIIydZ/DI83gPoWCPFIuXgr5XWH59bmXcZZTXSL+BsYDrA/n3sOyViQtQefaIylrOCz+uBXfTRijqYXbonWWaN/PaalA3J9kW0+DXnxSIRmdRzuBnmrjGFkesc3xdBv33MIu5xMNftHeT3fWkv10G7bPKHn7WNDlCzzahycxGUdkh0nWMtliHedSwoJk6y4R9+QrWeQtCwu0pXDXSzgJJWSKi4P5mQkgCvJ7og4HQxREkR+M/DC+Ds+TIE7i8XA2Ov9Dh5KuHdV9un5V6Ga2yx+tNl8Z40QTK0kK5eHll8Z16HpdgUQ/NL6zi6W6J1kGUp7imokfhddhmMRhEkyHk3FkXCNB1dVJdiqSvir37cz3CvkCbMLvRoAFOGRg2nVLXeWvCJiXvfJIJdVp2AKknJdAWBdBiRpMzZGKqFqeKOyeGPFjI2jy1Jb4dorszYn/Tj7/3MlnZ/A5PNlY/S9MM/82wv/HRnikD9rd7Pa+/Q2u298MI9u5Nof3iuBt+9nXY3ZazP6K2baRbZ/QRNyp/25b261VTZHs6OnW7ENqtnXZlNO28rrqujEVtiKCLEGBsHvrNmBbYa8udRfSNwAVUYW5KvhcUwG5hfGen+tfaB7fal/16vbV5Xd4o/d1Carg7k5C91GtJMFnW8mzpw6VjfGdeGzI1kLvR6FUJZOzM1LRYS19CIeKLPiQchO7z2Wg9lcdmTuNmdWCqrUBfS/4nJZwzR+AmWbbEfiojbXdyEaB78Taxl3Rn0EnRf/65AJ15ZEqiEJUoprRzzUgxdGa1wLZeB+id8D0dY12mTLy6RrZuNL9z4hauG8kqsgChm3m9Gi5nSuA5OZC4Ivf7kkMYTQax8TPpwHxxxDlfjob5X6cBebFZDo71839V1ArLh5ON9QtQActdUJDdGHMQldMwcLeUEn0/Rbje4si9brFrlPmXPTBWi/sM/+Syqok61+tVN+0vnvmeTw+J3nkz8JR5o/zycRP59PIj4MZxOn5jMxhpN3jouV097gFzoY97gGmqABUWdlOQFBmBUiW8Zq1V4Ad2/uMDoUACWMgMRA/z6PcH2eTkT87H8f+eZTG45yMp9OIYDO0szk3tlFlFl6TBb/6DV28v3pm4Js3b96gweAnvtLG1BKQKqhEOc9qPYKZHR4Mbtm1vqPsPtRekFVJlQ72VUGzwrlozetvBKCm7jSwlJl7Tv0YpBoidMscrUrwR5qDRGOU0/kcBDBlsWRyy3w0GHSTZDBIkCbjYkrwZTcXPUdlzWuUEYYWoKyMuWPt5eAtQ0iz0Ap6e6A1XJSSowfGV4hIHfN68+zbIfoPr1tco9vte3vB+0xBL3S1gitpKO1asc2z31i5RuSR0FI3d0TnjV/5ioFobo2Zy7smzGg3LZ+RuGCkXEsqLYtkMHjRkcRJeV31dvOaVw207/u3zETQRzfra6mL91foLcsrTplCH2BBObtlvxfA0JI82AOBiwIdG3pFG5+e2bllLRUiegtkBRmdr632Sp/aBNV5JQwsKRE4RUP0Y8G5BMQZNN6Z87LkK62xkZIoJRJyxJ2/FsAXglQFzUjpMJNbZr11w6iCHH1URIFEb4lUKNQ+Q9alN02qNNhoVUCT7e19uk4Tq9P5EIhUIBjqwQ8b1MHg5sMvWsufe7vk2Z/dPX1b65Ms+h3+B/Q0iKZmMY9w6nVlzcny0VuJLqEq+XrLRieMLHhd5qYSGA58xUyg3Hz4ZVtUe/FmuyZfEsokkpB1P5ZoJVaHrqN6vLDFLBwGw8B92iCZckf7iku1JKbYN023nWt6n0R6pfGp/ULy2q83rqco+KLOqpJQZk7uwtyF2InpUzuxYQ8n3fHtzsMFl/rwi5+e9N7ciHKz0Y8/1yDcFPxIBDUnCD0B5VTqv3OczEkp4YAd335wVfk7tI9m0w9Z96SAPXeI6BI1912uUbXHDD0gVKqz9tnHpd4Y+e7tNd5s/gv3Ausm sidebar_class_name: "get api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -18,203 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get settings information of the dashboard. - + + + Request + + {...require("./get-information.ParamsDetails.json")} +> + + - + + + + {...require("./get-information.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-policy-list.ParamsDetails.json b/docs/api/get-policy-list.ParamsDetails.json new file mode 100644 index 00000000..e2bb094a --- /dev/null +++ b/docs/api/get-policy-list.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orderBy","in":"query","required":true,"schema":{"type":"string","example":"created_at"}}]} \ No newline at end of file diff --git a/docs/api/get-policy-list.RequestSchema.json b/docs/api/get-policy-list.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-policy-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-policy-list.StatusCodes.json b/docs/api/get-policy-list.StatusCodes.json new file mode 100644 index 00000000..b1ef2bed --- /dev/null +++ b/docs/api/get-policy-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting Policy List","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","description":"Indicates if the policy is active","example":true},"id":{"type":"string","example":"654a7e62a34b9c000006886c2"},"profile":{"type":"string","example":"62fa9e65e0badb0019200"},"name":{"type":"string","example":"My Analysis Policy"},"created_at":{"type":"string","description":"Date and time when the policy was created","example":"2023-11-01T12:34:56.789Z"},"tags":{"type":"array","items":{},"example":[]}}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-policy-list.api.mdx b/docs/api/get-policy-list.api.mdx index 88e6a9f9..a2793c63 100644 --- a/docs/api/get-policy-list.api.mdx +++ b/docs/api/get-policy-list.api.mdx @@ -18,55 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List all access policies in your profile - + + Request + + {...require("./get-policy-list.ParamsDetails.json")} +> + + - + + + + {...require("./get-policy-list.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-profile-file-list.ParamsDetails.json b/docs/api/get-profile-file-list.ParamsDetails.json new file mode 100644 index 00000000..aee22233 --- /dev/null +++ b/docs/api/get-profile-file-list.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"qty","in":"query","schema":{"type":"string","example":"number"},"description":"Quantity of files to be returned in the response"}]} \ No newline at end of file diff --git a/docs/api/get-profile-file-list.RequestSchema.json b/docs/api/get-profile-file-list.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-profile-file-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-profile-file-list.StatusCodes.json b/docs/api/get-profile-file-list.StatusCodes.json new file mode 100644 index 00000000..0ebf18ef --- /dev/null +++ b/docs/api/get-profile-file-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get Profile's Files List","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","example":"layer01.png"},"last_modified":{"type":"string","example":"2023-10-16T13:25:04.000Z"},"public":{"type":"boolean","example":true},"size":{"type":"number","example":63480}}},"example":[{"filename":"layer01.png","last_modified":"2023-10-16T13:25:04.000Z","public":true,"size":63480},{"filename":"layer02.png","last_modified":"2023-10-16T13:23:58.000Z","public":true,"size":233444}]},"folders":{"type":"array","items":{"type":"string","example":"reports"},"example":["reports","image"]},"total":{"type":"number","example":50},"usage":{"type":"number","example":6.02}}},"status":{"type":"boolean","example":true}}},"examples":{"Get Profile's Files List":{"value":{"result":{"files":[{"filename":"layer01.png","last_modified":"2023-10-16T13:25:04.000Z","public":true,"size":63480},{"filename":"layer02.png","last_modified":"2023-10-16T13:23:58.000Z","public":true,"size":233444}],"folders":["reports","image"],"total":50,"usage":6.02},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-profile-file-list.api.mdx b/docs/api/get-profile-file-list.api.mdx index acec178c..aa8f1346 100644 --- a/docs/api/get-profile-file-list.api.mdx +++ b/docs/api/get-profile-file-list.api.mdx @@ -18,93 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get profile file list - + + Request + + {...require("./get-profile-file-list.ParamsDetails.json")} +> + + - + + + + {...require("./get-profile-file-list.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-run-settings.RequestSchema.json b/docs/api/get-run-settings.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-run-settings.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-run-settings.StatusCodes.json b/docs/api/get-run-settings.StatusCodes.json new file mode 100644 index 00000000..d8ac68b7 --- /dev/null +++ b/docs/api/get-run-settings.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"RUN settings retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"auth_token_ttl":{"type":"string","example":"3 months"},"created_at":{"type":"string","example":"2022-06-17T00:02:20.531Z"},"dictionary":{"example":null},"email_domain":{"example":null},"email_templates":{"type":"object","properties":{"password_recover":{"type":"object","properties":{"subject":{"type":"string","example":"Password Recovery"},"value":{"type":"string","example":"### Hi $name$.\n\nYou have requested to reset your password on $application.name$.\n\nClick [here]($recover_link$) and you'll be redirected to a secure site where you can set a new password."}}},"welcome_actived":{"type":"object","properties":{"subject":{"type":"string","example":"Your account was activated!"},"value":{"type":"string","example":"### Hi $name$.\n\nYour account was successfully confirmed. You are now able to log in!"}}},"welcome_adminconfirm":{"type":"object","properties":{"subject":{"type":"string","example":"Your account is being analysed"},"value":{"type":"string","example":"### Hi $name$.\n\nWelcome!\n\nYour account creation has been submitted, but is currently being analysed. We'll keep you posted."}}},"welcome_autoconfirm":{"type":"object","properties":{"subject":{"type":"string","example":"Welcome $name$!"},"value":{"type":"string","example":"### Hi $name$.\n\nWelcome!\n\nBefore you start to enjoy all the features, click [here]($confirmation_link$) to confirm your email."}}}}},"favicon":{"example":null},"feature_devicewifisetup":{"type":"object","properties":{"background_color":{"type":"string","example":"white"},"button_cancel_background_color":{"type":"string","example":"white"},"button_cancel_text_color":{"type":"string","example":"black"},"button_confirm_background_color":{"type":"string","example":"hsl(229, 100%, 23%)"},"button_confirm_text_color":{"type":"string","example":"white"},"enabled":{"type":"boolean","example":false},"ip":{"type":"string","example":""},"language":{"type":"string","example":"EN"},"name":{"type":"string","example":""},"port":{"type":"string","example":""},"protocol":{"type":"string","example":"http"},"text_color":{"type":"string","example":"rgb(60, 60, 60)"},"translations":{"type":"object","properties":{"EN":{"type":"object","properties":{"done_desc":{"type":"string","example":""},"done_title":{"type":"string","example":"Device configured!"},"intro_desc":{"type":"string","example":"Let's connect your device to Wi-Fi for you to start using it."},"intro_img":{"type":"string","example":""},"intro_title":{"type":"string","example":"Begin device setup"},"param_title":{"type":"string","example":"Device found!"},"wait_desc":{"type":"string","example":""},"wait_title":{"type":"string","example":"Waiting for device..."},"wifi_config_desc":{"type":"string","example":"Go to the Wi-Fi settings on your phone and select the AcmeTracking-XXX network. It may take up to a minute to appear on the list. After connecting your phone to the AcmeTracking-XXX network via Wi-Fi, return to the TagoRun app to continue the setup."},"wifi_config_title":{"type":"string","example":"Manually connect to the Device Network"}}}}}}},"feature_geolocation":{"example":null},"integration":{"type":"object","properties":{"google_analytics":{"type":"string","example":""},"zoho_salesiq":{"type":"string","example":""}}},"logo":{"example":null},"logo_options":{"type":"object","properties":{"tooltip":{"type":"string","example":""},"type":{"type":"string","example":""},"value":{"type":"string","example":""}}},"name":{"type":"string","example":"John Doe Run"},"profile":{"type":"string","example":"62ab4302ee089b00134f33ff"},"security":{"type":"object","properties":{}},"sidebar_buttons":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string","example":"grey"},"href":{"type":"string","example":"/"},"iconUrl":{"type":"string","example":"https://svg.internal.tago.io/home.svg"},"isInNewLine":{"type":"boolean","example":true},"text":{"type":"string","example":"Home"},"type":{"type":"string","example":""}}},"example":[{"color":"grey","href":"/","iconUrl":"https://svg.internal.tago.io/home.svg","text":"Home","type":""},{"color":"red","href":"users","iconUrl":"https://svg.internal.tago.io/group-profile-users.svg","text":"Users","type":""},{"color":"hsl(208, 56%, 46%)","href":"connections","iconUrl":"https://svg.internal.tago.io/wifi.svg","isInNewLine":true,"text":"Connections","type":""}]},"signup_fields":{"type":"array","items":{},"example":[]},"signup_logo":{"example":null},"signup_logo_options":{"type":"object","properties":{}},"signup_method":{"type":"string","example":"default"},"sso_saml_active":{"type":"boolean","example":false},"sub_title":{"type":"string","example":"Machine Management"},"theme":{"type":"object","properties":{"actionSchedule":{"type":"string","example":"#e6431e"},"actionTriggerByData":{"type":"string","example":"rgb(85, 107, 47)"},"actionTriggerByMQTT":{"type":"string","example":"hsl(296, 32%, 43%)"},"actionTriggerByResource":{"type":"string","example":"hsl(208, 56%, 45%)"},"alertActionDangerBackground":{"type":"string","example":"hsl(0, 49%, 54%)"},"alertActionInfoBackground":{"type":"string","example":"hsl(200, 74%, 88%)"},"alertActionWarningBackground":{"type":"string","example":"hsl(50, 100%, 86%)"},"alertDangerBackground":{"type":"string","example":"hsl(0, 60%, 92%)"},"alertInfoBackground":{"type":"string","example":"hsl(200, 65%, 91%)"},"alertWarningBackground":{"type":"string","example":"hsl(50, 100%, 94%)"},"analysisExternal":{"type":"string","example":"hsl(27, 80%, 49%)"},"analysisInternal":{"type":"string","example":"hsl(208, 56%, 46%)"},"auth_bg_opacity":{"type":"number","example":100},"auth_bg_src":{"type":"string","example":""},"auth_bg_type":{"type":"string","example":"default"},"auth_form_opacity":{"example":null},"blueprint":{"type":"string","example":"hsl(230, 100%, 32%)"},"buttonDanger":{"type":"string","example":"#e40000"},"buttonDangerText":{"type":"string","example":"hsl(0, 100%, 100%)"},"buttonDefault":{"type":"string","example":"hsl(0, 0%, 100%)"},"buttonDefaultText":{"type":"string","example":"hsl(0, 0%, 0%)"},"buttonDisabled":{"type":"string","example":"hsl(0, 0%, 90%)"},"buttonDisabledText":{"type":"string","example":"hsl(0, 0%, 0%)"},"buttonIconLabel":{"type":"string","example":"hsl(0, 4%, 29%)"},"buttonPrimary":{"type":"string","example":"hsl(229, 100%, 23%)"},"buttonPrimaryText":{"type":"string","example":"hsl(0, 0%, 100%)"},"buttonSuccess":{"type":"string","example":"#007d05"},"buttonSuccessText":{"type":"string","example":"hsl(0, 0%, 100%)"},"buttonUpgrade":{"type":"string","example":"hsl(31, 92%, 66%)"},"buttonUpgradeText":{"type":"string","example":"hsl(0, 0%, 0%)"},"buttonWarning":{"type":"string","example":"hsl(31, 92%, 66%)"},"buttonWarningText":{"type":"string","example":"hsl(0, 0%, 100%)"},"contentBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"contentHeader":{"type":"string","example":"hsl(0, 0%, 100%)"},"contentHeaderGradient":{"type":"string","example":"rgb(218, 218, 220)"},"contentHeaderSeparator":{"type":"string","example":"hsl(0, 4%, 29%)"},"contentHeaderText":{"type":"string","example":"hsl(0, 4%, 29%)"},"dataStorageImmutable":{"type":"string","example":"hsl(82, 39%, 30%)"},"dataStorageMutable":{"type":"string","example":"hsl(180, 100%, 27%)"},"deviceInputOutput1Day":{"type":"string","example":"hsl(298, 74%, 37%)"},"deviceInputOutput3Days":{"type":"string","example":"hsl(341, 74%, 36%)"},"deviceInputOutput3Hours":{"type":"string","example":"hsl(121, 84%, 40%)"},"deviceInputOutput6Hours":{"type":"string","example":"hsl(29, 98%, 48%)"},"deviceInputOutputRest":{"type":"string","example":"hsl(0, 0%, 50%)"},"deviceListAlternateRow":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"deviceListColumn":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"dictionaryAlertIcon":{"type":"string","example":"hsl(0, 95%, 70%)"},"dictionaryPrimary":{"type":"string","example":"hsl(208, 56%, 46%)"},"dottedBorder":{"type":"string","example":"hsl(0, 4%, 29%)"},"dropdownAccent":{"type":"string","example":"hsl(229, 100%, 23%)"},"dropdownBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"dynamicTableAlternateRow":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"dynamicTableColumn":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"filesSelection":{"type":"string","example":"hsl(207, 56%, 93%)"},"floatingSidebarTitle":{"type":"string","example":"hsl(229, 100%, 23%)"},"footerBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"formControlBorder":{"type":"string","example":"hsla(0, 0%, 0%, 0.07)"},"formControlFocus":{"type":"string","example":"hsl(208, 56%, 46%)"},"gaugeDanger":{"type":"string","example":"#C02416"},"gaugeEmpty":{"type":"string","example":"hsl(0, 0%, 80%)"},"gaugeFill":{"type":"string","example":"hsl(208, 56%, 46%)"},"gaugePrimaryText":{"type":"string","example":"hsl(0, 0%, 0%)"},"gaugeSecondaryText":{"type":"string","example":"hsl(0, 0%, 45%)"},"gaugeTick":{"type":"string","example":"hsl(0, 0%, 57%)"},"html5":{"type":"string","example":"hsl(14, 93%, 54%)"},"iconRadioSelected":{"type":"string","example":"hsl(0, 0%, 33%)"},"iconRadioSubTitle":{"type":"string","example":"hsl(0, 0%, 45%)"},"informationIcon":{"type":"string","example":"hsl(229, 100%, 23%)"},"inputBackground":{"type":"string","example":"hsl(0, 0%, 99%)"},"inputBackgroundReadOnly":{"type":"string","example":"hsl(0, 0%, 95%)"},"inputError":{"type":"string","example":"#e40000"},"inputForeground":{"type":"string","example":"hsl(225, 6%, 13%)"},"inputForegroundReadOnly":{"type":"string","example":"hsl(0, 0%, 45%)"},"lightBorder":{"type":"string","example":"hsla(0, 0%, 0%, 0.1)"},"limitAlert":{"type":"string","example":"hsl(0, 49%, 54%)"},"link":{"type":"string","example":"hsl(208, 56%, 46%)"},"listNavColor":{"type":"string","example":"hsl(0, 0%, 100%)"},"listTitleLabel":{"type":"string","example":"hsl(0, 0%, 33%)"},"loading":{"type":"string","example":"hsl(0, 0%, 20%)"},"loginButton":{"type":"string","example":"hsl(229, 81%, 54%)"},"loginButtonText":{"type":"string","example":"hsl(0, 100%, 100%)"},"loginForeground":{"type":"string","example":"hsl(0, 4%, 29%)"},"loginForm":{"type":"string","example":"hsla(0, 100%, 100%, 1)"},"modalContainer":{"type":"string","example":"hsl(0, 0%, 100%)"},"modalOverlay":{"type":"string","example":"hsla(0, 0%, 0%, 0.5)"},"navDescription":{"type":"string","example":"hsl(0, 0%, 55%)"},"navbar":{"type":"string","example":"hsl(229, 100%, 23%)"},"navbarBetaDeveloperBorder":{"type":"string","example":"rgb(0, 255, 126)"},"navbarButton":{"type":"string","example":"hsl(229, 100%, 23%)"},"navbarDropdownBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"navbarDropdownBorder":{"type":"string","example":"hsl(0, 0%, 80%)"},"navbarDropdownOption":{"type":"string","example":"hsl(0, 0%, 30%)"},"navbarDropdownOptionBackground":{"type":"string","example":"hsl(0, 0%, 98%)"},"navbarDropdownOptionBorder":{"type":"string","example":"rgb(225, 225, 225)"},"navbarDropdownOptionHover":{"type":"string","example":"hsl(0, 0%, 94%)"},"navbarDropdownSecondaryText":{"type":"string","example":"rgb(150, 150, 150)"},"navbarDropdownSignoutButton":{"type":"string","example":"hsl(0, 0%, 100%)"},"navbarSettings":{"type":"string","example":"hsl(0, 0%, 55%)"},"navbarText":{"type":"string","example":"hsl(0, 100%, 100%)"},"notificationButtonAmount":{"type":"string","example":"hsl(354, 81%, 60%)"},"notificationButtonAmountText":{"type":"string","example":"hsl(0, 100%, 100%)"},"notificationEmptyIcon":{"type":"string","example":"hsl(0, 0%, 78%)"},"notificationEmptyTitle":{"type":"string","example":"hsl(0, 0%, 62%)"},"notificationFilterBackground":{"type":"string","example":"hsl(240,4%,95%)"},"notificationFilterMessageIcon":{"type":"string","example":"rgba(0, 0, 0, 0.2)"},"notificationFooter":{"type":"string","example":"hsl(0, 0%, 98%)"},"notificationIconContainer":{"type":"string","example":"rgba(0, 0, 0, 0.04)"},"notificationItem":{"type":"string","example":"hsl(0, 0%, 100%)"},"notificationItemBorder":{"type":"string","example":"hsl(0, 0%, 90%)"},"notificationItemDate":{"type":"string","example":"rgba(0, 0, 0, 0.4)"},"notificationItemTextAccepted":{"type":"string","example":"hsl(0, 0%, 62%)"},"notificationItemUnread":{"type":"string","example":"hsla(0, 0%, 97%, 1)"},"notificationText":{"type":"string","example":"hsl(0, 4%, 29%)"},"pdf":{"type":"string","example":"hsl(3, 97%, 48%)"},"primary":{"type":"string","example":"hsl(229, 100%, 23%)"},"publicPageNavigationBar":{"type":"string","example":"#007d05"},"quickstart":{"type":"string","example":"hsl(233, 45%, 50%)"},"quickstartSidebarBackground":{"type":"string","example":"hsl(220, 16%, 96%)"},"quickstartTask":{"type":"string","example":"hsl(223, 12%, 89%)"},"quickstartTaskFinished":{"type":"string","example":"hsl(155, 54%, 46%)"},"quickstartText":{"type":"string","example":"hsl(0, 100%, 100%)"},"regularText":{"type":"string","example":"hsl(0, 4%, 29%)"},"sidebarAccessSelected":{"type":"string","example":"hsl(300, 100%, 25%)"},"sidebarAccountSelected":{"type":"string","example":"hsl(43, 94%, 37%)"},"sidebarActionSelected":{"type":"string","example":"#e6431e"},"sidebarAnalysisSelected":{"type":"string","example":"#294E80"},"sidebarBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"sidebarBillingSelected":{"type":"string","example":"rgb(28, 117, 8)"},"sidebarConnector":{"type":"string","example":"hsl(208, 56%, 46%)"},"sidebarDashboardSelected":{"type":"string","example":"hsl(321, 84%, 38%)"},"sidebarDeviceSelected":{"type":"string","example":"#118c8c"},"sidebarExploreSelected":{"type":"string","example":"hsl(206, 74%, 52%)"},"sidebarFileSelected":{"type":"string","example":"#ea8d13"},"sidebarForegroundIcon":{"type":"string","example":"hsl(0, 4%, 29%)"},"sidebarHomeSelected":{"type":"string","example":"hsl(208, 56%, 46%)"},"sidebarIntegration":{"type":"string","example":"hsl(0, 0%, 25%)"},"sidebarItem":{"type":"string","example":"hsl(240, 4%, 100%)"},"sidebarItemHover":{"type":"string","example":"hsl(240, 4%, 95%)"},"sidebarItemOdd":{"type":"string","example":"rgba(0, 0, 0, .015)"},"sidebarItemSelected":{"type":"string","example":"hsl(240, 4%, 97%)"},"sidebarNetwork":{"type":"string","example":"hsl(156, 74%, 25%)"},"sidebarRibbon":{"type":"string","example":"hsl(0, 0%, 97%)"},"sidebarRunSelected":{"type":"string","example":"rgb(120, 90, 255)"},"sidebarSecondBackground":{"type":"string","example":"hsl(240, 4%, 95%)"},"sidebarSeparator":{"type":"string","example":"hsl(0, 0%, 100%)"},"sidebarSeparatorForeground":{"type":"string","example":"hsla(0, 0%, 0%, .5)"},"sidebarTagoCoreSelected":{"type":"string","example":"hsl(0, 0%, 0%)"},"sidebarText":{"type":"string","example":"hsl(0, 4%, 29%)"},"sidebarUserSelected":{"type":"string","example":"rgb(113, 20, 20)"},"snakeButtonOutline":{"type":"string","example":"hsl(0, 0%, 60%)"},"svgTagoFont":{"type":"string","example":"hsl(208, 56%, 46%)"},"svgTagoIOHole":{"type":"string","example":"hsl(0, 0%, 100%)"},"switchDisabledBackground":{"type":"string","example":"hsl(0, 0%, 77%)"},"switchLabelDark":{"type":"string","example":"hsl(0, 0%, 97%)"},"switchLabelWhite":{"type":"string","example":"hsla(0, 0%, 0%, .5)"},"switchSlider":{"type":"string","example":"hsl(0, 0%, 100%)"},"tabLabelActive":{"type":"string","example":"hsl(208, 56%, 46%)"},"tabLabelBackground":{"type":"string","example":"hsl(240, 4%, 95%)"},"tabLabelBorder":{"type":"string","example":"hsl(204, 12%, 92%)"},"tabLabelHover":{"type":"string","example":"hsl(0, 0%, 100%)"},"tabText":{"type":"string","example":"hsl(0, 4%, 29%)"},"tableBackground":{"type":"string","example":"hsl(0, 100%, 100%)"},"tableBorder":{"type":"string","example":"hsla(0, 0%, 0%, 0.1)"},"tableEvenRowBackground":{"type":"string","example":"hsla(0, 0%, 0%, 0.03)"},"tableFooterBackground":{"type":"string","example":"hsl(240, 4%, 95%)"},"tableOddRowBackground":{"type":"string","example":"hsl(0, 100%, 100%)"},"toast":{"type":"string","example":"hsl(0,0%,100%)"},"toastText":{"type":"string","example":"hsl(0, 4%, 29%)"},"tooltipContainer":{"type":"string","example":"hsl(229, 100%, 23%)"},"tooltipText":{"type":"string","example":"hsl(0, 0%, 100%)"},"verticalTabItem":{"type":"string","example":"hsl(240, 20%, 98%)"},"verticalTabItemBorder":{"type":"string","example":"hsl(204, 12%, 92%)"},"widgetCardBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"widgetColors":{"type":"string","example":"hsl(208, 56%, 46%)"},"widgetIconsAccent":{"type":"string","example":"hsl(229, 100%, 23%)"},"widgetIconsBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"widgetIconsColor":{"type":"string","example":"hsl(0, 4%, 29%)"},"widgetIconsFooterBasic":{"type":"string","example":"hsl(0, 0%, 97%)"},"widgetIconsFooterPremium":{"type":"string","example":"hsl(53, 100%, 55%)"}}},"updated_at":{"type":"string","example":"2022-06-17T00:02:20.531Z"},"url":{"type":"string","example":"62ab4302ee089b00134f33ff.run.tago.io"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-run-settings.api.mdx b/docs/api/get-run-settings.api.mdx index 13f7683d..ca59eebc 100644 --- a/docs/api/get-run-settings.api.mdx +++ b/docs/api/get-run-settings.api.mdx @@ -18,387 +18,45 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Retrieve information about TagoRUN - - + + + + + + + + {...require("./get-run-settings.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-tags.ParamsDetails.json b/docs/api/get-tags.ParamsDetails.json new file mode 100644 index 00000000..cbb9085e --- /dev/null +++ b/docs/api/get-tags.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","example":"Device"},"description":"(Accepts Analysis, Device, User, Dashboard, Action)"}]} \ No newline at end of file diff --git a/docs/api/get-tags.RequestSchema.json b/docs/api/get-tags.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-tags.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-tags.StatusCodes.json b/docs/api/get-tags.StatusCodes.json new file mode 100644 index 00000000..fce75960 --- /dev/null +++ b/docs/api/get-tags.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get Device Tags","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"string","example":"numbervalue"},"example":["numbervalue","vumeter","test","bp","area","block","horizontal","multiple","user","problem","formula","chart","BP"]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-tags.api.mdx b/docs/api/get-tags.api.mdx index 9b1ce5a5..718537d6 100644 --- a/docs/api/get-tags.api.mdx +++ b/docs/api/get-tags.api.mdx @@ -18,64 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get a list containing all device tags in use on your profile - + + Request + + {...require("./get-tags.ParamsDetails.json")} +> + + - + + + + {...require("./get-tags.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-the-account-plan.RequestSchema.json b/docs/api/get-the-account-plan.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-the-account-plan.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-the-account-plan.StatusCodes.json b/docs/api/get-the-account-plan.StatusCodes.json new file mode 100644 index 00000000..d6165f3c --- /dev/null +++ b/docs/api/get-the-account-plan.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting the account plan","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"plan":{"type":"string","example":"starter"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting the account plan":{"value":{"result":{"plan":"starter"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-the-account-plan.api.mdx b/docs/api/get-the-account-plan.api.mdx index 535dda00..35baf1aa 100644 --- a/docs/api/get-the-account-plan.api.mdx +++ b/docs/api/get-the-account-plan.api.mdx @@ -18,35 +18,44 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get the Account Plan - + + + - + + + + {...require("./get-the-account-plan.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-widget-data.ParamsDetails.json b/docs/api/get-widget-data.ParamsDetails.json new file mode 100644 index 00000000..c53ccfe7 --- /dev/null +++ b/docs/api/get-widget-data.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file diff --git a/docs/api/get-widget-data.RequestSchema.json b/docs/api/get-widget-data.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-widget-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-widget-data.StatusCodes.json b/docs/api/get-widget-data.StatusCodes.json new file mode 100644 index 00000000..79918b70 --- /dev/null +++ b/docs/api/get-widget-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting widget Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"query":{"type":"string","example":"last_value"},"variables":{"type":"array","items":{"type":"string","example":"temperature"},"example":["temperature"]}}},"result":{"type":"array","items":{"type":"object","properties":{"device":{"type":"string","example":"6238a3a27d792400139e5b47"},"group":{"type":"string","example":"3ac3e21100e473e57d9a1b26"},"id":{"type":"string","example":"62b1a9d75e374e00112e3ca4"},"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"serie":{"type":"string","example":"3ac3e21100e473e57d9a1b26"},"time":{"type":"string","example":"2022-06-21T11:21:59.415Z"},"value":{"type":"number","example":71},"variable":{"type":"string","example":"temperature"}}},"example":[{"device":"6238a3a27d792400139e5b47","group":"3ac3e21100e473e57d9a1b26","id":"62b1a9d75e374e00112e3ca4","origin":"6238a3a27d792400139e5b47","serie":"3ac3e21100e473e57d9a1b26","time":"2022-06-21T11:21:59.415Z","value":71,"variable":"temperature"}]}}},"example":[{"data":{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},"result":[{"device":"6238a3a27d792400139e5b47","group":"3ac3e21100e473e57d9a1b26","id":"62b1a9d75e374e00112e3ca4","origin":"6238a3a27d792400139e5b47","serie":"3ac3e21100e473e57d9a1b26","time":"2022-06-21T11:21:59.415Z","value":71,"variable":"temperature"}]},{"data":{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]},"result":[{"device":"62308e38de51960019697e76","id":"62309cb173cb3b001a031db5","metadata":{"old_value":"45"},"origin":"62308e38de51960019697e76","time":"2022-03-15T14:03:29.476Z","unit":"C","value":"33","variable":"temperature"}]}]},"widget":{"type":"object","properties":{"analysis_run":{"example":null},"dashboard":{"type":"string","example":"623c74a15a13360011803f3e"},"data":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"query":{"type":"string","example":"last_value"},"variables":{"type":"array","items":{"type":"string","example":"temperature"},"example":["temperature"]}}},"example":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}]},"display":{"type":"object","properties":{"header_buttons":{"type":"array","items":{},"example":[]},"show_units":{"type":"boolean","example":true},"show_variables":{"type":"boolean","example":true},"theme":{"type":"object","properties":{"color":{"type":"object","properties":{"background":{"type":"string","example":"hsla(332, 33%, 73%, 1)"},"button":{"type":"string","example":"hsla(112, 91%, 58%, 1)"},"dot":{"type":"string","example":"hsla(0, 97%, 48%, 1)"},"header":{"type":"string","example":"hsla(336, 81%, 51%, 1)"}}}}},"variables":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"variable":{"type":"string","example":"temperature"}}},"example":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]}}},"id":{"type":"string","example":"623c79da5a13360011819b1d"},"label":{"type":"string","example":"Display #1"},"realtime":{"type":"string","example":"true"},"resource":{"type":"array","items":{},"example":[]},"type":{"type":"string","example":"display"}}}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting widget Data":{"value":{"result":{"content":[{"data":{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},"result":[{"device":"6238a3a27d792400139e5b47","group":"3ac3e21100e473e57d9a1b26","id":"62b1a9d75e374e00112e3ca4","origin":"6238a3a27d792400139e5b47","serie":"3ac3e21100e473e57d9a1b26","time":"2022-06-21T11:21:59.415Z","value":71,"variable":"temperature"}]},{"data":{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]},"result":[{"device":"62308e38de51960019697e76","id":"62309cb173cb3b001a031db5","metadata":{"old_value":"45"},"origin":"62308e38de51960019697e76","time":"2022-03-15T14:03:29.476Z","unit":"C","value":"33","variable":"temperature"}]}],"widget":{"analysis_run":null,"dashboard":"623c74a15a13360011803f3e","data":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}],"display":{"header_buttons":[],"show_units":true,"show_variables":true,"theme":{"color":{"background":"hsla(332, 33%, 73%, 1)","button":"hsla(112, 91%, 58%, 1)","dot":"hsla(0, 97%, 48%, 1)","header":"hsla(336, 81%, 51%, 1)"}},"variables":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]},"id":"623c79da5a13360011819b1d","label":"Display #1","realtime":"true","resource":[],"type":"display"}},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-widget-data.api.mdx b/docs/api/get-widget-data.api.mdx index c90ac505..59624332 100644 --- a/docs/api/get-widget-data.api.mdx +++ b/docs/api/get-widget-data.api.mdx @@ -18,263 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Retrieve all the data necessary to display a widget, according to its configuration in the `data` and `resource` fields. - + + + Request + + {...require("./get-widget-data.ParamsDetails.json")} +> + + - + + + + {...require("./get-widget-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/get-widget-information.ParamsDetails.json b/docs/api/get-widget-information.ParamsDetails.json new file mode 100644 index 00000000..c53ccfe7 --- /dev/null +++ b/docs/api/get-widget-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file diff --git a/docs/api/get-widget-information.RequestSchema.json b/docs/api/get-widget-information.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/get-widget-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/get-widget-information.StatusCodes.json b/docs/api/get-widget-information.StatusCodes.json new file mode 100644 index 00000000..d4d43a9c --- /dev/null +++ b/docs/api/get-widget-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a widget information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"analysis_run":{"example":null},"dashboard":{"type":"string","example":"623c74a15a13360011803f3e"},"data":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"query":{"type":"string","example":"last_value"},"variables":{"type":"array","items":{"type":"string","example":"temperature"},"example":["temperature"]}}},"example":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}]},"display":{"type":"object","properties":{"header_buttons":{"type":"array","items":{},"example":[]},"help":{"type":"string","example":""},"show_units":{"type":"boolean","example":true},"show_variables":{"type":"boolean","example":true},"theme":{"type":"object","properties":{"color":{"type":"object","properties":{"background":{"type":"string","example":"hsla(332, 33%, 73%, 1)"},"button":{"type":"string","example":"hsla(112, 91%, 58%, 1)"},"dot":{"type":"string","example":"hsla(0, 97%, 48%, 1)"},"header":{"type":"string","example":"hsla(336, 81%, 51%, 1)"}}}}},"variables":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"variable":{"type":"string","example":"temperature"}}},"example":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]}}},"id":{"type":"string","example":"623c79da5a13360011819b1d"},"label":{"type":"string","example":"Display #1"},"realtime":{"type":"boolean","example":true},"resource":{"type":"array","items":{},"example":[]},"token":{"example":null},"type":{"type":"string","example":"display"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting a widget information":{"value":{"result":{"analysis_run":null,"dashboard":"623c74a15a13360011803f3e","data":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}],"display":{"header_buttons":[],"help":"","show_units":true,"show_variables":true,"theme":{"color":{"background":"hsla(332, 33%, 73%, 1)","button":"hsla(112, 91%, 58%, 1)","dot":"hsla(0, 97%, 48%, 1)","header":"hsla(336, 81%, 51%, 1)"}},"variables":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]},"id":"623c79da5a13360011819b1d","label":"Display #1","realtime":true,"resource":[],"token":null,"type":"display"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/get-widget-information.api.mdx b/docs/api/get-widget-information.api.mdx index 4649019b..59e80eda 100644 --- a/docs/api/get-widget-information.api.mdx +++ b/docs/api/get-widget-information.api.mdx @@ -18,152 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Retrieve the complete JSON structure of the dashboard widget, including all settings and data/resource instructions used to populate the widget's data. - + + + Request + + {...require("./get-widget-information.ParamsDetails.json")} +> + + - + + + + {...require("./get-widget-information.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/import-data-from-a-csv-in-files.ParamsDetails.json b/docs/api/import-data-from-a-csv-in-files.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/import-data-from-a-csv-in-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/import-data-from-a-csv-in-files.RequestSchema.json b/docs/api/import-data-from-a-csv-in-files.RequestSchema.json new file mode 100644 index 00000000..5520ceb6 --- /dev/null +++ b/docs/api/import-data-from-a-csv-in-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_address":{"type":"string","example":"/July_data/31072024_data.csv"}}},"examples":{"Import Data from a CSV in Files":{"value":{"file_address":"/July_data/31072024_data.csv"}}}}}}} \ No newline at end of file diff --git a/docs/api/import-data-from-a-csv-in-files.StatusCodes.json b/docs/api/import-data-from-a-csv-in-files.StatusCodes.json new file mode 100644 index 00000000..0bbd9584 --- /dev/null +++ b/docs/api/import-data-from-a-csv-in-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Importing data from Files","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Data import added to the queue successfully!"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/import-data-from-a-csv-in-files.api.mdx b/docs/api/import-data-from-a-csv-in-files.api.mdx index 83a071b3..3111c909 100644 --- a/docs/api/import-data-from-a-csv-in-files.api.mdx +++ b/docs/api/import-data-from-a-csv-in-files.api.mdx @@ -18,53 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Import Data from a CSV in Files - + + Request + + {...require("./import-data-from-a-csv-in-files.ParamsDetails.json")} +> + + + {...require("./import-data-from-a-csv-in-files.RequestSchema.json")} +> + + + {...require("./import-data-from-a-csv-in-files.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-analysis-related-to-dashboard.ParamsDetails.json b/docs/api/list-analysis-related-to-dashboard.ParamsDetails.json new file mode 100644 index 00000000..19e3a3c8 --- /dev/null +++ b/docs/api/list-analysis-related-to-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"5f3e782ba1d6300027315c0e"}}]} \ No newline at end of file diff --git a/docs/api/list-analysis-related-to-dashboard.RequestSchema.json b/docs/api/list-analysis-related-to-dashboard.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-analysis-related-to-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-analysis-related-to-dashboard.StatusCodes.json b/docs/api/list-analysis-related-to-dashboard.StatusCodes.json new file mode 100644 index 00000000..d864bfb3 --- /dev/null +++ b/docs/api/list-analysis-related-to-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a list of analysis related to the dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"61969a2c87160b00189326e9"},"name":{"type":"string","example":"Analysis 001"}}},"example":[{"id":"61969a2c87160b00189326e9","name":"Analysis 001"},{"id":"61969a2c87160b00189326d2","name":"Analysis 002"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-analysis-related-to-dashboard.api.mdx b/docs/api/list-analysis-related-to-dashboard.api.mdx index 6f0cda14..795dd066 100644 --- a/docs/api/list-analysis-related-to-dashboard.api.mdx +++ b/docs/api/list-analysis-related-to-dashboard.api.mdx @@ -18,58 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List of analysis related to this dashboard - + + + Request + + {...require("./list-analysis-related-to-dashboard.ParamsDetails.json")} +> + + - + + + + {...require("./list-analysis-related-to-dashboard.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-dashboards.ParamsDetails.json b/docs/api/list-dashboards.ParamsDetails.json new file mode 100644 index 00000000..b864c23c --- /dev/null +++ b/docs/api/list-dashboards.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number."},{"name":"amount","in":"query","schema":{"type":"string","example":"5"},"description":"Amount of dashboards per page."},{"name":"orderBy","in":"query","schema":{"type":"string","example":"name"},"description":"Order dashboard by name."},{"name":"fields[]","in":"query","description":"Select which properties to include for each dashboard in the response.\nPass the parameter multiple times to include more than one field.\n\nExample: `?fields[]=label&fields[]=id&fields[]=type`\n","schema":{"type":"array","items":{"type":"string","enum":["label","id","type","tags","visible","created_at","last_access"]}},"style":"form","explode":true}]} \ No newline at end of file diff --git a/docs/api/list-dashboards.RequestSchema.json b/docs/api/list-dashboards.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-dashboards.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-dashboards.StatusCodes.json b/docs/api/list-dashboards.StatusCodes.json new file mode 100644 index 00000000..7aa158bf --- /dev/null +++ b/docs/api/list-dashboards.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Get a list of dashboards","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Dashboard ID","example":"623c74a15a13360011803f3e"},"label":{"type":"string","description":"Dashboard title label","example":"Door Sensor"},"tags":{"type":"array","description":"Dashboard tags","items":{"type":"object","properties":{"key":{"type":"string","example":"vehicle"},"value":{"type":"string","example":"gas"}}},"example":[]},"profile":{"type":"string","description":"Profile ID","example":"612ea05e3cc0780012715111"},"visible":{"type":"boolean","description":"Visibility status","example":true},"group_by":{"type":"array","description":"List of tags to group in the sidebar","items":{"type":"string"},"example":[]},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp","example":"2022-03-24T13:39:45.504Z"},"icon":{"type":"object","description":"Dashboard icon","properties":{"color":{"type":"string","example":"hsl(328, 89%, 47%)"},"url":{"type":"string","example":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"}},"example":{}},"last_access":{"type":"string","format":"date-time","description":"Last access timestamp","example":"2022-06-13T20:53:32.583Z"},"type":{"type":"string","description":"Dashboard type","enum":["dashboard","blueprint"],"example":"dashboard"},"tabs":{"type":"array","description":"Dashboard tabs","items":{"type":"object","properties":{"key":{"type":"string","example":"1648142133869"},"link":{"type":"string","example":""},"value":{"type":"string","example":"tab test"}}},"example":[]}}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-dashboards.api.mdx b/docs/api/list-dashboards.api.mdx index d6a3e6f6..e9949612 100644 --- a/docs/api/list-dashboards.api.mdx +++ b/docs/api/list-dashboards.api.mdx @@ -18,130 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Retrieves a list with all dashboards from the profile - + + + Request + + {...require("./list-dashboards.ParamsDetails.json")} +> + + - + + + + {...require("./list-dashboards.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-device-params.ParamsDetails.json b/docs/api/list-device-params.ParamsDetails.json new file mode 100644 index 00000000..a7c298ec --- /dev/null +++ b/docs/api/list-device-params.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sent_status","in":"query","schema":{"type":"string","example":"false"},"description":"Filter by Boolean."},{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"(Type your device ID)"}}]} \ No newline at end of file diff --git a/docs/api/list-device-params.RequestSchema.json b/docs/api/list-device-params.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-device-params.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-device-params.StatusCodes.json b/docs/api/list-device-params.StatusCodes.json new file mode 100644 index 00000000..28aea9a9 --- /dev/null +++ b/docs/api/list-device-params.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List Device Params","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"62ab8294c1ac39001361e11b"},"key":{"type":"string","example":"param1"},"sent":{"type":"boolean","example":false},"value":{"type":"string","example":"value1"}}},"example":[{"id":"62ab8294c1ac39001361e11b","key":"param1","sent":false,"value":"value1"},{"id":"62ab8294c1ac39001361e11c","key":"param2","sent":false,"value":"value2"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-device-params.api.mdx b/docs/api/list-device-params.api.mdx index c811bf03..2efe9d4d 100644 --- a/docs/api/list-device-params.api.mdx +++ b/docs/api/list-device-params.api.mdx @@ -18,61 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List params for the device - + + + Request + + {...require("./list-device-params.ParamsDetails.json")} +> + + - + + + + {...require("./list-device-params.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-devices-related-to-dashboard.ParamsDetails.json b/docs/api/list-devices-related-to-dashboard.ParamsDetails.json new file mode 100644 index 00000000..e93a3002 --- /dev/null +++ b/docs/api/list-devices-related-to-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type your dashboard ID)"}}]} \ No newline at end of file diff --git a/docs/api/list-devices-related-to-dashboard.RequestSchema.json b/docs/api/list-devices-related-to-dashboard.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-devices-related-to-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-devices-related-to-dashboard.StatusCodes.json b/docs/api/list-devices-related-to-dashboard.StatusCodes.json new file mode 100644 index 00000000..80ae3b5c --- /dev/null +++ b/docs/api/list-devices-related-to-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a list of devices related to a dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6238a3a27d792400139e5b47"},"name":{"type":"string","example":"Device 001"}}},"example":[{"id":"6238a3a27d792400139e5b47","name":"Device 001"},{"id":"6238a294ea60bc00120f0371","name":"Device 002"},{"id":"6230e64df5772600124c81df","name":"Device 003"},{"id":"62322173635f730011d1874c","name":"Device 004"}]},"status":{"type":"boolean","example":true}}},"examples":{"Getting a list of devices related to a dashboard":{"value":{"result":[{"id":"6238a3a27d792400139e5b47","name":"Device 001"},{"id":"6238a294ea60bc00120f0371","name":"Device 002"},{"id":"6230e64df5772600124c81df","name":"Device 003"},{"id":"62322173635f730011d1874c","name":"Device 004"}],"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-devices-related-to-dashboard.api.mdx b/docs/api/list-devices-related-to-dashboard.api.mdx index ec88294f..5dd35566 100644 --- a/docs/api/list-devices-related-to-dashboard.api.mdx +++ b/docs/api/list-devices-related-to-dashboard.api.mdx @@ -18,73 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List of devices related to this dashboard - + + + Request + + {...require("./list-devices-related-to-dashboard.ParamsDetails.json")} +> + + - + + + + {...require("./list-devices-related-to-dashboard.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-entities.ParamsDetails.json b/docs/api/list-entities.ParamsDetails.json new file mode 100644 index 00000000..2fe48dac --- /dev/null +++ b/docs/api/list-entities.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"number"},"description":"(default 1)"},{"name":"amount","in":"query","schema":{"type":"string","example":"number"},"description":"(default: 20, max: 100)"},{"name":"filter","in":"query","schema":{"type":"string","example":"[name]"},"description":"string"},{"name":"orderBy","in":"query","schema":{"type":"string","example":"created_at | updated_at"}},{"name":"fields","in":"query","schema":{"type":"string"},"description":"comma-separated list of fields to return"}]} \ No newline at end of file diff --git a/docs/api/list-entities.RequestSchema.json b/docs/api/list-entities.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-entities.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-entities.StatusCodes.json b/docs/api/list-entities.StatusCodes.json new file mode 100644 index 00000000..4c23a858 --- /dev/null +++ b/docs/api/list-entities.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Listing entity by field / Listing entity by tags","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2024-11-05T18:32:25.522Z"},"id":{"type":"string","example":"672a64b91807cd0008baa4d5"},"name":{"type":"string","example":"Control Entity"},"profile":{"type":"string","example":"63c82c9e6a7fb4000a1f95a0"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"yes"}}},"example":[{"key":"active","value":"yes"}]},"updated_at":{"type":"string","example":"2024-11-05T18:32:25.522Z"}}},"example":[{"created_at":"2024-11-05T18:32:25.522Z","id":"672a64b91807cd0008baa4d5","name":"Control Entity","profile":"63c82c9e6a7fb4000a1f95a0","tags":[{"key":"active","value":"yes"}],"updated_at":"2024-11-05T18:32:25.522Z"},{"created_at":"2024-11-05T18:49:16.438Z","id":"672a68ac640f330009872ca3","name":"Test Entity","profile":"63c82c9e6a7fb4000a1f95a0","tags":[],"updated_at":"2024-11-05T18:49:16.438Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-entities.api.mdx b/docs/api/list-entities.api.mdx index 73319e7e..a4eb00c5 100644 --- a/docs/api/list-entities.api.mdx +++ b/docs/api/list-entities.api.mdx @@ -18,95 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List Entities - + + Request + + {...require("./list-entities.ParamsDetails.json")} +> + + - + + + + {...require("./list-entities.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-of-chunks.ParamsDetails.json b/docs/api/list-of-chunks.ParamsDetails.json new file mode 100644 index 00000000..8d2ad668 --- /dev/null +++ b/docs/api/list-of-chunks.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file diff --git a/docs/api/list-of-chunks.RequestSchema.json b/docs/api/list-of-chunks.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-of-chunks.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-of-chunks.StatusCodes.json b/docs/api/list-of-chunks.StatusCodes.json new file mode 100644 index 00000000..daf10cec --- /dev/null +++ b/docs/api/list-of-chunks.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a list of chunks by device","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","example":1584},"from":{"type":"string","example":"2022-07-18T00:00:00.000+00:00"},"id":{"type":"string","example":"1658102400_1658707199"},"to":{"type":"string","example":"2022-07-24T23:59:59.999+00:00"}}},"example":[{"amount":1584,"from":"2022-07-18T00:00:00.000+00:00","id":"1658102400_1658707199","to":"2022-07-24T23:59:59.999+00:00"},{"amount":13383,"from":"2022-07-11T00:00:00.000+00:00","id":"1657497600_1658102399","to":"2022-07-17T23:59:59.999+00:00"},{"amount":12788,"from":"2022-07-04T00:00:00.000+00:00","id":"1656892800_1657497599","to":"2022-07-10T23:59:59.999+00:00"},{"amount":12784,"from":"2022-06-27T00:00:00.000+00:00","id":"1656288000_1656892799","to":"2022-07-03T23:59:59.999+00:00"},{"amount":4179,"from":"2022-03-07T00:00:00.000+00:00","id":"1646611200_1647215999","to":"2022-03-13T23:59:59.999+00:00"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-of-chunks.api.mdx b/docs/api/list-of-chunks.api.mdx index fe4d0b76..eec70717 100644 --- a/docs/api/list-of-chunks.api.mdx +++ b/docs/api/list-of-chunks.api.mdx @@ -18,83 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List of chunks - + + Request + + {...require("./list-of-chunks.ParamsDetails.json")} +> + + - + + + + {...require("./list-of-chunks.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-of-devices.ParamsDetails.json b/docs/api/list-of-devices.ParamsDetails.json new file mode 100644 index 00000000..a2af6db8 --- /dev/null +++ b/docs/api/list-of-devices.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number."},{"name":"amount","in":"query","schema":{"type":"string","example":"10"},"description":"Amount of devices by page."},{"name":"filter[id]","in":"query","schema":{"type":"string","example":""},"description":"Filter the device by ID."},{"name":"filter[name]","in":"query","schema":{"type":"string","example":""},"description":"Filter the device name."},{"name":"filter[visible]","in":"query","schema":{"type":"string","example":"true / false"},"description":"Filter the device visible status."},{"name":"filter[active]","in":"query","schema":{"type":"string","example":"true / false"},"description":"Filter the device active status."},{"name":"filter[connector]","in":"query","schema":{"type":"string","example":""},"description":"Filter the devices by the Connector ID."},{"name":"filter[network]","in":"query","schema":{"type":"string","example":""},"description":"Filter the devices by the Network ID."},{"name":"filter[tags]","in":"query","schema":{"type":"string","example":""},"description":"Filter device by it's tag. Check the example."},{"name":"filter[updated_at]","in":"query","schema":{"type":"string","example":"1 day"},"description":"Filter by time the device was received data. Can be an ISO-8601 or a relative date"},{"name":"filter[created_at]","in":"query","schema":{"type":"string","example":"1 day"},"description":"Filter by time the device was created. Can be an ISO-8601 or a relative date"},{"name":"orderBy","in":"query","schema":{"type":"string","example":"created_at"}}]} \ No newline at end of file diff --git a/docs/api/list-of-devices.RequestSchema.json b/docs/api/list-of-devices.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-of-devices.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-of-devices.StatusCodes.json b/docs/api/list-of-devices.StatusCodes.json new file mode 100644 index 00000000..97af6ba5 --- /dev/null +++ b/docs/api/list-of-devices.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of devices retrieved using query params","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"connector":{"type":"string","example":"5f5a8f3351d4db99c40ded2d"},"id":{"type":"string","example":"5dcad1c216174c001ca23ab9"},"name":{"type":"string","example":"Device #1"},"network":{"type":"string","example":"5bbd120d4051a50034cd1a05"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"type"},"value":{"type":"string","example":"Smoke Detector"}}},"example":[{"key":"type","value":"Smoke Detector"}]}}},"example":[{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad1c216174c001ca23ab9","name":"Device #1","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]},{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad25016174c001ca24a09","name":"Device #2","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]}]},"status":{"type":"boolean","example":true}}},"examples":{"List of devices retrieved using query params":{"value":{"result":[{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad1c216174c001ca23ab9","name":"Device #1","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]},{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad25016174c001ca24a09","name":"Device #2","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]}],"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-of-devices.api.mdx b/docs/api/list-of-devices.api.mdx index beffc134..38959538 100644 --- a/docs/api/list-of-devices.api.mdx +++ b/docs/api/list-of-devices.api.mdx @@ -5,7 +5,7 @@ description: "Retrieves a list with all devices from the profile" sidebar_label: "List of Devices" hide_title: true hide_table_of_contents: true -api: eJztWG1vIjkS/islz4eREE2AQF74sFJuMrcX3WhnNJlodUqi26JdgDeN3WO7w6CI/34quxuaEAibTebTfYpCl+t5XFWutwfhcezE4Fqc071KyYnbppDkUqtyr4wWA/GVvFV0Tw4QMuU8zJSfAGYZyHgERtZMwU8IcmtGKqMbLZrC5GSRVVxIMRB88POowmiKHC1OyZNl7AehcUpiIHIck2gKxbDfC7Jz0RQundAUxeBB+HnOQs5bpceiKegHTvOMf+qIxWPWX3BMoIvpkGxLLJpLCJyaQvsXgbQ3Uc6CNjCjpS2Gc+BbrGGOVObJXit5+xLcTdR/Bn3B4hGWUS/On8Lk/94MlZU/BXqvnBpmL8P1tiA4gBFmjvbhUGKB8+gL9xQbTL26/zlkItQOLqnRmlJv7Fv5JAQg//uhQtoWGORnxt69OY/fIs4WFpx8XpfC6kEo/96Bx3ELPkwovQtsSgVPUSlyiZ7kf9G/iFAHJM63smJjqCnVY2WGDiylpO5JgkSPLfiAGoYEqOHi8nNyctTugLGAYCnDEFjMEJ4KK0s/nXuJ+RLWxkqy/5i/hOrqpmKxuG0KSy432pHjY912m/+s3+ITl6xagrZlOZNQOKXHENAh1CMuTKnRnrRnPZjnmUpDDTv407Gyh02OZvgnpVxPcssVz6tIxZIrMl+TQ2sx3NjT1D1/fpkodpujP+rjyejwsN+RPTk8PU17bUmyK9mZSj5zVqYoO2m3c9Q57qXtdifF7iEOT/lsdNSu07GUw7tQestk8gzecCg73bbstfsd7Lfbh71UdrDdZwWxCXmpse5o/kwe5y+LprjHrHjmXpdTc0dwTj5af7FY1L5el1jx/FLfxqHbjWM1f253WvTZdsdUfqkZv2b77Qau7Ls//eYLGHf77TrjHrafYNx9K8a3i6aIdbfm36ExGaGuO5hLet07Qfwv5YjBwyqOqmf+fw//BA+vHFw6cREcOSU/McxxTCE1oJ+IgTiIvuSyQva+mjMKm4mBmHifu8HBAeaqVbiEOi2PY9NSJhSpTRkqkllNholQWljl50Hplzj1fDN3pMXg+rYucMn1IgZZNFBSiq1yXa7+TZzsHk0WUJcHP0EPykGh1feCwBuYm6LqdlrwK2metggQfJAfzgHTlFwI3yAa1b135XjyyG8lrbIiTwglWdEUP5Ja/qZO97DXx0QetzHpUVcmw5NDmfTTdvhwdHwSakfZ8e1/0apF3HnTUqgFZ+FacKE9jeOA6eCXpY5fohbH58aPjTIydl3Zygrbrn+uXJ7h/LcotX61dfOMZL93irKbnHQO06Qnj46S4ei4m/TbJ9Qfnp7giA7ZPGW07G+e8kB5hy3mIe2VXQ7gtYBQOgpgmoZR1ZH3So9d7e7rjHaFAHb6hH3CRMquTHrp0WFyctrrJ6fdYb8nsXd83EXBb1LpkQl3Uz4c/IZjc/EZzr5cbFzw3bt376DR+JeZ8WUKx42mciBNWkxJ++DhRuNGf+P2s/4jW8HlmfIc7LOJSielieameG8JLH0vlCVZqVU6tLD8MznfArjRJa3cmnslyUEPpBqNyJL2UZcb3OgEGo36I2k0BsBkypji3UftLTZLKnNTQIoaxuRX+xG59gZvNACzYIA1HzDCWeYM3GkzA3Qc8+y8+LUF/zHFSm/ALv2+9O4mwFroMsCFC5Qe32L5zj7rbA54jypDnq/VqLKrmWmyXC35eJnpl2Gm6s9yg8SZxmzulIssBo3Gk4bEUqpZh4/Oqz5VqpMkudEhgi7jzYPU2ZcL+KhlbpT28JXGyugb/fuENEzxjoWwigKODT6xis9m8Ny0cB6QXeByStUozrKYc99pFb8rG9RiBlQC8ZhpjCMwmirrjEyWmRkjVlIOhuhIgintNSYztphPVIpZqXNwo6O1rrTyJOHSoycHH9F56LDNIJr0qnoqlW6YTah67avRhZ9JxCxtSOg8WQ1r6luV1kbj6usnRvlja5U8+KPu048F9+LwO70CPVbC1KLOZzitVWXmFPmwK+Gc8szMl2z4wbiJKTIZMkHgYGY6BMrV10/LpLoWb7Fqmikq7cBRGtiWjmWQiMF5lNuLmMw6rXarXU6RmPL8x9kwN85PMST7MuVWDedqIbqWFB9WY+hL169lVfH0wx/kGSrNtSe0Ng9li3QtyhbptikmxnEXKx4e2BdXNlss+Oc4mXOPI5Vju0gxCMuwHXzXFq9beMSOr9z2Vh1faL72x9mxet2JulwAvxB36/J1J+raCvjVkOMCdh/gag/8atCP9677kKjthV+Nx6OV6z40Vgvh12KxZeu6D5m1jfCr86lvX/cKk9VW+O9x2XMNuw+nakf89wi96gZ2H9rr++Q3If9XV7B7xePaKnk37Xhwtc1dSd/yP1axeJiIm9U8sZr3eY7L63l4Y93KWpbD/a8fv4nF4n8ooJkU +api: eJztWG1vIjkS/islz4eREE2AQF74sFJuMrcX3WhnNJlodUqi26JdgDeN3WO7w6CI/34quxuaEAibTebTfYpCl+t5XFWutwfhcezE4Fqc071KyYnbppDkUqtyr4wWA/GVvFV0Tw4QMuU8zJSfAGYZyHgERtZMwU8IcmtGKqMbLZrC5GSRVVxIMRB88POowmiKHC1OyZNl7AehcUpiIHIck2gKxbDfC7Jz0RQundAUxeBB+HnOQs5bpceiKegHTvOMf+qIxWPWX3BMoIvpkGxLLJpLCJyaQvsXgbQ3Uc6CNjCjpS2Gc+BbrGGOVObJXit5+xLcTdR/Bn3B4hGWUS/On8Lk/94MlZU/BXqvnBpmL8P1tiA4gBFmjvbhUGKB8+gL9xQbTL26/zlkItQOLqnRmlJv7Fv5JAQg//uhQtoWGORnxt69OY/fIs4WFpx8XpfC6kEo/96Bx3ELPkwovQtsSgVPUSlyiZ7kf9G/iFAHJM63smJjqCnVY2WGDiylpO5JgkSPLfiAGoYEqOHi8nNyctTugLGAYCnDEFjM8KmosvTTqZeYLyBtrCT7j/lLmK4uKhaL26aw5HKjHTk+1m23+c/6JT5xwaqlZ1sWMwmFU3oMAR1CNeKylBrtSXvWg3meqTRUsIM/HSt72ORohn9SytUkt1zvvIpULLki8zU5tBbDjT1N3fPnl2litzn6oz6ejA4P+x3Zk8PT07TXliS7kn2p5DNnZYqyk3Y7R53jXtpud1LsHuLwlM9GR+06HQs5vAuFt0wlz+ANh7LTbcteu9/Bfrt92EtlB9t9VhBbkJca647mz2Rx/rJoinvMimfudTk1dwTn5KP1F4tF7et1iRXPL/VtHLrdOFbz53anRZ9td0zll5rxa7bfbuDKvvvTb76AcbffrjPuYfsJxt23Yny7aIpYdWv+HRqTEeq6g7mg170TxP9Sjhg8rOKoeub/9/BP8PDKwaUTF8GRU/ITwxzHFFID+okYiIPoSy4rZO+rKaOwmRiIife5GxwcYK5ahUuo0/I4Ni1lQpHalKEimdVkmAilhVV+HpR+iTPPN3NHWgyub+sCl1wvYpBFAyWl2CrX5erfxMnu0VwBdXnwE/SgHBRafS8IvIG5KapepwW/kuZZiwDBB/nhHDBNyYXwDaJR3XtXDieP/FbSKivyhFCSFU3xI6nlb+p0D3t9TORxG5MedWUyPDmUST9thw9HxyehdpT93v4XrRrEnTcthVpwFq4FF9rTOI6XDn5Z6vglanF8bvzYKCNj15WtrLDt+ufK5RnOf4tS61dbN89I9nunKLvJSecwTXry6CgZjo67Sb99Qv3h6QmO6JDNU0bL/uYpD5R32GIe0l7Z5fhdCwilowCmaRhUHXmv9NjV7r7OaFcIYKdP2CdMpOzKpJceHSYnp71+ctod9nsSe8fHXRT8JpUemXA35cPBbzg2F5/h7MvFxgXfvXv3DhqNf5kZX6Zw3GcqB9KkxZS0Dx5uNG70N+4+6z+yFVyeKc/BPpuodFKaaG6K95bA0vdCWZKVWqVDB8s/k/MtgBtd0sqtuVeSHPRAqtGILGkfdbnBjU6g0ag/kkZjAEymjCnefNTeYrOkMjcFpKhhTH61HZFrb/BGAzALBljzASOcZc7AnTYzQMcxz86LX1vwH1Os9Abs0u9L724CrIUuA1y4QOnxLZbv7LPO5oD3qDLk6VqNKruamSbL1ZKPl5l+GWaq/iw3SJxpzOZOuchi0Gg8aUgspZp1+Oi86lOlOkmSGx0i6DLePEidfbmAj1rmRmkPX2msjL7Rv09IwxTvWAirKODY4BOr+GwGz00L5wHZBS6nVI3iJIs5951W8buyQS1mQCUQD5nGOAKjqbLOyGSZmTFiJeVgiI4kmNJeYzJji/lEpZiVOgc3OlrrSitPEi49enLwEZ2HDtsMokmvqqdS6YbZhKrXvhpd+JlEzNKGhM6T1bCmvlVpbTSuvn5ilD+2VsmDP+o+/VhwLw6/0yvQYyVMLep8htNaVWZOkQ+7Es4pz8x8yYYfjJuYIpMhEwQOZqZDoFx9/bRMqmvxFqummaLSDhylgW3pWAaJGJxHub2IyazTarfa5RSJKc9/nA1z4/wUQ7IvU27VcK7WoWtJ8WE1hr50+VpWFU8//EGeodJce0Jr81C2SNeibJFum2JiHHex4uGBfXFls8WCf46TOfc4Ujm2ixSDsArbwXdt7bqFR+z4yl1v1fGF5mt/nB2L152oy/XvC3G3rl53oq4tgF8NOa5f9wGutsCvBv1467oPidpW+NV4PFq47kNjtQ5+LRZbdq77kFnbB786n/ruda8wWe2E/x6XPZew+3CqNsR/j9Br7l/3Yb2+TH4T7n9xAbtXNK7tkXezjgdXu9yV9C3/YxWLh3m4WU0Tq2mfp7i8noU3lq2sZTna//rxm1gs/gevB5iU sidebar_class_name: "get api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -18,162 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Retrieves a list with all devices from the profile - + + + Request + + {...require("./list-of-devices.ParamsDetails.json")} +> + + - + + + + {...require("./list-of-devices.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-of-notifications.ParamsDetails.json b/docs/api/list-of-notifications.ParamsDetails.json new file mode 100644 index 00000000..25da7410 --- /dev/null +++ b/docs/api/list-of-notifications.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file diff --git a/docs/api/list-of-notifications.RequestSchema.json b/docs/api/list-of-notifications.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-of-notifications.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-of-notifications.StatusCodes.json b/docs/api/list-of-notifications.StatusCodes.json new file mode 100644 index 00000000..7d5999a4 --- /dev/null +++ b/docs/api/list-of-notifications.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of the Run user notifications","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"buttons":{"type":"array","items":{},"example":[]},"buttons_autodisable":{"type":"boolean","example":true},"buttons_enabled":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2022-06-20T17:35:26.753Z"},"id":{"type":"string","example":"62b0afde27ce4d0012c62256"},"message":{"type":"string","example":"Your device has retuned to the regular temperature"},"read":{"type":"boolean","example":false},"title":{"type":"string","example":"Temperature back to normal"}}},"example":[{"buttons":[],"buttons_autodisable":true,"buttons_enabled":true,"created_at":"2022-06-20T17:35:26.753Z","id":"62b0afde27ce4d0012c62256","message":"Your device has retuned to the regular temperature","read":false,"title":"Temperature back to normal"},{"buttons":[],"buttons_autodisable":true,"buttons_enabled":true,"created_at":"2022-05-26T13:12:06.753Z","id":"62b0afde27ce4d0012c62286","message":"The temperature is lower than 18ºC.","read":true,"title":"Low Temperature"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-of-notifications.api.mdx b/docs/api/list-of-notifications.api.mdx index faf54b5e..b2ecfca1 100644 --- a/docs/api/list-of-notifications.api.mdx +++ b/docs/api/list-of-notifications.api.mdx @@ -18,77 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List of notifications for an user - + + + Request + + {...require("./list-of-notifications.ParamsDetails.json")} +> + + - + + + + {...require("./list-of-notifications.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-of-tokens.ParamsDetails.json b/docs/api/list-of-tokens.ParamsDetails.json new file mode 100644 index 00000000..74a0abb9 --- /dev/null +++ b/docs/api/list-of-tokens.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/list-of-tokens.RequestSchema.json b/docs/api/list-of-tokens.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-of-tokens.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-of-tokens.StatusCodes.json b/docs/api/list-of-tokens.StatusCodes.json new file mode 100644 index 00000000..b57cc020 --- /dev/null +++ b/docs/api/list-of-tokens.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":""}}} \ No newline at end of file diff --git a/docs/api/list-of-tokens.api.mdx b/docs/api/list-of-tokens.api.mdx index 3f5efd5c..bc997422 100644 --- a/docs/api/list-of-tokens.api.mdx +++ b/docs/api/list-of-tokens.api.mdx @@ -18,19 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Retrieves list of all tokens from device - + + + Request + + {...require("./list-of-tokens.ParamsDetails.json")} +> + + + + + + + + + + - - + \ No newline at end of file diff --git a/docs/api/list-profile-backups.ParamsDetails.json b/docs/api/list-profile-backups.ParamsDetails.json new file mode 100644 index 00000000..2e2d1ef8 --- /dev/null +++ b/docs/api/list-profile-backups.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number for pagination (default 1)"},{"name":"amount","in":"query","required":false,"schema":{"type":"integer","example":20},"description":"Number of items per page (default 20)"},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string","example":"created_at,desc"},"description":"Sort order (e.g., 'created_at,desc' or 'created_at,asc')"},{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"}]} \ No newline at end of file diff --git a/docs/api/list-profile-backups.RequestSchema.json b/docs/api/list-profile-backups.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-profile-backups.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-profile-backups.StatusCodes.json b/docs/api/list-profile-backups.StatusCodes.json new file mode 100644 index 00000000..cd07dc70 --- /dev/null +++ b/docs/api/list-profile-backups.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"List of backups retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":true},"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"678abc123def456789012345"},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"file_path":{"type":"string","example":"profile/61fac4d9a5c9f40012a5ff92/versioning/backup/backup-61fac4d9a5c9f40012a5ff92.zip"},"version_id":{"type":"string","example":"abc123def456"},"file_size":{"type":"number","example":15728640,"description":"File size in bytes"},"status":{"type":"string","enum":["queued","processing","completed","failed"],"example":"completed"},"error_message":{"type":"string","example":null,"description":"Error message if status is 'failed'"},"created_at":{"type":"string","example":"2025-01-07T14:30:00.000Z"}}}}}}}}},"403":{"description":"Forbidden - Free plan users cannot access backup features","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup feature is not available on the free plan. Please upgrade your plan to access backup functionality."}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-profile-backups.api.mdx b/docs/api/list-profile-backups.api.mdx index 3bc86481..eff0bfca 100644 --- a/docs/api/list-profile-backups.api.mdx +++ b/docs/api/list-profile-backups.api.mdx @@ -18,118 +18,59 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Retrieves a paginated list of all backups for the specified profile. Use this endpoint to check backup status and find backup IDs for download or deletion. **Backup statuses:** - - `queued` - Backup request received, waiting for processing - `processing` - Backup generation in progress - `completed` - Backup ready for download - `failed` - Backup generation failed (check error_message) - + + + Request + + {...require("./list-profile-backups.ParamsDetails.json")} +> + + - + + + + {...require("./list-profile-backups.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/list-users.ParamsDetails.json b/docs/api/list-users.ParamsDetails.json new file mode 100644 index 00000000..9cc6aad1 --- /dev/null +++ b/docs/api/list-users.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number."},{"name":"name","in":"query","schema":{"type":"string","example":"John Doe"},"description":"Filter by the RUN user's name."},{"name":"email","in":"query","schema":{"type":"string","example":"runuser@email.com"},"description":"Filter by the RUN user's email."},{"name":"timezone","in":"query","schema":{"type":"string","example":"America/New_York"},"description":"Filter by the RUN user's timezone."},{"name":"company","in":"query","schema":{"type":"string","example":"Companyname"},"description":"Filter by the RUN user's company."},{"name":"phone","in":"query","schema":{"type":"string","example":"+010001010011"},"description":"Filter by the RUN user's phone number."},{"name":"language","in":"query","schema":{"type":"string","example":"En"},"description":"Filter by the RUN user's language."},{"name":"tags","in":"query","schema":{"type":"string","example":"[{\"key\":\"tag_key\",\"value\":\"tag value\"}]"},"description":"Filter by the RUN user's tags and keys."},{"name":"active","in":"query","schema":{"type":"string","example":"true"},"description":"Filter by the RUN user's activation status."},{"name":"id","in":"query","schema":{"type":"string","example":"614889df6a302639012a7caef"},"description":"Filter by the RUN user's id."},{"name":"last_login","in":"query","schema":{"type":"string","example":"2021-04-15T15:52:01.102Z"},"description":"Filter by the RUN user's last login."},{"name":"created_at","in":"query","schema":{"type":"string","example":"2021-07-26T13:10:39.314Z"},"description":"Filter by the RUN user's creation timestamp."},{"name":"amount","in":"query","schema":{"type":"string","example":"5"},"description":"Amount of RUN users by page."},{"name":"orderBy","in":"query","schema":{"type":"string","example":"name,asc"},"description":"Order by the RUN users name/ascending/descending."}]} \ No newline at end of file diff --git a/docs/api/list-users.RequestSchema.json b/docs/api/list-users.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/list-users.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/list-users.StatusCodes.json b/docs/api/list-users.StatusCodes.json new file mode 100644 index 00000000..1035ccd7 --- /dev/null +++ b/docs/api/list-users.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting a list of RUN users","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"company":{"type":"string","example":"Companyname"},"created_at":{"type":"string","example":"2022-01-21T21:29:08.957Z"},"email":{"type":"string","example":"runuser@email"},"id":{"type":"string","example":"614889df6a302639012a7caef"},"language":{"type":"string","example":"en"},"last_login":{"type":"string","example":"2022-06-10T17:59:26.879Z"},"name":{"type":"string","example":"runusername"},"newsletter":{"example":null},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"MM/DD/YYYY"},"time_format":{"type":"string","example":"12"}}},"otp":{"type":"object","properties":{}},"phone":{"type":"string","example":"+010001010011"},"profile":{"type":"string","example":"612ea05e3cc07803480127151133"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"user_type"},"value":{"type":"string","example":"enduser"}}},"example":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}]},"timezone":{"type":"string","example":"America/New_York"},"updated_at":{"type":"string","example":"2022-06-14T14:16:52.377Z"}}},"example":[{"active":true,"company":"Companyname","created_at":"2022-01-21T21:29:08.957Z","email":"runuser@email","id":"614889df6a302639012a7caef","language":"en","last_login":"2022-06-10T17:59:26.879Z","name":"runusername","newsletter":null,"options":{"date_format":"MM/DD/YYYY","time_format":"12"},"otp":{},"phone":"+010001010011","profile":"612ea05e3cc07803480127151133","tags":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}],"timezone":"America/New_York","updated_at":"2022-06-14T14:16:52.377Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/list-users.api.mdx b/docs/api/list-users.api.mdx index 5db5d23f..342bb6de 100644 --- a/docs/api/list-users.api.mdx +++ b/docs/api/list-users.api.mdx @@ -18,183 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - List users from Run - + + + Request + + {...require("./list-users.ParamsDetails.json")} +> + + - + + + + {...require("./list-users.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/login-as-user.ParamsDetails.json b/docs/api/login-as-user.ParamsDetails.json new file mode 100644 index 00000000..aa959f8b --- /dev/null +++ b/docs/api/login-as-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"expire_time","in":"query","schema":{"type":"string","example":"3 months"},"description":"hours,days,months."},{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file diff --git a/docs/api/login-as-user.RequestSchema.json b/docs/api/login-as-user.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/login-as-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/login-as-user.StatusCodes.json b/docs/api/login-as-user.StatusCodes.json new file mode 100644 index 00000000..b9af8a7b --- /dev/null +++ b/docs/api/login-as-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Login as a RUN User","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"expire_time":{"type":"string","example":"2022-06-21T03:01:10.908Z"},"name":{"type":"string","example":"Login by Run Administrator(runadmin@mail.com)"},"run_user":{"type":"string","example":"61eb25a4d6a4a20011d4cd3c"},"token":{"type":"string","example":"fe82f846-d19c-42b3-863a-7e7dgcd519e6"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/login-as-user.api.mdx b/docs/api/login-as-user.api.mdx index 72a073e3..b0fdb22f 100644 --- a/docs/api/login-as-user.api.mdx +++ b/docs/api/login-as-user.api.mdx @@ -18,54 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get TagoRUN User Token and allow to perform request to TagoRUN specific endpoints (not available). - + + + Request + + {...require("./login-as-user.ParamsDetails.json")} +> + + - + + + + {...require("./login-as-user.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/login-to-account.RequestSchema.json b/docs/api/login-to-account.RequestSchema.json new file mode 100644 index 00000000..397ce25a --- /dev/null +++ b/docs/api/login-to-account.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","example":"example@mail.com"},"password":{"type":"string","example":"yourpassword"}}},"examples":{"Login to Account":{"value":{"email":"example@mail.com","password":"yourpassword"}}}}}}} \ No newline at end of file diff --git a/docs/api/login-to-account.StatusCodes.json b/docs/api/login-to-account.StatusCodes.json new file mode 100644 index 00000000..da353084 --- /dev/null +++ b/docs/api/login-to-account.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Login","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"company":{"type":"string","example":"companyname"},"email":{"type":"string","example":"example@mail.com"},"id":{"type":"string","example":"612ea05e3cc078001371895110"},"name":{"type":"string","example":"Your Name"},"phone":{"type":"string","example":"+9396363457126"},"profiles":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","example":"612ea05e3cc078001371895110"},"id":{"type":"string","example":"612ea05e3cc078001371895111"},"logo_url":{"example":null},"name":{"type":"string","example":"profilename"}}},"example":[{"account":"612ea05e3cc078001371895110","id":"612ea05e3cc078001371895111","logo_url":null,"name":"profilename"}]},"type":{"type":"string","example":"user"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/login-to-account.api.mdx b/docs/api/login-to-account.api.mdx index ad2d3d27..2eb46f68 100644 --- a/docs/api/login-to-account.api.mdx +++ b/docs/api/login-to-account.api.mdx @@ -18,83 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Login to account using email and password - - + + Request + + + + + + {...require("./login-to-account.RequestSchema.json")} +> + + + {...require("./login-to-account.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json b/docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json new file mode 100644 index 00000000..0b3235fb --- /dev/null +++ b/docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"paramID","in":"path","required":true,"schema":{"type":"string","example":"(Type your param ID)"}}]} \ No newline at end of file diff --git a/docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json b/docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json b/docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json new file mode 100644 index 00000000..7cb37046 --- /dev/null +++ b/docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Success Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Params Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/mark-a-configuration-parameter-as-read.api.mdx b/docs/api/mark-a-configuration-parameter-as-read.api.mdx index 27271687..958abbb3 100644 --- a/docs/api/mark-a-configuration-parameter-as-read.api.mdx +++ b/docs/api/mark-a-configuration-parameter-as-read.api.mdx @@ -18,42 +18,55 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + - + + + -Marks a configuration parameter as read on the current device. + + +Marks a configuration parameter as read on the current device. This is useful when collecting settings from Configuration Parameters and you need to track whether you have already processed the current value. Use this endpoint to set the `sent` field to `true`. - + + + Request + + {...require("./mark-a-configuration-parameter-as-read.ParamsDetails.json")} +> + + - + + + + {...require("./mark-a-configuration-parameter-as-read.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/send-data-to-device.ParamsDetails.json b/docs/api/send-data-to-device.ParamsDetails.json new file mode 100644 index 00000000..4af8f8f6 --- /dev/null +++ b/docs/api/send-data-to-device.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file diff --git a/docs/api/send-data-to-device.RequestSchema.json b/docs/api/send-data-to-device.RequestSchema.json new file mode 100644 index 00000000..ce0cebaa --- /dev/null +++ b/docs/api/send-data-to-device.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Accepts a single item or an array of items when sent as application/json.\nFor text/plain content, use the [Payload Parser](/docs/tagoio/devices/payload-parser/) to normalize the data into TagoIO JSON format.\n","oneOf":[{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},{"type":"array","items":{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},"description":"Accepts a single item or an array of items.","title":"DeviceDataArray"}],"title":"DeviceData"},"examples":{"Send data (object)":{"value":{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}}},"Send data (array)":{"value":[{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}},{"variable":"location","value":"New York Office","location":{"lat":40.712776,"lng":-74.005974}}]}}},"text/plain":{"schema":{"type":"string","description":"Raw text data that will be processed by the device's Payload Parser to normalize into TagoIO JSON format."},"examples":{"Raw sensor data":{"value":"temperature:23.5,humidity:45.2,battery:87"},"HEX payload":{"value":"41BC7E1F2A"},"Custom format":{"value":"sensor_id=123&temp=25.6&status=ok"}}}}}} \ No newline at end of file diff --git a/docs/api/send-data-to-device.StatusCodes.json b/docs/api/send-data-to-device.StatusCodes.json new file mode 100644 index 00000000..5e4bbb85 --- /dev/null +++ b/docs/api/send-data-to-device.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Sending data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"2 Data Added"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/send-data-to-device.api.mdx b/docs/api/send-data-to-device.api.mdx index be26a56a..afa0f2a1 100644 --- a/docs/api/send-data-to-device.api.mdx +++ b/docs/api/send-data-to-device.api.mdx @@ -18,168 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Send data to a specific Device within your profile - + + + Request + + {...require("./send-data-to-device.ParamsDetails.json")} +> + + + {...require("./send-data-to-device.RequestSchema.json")} +> + + + {...require("./send-data-to-device.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/send-data-using-network.ParamsDetails.json b/docs/api/send-data-using-network.ParamsDetails.json new file mode 100644 index 00000000..f601ed53 --- /dev/null +++ b/docs/api/send-data-using-network.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"authorization_token","in":"query","required":true,"description":"Authorization_Token\n","schema":{"type":"string","example":"at72fb69a8dc714059b6cebee41693eb0"}}]} \ No newline at end of file diff --git a/docs/api/send-data-using-network.RequestSchema.json b/docs/api/send-data-using-network.RequestSchema.json new file mode 100644 index 00000000..7e9fd429 --- /dev/null +++ b/docs/api/send-data-using-network.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"payload"},"value":{"type":"string","description":"Hexadecimal string payload","example":"41BC7E1F2A"},"metadata":{"type":"object","properties":{"serial":{"type":"string","description":"Device serial number","example":"SN123456789"}},"additionalProperties":false}},"description":"Network device data format with payload and serial metadata.","title":"NetworkDeviceData"}},"text/plain":{"schema":{"type":"string","description":"Arbitrary payload. Your [Network Payload Parser](/docs/tagoio/devices/payload-parser/) must normalize this text to the TagoIO array format accepted by application/json.\n"},"examples":{"Send Data using Network":{"value":"Any format data that your Payload Parser can normalize to TagoIO format.\n"}}}}}} \ No newline at end of file diff --git a/docs/api/send-data-using-network.StatusCodes.json b/docs/api/send-data-using-network.StatusCodes.json new file mode 100644 index 00000000..ef288aae --- /dev/null +++ b/docs/api/send-data-using-network.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Send Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Added"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/send-data-using-network.api.mdx b/docs/api/send-data-using-network.api.mdx index 85e3ee57..b6dedf2b 100644 --- a/docs/api/send-data-using-network.api.mdx +++ b/docs/api/send-data-using-network.api.mdx @@ -5,7 +5,7 @@ description: "Send data to TagoIO using the Network instead." sidebar_label: "Send Data using Network" hide_title: true hide_table_of_contents: true -api: eJztWOtvIjkS/1csz4dJEA2BQB6cMit2ZnY3utVMlIdWpxBdinYBnjR2j+0OYRH/+6lsN3STx+i0p/u0+ZBE7XLVr95VXnEHU8sHt/wLuoU2D+xcTdE6ftfkAm1qZO6kVnzAr1AJJsABc5pdw1Sff2WFlWrK3AxZeVsq6xBEa6RG6nomLUMlci2VY5BlemE98W1JfQHLTINgF2Asmru9ttCpbTuYaqnbAh9liradB6Ik90TtfZIvBSonJ0sGSjCDQhpM3QYdyUi1Cd88F5YaBIfiBcRgrU6lP1xIN6udXesHVF7G7bBwM23kn0DmCAc7eKVyODX+3LanqNBA1obqtfZ+tMtGwnu7YwMmLTP4vZAGBali0XlEFo2EzCOUyn9REWMwS4v9og3DJ5jnGQ5Iyv39PfsGjxB8OFJMTtje0BhYtqT1f/eiZff32WqkGGOpVtax+PXfBlOUjyjYWfmpNZFK7D2xsw/sqfUIRsI4Q3Z2dsZGPJKM+P4/PK8I+OwZu59ac3RArvqpFYjowpogs/v7e97kOsdgxnPBB9yiEp/AwQ15LpqNN3kOBubo0FDwrriCOfIBr5k7ceQl3uSS4vd7gWbJm7y0Lh84U+BulNfcnHg3j4iFTWc4Bz5YcbfMSZJ1Rqopb/JocxLujruT8dEpnIj0uNM76J+Oj1IcI/Y6R6eHOD7g6/Vdk1tMCyPd0uOOCgVJfHB7RxQEEa37WYslSdxFnGrlUDk6gjzPZBqC65slDVbPoerxN0xdTfVbXrqPEj03ZHIn0dKtzcmbyka38nWTP0JWvEhdN+1v+AQCUzmHjAWSMjZqjHudnz8ef+780h0S7zJWXlKnDjvE0o9hfAoFIcanKuZjNDUAV1863cNe/+j45JSv100OQki6C9lFReAEMot0XOdeVo5YdnxFmmgzBxeqS9TY15QIoVSxxZvcSecxRDYBK0W/R+LwybXzDOTLfn5F4aEZS2fALDdpzP6lC/NXq/C8sI4pUi2TfyJzVOwJYFmAY4sAqjSlCSBNMadKO16y3dBtjRQ5PPrBu9S3HNI+lu0y+32Q+pjjQ7VhHqr/DBxbkno7dTUFVUW7aWHhshdOP5QkNtfKBgTdgwP680In9E75C7lYD16Dtsjc2xnXCaYYCoE+7awDV9jKnbHWGYKqXqKCsV5HzeboZppKaq6thwBuxge82rjasau0RVDPonksS2xhMj7gM+dyO2i3IZetwibYaVGgtKTm6+ZLNFgkiwpNpf5dkW2C+iHOyyK4UQhy+U9cPg9oVqUPLpeWFUp+L7xrvf9D4LbYr74TO2Q0GhA9xV6aovUh5UkDu/eW5TBFSsPYTWqwYhuZIQhfMJ6SrWv66EsGJOL4AJIedkUyPjkUST89qNSS5m61/7Gi9UHkFU0jUYsNvVrsvDKIsA8bHh8CF0v3prtGmWhTZ7a1wmvqf5I2z2D5JVDVVaubZyL6vVMQ3eSkc5gmPXF0lIwnx92kf3CC/fHpCUzwkMxzYfREZv9FHMQLUYdXzEOTokGWB9pKQEgVCCBNdaEczVpOqqmt6F5H9FYIQKeP0EdIhOiKpJceHSYnp71+ctod93sCesfH3VDEqTRcbhv855JDtfHybWMsC12lLda7Ytn3nvUtqSbaGzH2lFjwhhfnzyz57t27d6zR+E0vyGqFjeVc6LSYo3I+lBqNMLnWPpK5bZ5JR1m1mMl0Fn2x1MV7g7VRltjG2TUOOC3GRirCyo1+lAIt6zEhJxM0qFzgZQcjlbBGo5qNjcaAEZgYvEbPq0nfjFCWuvB1f4ou0JBsUUt2P6uyIKDmbJIwzKxmD0ovGFhKLoqScOpb6Javlx0DbBNGzwXUcoQEnId9aFeLTUJ/VdmSwSPIzE/aclLaVS8UGqYntU2gjOfqIvIcxFBBtrTSBhSDRuNFQ0KkalbFB+eVRyXrJElGykfQVdDcUw0vztnncve7xKnUaqT+mKFic3ggIiijYGdgGF6cN73n/IAB5AKbY0rLnpeeU+c0tLAx49lCtlkyW+zjTGuLTCssrTPRtHiSxJLKsjFYFExHe01RTw3kM5lCFnn6DYqsdaMkzStXDhxa9hmsYx2yGQsmvSlTZbPmLmZYlpXtPEBpEmRGGyJYh0axGvtWybXRuLn8naTcv9pt2/dVn34uaJpgf+D/AB4xIWiB5w8w1bo7YQp4yJXsE+aZXm7QUMLYmS4y4SuBx6AXygfKzeXvm+pdi7fQnvUcpLLMYurRRseSkCCDCjaNKaGYdVoHrYM4mkFKQxVVQ5p55uC7Sqztr02XO8VxtZ3x/n4D+fsN5P/0BhInn8rGt26G6XoV5/ZbXjE2TSzb8KXJ4K7JZzTmD275akXJfWOy9Zo+h4cQmuiFtIRexG32jcDfu4z+2GevvZC8iPgBl6++ypSTjV8KtrPP7d26WY5YBDKw+BigJNckZXv32c5FS0i4MfS75pu0d5Wd6OLr1TVv8nF8c5lrQXcMLOjdBBaEk16mfGT7jY2+rXgGalrAlGgDT/9iUJCDquPrgx9f4z+kVXmklhWE5ZQZFKDfpM6LpKtVGIrX6w19OHr1xmZqDdTkn7v1ev0f48SeHQ== +api: eJztWFtvG7cS/isE8xBb0EqWLfmiA6dQE/fUOEVi+IKisIx4tBxJjFfkhuRaVgX992JIrrQrX4KDHpyn+sE2lsOZb+4zXHIHE8v7t/wzurk2D+xcTdA6ftfkAm1qZO6kVrzPr1AJJsABc5pdw0Sff2GFlWrC3BRZeVsq6xBEa6iG6noqLUMlci2VY5Blem498W1JfQGLTINgF2AsmrudttCpbTuYaKnbAh9liradB6Ik90TtXZIvBSonxwsGSjCDQhpM3RodyUi1Cd88F5YaBIfiBcRgrU6lP5xLN62dXesHVF7G7aBwU23kn0DmCAdbeKVyODH+3LYnqNBA1obqtfZutMtawnu7ZQMmLTP4vZAGBali0XlEFo2EzCOUyn9REWMwS4v9og3DJ5jlGfZJyv39PfsGjxB8OFRMjtnOwBhYtKT1f3eiZXd32XKoGGOpVtax+PWrwRTlIwp2Wn5qjaUSO0/s9AN7aj2CkTDKkJ2enrIhjyRDvvsvzysCPn3G7qfWDB2Qq35qBSK6sCLI7P7+nje5zjGY8VzwPreoxCdwcEOei2bjTZ6DgRk6NBS8S65ghrzPa+b+6shLvMklxe/3As2CN3lpXd53psDtKK+5+at385BY2HSKM+D9JXeLnCRZZ6Sa8CaPNifh7mh/PDo8gWORHnW6e72T0WGKI8Ru5/DkAEd7fLW6a3KLaWGkW3jcUaHES+L92zuiIIho3c9aLEjiNuJUK4fK0RHkeSbTEFzfLGmwfA5Vj75h6mqq3/LSfZTouSGTO4mWbq1P3lQ2upWvmvwRsuJF6rppf8UnEJjKGWQskJSxUWPc7fz88eis88v+gHiXsfKSOnXYIZZ+DONTKAgxPlUxG6GpAbj63Nk/6PYOj45P+GrV5CCEpLuQXVQEjiGzSMd17mXliGXHV6SxNjNwobpEjX1NiRBKFVu8yZ10HkNkE7BS9HskDp9cO89AvuznVxQemJF0BsxincbsD12Yv1uFZ4V1TJFqmfwTmaNiTwDLAhxbBFClKU0AaYo5VdrRgm2HbmuoyOHRD96lvuWQ9rFsl9nvg9THHB+oNfNQ/afg2ILU26qrKagq2nULC5e9cPqhJLG5VjYg2N/boz8vdELvlL+Ri/XgNWiLzL2dcZ1gioEQ6NPOOnCFrdwZaZ0hqOolKhirVdRshm6qqaTm2noI4Ka8z6uNqx27SlsE9Syax7LEFibjfT51Lrf9dhty2Spsgp0WBUpLar5qvkSDRTKv0FTq3xXZJqgf4rwsgmuFIJf/wcXzgGZV+uByaVmh5PfCu9b7PwRui/3bd2KHjEYDoqfYS1O0PqQ8aWD33rIcJkhpGLtJDVZsI1ME4QvGU7JxTQ99yYBEHO1B0sV9kYyOD0TSS/cqtaS5Xe1/rGh9EHlF00jUYgOvFjuvDCLsw5rHh8DF0r3JtlHG2tSZbazwmvqfpM0zWHwOVHXV6uYZi173BMR+ctw5SJOuODxMRuOj/aS3d4y90ckxjPGAzHNh9Fhm/0UcxAtRh1fMQ5OiQZYH2kpASBUIIE11oRzNWk6qia3oXkf0VghAp4fQQ0iE2BdJNz08SI5Pur3kZH/U6wroHh3thyJOpeFy0+DPSg7Vxss3jbEsdJW2WO+KZd971rekGmtvxNhTYsEbXJw/s+S7d+/esUbjVz0nqxU2lnOh02KGyvlQajTC5Fr7SOa2eSYdZdV8KtNp9MVCF+8N1kZZYhtn1zjgtBgbqggrN/pRCrSsy4Qcj9GgcoGX7Q9VwhqNajY2Gn1GYGLwGj2rJn0zQlnowtf9CbpAQ7JFLdn9rMqCgJqzScIgs5o9KD1nYCm5KErCqW+hG75edgywdRg9F1DLERJwHvahbS3WCf1FZQsGjyAzP2nLcWlXPVdomB7XNoEynquLyHMQAwXZwkobUPQbjRcNCZGqWRUfnFcelayTJBkqH0FXQXNPNbg4Z2fl7neJE6nVUP0+RcVm8EBEUEbB1sAwuDhves/5AQPIBTbHlJY9Lz2nzmloYWPGs4VsvWS22Mep1haZVlhaZ6xp8SSJJZVlI7AomI72mqCeGMinMoUs8vQbFFnrRkmaV64cOLTsDKxjHbIZCya9KVNlvebOp1iWlc08QGkSZEYbIliHRrEa+1bJtdG4ufyNpNy/2m3b91WfnhU0TbDf8X8Aj5gQtMDzB5hq3Z0wBTzkSvYJ80wv1mgoYexUF5nwlcBj0HPlA+Xm8rd19a7FW2jPegZSWWYx9WijY0lIkEEFm8aUUMw6rb3WXhzNIKWhiqohzTwz8F0l1vbXpsut4rjczHj/vIH88wbyf3oDiZNPZeNbNcN0vYxz+y2vGJsmlk340mRw1+RTGvP7t3y5pOS+MdlqRZ/DQwhN9EJaQi/iNvtG4O9cRn/sstdeSF5E/ICLV19lysnGLwWb2ef2btUsRywCGVh8DFCSa5Kyufts56IlJNwY+F3zTdq7yk508eXqmjf5KL65zLSgOwbm9G4Cc8JJL1M+sv3GRt+WPAM1KWBCtIGnfzEoyEHV8fXBj6/xH9KqPFKLCsJyygwK0G9S50XS5TIMxavVmj4cvXpjPbUGavLP3Wq1+gv30J7l sidebar_class_name: "post api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -18,10 +18,24 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Send data to TagoIO using the Network instead. @@ -29,82 +43,39 @@ This endpoint allows the [Network Payload Parser](/docs/tagoio/devices/payload-p The Network's Payload Parser is required to set the serial within the network parser. For example: -```javascript -if (Array.isArray(payload)) { - const payload_received = payload.find((x) => x.variable === "payload"); - serial = payload_received?.metadata?.serial; -} -``` +``` javascript + if (Array.isArray(payload)) { + const payload_received = payload.find(x => x.variable === "payload"); + serial = payload_received?.metadata?.serial; + } + + ``` - + + Request + + {...require("./send-data-using-network.ParamsDetails.json")} +> + + + {...require("./send-data-using-network.RequestSchema.json")} +> + + + {...require("./send-data-using-network.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/send-data.RequestSchema.json b/docs/api/send-data.RequestSchema.json new file mode 100644 index 00000000..ce0cebaa --- /dev/null +++ b/docs/api/send-data.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Accepts a single item or an array of items when sent as application/json.\nFor text/plain content, use the [Payload Parser](/docs/tagoio/devices/payload-parser/) to normalize the data into TagoIO JSON format.\n","oneOf":[{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},{"type":"array","items":{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},"description":"Accepts a single item or an array of items.","title":"DeviceDataArray"}],"title":"DeviceData"},"examples":{"Send data (object)":{"value":{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}}},"Send data (array)":{"value":[{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}},{"variable":"location","value":"New York Office","location":{"lat":40.712776,"lng":-74.005974}}]}}},"text/plain":{"schema":{"type":"string","description":"Raw text data that will be processed by the device's Payload Parser to normalize into TagoIO JSON format."},"examples":{"Raw sensor data":{"value":"temperature:23.5,humidity:45.2,battery:87"},"HEX payload":{"value":"41BC7E1F2A"},"Custom format":{"value":"sensor_id=123&temp=25.6&status=ok"}}}}}} \ No newline at end of file diff --git a/docs/api/send-data.StatusCodes.json b/docs/api/send-data.StatusCodes.json new file mode 100644 index 00000000..5e4bbb85 --- /dev/null +++ b/docs/api/send-data.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Sending data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"2 Data Added"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/send-data.api.mdx b/docs/api/send-data.api.mdx index 478fedde..75ccbaa6 100644 --- a/docs/api/send-data.api.mdx +++ b/docs/api/send-data.api.mdx @@ -18,158 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Send Device Data - - + + Request + + + + + + {...require("./send-data.RequestSchema.json")} +> + + + {...require("./send-data.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/tagoio-api.info.mdx b/docs/api/tagoio-api.info.mdx index 010c44b5..5c51df09 100644 --- a/docs/api/tagoio-api.info.mdx +++ b/docs/api/tagoio-api.info.mdx @@ -14,32 +14,42 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; - + + - + + -#### **How to use this documentation** + +#### **How to use this documentation** The documentation is split by which token you're required to use in the request. TagoIO provides 4 different tokens: - - **Device-Token**: The token from your device, which you can get from the device's page. + - **Profile-Token**: Also know as Account-Token. You get from your profile settings page. + - **Network-Token**: Is the token from your Network. Only available if you're owner of the network in your integrations page. + - **Analysis-Token:** The token from your analysis, available in the analysis page. - --- - #### Setting the API Endpoint Region - When making a request to the TagoIO API, you must also specify the appropriate regional endpoint. Choose one of the following endpoints based on your geographical region: - **United States East 1:** - Use this endpoint when your application is based in the eastern United States. - **URL:** `https://api.us-e1.tago.io/` + Use this endpoint when your application is based in the eastern United States. + **URL:** `https://api.us-e1.tago.io/` + - **Europe West 1:** - Use this endpoint when your application is based in Western Europe. - **URL:** `https://api.eu-w1.tago.io/` + Use this endpoint when your application is based in Western Europe. + **URL:** `https://api.eu-w1.tago.io/` - **Tago Deploy:** You should use your own API URL that is available in your Domains section of the TagoDeploy. @@ -140,3 +150,4 @@ When making a request to the TagoIO API, you must also specify the appropriate r + \ No newline at end of file diff --git a/docs/api/test-profile-service.ParamsDetails.json b/docs/api/test-profile-service.ParamsDetails.json new file mode 100644 index 00000000..12ad4f3a --- /dev/null +++ b/docs/api/test-profile-service.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"},{"name":"service_type","in":"path","required":true,"schema":{"type":"string","enum":["sms","email"],"example":"sms"},"description":"The type of service to test (sms or email)"}]} \ No newline at end of file diff --git a/docs/api/test-profile-service.RequestSchema.json b/docs/api/test-profile-service.RequestSchema.json new file mode 100644 index 00000000..c9846e48 --- /dev/null +++ b/docs/api/test-profile-service.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to"],"properties":{"to":{"type":"string","description":"The recipient address for the test message.\n- For SMS: Phone number in E.164 format (e.g., +15551234567)\n- For Email: Email address (e.g., user@example.com)\n","example":"+15559876543"},"message":{"type":"string","description":"Custom test message content (optional). If not provided, a default test message will be sent.","example":"This is a test message from TagoIO"},"subject":{"type":"string","description":"Email subject line (only for email service type, optional)","example":"Test Email from TagoIO"}}},"examples":{"Test SMS":{"value":{"to":"+15559876543","message":"This is a test SMS from TagoIO"}},"Test Email":{"value":{"to":"user@example.com","subject":"Test Email from TagoIO","message":"This is a test email from TagoIO to verify your email service configuration."}}}}}}} \ No newline at end of file diff --git a/docs/api/test-profile-service.StatusCodes.json b/docs/api/test-profile-service.StatusCodes.json new file mode 100644 index 00000000..7c60abac --- /dev/null +++ b/docs/api/test-profile-service.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Test message sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"message":{"type":"string","example":"Test message sent successfully"},"message_id":{"type":"string","description":"Provider's message ID for tracking (if available)","example":"SM1234567890abcdef1234567890abcdef"}}},"status":{"type":"boolean","example":true}}}}}},"400":{"description":"Bad request - Invalid recipient or message format","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid phone number format. Use E.164 format (e.g., +15551234567)"}}}}}},"404":{"description":"Service provider not configured","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"No service provider configured for the specified service type"}}}}}},"500":{"description":"Provider error - Failed to send test message","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Failed to send test message: Invalid credentials"}}}}}}}} \ No newline at end of file diff --git a/docs/api/test-profile-service.api.mdx b/docs/api/test-profile-service.api.mdx index 3a1442d1..a27760c0 100644 --- a/docs/api/test-profile-service.api.mdx +++ b/docs/api/test-profile-service.api.mdx @@ -18,165 +18,62 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + + +> + + + + Test a configured service provider by sending a test message. This helps verify that your service provider configuration is working correctly before using it in production. **Supported service types:** - - `sms` - Sends a test SMS message to the specified phone number - `email` - Sends a test email to the specified email address **Important notes:** - - A service provider must be configured before testing - Test messages will consume your provider's quota/credits - For SMS, ensure the recipient number is in E.164 format (e.g., +15551234567) - + + + Request + + {...require("./test-profile-service.ParamsDetails.json")} +> + + + {...require("./test-profile-service.RequestSchema.json")} +> + + + {...require("./test-profile-service.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/update-dictionary-language.ParamsDetails.json b/docs/api/update-dictionary-language.ParamsDetails.json new file mode 100644 index 00000000..89bc5982 --- /dev/null +++ b/docs/api/update-dictionary-language.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"},{"name":"language","in":"path","required":true,"schema":{"type":"string","example":"Language Code"},"description":"Language that will be updated"}]} \ No newline at end of file diff --git a/docs/api/update-dictionary-language.RequestSchema.json b/docs/api/update-dictionary-language.RequestSchema.json new file mode 100644 index 00000000..7abe2136 --- /dev/null +++ b/docs/api/update-dictionary-language.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"dictionary":{"type":"object","properties":{"test":{"type":"string","example":"teste"}}}}},"examples":{"Update Dictionary Language":{"value":{"dictionary":{"test":"teste"}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-dictionary-language.StatusCodes.json b/docs/api/update-dictionary-language.StatusCodes.json new file mode 100644 index 00000000..79d34ee7 --- /dev/null +++ b/docs/api/update-dictionary-language.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Put Dictionary Language","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Dictionary language Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-dictionary-language.api.mdx b/docs/api/update-dictionary-language.api.mdx index f53888b6..cc3d150c 100644 --- a/docs/api/update-dictionary-language.api.mdx +++ b/docs/api/update-dictionary-language.api.mdx @@ -18,66 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Update Dictionary Language - + + Request + + {...require("./update-dictionary-language.ParamsDetails.json")} +> + + + {...require("./update-dictionary-language.RequestSchema.json")} +> + + + {...require("./update-dictionary-language.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/update-dictionary.ParamsDetails.json b/docs/api/update-dictionary.ParamsDetails.json new file mode 100644 index 00000000..b8515d71 --- /dev/null +++ b/docs/api/update-dictionary.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"}]} \ No newline at end of file diff --git a/docs/api/update-dictionary.RequestSchema.json b/docs/api/update-dictionary.RequestSchema.json new file mode 100644 index 00000000..9ee6e420 --- /dev/null +++ b/docs/api/update-dictionary.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"fallback":{"type":"string","example":"fr-FR"},"languages":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"code":{"type":"string","example":"fr-FR"}}},"example":[{"active":true,"code":"fr-FR"},{"active":true,"code":"pt-BR"}]},"name":{"type":"string","example":"updated.test"},"slug":{"type":"string","example":"TEEEE"}}},"examples":{"Update Dictionary":{"value":{"fallback":"fr-FR","languages":[{"active":true,"code":"fr-FR"},{"active":true,"code":"pt-BR"}],"name":"updated.test","slug":"TEEEE"}}}}}}} \ No newline at end of file diff --git a/docs/api/update-dictionary.StatusCodes.json b/docs/api/update-dictionary.StatusCodes.json new file mode 100644 index 00000000..6df93b92 --- /dev/null +++ b/docs/api/update-dictionary.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updating a Dictionary name","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-dictionary.api.mdx b/docs/api/update-dictionary.api.mdx index f53f9a4d..47e9c6bf 100644 --- a/docs/api/update-dictionary.api.mdx +++ b/docs/api/update-dictionary.api.mdx @@ -18,86 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Update Dictionary - + + Request + + {...require("./update-dictionary.ParamsDetails.json")} +> + + + {...require("./update-dictionary.RequestSchema.json")} +> + + + {...require("./update-dictionary.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/update-entity-schema.ParamsDetails.json b/docs/api/update-entity-schema.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/update-entity-schema.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/update-entity-schema.RequestSchema.json b/docs/api/update-entity-schema.RequestSchema.json new file mode 100644 index 00000000..b1271f55 --- /dev/null +++ b/docs/api/update-entity-schema.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"object","properties":{"update_new_date":{"type":"object","properties":{"action":{"type":"string","example":"delete"}}}}}}},"examples":{"Update Entity Schema":{"value":{"schema":{"update_new_date":{"action":"delete"}}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-entity-schema.StatusCodes.json b/docs/api/update-entity-schema.StatusCodes.json new file mode 100644 index 00000000..8aca82d2 --- /dev/null +++ b/docs/api/update-entity-schema.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updating any entity field","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"message":{"type":"string","example":"Entity Successfully Updated"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-entity-schema.api.mdx b/docs/api/update-entity-schema.api.mdx index 54980862..fec3bee3 100644 --- a/docs/api/update-entity-schema.api.mdx +++ b/docs/api/update-entity-schema.api.mdx @@ -18,63 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Update Entity Schema - + + Request + + {...require("./update-entity-schema.ParamsDetails.json")} +> + + + {...require("./update-entity-schema.RequestSchema.json")} +> + + + {...require("./update-entity-schema.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/update-entity.ParamsDetails.json b/docs/api/update-entity.ParamsDetails.json new file mode 100644 index 00000000..3eba60a2 --- /dev/null +++ b/docs/api/update-entity.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file diff --git a/docs/api/update-entity.RequestSchema.json b/docs/api/update-entity.RequestSchema.json new file mode 100644 index 00000000..57267399 --- /dev/null +++ b/docs/api/update-entity.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Updated Entity"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"no"}}},"example":[{"key":"active","value":"no"}]}}},"examples":{"Update Entity":{"value":{"name":"Updated Entity","tags":[{"key":"active","value":"no"}]}}}}}}} \ No newline at end of file diff --git a/docs/api/update-entity.StatusCodes.json b/docs/api/update-entity.StatusCodes.json new file mode 100644 index 00000000..ac533ea9 --- /dev/null +++ b/docs/api/update-entity.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updating entity name and tag","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"message":{"type":"string","example":"Entity Successfully Updated"}}},"status":{"type":"boolean","example":true}}},"examples":{"Updating entity name and tag":{"value":{"result":{"message":"Entity Successfully Updated"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-entity.api.mdx b/docs/api/update-entity.api.mdx index e98774de..ee670aa8 100644 --- a/docs/api/update-entity.api.mdx +++ b/docs/api/update-entity.api.mdx @@ -18,71 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Update Entity - + + Request + + {...require("./update-entity.ParamsDetails.json")} +> + + + {...require("./update-entity.RequestSchema.json")} +> + + + {...require("./update-entity.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/update-policy.ParamsDetails.json b/docs/api/update-policy.ParamsDetails.json new file mode 100644 index 00000000..751f58ce --- /dev/null +++ b/docs/api/update-policy.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"am_id","in":"path","required":true,"schema":{"type":"string","example":"(Type a Access Management/Policy ID)"},"description":"Can be obtained in the GET Policy response"}]} \ No newline at end of file diff --git a/docs/api/update-policy.RequestSchema.json b/docs/api/update-policy.RequestSchema.json new file mode 100644 index 00000000..dbc9893f --- /dev/null +++ b/docs/api/update-policy.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":true},"name":{"type":"string","example":"Updated policy name"},"permissions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"array","items":{"type":"string","example":"access"},"example":["access"]},"effect":{"type":"string","example":"denied"},"resource":{"type":"array","items":{"type":"string","example":"device"},"example":["device"]}}},"example":[{"action":["access"],"effect":"denied","resource":["device"]}]},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"access"},"value":{"type":"string","example":"blocked"}}},"example":[{"key":"access","value":"blocked"}]},"targets":{"type":"array","items":{"type":"array","items":{"type":"string","example":"run_user"},"example":["run_user"]},"example":[["run_user"]]}}},"examples":{"Update policy":{"value":{"active":true,"name":"Updated policy name","permissions":[{"action":["access"],"effect":"denied","resource":["device"]}],"tags":[{"key":"access","value":"blocked"}],"targets":[["run_user"]]}}}},"text/plain":{"examples":{"Update policy":{"value":"{\n \"name\": \"Updated Policy Name\", //edit the policy name\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\n \"access\"\n ],\n \"resource\": [\n \"device\"\n ] //updating resouces, they can be \"device\", \"dashboard\" and \"run_user\" types\n }\n ],\n \"targets\": [\n [\n \"run_user\"\n ] // update the target, possible \"run_user\" and \"analysis\" types\n ],\n \"tags\": [\n {\n \"key\": \"access\",\n \"value\": \"admin\"\n }\n ], //able to update tags \n \"active\": true //able to active and deactive policy (true or false)\n}"}}}}}} \ No newline at end of file diff --git a/docs/api/update-policy.StatusCodes.json b/docs/api/update-policy.StatusCodes.json new file mode 100644 index 00000000..7563952b --- /dev/null +++ b/docs/api/update-policy.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Updating a policy","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Access Management Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Updating a policy":{"value":{"result":"Access Management Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-policy.api.mdx b/docs/api/update-policy.api.mdx index 7c6f0978..8ab4450b 100644 --- a/docs/api/update-policy.api.mdx +++ b/docs/api/update-policy.api.mdx @@ -18,111 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Update policy - + + Request + + {...require("./update-policy.ParamsDetails.json")} +> + + + {...require("./update-policy.RequestSchema.json")} +> + + + {...require("./update-policy.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/update-the-account-resources-allocation.RequestSchema.json b/docs/api/update-the-account-resources-allocation.RequestSchema.json new file mode 100644 index 00000000..d81f5c78 --- /dev/null +++ b/docs/api/update-the-account-resources-allocation.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["profile"],"properties":{"profile":{"type":"string","example":"62cdb70512b7320012dc0880"},"analysis":{"type":"number","example":200},"data_records":{"type":"number","example":6667},"email":{"type":"number","example":17},"file_storage":{"type":"number","example":80},"input":{"type":"number","example":33334},"output":{"type":"number","example":100000},"push_notification":{"type":"number","example":4},"run_users":{"type":"number","example":0},"sms":{"type":"number","example":5}}},"example":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc0880","push_notification":4,"run_users":0,"sms":5},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc07800127u5111","push_notification":83,"run_users":8,"sms":0},{"analysis":1100,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5wf93","push_notification":13,"run_users":2,"sms":5}]},"examples":{"Update the account resources allocation":{"value":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc0880","push_notification":4,"run_users":0,"sms":5},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc07800127u5111","push_notification":83,"run_users":8,"sms":0},{"analysis":1100,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5wf93","push_notification":13,"run_users":2,"sms":5}]}}}}}} \ No newline at end of file diff --git a/docs/api/update-the-account-resources-allocation.StatusCodes.json b/docs/api/update-the-account-resources-allocation.StatusCodes.json new file mode 100644 index 00000000..09b84085 --- /dev/null +++ b/docs/api/update-the-account-resources-allocation.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Update the account's allocation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Profile resource allocation Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Update the account's allocation":{"value":{"result":"Profile resource allocation Successfully Updated","status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/update-the-account-resources-allocation.api.mdx b/docs/api/update-the-account-resources-allocation.api.mdx index 52f2ea36..35e7b4b3 100644 --- a/docs/api/update-the-account-resources-allocation.api.mdx +++ b/docs/api/update-the-account-resources-allocation.api.mdx @@ -18,148 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Update the account resources allocation - + + Request + - + + + + {...require("./update-the-account-resources-allocation.RequestSchema.json")} +> + + + {...require("./update-the-account-resources-allocation.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/upload-file-part.RequestSchema.json b/docs/api/upload-file-part.RequestSchema.json new file mode 100644 index 00000000..78360f66 --- /dev/null +++ b/docs/api/upload-file-part.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","example":"/Screenshot 2023-11-03 at 16.35.29.png"},"multipart_action":{"type":"string","example":"end"},"parts":{"type":"array","items":{"type":"object","properties":{"ETag":{"type":"string","example":"\"0f75e3da7675ca382dac146ed1247162\""},"PartNumber":{"type":"number","example":1}}},"example":[{"ETag":"\"0f75e3da7675ca382dac146ed1247162\"","PartNumber":1}]},"upload_id":{"type":"string","example":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"}}},"examples":{"Upload file part 1":{"value":{"contentType":"image/png","filename":"/Screenshot 2023-11-03 at 16.35.29.png","multipart_action":"start","public":true}},"Upload file part 2":{"value":{"file":"(binary)","filename":"/Screenshot 2023-11-03 at 16.35.29.png","multipart_action":"upload","part":1,"upload_id":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW. k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"}},"Upload file part 3":{"value":{"filename":"/Screenshot 2023-11-03 at 16.35.29.png","multipart_action":"end","parts":[{"ETag":"\"0f75e3da7675ca382dac146ed1247162\"","PartNumber":1}],"upload_id":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"}}}}}}} \ No newline at end of file diff --git a/docs/api/upload-file-part.StatusCodes.json b/docs/api/upload-file-part.StatusCodes.json new file mode 100644 index 00000000..eb76f313 --- /dev/null +++ b/docs/api/upload-file-part.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Upload file part 1 / Upload file part 2 / Upload file part 3","headers":{"Etag":{"schema":{"type":"string","example":"W/\"12e-fdk/2Vt3///sBaogLtoHsVN43c0\""}}},"content":{"application/json":{"schema":{"type":"object","properties":{"result":{"example":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-","anyOf":[{"type":"string","example":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"},{"type":"object","properties":{"$metadata":{"type":"object","properties":{"attempts":{"type":"number","example":1},"extendedRequestId":{"type":"string","example":"etfQlHP3vxwKW5DnCMCxnNvqHxmq8YxostIXn3qP0GwM34BtB11KAKuU7it4+REbO7iJKMobqZI="},"httpStatusCode":{"type":"number","example":200},"requestId":{"type":"string","example":"7V63NVZWY2EZFVQJ"},"totalRetryDelay":{"type":"number","example":0}}},"ETag":{"type":"string","example":"\"0f75e3da7675ca382dac146ed1247162\""},"ServerSideEncryption":{"type":"string","example":"AES256"}}},{"type":"object","properties":{"file":{"type":"string","example":"https://api.tago.io/file/61fab40aa5c9f40012a5ff93/Screenshot%202023-11-03%20at%2016.35.29.png"}}}]},"status":{"type":"boolean","example":true}}},"examples":{"Upload file part 1":{"value":{"result":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-","status":true}},"Upload file part 2":{"value":{"result":{"$metadata":{"attempts":1,"extendedRequestId":"etfQlHP3vxwKW5DnCMCxnNvqHxmq8YxostIXn3qP0GwM34BtB11KAKuU7it4+REbO7iJKMobqZI=","httpStatusCode":200,"requestId":"7V63NVZWY2EZFVQJ","totalRetryDelay":0},"ETag":"\"0f75e3da7675ca382dac146ed1247162\"","ServerSideEncryption":"AES256"},"status":true}},"Upload file part 3":{"value":{"result":{"file":"https://api.tago.io/file/61fab40aa5c9f40012a5ff93/Screenshot%202023-11-03%20at%2016.35.29.png"},"status":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/upload-file-part.api.mdx b/docs/api/upload-file-part.api.mdx index 49a201f2..0bfc8b5b 100644 --- a/docs/api/upload-file-part.api.mdx +++ b/docs/api/upload-file-part.api.mdx @@ -18,170 +18,52 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Upload file - + + Request + - + + + + {...require("./upload-file-part.RequestSchema.json")} +> + + + {...require("./upload-file-part.StatusCodes.json")} +> + + + + + \ No newline at end of file diff --git a/docs/api/user-information.ParamsDetails.json b/docs/api/user-information.ParamsDetails.json new file mode 100644 index 00000000..25da7410 --- /dev/null +++ b/docs/api/user-information.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file diff --git a/docs/api/user-information.RequestSchema.json b/docs/api/user-information.RequestSchema.json new file mode 100644 index 00000000..c96bcede --- /dev/null +++ b/docs/api/user-information.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/user-information.StatusCodes.json b/docs/api/user-information.StatusCodes.json new file mode 100644 index 00000000..2d524280 --- /dev/null +++ b/docs/api/user-information.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Getting RUN user information by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"company":{"type":"string","example":"Companyname"},"created_at":{"type":"string","example":"2022-01-21T21:29:08.957Z"},"email":{"type":"string","example":"runuser@email"},"id":{"type":"string","example":"614889df6a302639012a7caef"},"language":{"type":"string","example":"en"},"last_login":{"type":"string","example":"2022-06-10T17:59:26.879Z"},"name":{"type":"string","example":"runusername"},"newsletter":{"example":null},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"MM/DD/YYYY"},"time_format":{"type":"string","example":"12"}}},"otp":{"type":"object","properties":{}},"phone":{"type":"string","example":"+010001010011"},"profile":{"type":"string","example":"612ea05e3cc07803480127151133"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"user_type"},"value":{"type":"string","example":"enduser"}}},"example":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}]},"timezone":{"type":"string","example":"America/New_York"},"updated_at":{"type":"string","example":"2022-06-14T14:16:52.377Z"}}},"example":[{"active":true,"company":"Companyname","created_at":"2022-01-21T21:29:08.957Z","email":"runuser@email","id":"614889df6a302639012a7caef","language":"en","last_login":"2022-06-10T17:59:26.879Z","name":"runusername","newsletter":null,"options":{"date_format":"MM/DD/YYYY","time_format":"12"},"otp":{},"phone":"+010001010011","profile":"612ea05e3cc07803480127151133","tags":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}],"timezone":"America/New_York","updated_at":"2022-06-14T14:16:52.377Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file diff --git a/docs/api/user-information.api.mdx b/docs/api/user-information.api.mdx index 3810e123..f3373ecb 100644 --- a/docs/api/user-information.api.mdx +++ b/docs/api/user-information.api.mdx @@ -18,105 +18,53 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + - - Get information about an user using userID - + + + Request + + {...require("./user-information.ParamsDetails.json")} +> + + - + + + + {...require("./user-information.StatusCodes.json")} +> + + + + + \ No newline at end of file From 2481092d283ff286c203398a35ddca1f0b4e03cf Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Mon, 6 Apr 2026 10:38:23 -0300 Subject: [PATCH 2/2] chore: format generated API docs JSON files Apply consistent JSON formatting to all generated ParamsDetails, RequestSchema, and StatusCodes JSON files. --- docs/api/add-entity-data.ParamsDetails.json | 11 +- docs/api/add-entity-data.RequestSchema.json | 20 +- docs/api/add-entity-data.StatusCodes.json | 20 +- docs/api/add-entity-data.api.mdx | 44 +-- ...nfigure-profile-service.ParamsDetails.json | 12 +- ...nfigure-profile-service.RequestSchema.json | 138 ++++++- ...configure-profile-service.StatusCodes.json | 64 ++- docs/api/configure-profile-service.api.mdx | 61 +-- .../convert-device-type.ParamsDetails.json | 11 +- .../convert-device-type.RequestSchema.json | 31 +- docs/api/convert-device-type.StatusCodes.json | 19 +- docs/api/convert-device-type.api.mdx | 44 +-- ...-and-edit-device-params.ParamsDetails.json | 11 +- ...-and-edit-device-params.RequestSchema.json | 24 +- ...te-and-edit-device-params.StatusCodes.json | 19 +- .../api/create-and-edit-device-params.api.mdx | 45 +-- ...create-dashboard-widget.ParamsDetails.json | 11 +- ...create-dashboard-widget.RequestSchema.json | 73 +++- .../create-dashboard-widget.StatusCodes.json | 2 +- docs/api/create-dashboard-widget.api.mdx | 45 +-- docs/api/create-dashboard.RequestSchema.json | 94 ++++- docs/api/create-dashboard.StatusCodes.json | 27 +- docs/api/create-dashboard.api.mdx | 45 +-- docs/api/create-dictionary.RequestSchema.json | 40 +- docs/api/create-dictionary.StatusCodes.json | 22 +- docs/api/create-dictionary.api.mdx | 44 +-- docs/api/create-entity.RequestSchema.json | 76 +++- docs/api/create-entity.StatusCodes.json | 22 +- docs/api/create-entity.api.mdx | 44 +-- docs/api/create-new-device.RequestSchema.json | 165 +++++++- docs/api/create-new-device.StatusCodes.json | 25 +- docs/api/create-new-device.api.mdx | 44 +-- .../create-notification.RequestSchema.json | 66 +++- docs/api/create-notification.StatusCodes.json | 27 +- docs/api/create-notification.api.mdx | 45 +-- docs/api/create-policy.RequestSchema.json | 194 ++++++++- docs/api/create-policy.StatusCodes.json | 22 +- docs/api/create-policy.api.mdx | 44 +-- .../create-profile-backup.ParamsDetails.json | 12 +- .../create-profile-backup.RequestSchema.json | 2 +- .../create-profile-backup.StatusCodes.json | 40 +- docs/api/create-profile-backup.api.mdx | 47 +-- docs/api/create-token.RequestSchema.json | 35 +- docs/api/create-token.StatusCodes.json | 26 +- docs/api/create-token.api.mdx | 45 +-- docs/api/create-user.RequestSchema.json | 21 +- docs/api/create-user.StatusCodes.json | 22 +- docs/api/create-user.api.mdx | 45 +-- ...rent-device-information.RequestSchema.json | 2 +- ...urrent-device-information.StatusCodes.json | 39 +- docs/api/current-device-information.api.mdx | 39 +- docs/api/delete-a-file.RequestSchema.json | 2 +- docs/api/delete-a-file.StatusCodes.json | 20 +- docs/api/delete-a-file.api.mdx | 38 +- docs/api/delete-chunk.ParamsDetails.json | 19 +- docs/api/delete-chunk.RequestSchema.json | 2 +- docs/api/delete-chunk.StatusCodes.json | 19 +- docs/api/delete-chunk.api.mdx | 44 +-- docs/api/delete-dashboard.ParamsDetails.json | 11 +- docs/api/delete-dashboard.RequestSchema.json | 2 +- docs/api/delete-dashboard.StatusCodes.json | 20 +- docs/api/delete-dashboard.api.mdx | 45 +-- docs/api/delete-data.ParamsDetails.json | 52 ++- docs/api/delete-data.RequestSchema.json | 2 +- docs/api/delete-data.StatusCodes.json | 19 +- docs/api/delete-data.api.mdx | 45 +-- .../api/delete-device-data.ParamsDetails.json | 59 ++- .../api/delete-device-data.RequestSchema.json | 2 +- docs/api/delete-device-data.StatusCodes.json | 19 +- docs/api/delete-device-data.api.mdx | 44 +-- .../delete-device-param.ParamsDetails.json | 17 +- .../delete-device-param.RequestSchema.json | 2 +- docs/api/delete-device-param.StatusCodes.json | 19 +- docs/api/delete-device-param.api.mdx | 45 +-- docs/api/delete-device.ParamsDetails.json | 11 +- docs/api/delete-device.RequestSchema.json | 2 +- docs/api/delete-device.StatusCodes.json | 19 +- docs/api/delete-device.api.mdx | 45 +-- docs/api/delete-dictionary.ParamsDetails.json | 12 +- docs/api/delete-dictionary.RequestSchema.json | 2 +- docs/api/delete-dictionary.StatusCodes.json | 19 +- docs/api/delete-dictionary.api.mdx | 44 +-- .../api/delete-entity-data.ParamsDetails.json | 11 +- .../api/delete-entity-data.RequestSchema.json | 2 +- docs/api/delete-entity-data.StatusCodes.json | 20 +- docs/api/delete-entity-data.api.mdx | 44 +-- docs/api/delete-entity.ParamsDetails.json | 11 +- docs/api/delete-entity.RequestSchema.json | 2 +- docs/api/delete-entity.StatusCodes.json | 20 +- docs/api/delete-entity.api.mdx | 44 +-- .../delete-notification.ParamsDetails.json | 11 +- .../delete-notification.RequestSchema.json | 2 +- docs/api/delete-notification.StatusCodes.json | 19 +- docs/api/delete-notification.api.mdx | 45 +-- docs/api/delete-policy.ParamsDetails.json | 12 +- docs/api/delete-policy.RequestSchema.json | 2 +- docs/api/delete-policy.StatusCodes.json | 22 +- docs/api/delete-policy.api.mdx | 44 +-- .../delete-profile-backup.ParamsDetails.json | 19 +- .../delete-profile-backup.RequestSchema.json | 39 +- .../delete-profile-backup.StatusCodes.json | 47 ++- docs/api/delete-profile-backup.api.mdx | 41 +- docs/api/delete-token.ParamsDetails.json | 11 +- docs/api/delete-token.RequestSchema.json | 2 +- docs/api/delete-token.StatusCodes.json | 19 +- docs/api/delete-token.api.mdx | 45 +-- docs/api/delete-user.ParamsDetails.json | 11 +- docs/api/delete-user.RequestSchema.json | 2 +- docs/api/delete-user.StatusCodes.json | 19 +- docs/api/delete-user.api.mdx | 45 +-- docs/api/delete-widget.ParamsDetails.json | 17 +- docs/api/delete-widget.RequestSchema.json | 2 +- docs/api/delete-widget.StatusCodes.json | 20 +- docs/api/delete-widget.api.mdx | 45 +-- .../api/device-data-amount.ParamsDetails.json | 11 +- .../api/device-data-amount.RequestSchema.json | 2 +- docs/api/device-data-amount.StatusCodes.json | 19 +- docs/api/device-data-amount.api.mdx | 44 +-- .../api/device-information.ParamsDetails.json | 11 +- .../api/device-information.RequestSchema.json | 2 +- docs/api/device-information.StatusCodes.json | 54 ++- docs/api/device-information.api.mdx | 44 +-- ...download-profile-backup.ParamsDetails.json | 19 +- ...download-profile-backup.RequestSchema.json | 39 +- .../download-profile-backup.StatusCodes.json | 78 +++- docs/api/download-profile-backup.api.mdx | 41 +- .../duplicate-dashboard.ParamsDetails.json | 11 +- .../duplicate-dashboard.RequestSchema.json | 62 ++- docs/api/duplicate-dashboard.StatusCodes.json | 25 +- docs/api/duplicate-dashboard.api.mdx | 47 +-- docs/api/edit-a-file.RequestSchema.json | 22 +- docs/api/edit-a-file.StatusCodes.json | 20 +- docs/api/edit-a-file.api.mdx | 44 +-- docs/api/edit-account.RequestSchema.json | 55 ++- docs/api/edit-account.StatusCodes.json | 22 +- docs/api/edit-account.api.mdx | 45 +-- docs/api/edit-dashboard.ParamsDetails.json | 11 +- docs/api/edit-dashboard.RequestSchema.json | 179 ++++++++- docs/api/edit-dashboard.StatusCodes.json | 22 +- docs/api/edit-dashboard.api.mdx | 45 +-- docs/api/edit-data.RequestSchema.json | 30 +- docs/api/edit-data.StatusCodes.json | 19 +- docs/api/edit-data.api.mdx | 44 +-- ...configuration-parameter.ParamsDetails.json | 2 +- ...configuration-parameter.RequestSchema.json | 42 +- ...e-configuration-parameter.StatusCodes.json | 19 +- ...dit-device-configuration-parameter.api.mdx | 44 +-- docs/api/edit-device-data.ParamsDetails.json | 12 +- docs/api/edit-device-data.RequestSchema.json | 18 +- docs/api/edit-device-data.StatusCodes.json | 20 +- docs/api/edit-device-data.api.mdx | 44 +-- docs/api/edit-device.ParamsDetails.json | 11 +- docs/api/edit-device.RequestSchema.json | 49 ++- docs/api/edit-device.StatusCodes.json | 19 +- docs/api/edit-device.api.mdx | 45 +-- docs/api/edit-entity-data.ParamsDetails.json | 11 +- docs/api/edit-entity-data.RequestSchema.json | 20 +- docs/api/edit-entity-data.StatusCodes.json | 20 +- docs/api/edit-entity-data.api.mdx | 44 +-- docs/api/edit-notification.ParamsDetails.json | 11 +- docs/api/edit-notification.RequestSchema.json | 19 +- docs/api/edit-notification.StatusCodes.json | 19 +- docs/api/edit-notification.api.mdx | 45 +-- docs/api/edit-permission.RequestSchema.json | 22 +- docs/api/edit-permission.StatusCodes.json | 20 +- docs/api/edit-permission.api.mdx | 44 +-- docs/api/edit-settings.RequestSchema.json | 19 +- docs/api/edit-settings.StatusCodes.json | 19 +- docs/api/edit-settings.api.mdx | 45 +-- docs/api/edit-user.ParamsDetails.json | 11 +- docs/api/edit-user.RequestSchema.json | 42 +- docs/api/edit-user.StatusCodes.json | 19 +- docs/api/edit-user.api.mdx | 45 +-- docs/api/edit-widget.ParamsDetails.json | 17 +- docs/api/edit-widget.RequestSchema.json | 93 ++++- docs/api/edit-widget.StatusCodes.json | 20 +- docs/api/edit-widget.api.mdx | 41 +- .../empty-a-device-s-data.ParamsDetails.json | 11 +- .../empty-a-device-s-data.RequestSchema.json | 2 +- .../empty-a-device-s-data.StatusCodes.json | 19 +- docs/api/empty-a-device-s-data.api.mdx | 44 +-- ...a-chunk-as-csv-to-files.ParamsDetails.json | 11 +- ...a-chunk-as-csv-to-files.RequestSchema.json | 27 +- ...t-a-chunk-as-csv-to-files.StatusCodes.json | 28 +- .../export-a-chunk-as-csv-to-files.api.mdx | 44 +-- ...rt-data-to-csv-in-files.ParamsDetails.json | 12 +- ...rt-data-to-csv-in-files.RequestSchema.json | 22 +- ...port-data-to-csv-in-files.StatusCodes.json | 24 +- docs/api/export-data-to-csv-in-files.api.mdx | 44 +-- .../api/export-entity-data.ParamsDetails.json | 6 +- .../api/export-entity-data.RequestSchema.json | 26 +- docs/api/export-entity-data.StatusCodes.json | 22 +- docs/api/export-entity-data.api.mdx | 45 +-- docs/api/file-copy.RequestSchema.json | 22 +- docs/api/file-copy.StatusCodes.json | 20 +- docs/api/file-copy.api.mdx | 44 +-- .../generate-profile-token.RequestSchema.json | 30 +- .../generate-profile-token.StatusCodes.json | 28 +- docs/api/generate-profile-token.api.mdx | 45 +-- .../generate-public-token.ParamsDetails.json | 18 +- .../generate-public-token.RequestSchema.json | 2 +- .../generate-public-token.StatusCodes.json | 25 +- docs/api/generate-public-token.api.mdx | 51 +-- docs/api/generate-token.ParamsDetails.json | 17 +- docs/api/generate-token.RequestSchema.json | 2 +- docs/api/generate-token.StatusCodes.json | 29 +- docs/api/generate-token.api.mdx | 47 +-- .../get-a-profile-details.ParamsDetails.json | 12 +- .../get-a-profile-details.RequestSchema.json | 2 +- .../get-a-profile-details.StatusCodes.json | 68 +++- docs/api/get-a-profile-details.api.mdx | 44 +-- ...et-a-profile-statistics.ParamsDetails.json | 24 +- ...et-a-profile-statistics.RequestSchema.json | 2 +- .../get-a-profile-statistics.StatusCodes.json | 266 ++++++++++++- docs/api/get-a-profile-statistics.api.mdx | 44 +-- .../get-a-profile-summary.ParamsDetails.json | 12 +- .../get-a-profile-summary.RequestSchema.json | 2 +- .../get-a-profile-summary.StatusCodes.json | 138 ++++++- docs/api/get-a-profile-summary.api.mdx | 44 +-- ...get-account-information.RequestSchema.json | 2 +- .../get-account-information.StatusCodes.json | 83 +++- docs/api/get-account-information.api.mdx | 39 +- ...nt-resources-allocation.RequestSchema.json | 2 +- ...ount-resources-allocation.StatusCodes.json | 126 +++++- .../get-account-resources-allocation.api.mdx | 38 +- ...onfiguration-parameters.ParamsDetails.json | 11 +- ...onfiguration-parameters.RequestSchema.json | 2 +- ...-configuration-parameters.StatusCodes.json | 30 +- docs/api/get-configuration-parameters.api.mdx | 45 +-- docs/api/get-data.ParamsDetails.json | 78 +++- docs/api/get-data.RequestSchema.json | 2 +- docs/api/get-data.StatusCodes.json | 58 ++- docs/api/get-data.api.mdx | 44 +-- docs/api/get-device-data.ParamsDetails.json | 24 +- docs/api/get-device-data.RequestSchema.json | 2 +- docs/api/get-device-data.StatusCodes.json | 320 ++++++++++++++- docs/api/get-device-data.api.mdx | 44 +-- ...al-number-authorization.ParamsDetails.json | 19 +- ...al-number-authorization.RequestSchema.json | 2 +- ...rial-number-authorization.StatusCodes.json | 19 +- ...n-with-serial-number-authorization.api.mdx | 40 +- ...oken-with-serial-number.ParamsDetails.json | 12 +- ...oken-with-serial-number.RequestSchema.json | 2 +- ...-token-with-serial-number.StatusCodes.json | 19 +- ...et-device-token-with-serial-number.api.mdx | 40 +- .../get-dictionary-details.ParamsDetails.json | 12 +- .../get-dictionary-details.RequestSchema.json | 2 +- .../get-dictionary-details.StatusCodes.json | 43 +- docs/api/get-dictionary-details.api.mdx | 44 +-- ...ionary-language-details.ParamsDetails.json | 19 +- ...ionary-language-details.RequestSchema.json | 2 +- ...ctionary-language-details.StatusCodes.json | 19 +- .../get-dictionary-language-details.api.mdx | 40 +- .../get-dictionary-list.RequestSchema.json | 2 +- docs/api/get-dictionary-list.StatusCodes.json | 62 ++- docs/api/get-dictionary-list.api.mdx | 38 +- .../get-entity-data-amount.ParamsDetails.json | 11 +- .../get-entity-data-amount.RequestSchema.json | 2 +- .../get-entity-data-amount.StatusCodes.json | 20 +- docs/api/get-entity-data-amount.api.mdx | 44 +-- docs/api/get-entity-data.ParamsDetails.json | 43 +- docs/api/get-entity-data.RequestSchema.json | 2 +- docs/api/get-entity-data.StatusCodes.json | 98 ++++- docs/api/get-entity-data.api.mdx | 44 +-- docs/api/get-entity-info.ParamsDetails.json | 11 +- docs/api/get-entity-info.RequestSchema.json | 2 +- docs/api/get-entity-info.StatusCodes.json | 164 +++++++- docs/api/get-entity-info.api.mdx | 44 +-- docs/api/get-information.ParamsDetails.json | 11 +- docs/api/get-information.RequestSchema.json | 2 +- docs/api/get-information.StatusCodes.json | 182 ++++++++- docs/api/get-information.api.mdx | 45 +-- docs/api/get-policy-list.ParamsDetails.json | 6 +- docs/api/get-policy-list.RequestSchema.json | 2 +- docs/api/get-policy-list.StatusCodes.json | 40 +- docs/api/get-policy-list.api.mdx | 44 +-- .../get-profile-file-list.ParamsDetails.json | 11 +- .../get-profile-file-list.RequestSchema.json | 2 +- .../get-profile-file-list.StatusCodes.json | 82 +++- docs/api/get-profile-file-list.api.mdx | 44 +-- docs/api/get-run-settings.RequestSchema.json | 2 +- docs/api/get-run-settings.StatusCodes.json | 370 +++++++++++++++++- docs/api/get-run-settings.api.mdx | 39 +- docs/api/get-tags.ParamsDetails.json | 12 +- docs/api/get-tags.RequestSchema.json | 2 +- docs/api/get-tags.StatusCodes.json | 37 +- docs/api/get-tags.api.mdx | 44 +-- .../get-the-account-plan.RequestSchema.json | 2 +- .../api/get-the-account-plan.StatusCodes.json | 20 +- docs/api/get-the-account-plan.api.mdx | 38 +- docs/api/get-widget-data.ParamsDetails.json | 17 +- docs/api/get-widget-data.RequestSchema.json | 2 +- docs/api/get-widget-data.StatusCodes.json | 257 +++++++++++- docs/api/get-widget-data.api.mdx | 45 +-- .../get-widget-information.ParamsDetails.json | 17 +- .../get-widget-information.RequestSchema.json | 2 +- .../get-widget-information.StatusCodes.json | 126 +++++- docs/api/get-widget-information.api.mdx | 41 +- ...ata-from-a-csv-in-files.ParamsDetails.json | 11 +- ...ata-from-a-csv-in-files.RequestSchema.json | 17 +- ...-data-from-a-csv-in-files.StatusCodes.json | 19 +- .../import-data-from-a-csv-in-files.api.mdx | 44 +-- ...is-related-to-dashboard.ParamsDetails.json | 11 +- ...is-related-to-dashboard.RequestSchema.json | 2 +- ...ysis-related-to-dashboard.StatusCodes.json | 32 +- ...list-analysis-related-to-dashboard.api.mdx | 45 +-- docs/api/list-dashboards.ParamsDetails.json | 29 +- docs/api/list-dashboards.RequestSchema.json | 2 +- docs/api/list-dashboards.StatusCodes.json | 85 +++- docs/api/list-dashboards.api.mdx | 45 +-- .../api/list-device-params.ParamsDetails.json | 17 +- .../api/list-device-params.RequestSchema.json | 2 +- docs/api/list-device-params.StatusCodes.json | 34 +- docs/api/list-device-params.api.mdx | 45 +-- ...es-related-to-dashboard.ParamsDetails.json | 11 +- ...es-related-to-dashboard.RequestSchema.json | 2 +- ...ices-related-to-dashboard.StatusCodes.json | 47 ++- .../list-devices-related-to-dashboard.api.mdx | 45 +-- docs/api/list-entities.ParamsDetails.json | 25 +- docs/api/list-entities.RequestSchema.json | 2 +- docs/api/list-entities.StatusCodes.json | 60 ++- docs/api/list-entities.api.mdx | 44 +-- docs/api/list-of-chunks.ParamsDetails.json | 11 +- docs/api/list-of-chunks.RequestSchema.json | 2 +- docs/api/list-of-chunks.StatusCodes.json | 62 ++- docs/api/list-of-chunks.api.mdx | 44 +-- docs/api/list-of-devices.ParamsDetails.json | 67 +++- docs/api/list-of-devices.RequestSchema.json | 2 +- docs/api/list-of-devices.StatusCodes.json | 80 +++- docs/api/list-of-devices.api.mdx | 45 +-- .../list-of-notifications.ParamsDetails.json | 11 +- .../list-of-notifications.RequestSchema.json | 2 +- .../list-of-notifications.StatusCodes.json | 56 ++- docs/api/list-of-notifications.api.mdx | 45 +-- docs/api/list-of-tokens.ParamsDetails.json | 2 +- docs/api/list-of-tokens.RequestSchema.json | 2 +- docs/api/list-of-tokens.StatusCodes.json | 2 +- docs/api/list-of-tokens.api.mdx | 45 +-- .../list-profile-backups.ParamsDetails.json | 33 +- .../list-profile-backups.RequestSchema.json | 2 +- .../api/list-profile-backups.StatusCodes.json | 62 ++- docs/api/list-profile-backups.api.mdx | 46 +-- docs/api/list-users.ParamsDetails.json | 84 +++- docs/api/list-users.RequestSchema.json | 2 +- docs/api/list-users.StatusCodes.json | 84 +++- docs/api/list-users.api.mdx | 45 +-- docs/api/login-as-user.ParamsDetails.json | 17 +- docs/api/login-as-user.RequestSchema.json | 2 +- docs/api/login-as-user.StatusCodes.json | 27 +- docs/api/login-as-user.api.mdx | 45 +-- docs/api/login-to-account.RequestSchema.json | 19 +- docs/api/login-to-account.StatusCodes.json | 49 ++- docs/api/login-to-account.api.mdx | 45 +-- ...ation-parameter-as-read.ParamsDetails.json | 11 +- ...ation-parameter-as-read.RequestSchema.json | 2 +- ...uration-parameter-as-read.StatusCodes.json | 19 +- ...-a-configuration-parameter-as-read.api.mdx | 47 +-- .../send-data-to-device.ParamsDetails.json | 12 +- .../send-data-to-device.RequestSchema.json | 128 +++++- docs/api/send-data-to-device.StatusCodes.json | 19 +- docs/api/send-data-to-device.api.mdx | 45 +-- ...send-data-using-network.ParamsDetails.json | 12 +- ...send-data-using-network.RequestSchema.json | 39 +- .../send-data-using-network.StatusCodes.json | 19 +- docs/api/send-data-using-network.api.mdx | 57 +-- docs/api/send-data.RequestSchema.json | 128 +++++- docs/api/send-data.StatusCodes.json | 19 +- docs/api/send-data.api.mdx | 45 +-- docs/api/tagoio-api.info.mdx | 33 +- .../test-profile-service.ParamsDetails.json | 19 +- .../test-profile-service.RequestSchema.json | 42 +- .../api/test-profile-service.StatusCodes.json | 77 +++- docs/api/test-profile-service.api.mdx | 43 +- ...ate-dictionary-language.ParamsDetails.json | 19 +- ...ate-dictionary-language.RequestSchema.json | 17 +- ...pdate-dictionary-language.StatusCodes.json | 19 +- docs/api/update-dictionary-language.api.mdx | 44 +-- docs/api/update-dictionary.ParamsDetails.json | 12 +- docs/api/update-dictionary.RequestSchema.json | 45 ++- docs/api/update-dictionary.StatusCodes.json | 19 +- docs/api/update-dictionary.api.mdx | 44 +-- .../update-entity-schema.ParamsDetails.json | 11 +- .../update-entity-schema.RequestSchema.json | 25 +- .../api/update-entity-schema.StatusCodes.json | 22 +- docs/api/update-entity-schema.api.mdx | 44 +-- docs/api/update-entity.ParamsDetails.json | 11 +- docs/api/update-entity.RequestSchema.json | 30 +- docs/api/update-entity.StatusCodes.json | 27 +- docs/api/update-entity.api.mdx | 44 +-- docs/api/update-policy.ParamsDetails.json | 12 +- docs/api/update-policy.RequestSchema.json | 75 +++- docs/api/update-policy.StatusCodes.json | 22 +- docs/api/update-policy.api.mdx | 44 +-- ...nt-resources-allocation.RequestSchema.json | 109 +++++- ...ount-resources-allocation.StatusCodes.json | 24 +- ...e-the-account-resources-allocation.api.mdx | 44 +-- docs/api/upload-file-part.RequestSchema.json | 59 ++- docs/api/upload-file-part.StatusCodes.json | 89 ++++- docs/api/upload-file-part.api.mdx | 44 +-- docs/api/user-information.ParamsDetails.json | 11 +- docs/api/user-information.RequestSchema.json | 2 +- docs/api/user-information.StatusCodes.json | 84 +++- docs/api/user-information.api.mdx | 45 +-- 403 files changed, 9644 insertions(+), 4385 deletions(-) diff --git a/docs/api/add-entity-data.ParamsDetails.json b/docs/api/add-entity-data.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/add-entity-data.ParamsDetails.json +++ b/docs/api/add-entity-data.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/add-entity-data.RequestSchema.json b/docs/api/add-entity-data.RequestSchema.json index 77f95745..0ae7fc5d 100644 --- a/docs/api/add-entity-data.RequestSchema.json +++ b/docs/api/add-entity-data.RequestSchema.json @@ -1 +1,19 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"monthly_revenue":{"type":"number","example":2345.34},"update_date":{"type":"string","example":"2024-11-01T03:00:00.000Z"}}},"examples":{"Add Entity Data":{"value":{"monthly_revenue":2345.34,"update_date":"2024-11-01T03:00:00.000Z"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "monthly_revenue": { "type": "number", "example": 2345.34 }, + "update_date": { "type": "string", "example": "2024-11-01T03:00:00.000Z" } + } + }, + "examples": { + "Add Entity Data": { "value": { "monthly_revenue": 2345.34, "update_date": "2024-11-01T03:00:00.000Z" } } + } + } + } + } +} diff --git a/docs/api/add-entity-data.StatusCodes.json b/docs/api/add-entity-data.StatusCodes.json index c5349a3e..2f4e731d 100644 --- a/docs/api/add-entity-data.StatusCodes.json +++ b/docs/api/add-entity-data.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Add Entity Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Added"},"status":{"type":"boolean","example":true}}},"examples":{"Add Entity Data":{"value":{"result":"1 Data Added","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Add Entity Data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "1 Data Added" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Add Entity Data": { "value": { "result": "1 Data Added", "status": true } } } + } + } + } + } +} diff --git a/docs/api/add-entity-data.api.mdx b/docs/api/add-entity-data.api.mdx index 312623a7..9fb3b7a3 100644 --- a/docs/api/add-entity-data.api.mdx +++ b/docs/api/add-entity-data.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Add Entity Data - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/configure-profile-service.ParamsDetails.json b/docs/api/configure-profile-service.ParamsDetails.json index ec34447e..c6408deb 100644 --- a/docs/api/configure-profile-service.ParamsDetails.json +++ b/docs/api/configure-profile-service.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "description": "The ID of the profile" + } + ] +} diff --git a/docs/api/configure-profile-service.RequestSchema.json b/docs/api/configure-profile-service.RequestSchema.json index 00540cb0..2546a479 100644 --- a/docs/api/configure-profile-service.RequestSchema.json +++ b/docs/api/configure-profile-service.RequestSchema.json @@ -1 +1,137 @@ -{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"object","description":"Email service configuration","properties":{"provider":{"type":"string","enum":["sendgrid","ses","smtp"],"description":"The email provider to use","example":"smtp"},"from":{"type":"string","description":"Sender email address","example":"noreply@example.com"},"secrets":{"type":"object","description":"Secret IDs for provider credentials","properties":{"data":{"type":"string","description":"Secret ID containing SMTP configuration (required for SMTP provider) or AWS SQS Secret (required for SES provider)","example":"68c9977a28079e0010aaf399"},"api_key":{"type":"string","description":"Secret ID containing SendGrid API Key (required for SendGrid provider)","example":"68c9977a28079e0010aaf399"}}}}},"sms":{"type":"object","description":"SMS service configuration","properties":{"provider":{"type":"string","enum":["twilio","sns"],"description":"The SMS provider to use","example":"twilio"},"from":{"type":"string","description":"Sender phone number in E.164 format (required for Twilio, optional for SNS)","example":"+15551234567"},"secrets":{"type":"object","description":"Secret IDs for provider credentials","properties":{"twilio_sid":{"type":"string","description":"Secret ID containing Twilio Account SID (required for Twilio provider)","example":"674f1740f9ccd2000aaa4551"},"twilio_token":{"type":"string","description":"Secret ID containing Twilio Auth Token (required for Twilio provider)","example":"674f1736f9ccd2000aaa4550"},"data":{"type":"string","description":"Secret ID containing AWS SQS Secret (required for SNS provider)","example":"68c9977a28079e0010aaf399"}}}}}}},"examples":{"Configure SMS and Email":{"value":{"email":{"provider":"smtp","from":"noreply@example.com","secrets":{"data":"68c9977a28079e0010aaf399"}},"sms":{"provider":"twilio","from":"+15551234567","secrets":{"twilio_sid":"674f1740f9ccd2000aaa4551","twilio_token":"674f1736f9ccd2000aaa4550"}}}},"Configure SMS only":{"value":{"sms":{"provider":"twilio","from":"+15551234567","secrets":{"twilio_sid":"674f1740f9ccd2000aaa4551","twilio_token":"674f1736f9ccd2000aaa4550"}}}},"Configure Email with SendGrid":{"value":{"email":{"provider":"sendgrid","from":"noreply@example.com","secrets":{"api_key":"68c9977a28079e0010aaf399"}}}},"Configure Email with SMTP":{"value":{"email":{"provider":"smtp","from":"noreply@example.com","secrets":{"data":"68c9977a28079e0010aaf399"}}}},"Configure Email with SES":{"value":{"email":{"provider":"ses","from":"noreply@example.com","secrets":{"data":"68c9977a28079e0010aaf399"}}}},"Configure SMS with SNS":{"value":{"sms":{"provider":"sns","secrets":{"data":"68c9977a28079e0010aaf399"}}}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "object", + "description": "Email service configuration", + "properties": { + "provider": { + "type": "string", + "enum": ["sendgrid", "ses", "smtp"], + "description": "The email provider to use", + "example": "smtp" + }, + "from": { "type": "string", "description": "Sender email address", "example": "noreply@example.com" }, + "secrets": { + "type": "object", + "description": "Secret IDs for provider credentials", + "properties": { + "data": { + "type": "string", + "description": "Secret ID containing SMTP configuration (required for SMTP provider) or AWS SQS Secret (required for SES provider)", + "example": "68c9977a28079e0010aaf399" + }, + "api_key": { + "type": "string", + "description": "Secret ID containing SendGrid API Key (required for SendGrid provider)", + "example": "68c9977a28079e0010aaf399" + } + } + } + } + }, + "sms": { + "type": "object", + "description": "SMS service configuration", + "properties": { + "provider": { + "type": "string", + "enum": ["twilio", "sns"], + "description": "The SMS provider to use", + "example": "twilio" + }, + "from": { + "type": "string", + "description": "Sender phone number in E.164 format (required for Twilio, optional for SNS)", + "example": "+15551234567" + }, + "secrets": { + "type": "object", + "description": "Secret IDs for provider credentials", + "properties": { + "twilio_sid": { + "type": "string", + "description": "Secret ID containing Twilio Account SID (required for Twilio provider)", + "example": "674f1740f9ccd2000aaa4551" + }, + "twilio_token": { + "type": "string", + "description": "Secret ID containing Twilio Auth Token (required for Twilio provider)", + "example": "674f1736f9ccd2000aaa4550" + }, + "data": { + "type": "string", + "description": "Secret ID containing AWS SQS Secret (required for SNS provider)", + "example": "68c9977a28079e0010aaf399" + } + } + } + } + } + } + }, + "examples": { + "Configure SMS and Email": { + "value": { + "email": { + "provider": "smtp", + "from": "noreply@example.com", + "secrets": { "data": "68c9977a28079e0010aaf399" } + }, + "sms": { + "provider": "twilio", + "from": "+15551234567", + "secrets": { "twilio_sid": "674f1740f9ccd2000aaa4551", "twilio_token": "674f1736f9ccd2000aaa4550" } + } + } + }, + "Configure SMS only": { + "value": { + "sms": { + "provider": "twilio", + "from": "+15551234567", + "secrets": { "twilio_sid": "674f1740f9ccd2000aaa4551", "twilio_token": "674f1736f9ccd2000aaa4550" } + } + } + }, + "Configure Email with SendGrid": { + "value": { + "email": { + "provider": "sendgrid", + "from": "noreply@example.com", + "secrets": { "api_key": "68c9977a28079e0010aaf399" } + } + } + }, + "Configure Email with SMTP": { + "value": { + "email": { + "provider": "smtp", + "from": "noreply@example.com", + "secrets": { "data": "68c9977a28079e0010aaf399" } + } + } + }, + "Configure Email with SES": { + "value": { + "email": { + "provider": "ses", + "from": "noreply@example.com", + "secrets": { "data": "68c9977a28079e0010aaf399" } + } + } + }, + "Configure SMS with SNS": { + "value": { "sms": { "provider": "sns", "secrets": { "data": "68c9977a28079e0010aaf399" } } } + } + } + } + } + } +} diff --git a/docs/api/configure-profile-service.StatusCodes.json b/docs/api/configure-profile-service.StatusCodes.json index 5ccadb6a..6fc4fb34 100644 --- a/docs/api/configure-profile-service.StatusCodes.json +++ b/docs/api/configure-profile-service.StatusCodes.json @@ -1 +1,63 @@ -{"responses":{"200":{"description":"Service provider configured successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Service provider configured successfully"},"status":{"type":"boolean","example":true}}}}}},"400":{"description":"Bad request - Invalid configuration","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid credentials format for the selected provider"}}}}}},"401":{"description":"Unauthorized - Invalid or missing token","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Unauthorized"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"You do not have permission to configure services for this profile"}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Service provider configured successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Service provider configured successfully" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + }, + "400": { + "description": "Bad request - Invalid configuration", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Invalid credentials format for the selected provider" } + } + } + } + } + }, + "401": { + "description": "Unauthorized - Invalid or missing token", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Unauthorized" } + } + } + } + } + }, + "403": { + "description": "Forbidden - Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { + "type": "string", + "example": "You do not have permission to configure services for this profile" + } + } + } + } + } + } + } +} diff --git a/docs/api/configure-profile-service.api.mdx b/docs/api/configure-profile-service.api.mdx index e409d708..8c215422 100644 --- a/docs/api/configure-profile-service.api.mdx +++ b/docs/api/configure-profile-service.api.mdx @@ -20,73 +20,42 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Configure external service providers for your profile. This allows you to set up integrations with third-party services for SMS and Email messaging. **Available service providers:** -| Service Type | Provider | Description | -|--------------|----------|-------------| -| `sms` | Twilio | Send SMS messages via Twilio | -| `sms` | SNS | Send SMS messages via Amazon SNS | -| `email` | SendGrid | Send emails via SendGrid API | -| `email` | SES | Send emails via Amazon SES | -| `email` | SMTP | Send emails via custom SMTP server | +| Service Type | Provider | Description | +| ------------ | -------- | ---------------------------------- | +| `sms` | Twilio | Send SMS messages via Twilio | +| `sms` | SNS | Send SMS messages via Amazon SNS | +| `email` | SendGrid | Send emails via SendGrid API | +| `email` | SES | Send emails via Amazon SES | +| `email` | SMTP | Send emails via custom SMTP server | **Important notes:** + - Credentials are securely stored using [TagoIO Secrets](/docs/tagoio/getting-started/secrets). You must create the appropriate secrets before configuring a service provider. - Each service type can only have one active provider configuration at a time - Use the test endpoint to verify your configuration before using it in production **Required secrets by provider:** + - **Twilio SMS**: Create two Text secrets containing your Twilio SID and Auth Token - **SNS SMS**: Create an AWS SQS Secret with your AWS credentials (region, access key, secret key) - **SendGrid Email**: Create a Text secret containing your SendGrid API Key - **SES Email**: Create an AWS SQS Secret with your AWS credentials (region, access key, secret key) - **SMTP Email**: Create an SMTP Secret with your server configuration - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/convert-device-type.ParamsDetails.json b/docs/api/convert-device-type.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/convert-device-type.ParamsDetails.json +++ b/docs/api/convert-device-type.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/convert-device-type.RequestSchema.json b/docs/api/convert-device-type.RequestSchema.json index 4d8fb574..3250b73b 100644 --- a/docs/api/convert-device-type.RequestSchema.json +++ b/docs/api/convert-device-type.RequestSchema.json @@ -1 +1,30 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","title":"ConvertDeviceTypeRequest","properties":{"type":{"type":"string","example":"immutable"},"chunk_period":{"type":"string","example":"quarter","description":"Only required when converting to immutable. Defines the period for data chunking (e.g., quarter, month, year)."},"chunk_retention":{"type":"number","example":4,"description":"Only required when converting to immutable. Number of chunk periods to retain."}}},"examples":{"Convert to Immutable":{"value":{"type":"immutable","chunk_period":"quarter","chunk_retention":4}},"Convert to Mutable":{"value":{"type":"mutable"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ConvertDeviceTypeRequest", + "properties": { + "type": { "type": "string", "example": "immutable" }, + "chunk_period": { + "type": "string", + "example": "quarter", + "description": "Only required when converting to immutable. Defines the period for data chunking (e.g., quarter, month, year)." + }, + "chunk_retention": { + "type": "number", + "example": 4, + "description": "Only required when converting to immutable. Number of chunk periods to retain." + } + } + }, + "examples": { + "Convert to Immutable": { "value": { "type": "immutable", "chunk_period": "quarter", "chunk_retention": 4 } }, + "Convert to Mutable": { "value": { "type": "mutable" } } + } + } + } + } +} diff --git a/docs/api/convert-device-type.StatusCodes.json b/docs/api/convert-device-type.StatusCodes.json index b18b678b..de1c519e 100644 --- a/docs/api/convert-device-type.StatusCodes.json +++ b/docs/api/convert-device-type.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Converting a device type","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Device type/chunk was converted"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Converting a device type", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Device type/chunk was converted" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/convert-device-type.api.mdx b/docs/api/convert-device-type.api.mdx index 15ca71fa..253b86a8 100644 --- a/docs/api/convert-device-type.api.mdx +++ b/docs/api/convert-device-type.api.mdx @@ -20,53 +20,21 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Convert the device immutable or mutable. The device must be empty before being converted. You can empty your device through your device's page. The Device-Token is preserved when converting using this route. The device must be disabled before being converted. You can disable the device by going to the device's page and turn off the active switch. - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-and-edit-device-params.ParamsDetails.json b/docs/api/create-and-edit-device-params.ParamsDetails.json index e4d00ef5..b70e0621 100644 --- a/docs/api/create-and-edit-device-params.ParamsDetails.json +++ b/docs/api/create-and-edit-device-params.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"(Type your device ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your device ID)" } + } + ] +} diff --git a/docs/api/create-and-edit-device-params.RequestSchema.json b/docs/api/create-and-edit-device-params.RequestSchema.json index 9b359aa6..f5fca7aa 100644 --- a/docs/api/create-and-edit-device-params.RequestSchema.json +++ b/docs/api/create-and-edit-device-params.RequestSchema.json @@ -1 +1,23 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"62aba74d84acd30011ac593f"},"key":{"type":"string","example":"updatedKey"},"sent":{"type":"boolean","example":false},"value":{"type":"string","example":"updatedValue"}}},"examples":{"Create and Edit Device Params":{"value":{"id":"62aba74d84acd30011ac593f","key":"updatedKey","sent":false,"value":"updatedValue"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "62aba74d84acd30011ac593f" }, + "key": { "type": "string", "example": "updatedKey" }, + "sent": { "type": "boolean", "example": false }, + "value": { "type": "string", "example": "updatedValue" } + } + }, + "examples": { + "Create and Edit Device Params": { + "value": { "id": "62aba74d84acd30011ac593f", "key": "updatedKey", "sent": false, "value": "updatedValue" } + } + } + } + } + } +} diff --git a/docs/api/create-and-edit-device-params.StatusCodes.json b/docs/api/create-and-edit-device-params.StatusCodes.json index 454d169e..55433784 100644 --- a/docs/api/create-and-edit-device-params.StatusCodes.json +++ b/docs/api/create-and-edit-device-params.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"201":{"description":"Creating or editing device parameters","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Params Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "201": { + "description": "Creating or editing device parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Params Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-and-edit-device-params.api.mdx b/docs/api/create-and-edit-device-params.api.mdx index c90f99aa..5b892151 100644 --- a/docs/api/create-and-edit-device-params.api.mdx +++ b/docs/api/create-and-edit-device-params.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create and edit params for the device - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-dashboard-widget.ParamsDetails.json b/docs/api/create-dashboard-widget.ParamsDetails.json index ad79fd90..90c109ae 100644 --- a/docs/api/create-dashboard-widget.ParamsDetails.json +++ b/docs/api/create-dashboard-widget.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + } + ] +} diff --git a/docs/api/create-dashboard-widget.RequestSchema.json b/docs/api/create-dashboard-widget.RequestSchema.json index 91cf3e0e..e9abc584 100644 --- a/docs/api/create-dashboard-widget.RequestSchema.json +++ b/docs/api/create-dashboard-widget.RequestSchema.json @@ -1 +1,72 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"analysis_run":{"type":"string","example":"Analysis to trigger when a button is pressed. Used by Form and Dynamic Table widgets."},"dashboard":{"type":"string","description":"Your Dashboard ID"},"data":{"type":"array","items":{"type":"object"},"description":"Data that will be available to your widget."},"display":{"type":"object","description":"The display property of your widget. Each widget has it's unique properties."},"id":{"type":"string"},"label":{"type":"string","example":"Title Label of the Widget"},"realtime":{"type":"boolean","example":true},"type":{"type":"string","example":"The widget unique type."}}},"examples":{"Card Widget Example":{"value":{"analysis_run":null,"display":{"alias":"Ice Cream","header_buttons":[{"color":null,"icon":"","text":"","trigger":"widget","widget":null}],"help":"You can edit this widget to add a message here","frame_settings":{"shadow":{"hide":false},"header_visibility":"show_always"},"theme":{"color":{"background":"hsl(210, 12%, 12%)","header":"hsl(210, 65%, 60%)","text":"hsl(210, 20%, 92%)"}},"show_variables":true,"formula":{"enable":false,"unit_type":"origin","fixed_unit":"","apply_all_matching_formulas":false},"number_format":{"decimals":-1,"show_thousand":false},"max_points":10,"show_chart":true,"show_unit":true,"url":"","variable":"temperature"},"data":[{"qty":10,"origin":"68c9baabb24379000ab1c8cc","variables":["temperature"]}],"resource":[],"id":"68c9bab8fe8818000a7ec597","label":"Temperature","realtime":null,"type":"card","cache":null}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "analysis_run": { + "type": "string", + "example": "Analysis to trigger when a button is pressed. Used by Form and Dynamic Table widgets." + }, + "dashboard": { "type": "string", "description": "Your Dashboard ID" }, + "data": { + "type": "array", + "items": { "type": "object" }, + "description": "Data that will be available to your widget." + }, + "display": { + "type": "object", + "description": "The display property of your widget. Each widget has it's unique properties." + }, + "id": { "type": "string" }, + "label": { "type": "string", "example": "Title Label of the Widget" }, + "realtime": { "type": "boolean", "example": true }, + "type": { "type": "string", "example": "The widget unique type." } + } + }, + "examples": { + "Card Widget Example": { + "value": { + "analysis_run": null, + "display": { + "alias": "Ice Cream", + "header_buttons": [{ "color": null, "icon": "", "text": "", "trigger": "widget", "widget": null }], + "help": "You can edit this widget to add a message here", + "frame_settings": { "shadow": { "hide": false }, "header_visibility": "show_always" }, + "theme": { + "color": { + "background": "hsl(210, 12%, 12%)", + "header": "hsl(210, 65%, 60%)", + "text": "hsl(210, 20%, 92%)" + } + }, + "show_variables": true, + "formula": { + "enable": false, + "unit_type": "origin", + "fixed_unit": "", + "apply_all_matching_formulas": false + }, + "number_format": { "decimals": -1, "show_thousand": false }, + "max_points": 10, + "show_chart": true, + "show_unit": true, + "url": "", + "variable": "temperature" + }, + "data": [{ "qty": 10, "origin": "68c9baabb24379000ab1c8cc", "variables": ["temperature"] }], + "resource": [], + "id": "68c9bab8fe8818000a7ec597", + "label": "Temperature", + "realtime": null, + "type": "card", + "cache": null + } + } + } + } + } + } +} diff --git a/docs/api/create-dashboard-widget.StatusCodes.json b/docs/api/create-dashboard-widget.StatusCodes.json index b57cc020..d8fc1553 100644 --- a/docs/api/create-dashboard-widget.StatusCodes.json +++ b/docs/api/create-dashboard-widget.StatusCodes.json @@ -1 +1 @@ -{"responses":{"200":{"description":""}}} \ No newline at end of file +{ "responses": { "200": { "description": "" } } } diff --git a/docs/api/create-dashboard-widget.api.mdx b/docs/api/create-dashboard-widget.api.mdx index af068d11..edff15a3 100644 --- a/docs/api/create-dashboard-widget.api.mdx +++ b/docs/api/create-dashboard-widget.api.mdx @@ -20,22 +20,9 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create a widget within a specific dashboard in your profile. Each widget has unique properties. To ensure accuracy, we recommend opening your Admin Developer Panel, navigating to the desired Dashboard, and copying the Widget's JSON structure directly. @@ -43,32 +30,12 @@ Each widget has unique properties. To ensure accuracy, we recommend opening your After you create a widget, it is not automatically added to the dashboard's Arrangement parameter. You must manually edit the dashboard arrangement to include the widget's position in the grid. ::: - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-dashboard.RequestSchema.json b/docs/api/create-dashboard.RequestSchema.json index ee78d7c7..33d3871f 100644 --- a/docs/api/create-dashboard.RequestSchema.json +++ b/docs/api/create-dashboard.RequestSchema.json @@ -1 +1,93 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["label","type"],"properties":{"group_by":{"type":"array","items":{},"description":"List of tags to group in the sidebar","example":[]},"icon":{"type":"object","properties":{"color":{"type":"string","example":"hsl(328, 89%, 47%)"},"url":{"type":"string","example":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"}}},"label":{"type":"string","example":"Tracker dashboard"},"tabs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"1648142133869"},"link":{"type":"string","example":""},"value":{"type":"string","example":"tab test"}}},"example":[{"key":"1648142133869","link":"","value":"tab test"},{"key":"1648142564354","link":"","value":"tab 2 "},{"key":"1648142571171","link":"","value":"tab 3 "}]},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"vehicle"},"value":{"type":"string","example":"gas"}}},"example":[{"key":"vehicle","value":"gas"},{"key":"speed","value":"mph"}]},"type":{"type":"string","enum":["dashboard","blueprint"],"example":"blueprint","description":"The type of dashboard. Can be \"dashboard\" or \"blueprint\"."},"visible":{"type":"boolean","example":true,"default":true}}},"examples":{"Create Dashboard":{"value":{"group_by":[],"icon":{"color":"hsl(328, 89%, 47%)","url":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"},"label":"Tracker dashboard","profile":"612ea05e3cc0780012715111","tabs":[{"key":"1648142133869","link":"","value":"tab test"},{"key":"1648142564354","link":"","value":"tab 2 "},{"key":"1648142571171","link":"","value":"tab 3 "}],"tags":[{"key":"vehicle","value":"gas"},{"key":"speed","value":"mph"}],"type":"dashboard","visible":true}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["label", "type"], + "properties": { + "group_by": { + "type": "array", + "items": {}, + "description": "List of tags to group in the sidebar", + "example": [] + }, + "icon": { + "type": "object", + "properties": { + "color": { "type": "string", "example": "hsl(328, 89%, 47%)" }, + "url": { + "type": "string", + "example": "https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg" + } + } + }, + "label": { "type": "string", "example": "Tracker dashboard" }, + "tabs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "1648142133869" }, + "link": { "type": "string", "example": "" }, + "value": { "type": "string", "example": "tab test" } + } + }, + "example": [ + { "key": "1648142133869", "link": "", "value": "tab test" }, + { "key": "1648142564354", "link": "", "value": "tab 2 " }, + { "key": "1648142571171", "link": "", "value": "tab 3 " } + ] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "vehicle" }, + "value": { "type": "string", "example": "gas" } + } + }, + "example": [ + { "key": "vehicle", "value": "gas" }, + { "key": "speed", "value": "mph" } + ] + }, + "type": { + "type": "string", + "enum": ["dashboard", "blueprint"], + "example": "blueprint", + "description": "The type of dashboard. Can be \"dashboard\" or \"blueprint\"." + }, + "visible": { "type": "boolean", "example": true, "default": true } + } + }, + "examples": { + "Create Dashboard": { + "value": { + "group_by": [], + "icon": { + "color": "hsl(328, 89%, 47%)", + "url": "https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg" + }, + "label": "Tracker dashboard", + "profile": "612ea05e3cc0780012715111", + "tabs": [ + { "key": "1648142133869", "link": "", "value": "tab test" }, + { "key": "1648142564354", "link": "", "value": "tab 2 " }, + { "key": "1648142571171", "link": "", "value": "tab 3 " } + ], + "tags": [ + { "key": "vehicle", "value": "gas" }, + { "key": "speed", "value": "mph" } + ], + "type": "dashboard", + "visible": true + } + } + } + } + } + } +} diff --git a/docs/api/create-dashboard.StatusCodes.json b/docs/api/create-dashboard.StatusCodes.json index 672affce..1d7f8432 100644 --- a/docs/api/create-dashboard.StatusCodes.json +++ b/docs/api/create-dashboard.StatusCodes.json @@ -1 +1,26 @@ -{"responses":{"201":{"description":"Creating a dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"dashboard":{"type":"string","example":"614e0aa36f480300126652f9a38"}}},"status":{"type":"boolean","example":true}}},"examples":{"Creating a dashboard":{"value":{"result":{"dashboard":"614e0aa36f480300126652f9a38"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "201": { + "description": "Creating a dashboard", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "dashboard": { "type": "string", "example": "614e0aa36f480300126652f9a38" } } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Creating a dashboard": { + "value": { "result": { "dashboard": "614e0aa36f480300126652f9a38" }, "status": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-dashboard.api.mdx b/docs/api/create-dashboard.api.mdx index 40da06a6..c62a16cd 100644 --- a/docs/api/create-dashboard.api.mdx +++ b/docs/api/create-dashboard.api.mdx @@ -20,53 +20,20 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Creates a dashboard of type Blueprint or Normal Dashboard into your profile. It's recommended to access your Admin Developer panel and Copy the Dashboard JSON Structure to see all available fields. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-dictionary.RequestSchema.json b/docs/api/create-dictionary.RequestSchema.json index cd6a73f8..5c9a9cb5 100644 --- a/docs/api/create-dictionary.RequestSchema.json +++ b/docs/api/create-dictionary.RequestSchema.json @@ -1 +1,39 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["name","slug"],"properties":{"name":{"type":"string","example":"dic.DICT"},"slug":{"type":"string","example":"DIC"},"fallback":{"type":"string","example":"fr-FR"},"languages":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"fr-FR"},"message":{"type":"string","example":"true"}}},"example":[{"code":"fr-FR","message":"true"}]}}},"examples":{"Create Dictionary":{"value":{"fallback":"fr-FR","languages":[{"code":"fr-FR","message":"true"}],"name":"dic.DICT","slug":"DIC"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["name", "slug"], + "properties": { + "name": { "type": "string", "example": "dic.DICT" }, + "slug": { "type": "string", "example": "DIC" }, + "fallback": { "type": "string", "example": "fr-FR" }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { "type": "string", "example": "fr-FR" }, + "message": { "type": "string", "example": "true" } + } + }, + "example": [{ "code": "fr-FR", "message": "true" }] + } + } + }, + "examples": { + "Create Dictionary": { + "value": { + "fallback": "fr-FR", + "languages": [{ "code": "fr-FR", "message": "true" }], + "name": "dic.DICT", + "slug": "DIC" + } + } + } + } + } + } +} diff --git a/docs/api/create-dictionary.StatusCodes.json b/docs/api/create-dictionary.StatusCodes.json index b20bda4e..53d49243 100644 --- a/docs/api/create-dictionary.StatusCodes.json +++ b/docs/api/create-dictionary.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"201":{"description":"Creating a dictionary","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"dictionary":{"type":"string","example":"654bdc4449769c00097fee32"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "201": { + "description": "Creating a dictionary", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "dictionary": { "type": "string", "example": "654bdc4449769c00097fee32" } } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-dictionary.api.mdx b/docs/api/create-dictionary.api.mdx index 78504d7e..f750e934 100644 --- a/docs/api/create-dictionary.api.mdx +++ b/docs/api/create-dictionary.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create Dictionary - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-entity.RequestSchema.json b/docs/api/create-entity.RequestSchema.json index 4ea6fa4a..e40bc6d1 100644 --- a/docs/api/create-entity.RequestSchema.json +++ b/docs/api/create-entity.RequestSchema.json @@ -1 +1,75 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"2938924293"},"index":{"type":"object","properties":{"index_charge_amount":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"charge_amount"},"example":["charge_amount"]}}}}},"name":{"type":"string","example":"Control Entity"},"schema":{"type":"object","properties":{"charge_amount":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"int"}}},"update_date":{"type":"object","properties":{"required":{"type":"boolean","example":true},"type":{"type":"string","example":"timestamp"}}}}},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"yes"}}},"example":[{"key":"active","value":"yes"}]}}},"examples":{"Create Entity":{"value":{"id":"2938924293","index":{"index_charge_amount":{"fields":["charge_amount"]}},"name":"Control Entity","schema":{"charge_amount":{"required":false,"type":"int"},"update_date":{"required":true,"type":"timestamp"}},"tags":[{"key":"active","value":"yes"}]}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "2938924293" }, + "index": { + "type": "object", + "properties": { + "index_charge_amount": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { "type": "string", "example": "charge_amount" }, + "example": ["charge_amount"] + } + } + } + } + }, + "name": { "type": "string", "example": "Control Entity" }, + "schema": { + "type": "object", + "properties": { + "charge_amount": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": false }, + "type": { "type": "string", "example": "int" } + } + }, + "update_date": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": true }, + "type": { "type": "string", "example": "timestamp" } + } + } + } + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "active" }, + "value": { "type": "string", "example": "yes" } + } + }, + "example": [{ "key": "active", "value": "yes" }] + } + } + }, + "examples": { + "Create Entity": { + "value": { + "id": "2938924293", + "index": { "index_charge_amount": { "fields": ["charge_amount"] } }, + "name": "Control Entity", + "schema": { + "charge_amount": { "required": false, "type": "int" }, + "update_date": { "required": true, "type": "timestamp" } + }, + "tags": [{ "key": "active", "value": "yes" }] + } + } + } + } + } + } +} diff --git a/docs/api/create-entity.StatusCodes.json b/docs/api/create-entity.StatusCodes.json index a4bfb869..d1a23a44 100644 --- a/docs/api/create-entity.StatusCodes.json +++ b/docs/api/create-entity.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Creating an entity","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","example":"672a64b91807cd7008bae4d5"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Creating an entity", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "id": { "type": "string", "example": "672a64b91807cd7008bae4d5" } } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-entity.api.mdx b/docs/api/create-entity.api.mdx index a4b17874..0291bc50 100644 --- a/docs/api/create-entity.api.mdx +++ b/docs/api/create-entity.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create Entity - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-new-device.RequestSchema.json b/docs/api/create-new-device.RequestSchema.json index 140ce74f..4897ebfb 100644 --- a/docs/api/create-new-device.RequestSchema.json +++ b/docs/api/create-new-device.RequestSchema.json @@ -1 +1,164 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"oneOf":[{"title":"Immutable Device Creation","type":"object","required":["name","type","network","connector","chunk_period","chunk_retention"],"properties":{"name":{"type":"string","description":"Device name","example":"My first immutable device"},"type":{"type":"string","enum":["immutable"],"description":"Device type - must be 'immutable' for immutable devices","example":"immutable"},"network":{"type":"string","description":"Network ID where the device will be created","example":"5bbd0d144051a50034cd19fb"},"connector":{"type":"string","description":"Connector ID for the device","example":"5f5a8f3351d4db99c40dece5"},"chunk_period":{"type":"string","enum":["day","week","month","quarter"],"description":"Chunk period for data storage - one of day, week, month, quarter","example":"quarter"},"chunk_retention":{"type":"number","minimum":0,"maximum":36,"description":"Number of chunks to retain (0-36)","example":36},"serie_number":{"type":"string","description":"Serial number - only required if specified by the network","example":"AB87392C17CA"},"tags":{"type":"array","description":"Device tags as key-value string pairs","items":{"type":"object","properties":{"key":{"type":"string","description":"Tag key","example":"tagKey1"},"value":{"type":"string","description":"Tag value","example":"value1"}}},"example":[{"key":"tagKey1","value":"value1"},{"key":"tagKey2","value":"value2"}]}}},{"title":"Mutable Device Creation","type":"object","required":["name","type","network","connector"],"properties":{"name":{"type":"string","description":"Device name","example":"My first device"},"type":{"type":"string","enum":["mutable"],"description":"Device type - must be 'mutable' for mutable devices","example":"mutable"},"network":{"type":"string","description":"Network ID where the device will be created","example":"5bbd0d144051a50034cd19fb"},"connector":{"type":"string","description":"Connector ID for the device","example":"5f5a8f3351d4db99c40dece5"},"serie_number":{"type":"string","description":"Serial number - only required if specified by the network","example":"AB87392C12CA"},"active":{"type":"boolean","description":"Device active status","example":true},"payload_decoder":{"type":"string","description":"Base64 encoded payload decoder function"},"tags":{"type":"array","description":"Device tags","items":{"type":"object","properties":{"key":{"type":"string","example":"tagKey1"},"value":{"type":"string","example":"value1"}}},"example":[{"key":"tagKey1","value":"value1"},{"key":"tagKey2","value":"value2"}]},"visible":{"type":"boolean","description":"Device visibility status","example":true}}}]},"examples":{"Create Immutable Device":{"value":{"name":"My first immutable device","type":"immutable","network":"5bbd0d144051a50034cd19fb","connector":"5f5a8f3351d4db99c40dece5","chunk_period":"quarter","chunk_retention":36,"serie_number":"AB87392C17CA"}},"Create Mutable Device":{"value":{"name":"My first device","type":"mutable","network":"5bbd0d144051a50034cd19fb","connector":"5f5a8f3351d4db99c40dece5","serie_number":"AB87392C12CA"}},"Create Mutable Device with Parse Function":{"value":{"name":"Mutable device","type":"mutable","network":"5bbd0d144051a50034cd19fb","connector":"5f5a8f3351d4db99c40dece5","action":true,"active":true,"visible":true,"tags":[{"key":"tagKey1","value":"value1"},{"key":"tagKey2","value":"value2"}]}}}},"text/plain":{"examples":{"Create Immutable Device":{"value":"{\r\n \"name\": \"My first immutable device\",\r\n \"type\": \"immutable\",\r\n \"network\": \"5bbd0d144051a50034cd19fb\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"chunk_period\": \"quarter\", //define a chunk period by \"day\",\"week\", \"month\", \"quarter\"\r\n \"chunk_retention\": 36, //acceptable range between 0-36\r\n \"serie_number\": \"AB87392C17CA\" //only if required by network (optional)\r\n }"},"Create Mutable Device":{"value":"{\r\n \"name\": \"My first device\",\r\n \"type\": \"mutable\",\r\n \"network\": \"5bbd0d144051a50034cd19fb\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"serie_number\": \"AB87392C12CA\" //only if required by network (optional)\r\n }"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Immutable Device Creation", + "type": "object", + "required": ["name", "type", "network", "connector", "chunk_period", "chunk_retention"], + "properties": { + "name": { "type": "string", "description": "Device name", "example": "My first immutable device" }, + "type": { + "type": "string", + "enum": ["immutable"], + "description": "Device type - must be 'immutable' for immutable devices", + "example": "immutable" + }, + "network": { + "type": "string", + "description": "Network ID where the device will be created", + "example": "5bbd0d144051a50034cd19fb" + }, + "connector": { + "type": "string", + "description": "Connector ID for the device", + "example": "5f5a8f3351d4db99c40dece5" + }, + "chunk_period": { + "type": "string", + "enum": ["day", "week", "month", "quarter"], + "description": "Chunk period for data storage - one of day, week, month, quarter", + "example": "quarter" + }, + "chunk_retention": { + "type": "number", + "minimum": 0, + "maximum": 36, + "description": "Number of chunks to retain (0-36)", + "example": 36 + }, + "serie_number": { + "type": "string", + "description": "Serial number - only required if specified by the network", + "example": "AB87392C17CA" + }, + "tags": { + "type": "array", + "description": "Device tags as key-value string pairs", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "description": "Tag key", "example": "tagKey1" }, + "value": { "type": "string", "description": "Tag value", "example": "value1" } + } + }, + "example": [ + { "key": "tagKey1", "value": "value1" }, + { "key": "tagKey2", "value": "value2" } + ] + } + } + }, + { + "title": "Mutable Device Creation", + "type": "object", + "required": ["name", "type", "network", "connector"], + "properties": { + "name": { "type": "string", "description": "Device name", "example": "My first device" }, + "type": { + "type": "string", + "enum": ["mutable"], + "description": "Device type - must be 'mutable' for mutable devices", + "example": "mutable" + }, + "network": { + "type": "string", + "description": "Network ID where the device will be created", + "example": "5bbd0d144051a50034cd19fb" + }, + "connector": { + "type": "string", + "description": "Connector ID for the device", + "example": "5f5a8f3351d4db99c40dece5" + }, + "serie_number": { + "type": "string", + "description": "Serial number - only required if specified by the network", + "example": "AB87392C12CA" + }, + "active": { "type": "boolean", "description": "Device active status", "example": true }, + "payload_decoder": { "type": "string", "description": "Base64 encoded payload decoder function" }, + "tags": { + "type": "array", + "description": "Device tags", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "tagKey1" }, + "value": { "type": "string", "example": "value1" } + } + }, + "example": [ + { "key": "tagKey1", "value": "value1" }, + { "key": "tagKey2", "value": "value2" } + ] + }, + "visible": { "type": "boolean", "description": "Device visibility status", "example": true } + } + } + ] + }, + "examples": { + "Create Immutable Device": { + "value": { + "name": "My first immutable device", + "type": "immutable", + "network": "5bbd0d144051a50034cd19fb", + "connector": "5f5a8f3351d4db99c40dece5", + "chunk_period": "quarter", + "chunk_retention": 36, + "serie_number": "AB87392C17CA" + } + }, + "Create Mutable Device": { + "value": { + "name": "My first device", + "type": "mutable", + "network": "5bbd0d144051a50034cd19fb", + "connector": "5f5a8f3351d4db99c40dece5", + "serie_number": "AB87392C12CA" + } + }, + "Create Mutable Device with Parse Function": { + "value": { + "name": "Mutable device", + "type": "mutable", + "network": "5bbd0d144051a50034cd19fb", + "connector": "5f5a8f3351d4db99c40dece5", + "action": true, + "active": true, + "visible": true, + "tags": [ + { "key": "tagKey1", "value": "value1" }, + { "key": "tagKey2", "value": "value2" } + ] + } + } + } + }, + "text/plain": { + "examples": { + "Create Immutable Device": { + "value": "{\r\n \"name\": \"My first immutable device\",\r\n \"type\": \"immutable\",\r\n \"network\": \"5bbd0d144051a50034cd19fb\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"chunk_period\": \"quarter\", //define a chunk period by \"day\",\"week\", \"month\", \"quarter\"\r\n \"chunk_retention\": 36, //acceptable range between 0-36\r\n \"serie_number\": \"AB87392C17CA\" //only if required by network (optional)\r\n }" + }, + "Create Mutable Device": { + "value": "{\r\n \"name\": \"My first device\",\r\n \"type\": \"mutable\",\r\n \"network\": \"5bbd0d144051a50034cd19fb\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"serie_number\": \"AB87392C12CA\" //only if required by network (optional)\r\n }" + } + } + } + } + } +} diff --git a/docs/api/create-new-device.StatusCodes.json b/docs/api/create-new-device.StatusCodes.json index 94c6c6d3..6f7ecdc6 100644 --- a/docs/api/create-new-device.StatusCodes.json +++ b/docs/api/create-new-device.StatusCodes.json @@ -1 +1,24 @@ -{"responses":{"201":{"description":"Mutable device created / Mutable device created with parse function / Immutable device created","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"deviceID":{"type":"string","example":"5dcad1c216174c001ca23ab9"},"token":{"type":"string","example":"5a16405f-b32c-4c91-ae39-cbb2caba18d8"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "201": { + "description": "Mutable device created / Mutable device created with parse function / Immutable device created", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "deviceID": { "type": "string", "example": "5dcad1c216174c001ca23ab9" }, + "token": { "type": "string", "example": "5a16405f-b32c-4c91-ae39-cbb2caba18d8" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-new-device.api.mdx b/docs/api/create-new-device.api.mdx index 7deac22e..e16d890f 100644 --- a/docs/api/create-new-device.api.mdx +++ b/docs/api/create-new-device.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings. - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-notification.RequestSchema.json b/docs/api/create-notification.RequestSchema.json index 139289f3..f8d2bd8a 100644 --- a/docs/api/create-notification.RequestSchema.json +++ b/docs/api/create-notification.RequestSchema.json @@ -1 +1,65 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"buttons":{"type":"array","items":{"type":"object","properties":{"analysis":{"type":"string","example":"5515de2676ab4e3211109e41c"},"color":{"type":"string","example":"green"},"id":{"type":"string","example":"btn_1249384"},"label":{"type":"string","example":"Acknowledge"}}},"example":[{"analysis":"5515de2676ab4e3211109e41c","color":"green","id":"btn_1249384","label":"Acknowledge"}]},"buttons_autodisable":{"type":"boolean","example":true},"buttons_enabled":{"type":"boolean","example":true},"message":{"type":"string","example":"The temperature is lower than 18ºC."},"run_user":{"type":"string","example":"614edef8749df6a30280012a3caef"},"title":{"type":"string","example":"Low Temperature"}}},"examples":{"Create Notification":{"value":{"buttons":[{"analysis":"5515de2676ab4e3211109e41c","color":"green","id":"btn_1249384","label":"Acknowledge"}],"buttons_autodisable":true,"buttons_enabled":true,"message":"The temperature is lower than 18ºC.","run_user":"614edef8749df6a30280012a3caef","title":"Low Temperature"}}}},"text/plain":{"examples":{"Create Notification":{"value":"{\r\n \"run_user\": \"\",\r\n \"title\": \"notification title\",\r\n \"message\": \"message to be read\",\r\n \"buttons\": [ // optional\r\n {\r\n \"label\": \"label of the button\",\r\n \"id\": \"id_of_the_button\", // no space allowed\r\n \"color\": \"color of the button\", //hexadecimal allowed\r\n \"url\": \"url to redirect the user\", //optional\r\n \"analysis\": \"analysis to run when clicked\" //optional\r\n }\r\n ],\r\n \"buttons_enabled\": true, // optional\r\n \"buttons_autodisable\": true // optional\r\n}"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "buttons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "analysis": { "type": "string", "example": "5515de2676ab4e3211109e41c" }, + "color": { "type": "string", "example": "green" }, + "id": { "type": "string", "example": "btn_1249384" }, + "label": { "type": "string", "example": "Acknowledge" } + } + }, + "example": [ + { + "analysis": "5515de2676ab4e3211109e41c", + "color": "green", + "id": "btn_1249384", + "label": "Acknowledge" + } + ] + }, + "buttons_autodisable": { "type": "boolean", "example": true }, + "buttons_enabled": { "type": "boolean", "example": true }, + "message": { "type": "string", "example": "The temperature is lower than 18ºC." }, + "run_user": { "type": "string", "example": "614edef8749df6a30280012a3caef" }, + "title": { "type": "string", "example": "Low Temperature" } + } + }, + "examples": { + "Create Notification": { + "value": { + "buttons": [ + { + "analysis": "5515de2676ab4e3211109e41c", + "color": "green", + "id": "btn_1249384", + "label": "Acknowledge" + } + ], + "buttons_autodisable": true, + "buttons_enabled": true, + "message": "The temperature is lower than 18ºC.", + "run_user": "614edef8749df6a30280012a3caef", + "title": "Low Temperature" + } + } + } + }, + "text/plain": { + "examples": { + "Create Notification": { + "value": "{\r\n \"run_user\": \"\",\r\n \"title\": \"notification title\",\r\n \"message\": \"message to be read\",\r\n \"buttons\": [ // optional\r\n {\r\n \"label\": \"label of the button\",\r\n \"id\": \"id_of_the_button\", // no space allowed\r\n \"color\": \"color of the button\", //hexadecimal allowed\r\n \"url\": \"url to redirect the user\", //optional\r\n \"analysis\": \"analysis to run when clicked\" //optional\r\n }\r\n ],\r\n \"buttons_enabled\": true, // optional\r\n \"buttons_autodisable\": true // optional\r\n}" + } + } + } + } + } +} diff --git a/docs/api/create-notification.StatusCodes.json b/docs/api/create-notification.StatusCodes.json index 4db324f0..c628a526 100644 --- a/docs/api/create-notification.StatusCodes.json +++ b/docs/api/create-notification.StatusCodes.json @@ -1 +1,26 @@ -{"responses":{"200":{"description":"Creating a RUN notification","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string","example":"3415de2676ff4e2001109e63b"}}},"status":{"type":"boolean","example":true}}},"examples":{"Creating a RUN notification":{"value":{"result":{"id":"3415de2676ff4e2001109e63b"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Creating a RUN notification", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "id": { "type": "string", "example": "3415de2676ff4e2001109e63b" } } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Creating a RUN notification": { + "value": { "result": { "id": "3415de2676ff4e2001109e63b" }, "status": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-notification.api.mdx b/docs/api/create-notification.api.mdx index 3bde6e8e..5729be78 100644 --- a/docs/api/create-notification.api.mdx +++ b/docs/api/create-notification.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create Notification for an user - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-policy.RequestSchema.json b/docs/api/create-policy.RequestSchema.json index a69b5b51..8c8932ab 100644 --- a/docs/api/create-policy.RequestSchema.json +++ b/docs/api/create-policy.RequestSchema.json @@ -1 +1,193 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"User Policy","required":["name","permissions","targets","active"],"properties":{"name":{"type":"string","description":"Name of the policy","example":"User permissions"},"permissions":{"type":"array","description":"Array of permission objects","items":{"type":"object","properties":{"effect":{"type":"string","enum":["allow","deny"],"description":"Allow or deny the permission","example":"allow"},"action":{"type":"array","items":{"type":"string"},"description":"Actions allowed: access, edit, delete, create","example":["access"]},"resource":{"type":"array","items":{"type":"string"},"description":"Resources: device, dashboard, analysis, run_user, etc.","example":["device"]}}}},"targets":{"type":"array","description":"Global: [\"run_user\"]. Specific: [\"run_user\", \"id\", \"user_id\"]. Tag-based: [\"run_user\", \"tag_match\", \"tag_key\"]","items":{"type":"array","items":{"type":"string"},"example":["run_user"]},"example":[["run_user"]]},"tags":{"type":"array","description":"Optional tags for targeting specific users/analysis","items":{"type":"object","properties":{"key":{"type":"string","description":"Tag key","example":"user"},"value":{"type":"string","description":"Tag value","example":"admin"}}},"example":[{"key":"user","value":"admin"}]},"active":{"type":"boolean","description":"Whether the policy is active","example":true}}},{"type":"object","title":"Analysis Policy","required":["name","permissions","targets","active"],"properties":{"name":{"type":"string","description":"Name of the policy","example":"Policy"},"permissions":{"type":"array","description":"Array of permission objects","items":{"type":"object","properties":{"effect":{"type":"string","enum":["allow","deny"],"description":"Allow or deny the permission","example":"allow"},"action":{"type":"array","items":{"type":"string"},"description":"Actions allowed: access, edit, delete, create","example":["edit","delete","create","access"]},"resource":{"type":"array","items":{"type":"string"},"description":"Resources: device, dashboard, analysis, run_user, etc.","example":["device"]}}}},"targets":{"type":"array","description":"Global: [\"analysis\"]. Specific: [\"analysis\", \"id\", \"analysis_id\"]. Tag-based: [\"analysis\", \"tag_match\", \"tag_key\"]","items":{"type":"array","items":{"type":"string"},"example":["analysis"]},"example":[["analysis"]]},"tags":{"type":"array","description":"Optional tags for targeting specific users/analysis","items":{"type":"object","properties":{"key":{"type":"string","description":"Tag key","example":"user"},"value":{"type":"string","description":"Tag value","example":"admin"}}},"example":[{"key":"user","value":"admin"}]},"active":{"type":"boolean","description":"Whether the policy is active","example":true}}}]},"examples":{"Create Policy - Run User (Global)":{"value":{"name":"User permissions","permissions":[{"effect":"allow","action":["access"],"resource":["device"]}],"targets":[["run_user"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Run User (Specific ID)":{"value":{"name":"User permissions","permissions":[{"effect":"allow","action":["access"],"resource":["device"]}],"targets":[["run_user","id","68b5dd292ee817000af854dc"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Run User (Tag Match)":{"value":{"name":"User permissions","permissions":[{"effect":"allow","action":["access"],"resource":["device"]}],"targets":[["run_user","tag_match","account_token"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Analysis (Global)":{"value":{"name":"Policy","permissions":[{"effect":"allow","action":["edit","delete","create","access"],"resource":["device"]}],"targets":[["analysis"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Analysis (Specific ID)":{"value":{"name":"Policy","permissions":[{"effect":"allow","action":["edit","delete","create","access"],"resource":["device"]}],"targets":[["analysis","id","68b5dd292ee817000af854dc"]],"tags":[{"key":"user","value":"admin"}],"active":true}},"Create Policy - Analysis (Tag Match)":{"value":{"name":"Policy","permissions":[{"effect":"allow","action":["edit","delete","create","access"],"resource":["device"]}],"targets":[["analysis","tag_match","account_token"]],"tags":[{"key":"user","value":"admin"}],"active":true}}}},"text/plain":{"examples":{"Create Policy - Run User (Global)":{"value":"{\n \"name\": \"User permissions\",\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\"access\"],\n \"resource\": [\"device\"]\n }\n ],\n \"targets\": [[\"run_user\"]],\n \"tags\": [{\"key\": \"user\", \"value\": \"admin\"}],\n \"active\": true\n}"},"Create Policy - Analysis (Global)":{"value":"{\n \"name\": \"Policy\",\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\"edit\", \"delete\", \"create\", \"access\"],\n \"resource\": [\"device\"]\n }\n ],\n \"targets\": [[\"analysis\"]],\n \"tags\": [{\"key\": \"user\", \"value\": \"admin\"}],\n \"active\": true\n}"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "title": "User Policy", + "required": ["name", "permissions", "targets", "active"], + "properties": { + "name": { "type": "string", "description": "Name of the policy", "example": "User permissions" }, + "permissions": { + "type": "array", + "description": "Array of permission objects", + "items": { + "type": "object", + "properties": { + "effect": { + "type": "string", + "enum": ["allow", "deny"], + "description": "Allow or deny the permission", + "example": "allow" + }, + "action": { + "type": "array", + "items": { "type": "string" }, + "description": "Actions allowed: access, edit, delete, create", + "example": ["access"] + }, + "resource": { + "type": "array", + "items": { "type": "string" }, + "description": "Resources: device, dashboard, analysis, run_user, etc.", + "example": ["device"] + } + } + } + }, + "targets": { + "type": "array", + "description": "Global: [\"run_user\"]. Specific: [\"run_user\", \"id\", \"user_id\"]. Tag-based: [\"run_user\", \"tag_match\", \"tag_key\"]", + "items": { "type": "array", "items": { "type": "string" }, "example": ["run_user"] }, + "example": [["run_user"]] + }, + "tags": { + "type": "array", + "description": "Optional tags for targeting specific users/analysis", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "description": "Tag key", "example": "user" }, + "value": { "type": "string", "description": "Tag value", "example": "admin" } + } + }, + "example": [{ "key": "user", "value": "admin" }] + }, + "active": { "type": "boolean", "description": "Whether the policy is active", "example": true } + } + }, + { + "type": "object", + "title": "Analysis Policy", + "required": ["name", "permissions", "targets", "active"], + "properties": { + "name": { "type": "string", "description": "Name of the policy", "example": "Policy" }, + "permissions": { + "type": "array", + "description": "Array of permission objects", + "items": { + "type": "object", + "properties": { + "effect": { + "type": "string", + "enum": ["allow", "deny"], + "description": "Allow or deny the permission", + "example": "allow" + }, + "action": { + "type": "array", + "items": { "type": "string" }, + "description": "Actions allowed: access, edit, delete, create", + "example": ["edit", "delete", "create", "access"] + }, + "resource": { + "type": "array", + "items": { "type": "string" }, + "description": "Resources: device, dashboard, analysis, run_user, etc.", + "example": ["device"] + } + } + } + }, + "targets": { + "type": "array", + "description": "Global: [\"analysis\"]. Specific: [\"analysis\", \"id\", \"analysis_id\"]. Tag-based: [\"analysis\", \"tag_match\", \"tag_key\"]", + "items": { "type": "array", "items": { "type": "string" }, "example": ["analysis"] }, + "example": [["analysis"]] + }, + "tags": { + "type": "array", + "description": "Optional tags for targeting specific users/analysis", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "description": "Tag key", "example": "user" }, + "value": { "type": "string", "description": "Tag value", "example": "admin" } + } + }, + "example": [{ "key": "user", "value": "admin" }] + }, + "active": { "type": "boolean", "description": "Whether the policy is active", "example": true } + } + } + ] + }, + "examples": { + "Create Policy - Run User (Global)": { + "value": { + "name": "User permissions", + "permissions": [{ "effect": "allow", "action": ["access"], "resource": ["device"] }], + "targets": [["run_user"]], + "tags": [{ "key": "user", "value": "admin" }], + "active": true + } + }, + "Create Policy - Run User (Specific ID)": { + "value": { + "name": "User permissions", + "permissions": [{ "effect": "allow", "action": ["access"], "resource": ["device"] }], + "targets": [["run_user", "id", "68b5dd292ee817000af854dc"]], + "tags": [{ "key": "user", "value": "admin" }], + "active": true + } + }, + "Create Policy - Run User (Tag Match)": { + "value": { + "name": "User permissions", + "permissions": [{ "effect": "allow", "action": ["access"], "resource": ["device"] }], + "targets": [["run_user", "tag_match", "account_token"]], + "tags": [{ "key": "user", "value": "admin" }], + "active": true + } + }, + "Create Policy - Analysis (Global)": { + "value": { + "name": "Policy", + "permissions": [ + { "effect": "allow", "action": ["edit", "delete", "create", "access"], "resource": ["device"] } + ], + "targets": [["analysis"]], + "tags": [{ "key": "user", "value": "admin" }], + "active": true + } + }, + "Create Policy - Analysis (Specific ID)": { + "value": { + "name": "Policy", + "permissions": [ + { "effect": "allow", "action": ["edit", "delete", "create", "access"], "resource": ["device"] } + ], + "targets": [["analysis", "id", "68b5dd292ee817000af854dc"]], + "tags": [{ "key": "user", "value": "admin" }], + "active": true + } + }, + "Create Policy - Analysis (Tag Match)": { + "value": { + "name": "Policy", + "permissions": [ + { "effect": "allow", "action": ["edit", "delete", "create", "access"], "resource": ["device"] } + ], + "targets": [["analysis", "tag_match", "account_token"]], + "tags": [{ "key": "user", "value": "admin" }], + "active": true + } + } + } + }, + "text/plain": { + "examples": { + "Create Policy - Run User (Global)": { + "value": "{\n \"name\": \"User permissions\",\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\"access\"],\n \"resource\": [\"device\"]\n }\n ],\n \"targets\": [[\"run_user\"]],\n \"tags\": [{\"key\": \"user\", \"value\": \"admin\"}],\n \"active\": true\n}" + }, + "Create Policy - Analysis (Global)": { + "value": "{\n \"name\": \"Policy\",\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\"edit\", \"delete\", \"create\", \"access\"],\n \"resource\": [\"device\"]\n }\n ],\n \"targets\": [[\"analysis\"]],\n \"tags\": [{\"key\": \"user\", \"value\": \"admin\"}],\n \"active\": true\n}" + } + } + } + } + } +} diff --git a/docs/api/create-policy.StatusCodes.json b/docs/api/create-policy.StatusCodes.json index b7fad655..29325bb2 100644 --- a/docs/api/create-policy.StatusCodes.json +++ b/docs/api/create-policy.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"201":{"description":"Create Policy - Run User / Create Policy - Analysis","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"am_id":{"type":"string","example":"654a8bf3fefe2f00099a16a2"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "201": { + "description": "Create Policy - Run User / Create Policy - Analysis", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "am_id": { "type": "string", "example": "654a8bf3fefe2f00099a16a2" } } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-policy.api.mdx b/docs/api/create-policy.api.mdx index 55f5e3ef..828e2a9b 100644 --- a/docs/api/create-policy.api.mdx +++ b/docs/api/create-policy.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create a policy that targets either Run User or Analysis - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-profile-backup.ParamsDetails.json b/docs/api/create-profile-backup.ParamsDetails.json index 22d63f83..b927177d 100644 --- a/docs/api/create-profile-backup.ParamsDetails.json +++ b/docs/api/create-profile-backup.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "profile_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "description": "The ID of the profile" + } + ] +} diff --git a/docs/api/create-profile-backup.RequestSchema.json b/docs/api/create-profile-backup.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/create-profile-backup.RequestSchema.json +++ b/docs/api/create-profile-backup.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/create-profile-backup.StatusCodes.json b/docs/api/create-profile-backup.StatusCodes.json index b0cab8d9..9d71422a 100644 --- a/docs/api/create-profile-backup.StatusCodes.json +++ b/docs/api/create-profile-backup.StatusCodes.json @@ -1 +1,39 @@ -{"responses":{"200":{"description":"Backup creation initiated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Backup generation has been queued and will be processed shortly. You can check the status using the list backups endpoint."},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"backup_id":{"type":"string","example":"678abc123def456789012345"}}}}}},"403":{"description":"Forbidden - Free plan or rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Daily backup limit reached (1 backups per day). Please try again in 8 hours or contact support to increase your limit."}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Backup creation initiated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Backup generation has been queued and will be processed shortly. You can check the status using the list backups endpoint." + }, + "profile": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "backup_id": { "type": "string", "example": "678abc123def456789012345" } + } + } + } + } + }, + "403": { + "description": "Forbidden - Free plan or rate limit exceeded", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { + "type": "string", + "example": "Daily backup limit reached (1 backups per day). Please try again in 8 hours or contact support to increase your limit." + } + } + } + } + } + } + } +} diff --git a/docs/api/create-profile-backup.api.mdx b/docs/api/create-profile-backup.api.mdx index fc4faa6f..a18ad921 100644 --- a/docs/api/create-profile-backup.api.mdx +++ b/docs/api/create-profile-backup.api.mdx @@ -20,63 +20,32 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Initiates a new backup generation for the specified profile. The backup is processed asynchronously in a background queue. **What's included in the backup:** + - User storage files (uploaded via `/files` route) - Dashboard version history - Analysis script versions - All resource configurations as JSON files (devices, actions, dashboards, analysis, access management, networks, connectors, secrets, dictionaries, run users, etc.) **Important notes:** + - Backups are rate-limited (1 per day based on your account timezone) - Free plan users do not have access to backup features - Backup generation may take several minutes depending on profile size - Restoration is manual - you can write scripts to parse the JSON files and recreate resources via API, or contact TagoIO support - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-token.RequestSchema.json b/docs/api/create-token.RequestSchema.json index ef299341..e292f0d1 100644 --- a/docs/api/create-token.RequestSchema.json +++ b/docs/api/create-token.RequestSchema.json @@ -1 +1,34 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"string","example":"6243321z80d789a05800143075a4"},"expire_time":{"type":"string","example":"3 hours"},"name":{"type":"string","example":"TestToken"},"serie_number":{"type":"string","example":359881234567890,"description":"If applicable for the selected Network. Can be an IMEI, EUI, or unique serial number."}}},"examples":{"Create token":{"value":{"device":"6243321z80d789a05800143075a4","expire_time":"3 hours","name":"TestToken"}}}},"text/plain":{"examples":{"Create token":{"value":"{\r\n \"expire_time\": \"never\", // ISO-8601 or relative date, e.g 1 day\r\n \"name\": \"Token #2\",\r\n \"permission\": \"full\", // full, read or write\r\n \"serie_number\": \"\", //Optional\r\n \"device\": \"6298fcc3e0b6840012b6abfa\"\r\n}"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "device": { "type": "string", "example": "6243321z80d789a05800143075a4" }, + "expire_time": { "type": "string", "example": "3 hours" }, + "name": { "type": "string", "example": "TestToken" }, + "serie_number": { + "type": "string", + "example": 359881234567890, + "description": "If applicable for the selected Network. Can be an IMEI, EUI, or unique serial number." + } + } + }, + "examples": { + "Create token": { + "value": { "device": "6243321z80d789a05800143075a4", "expire_time": "3 hours", "name": "TestToken" } + } + } + }, + "text/plain": { + "examples": { + "Create token": { + "value": "{\r\n \"expire_time\": \"never\", // ISO-8601 or relative date, e.g 1 day\r\n \"name\": \"Token #2\",\r\n \"permission\": \"full\", // full, read or write\r\n \"serie_number\": \"\", //Optional\r\n \"device\": \"6298fcc3e0b6840012b6abfa\"\r\n}" + } + } + } + } + } +} diff --git a/docs/api/create-token.StatusCodes.json b/docs/api/create-token.StatusCodes.json index dd340225..a8c7ff10 100644 --- a/docs/api/create-token.StatusCodes.json +++ b/docs/api/create-token.StatusCodes.json @@ -1 +1,25 @@ -{"responses":{"201":{"description":"Token created","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"expire_time":{"type":"string","example":"2022-03-30T01:15:14.914Z"},"permission":{"type":"string","example":"full"},"token":{"type":"string","example":"f2ba4b46-3c57-44ce-810f-98e1271ea602"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "201": { + "description": "Token created", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "expire_time": { "type": "string", "example": "2022-03-30T01:15:14.914Z" }, + "permission": { "type": "string", "example": "full" }, + "token": { "type": "string", "example": "f2ba4b46-3c57-44ce-810f-98e1271ea602" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-token.api.mdx b/docs/api/create-token.api.mdx index 8e00ca53..c9f9609b 100644 --- a/docs/api/create-token.api.mdx +++ b/docs/api/create-token.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Generate and retrieve a new token - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/create-user.RequestSchema.json b/docs/api/create-user.RequestSchema.json index d1671a6d..114ada27 100644 --- a/docs/api/create-user.RequestSchema.json +++ b/docs/api/create-user.RequestSchema.json @@ -1 +1,20 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["name","email","password"],"properties":{"active":{"type":"boolean","example":true},"email":{"type":"string","example":"janedoe@mail.com"},"name":{"type":"string","example":"Jane Doe"},"password":{"type":"string","example":"Testing_01"},"timezone":{"type":"string","example":"New_York/America"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["name", "email", "password"], + "properties": { + "active": { "type": "boolean", "example": true }, + "email": { "type": "string", "example": "janedoe@mail.com" }, + "name": { "type": "string", "example": "Jane Doe" }, + "password": { "type": "string", "example": "Testing_01" }, + "timezone": { "type": "string", "example": "New_York/America" } + } + } + } + } + } +} diff --git a/docs/api/create-user.StatusCodes.json b/docs/api/create-user.StatusCodes.json index e01ff346..dfaf1330 100644 --- a/docs/api/create-user.StatusCodes.json +++ b/docs/api/create-user.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Creating a RUN user","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"user":{"type":"string","example":"62b086df27ce4d0012be6bac"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Creating a RUN user", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "user": { "type": "string", "example": "62b086df27ce4d0012be6bac" } } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/create-user.api.mdx b/docs/api/create-user.api.mdx index 1a9c0836..cdb0820d 100644 --- a/docs/api/create-user.api.mdx +++ b/docs/api/create-user.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Create user on Run - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/current-device-information.RequestSchema.json b/docs/api/current-device-information.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/current-device-information.RequestSchema.json +++ b/docs/api/current-device-information.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/current-device-information.StatusCodes.json b/docs/api/current-device-information.StatusCodes.json index 6e5a78c5..48e46265 100644 --- a/docs/api/current-device-information.StatusCodes.json +++ b/docs/api/current-device-information.StatusCodes.json @@ -1 +1,38 @@ -{"responses":{"200":{"description":"Get information about current device successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"connector":{"type":"string","example":"62333bd36977fc001a2990c8"},"created_at":{"type":"string","example":"2022-06-02T18:09:07.135Z"},"id":{"type":"string","example":"6298fcc3e0b6840012b6abfa"},"last_input":{"type":"string","example":"2022-06-02T19:40:54.517Z"},"name":{"type":"string","example":"TagoIO Device"},"network":{"type":"string","example":"62336c32ab6e0d0012e06c04"},"payload_decoder":{"type":"string","example":"LyogVGhpcyBpcyBhIGRlZmF1bHQgZXhhbXBsZSBmb3IgcGF5bG9hZCBwYXJzZXIuCioqIFRoZSBpZ25vcmVfdmFycyB2YXJpYWJsZSBpbiB0aGlzIGNvZGUgc2hvdWxkIGJlIHVzZWQgdG8gaWdub3JlIHZhcmlhYmxlcwoqKiBmcm9tIHRoZSBkZXZpY2UgdGhhdCB5b3UgZG9uJ3Qgd2FudC4KKioKKiogVGVzdGluZzoKKiogWW91IGNhbiBkbyBtYW51YWwgdGVzdHMgdG8gdGhpcyBwYXJzZSBieSB1c2luZyB0aGUgRGV2aWNlIEVtdWxhdG9yLiBDb3B5IGFuZCBQYXN0ZSB0aGUgZm9sbG93aW5nIGNvZGU6CioqIFt7ICJ2YXJpYWJsZSI6ICJwYXlsb2FkIiwgInZhbHVlIjogIjAxMDk2MTEzOTUiIH1dCioqCiovCi8vIEFkZCBpZ25vcmFibGUgdmFyaWFibGVzIGluIHRoaXMgYXJyYXkuCmNvbnN0IGlnbm9yZV92YXJzID0gWydyZl9jaGFpbicsICdjaGFubmVsJywgJ21vZHVsYXRpb24nLCAnYXBwX2lkJywgJ2Rldl9pZCcsICd0aW1lJywgJ2d0d190cnVzdGVkJywgJ3BvcnQnXTsKCi8vIFJlbW92ZSB1bndhbnRlZCB2YXJpYWJsZXMuCnBheWxvYWQgPSBwYXlsb2FkLmZpbHRlcih4ID0+ICFpZ25vcmVfdmFycy5pbmNsdWRlcyh4LnZhcmlhYmxlKSk7CgovLyBZb3UgY2FuIGVkaXQgYW55IHZhcmlhYmxlIHRoYXQncyBiZWluZyBhZGRlZCB0byB5b3VyIGRldmljZS4KLy8gRm9yIGV4YW1wbGUsIGlmIHlvdSBuZWVkIHRvIGNvbnZlcnQgYSB2YXJpYWJsZSBmcm9tIEZhaHJlaW50aCB0byBDZWxzaXVzLCB1bmNvbW1lbnQgdGhlIGZvbGxvd2luZyBjb2RlOgovLyBjb25zdCB0ZW1wZXJhdHVyZSA9IHBheWxvYWQuZmluZCh4ID0+IHgudmFyaWFibGUgPT09ICJ0ZW1wZXJhdHVyZSIpOwovLyBpZiAodGVtcGVyYXR1cmUpIHsKLy8gICB0ZW1wZXJhdHVyZS52YWx1ZSA9ICg1IC8gOSkgKiAodGVtcGVyYXR1cmUudmFsdWUgLSAzMik7Ci8vICAgdGVtcGVyYXR1cmUudW5pdCA9ICJDIjsKLy8gfQ=="},"profile":{"type":"string","example":"5e1e192a06fbee00265ccfb0"},"tags":{"type":"array","items":{},"example":[]},"type":{"type":"string","example":"mutable"},"updated_at":{"type":"string","example":"2022-06-10T20:22:59.405Z"},"visible":{"type":"boolean","example":true}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get information about current device successfuly", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "connector": { "type": "string", "example": "62333bd36977fc001a2990c8" }, + "created_at": { "type": "string", "example": "2022-06-02T18:09:07.135Z" }, + "id": { "type": "string", "example": "6298fcc3e0b6840012b6abfa" }, + "last_input": { "type": "string", "example": "2022-06-02T19:40:54.517Z" }, + "name": { "type": "string", "example": "TagoIO Device" }, + "network": { "type": "string", "example": "62336c32ab6e0d0012e06c04" }, + "payload_decoder": { + "type": "string", + "example": "LyogVGhpcyBpcyBhIGRlZmF1bHQgZXhhbXBsZSBmb3IgcGF5bG9hZCBwYXJzZXIuCioqIFRoZSBpZ25vcmVfdmFycyB2YXJpYWJsZSBpbiB0aGlzIGNvZGUgc2hvdWxkIGJlIHVzZWQgdG8gaWdub3JlIHZhcmlhYmxlcwoqKiBmcm9tIHRoZSBkZXZpY2UgdGhhdCB5b3UgZG9uJ3Qgd2FudC4KKioKKiogVGVzdGluZzoKKiogWW91IGNhbiBkbyBtYW51YWwgdGVzdHMgdG8gdGhpcyBwYXJzZSBieSB1c2luZyB0aGUgRGV2aWNlIEVtdWxhdG9yLiBDb3B5IGFuZCBQYXN0ZSB0aGUgZm9sbG93aW5nIGNvZGU6CioqIFt7ICJ2YXJpYWJsZSI6ICJwYXlsb2FkIiwgInZhbHVlIjogIjAxMDk2MTEzOTUiIH1dCioqCiovCi8vIEFkZCBpZ25vcmFibGUgdmFyaWFibGVzIGluIHRoaXMgYXJyYXkuCmNvbnN0IGlnbm9yZV92YXJzID0gWydyZl9jaGFpbicsICdjaGFubmVsJywgJ21vZHVsYXRpb24nLCAnYXBwX2lkJywgJ2Rldl9pZCcsICd0aW1lJywgJ2d0d190cnVzdGVkJywgJ3BvcnQnXTsKCi8vIFJlbW92ZSB1bndhbnRlZCB2YXJpYWJsZXMuCnBheWxvYWQgPSBwYXlsb2FkLmZpbHRlcih4ID0+ICFpZ25vcmVfdmFycy5pbmNsdWRlcyh4LnZhcmlhYmxlKSk7CgovLyBZb3UgY2FuIGVkaXQgYW55IHZhcmlhYmxlIHRoYXQncyBiZWluZyBhZGRlZCB0byB5b3VyIGRldmljZS4KLy8gRm9yIGV4YW1wbGUsIGlmIHlvdSBuZWVkIHRvIGNvbnZlcnQgYSB2YXJpYWJsZSBmcm9tIEZhaHJlaW50aCB0byBDZWxzaXVzLCB1bmNvbW1lbnQgdGhlIGZvbGxvd2luZyBjb2RlOgovLyBjb25zdCB0ZW1wZXJhdHVyZSA9IHBheWxvYWQuZmluZCh4ID0+IHgudmFyaWFibGUgPT09ICJ0ZW1wZXJhdHVyZSIpOwovLyBpZiAodGVtcGVyYXR1cmUpIHsKLy8gICB0ZW1wZXJhdHVyZS52YWx1ZSA9ICg1IC8gOSkgKiAodGVtcGVyYXR1cmUudmFsdWUgLSAzMik7Ci8vICAgdGVtcGVyYXR1cmUudW5pdCA9ICJDIjsKLy8gfQ==" + }, + "profile": { "type": "string", "example": "5e1e192a06fbee00265ccfb0" }, + "tags": { "type": "array", "items": {}, "example": [] }, + "type": { "type": "string", "example": "mutable" }, + "updated_at": { "type": "string", "example": "2022-06-10T20:22:59.405Z" }, + "visible": { "type": "boolean", "example": true } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/current-device-information.api.mdx b/docs/api/current-device-information.api.mdx index 47523f10..54fe479f 100644 --- a/docs/api/current-device-information.api.mdx +++ b/docs/api/current-device-information.api.mdx @@ -20,43 +20,14 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get information about the current device + - - - - - - - - - - - - + - \ No newline at end of file + diff --git a/docs/api/delete-a-file.RequestSchema.json b/docs/api/delete-a-file.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-a-file.RequestSchema.json +++ b/docs/api/delete-a-file.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-a-file.StatusCodes.json b/docs/api/delete-a-file.StatusCodes.json index a7b53110..528348b8 100644 --- a/docs/api/delete-a-file.StatusCodes.json +++ b/docs/api/delete-a-file.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Deleting a file","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting a file":{"value":{"result":"Successfully Removed","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting a file", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Deleting a file": { "value": { "result": "Successfully Removed", "status": true } } } + } + } + } + } +} diff --git a/docs/api/delete-a-file.api.mdx b/docs/api/delete-a-file.api.mdx index b180bfb7..26361d9c 100644 --- a/docs/api/delete-a-file.api.mdx +++ b/docs/api/delete-a-file.api.mdx @@ -20,42 +20,14 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete a file - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-chunk.ParamsDetails.json b/docs/api/delete-chunk.ParamsDetails.json index b6f85ab9..b5e1c2c8 100644 --- a/docs/api/delete-chunk.ParamsDetails.json +++ b/docs/api/delete-chunk.ParamsDetails.json @@ -1 +1,18 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"},{"name":"chunkID","in":"path","required":true,"schema":{"type":"string","example":"(Type a chunk ID)"},"description":"Chunk ID"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" }, + "description": "Device ID" + }, + { + "name": "chunkID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a chunk ID)" }, + "description": "Chunk ID" + } + ] +} diff --git a/docs/api/delete-chunk.RequestSchema.json b/docs/api/delete-chunk.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-chunk.RequestSchema.json +++ b/docs/api/delete-chunk.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-chunk.StatusCodes.json b/docs/api/delete-chunk.StatusCodes.json index 8704732d..888a6fc1 100644 --- a/docs/api/delete-chunk.StatusCodes.json +++ b/docs/api/delete-chunk.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Chunk deleted from device","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Chunk 1657497600_1658102399 deleted"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Chunk deleted from device", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Chunk 1657497600_1658102399 deleted" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-chunk.api.mdx b/docs/api/delete-chunk.api.mdx index a321a40f..afc541ad 100644 --- a/docs/api/delete-chunk.api.mdx +++ b/docs/api/delete-chunk.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete chunk - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-dashboard.ParamsDetails.json b/docs/api/delete-dashboard.ParamsDetails.json index ad79fd90..90c109ae 100644 --- a/docs/api/delete-dashboard.ParamsDetails.json +++ b/docs/api/delete-dashboard.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + } + ] +} diff --git a/docs/api/delete-dashboard.RequestSchema.json b/docs/api/delete-dashboard.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-dashboard.RequestSchema.json +++ b/docs/api/delete-dashboard.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-dashboard.StatusCodes.json b/docs/api/delete-dashboard.StatusCodes.json index c2ae39af..7eb32116 100644 --- a/docs/api/delete-dashboard.StatusCodes.json +++ b/docs/api/delete-dashboard.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Deleting a dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting a dashboard":{"value":{"result":"Successfully Removed","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting a dashboard", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Deleting a dashboard": { "value": { "result": "Successfully Removed", "status": true } } } + } + } + } + } +} diff --git a/docs/api/delete-dashboard.api.mdx b/docs/api/delete-dashboard.api.mdx index c7b92b0e..92e71163 100644 --- a/docs/api/delete-dashboard.api.mdx +++ b/docs/api/delete-dashboard.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete the dashboard - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-data.ParamsDetails.json b/docs/api/delete-data.ParamsDetails.json index cbd26e30..53f755ac 100644 --- a/docs/api/delete-data.ParamsDetails.json +++ b/docs/api/delete-data.ParamsDetails.json @@ -1 +1,51 @@ -{"parameters":[{"name":"qty","in":"query","description":"Quantity of data records to delete. Default is 15.","schema":{"type":"integer","minimum":1,"default":15,"example":20}},{"name":"ordination","in":"query","description":"Sort direction. Default is descending.","schema":{"type":"string","enum":["ascending","descending"],"default":"descending","example":"descending"}},{"name":"skip","in":"query","description":"Number of items to skip (pagination).","schema":{"type":"integer","minimum":0,"example":15}},{"name":"variables","in":"query","description":"Filter data by variable.","schema":{"type":"string","example":"temperature"}},{"name":"values","in":"query","description":"Filter data by value. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"12"}},{"name":"ids","in":"query","description":"Filter data by id. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"6144a25e280ad80019688e689"}},{"name":"groups","in":"query","description":"Filter data by group. Accepts single or multiple values.\nFor multiple, send `groups[0]=foo&groups[1]=bar`.\n","schema":{"type":"string","items":{"type":"string"},"example":"16731887966346"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "qty", + "in": "query", + "description": "Quantity of data records to delete. Default is 15.", + "schema": { "type": "integer", "minimum": 1, "default": 15, "example": 20 } + }, + { + "name": "ordination", + "in": "query", + "description": "Sort direction. Default is descending.", + "schema": { + "type": "string", + "enum": ["ascending", "descending"], + "default": "descending", + "example": "descending" + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of items to skip (pagination).", + "schema": { "type": "integer", "minimum": 0, "example": 15 } + }, + { + "name": "variables", + "in": "query", + "description": "Filter data by variable.", + "schema": { "type": "string", "example": "temperature" } + }, + { + "name": "values", + "in": "query", + "description": "Filter data by value. Accepts single or multiple values.", + "schema": { "type": "string", "items": { "type": "string" }, "example": "12" } + }, + { + "name": "ids", + "in": "query", + "description": "Filter data by id. Accepts single or multiple values.", + "schema": { "type": "string", "items": { "type": "string" }, "example": "6144a25e280ad80019688e689" } + }, + { + "name": "groups", + "in": "query", + "description": "Filter data by group. Accepts single or multiple values.\nFor multiple, send `groups[0]=foo&groups[1]=bar`.\n", + "schema": { "type": "string", "items": { "type": "string" }, "example": "16731887966346" } + } + ] +} diff --git a/docs/api/delete-data.RequestSchema.json b/docs/api/delete-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-data.RequestSchema.json +++ b/docs/api/delete-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-data.StatusCodes.json b/docs/api/delete-data.StatusCodes.json index c2e96cf9..ee1a9806 100644 --- a/docs/api/delete-data.StatusCodes.json +++ b/docs/api/delete-data.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Deleting data using params","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting data using params", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "1 Data Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-data.api.mdx b/docs/api/delete-data.api.mdx index 4785e8f5..8ecf091b 100644 --- a/docs/api/delete-data.api.mdx +++ b/docs/api/delete-data.api.mdx @@ -20,54 +20,21 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete data from the device. :::info This request is only available when using Mutable Storage on Devices. ::: - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-device-data.ParamsDetails.json b/docs/api/delete-device-data.ParamsDetails.json index 748f244f..87e2b24c 100644 --- a/docs/api/delete-device-data.ParamsDetails.json +++ b/docs/api/delete-device-data.ParamsDetails.json @@ -1 +1,58 @@ -{"parameters":[{"name":"qty","in":"query","description":"Quantity of data records to delete. Default is 15.","schema":{"type":"integer","minimum":1,"default":15,"example":20}},{"name":"ordination","in":"query","description":"Sort direction. Default is descending.","schema":{"type":"string","enum":["ascending","descending"],"default":"descending","example":"descending"}},{"name":"skip","in":"query","description":"Number of items to skip (pagination).","schema":{"type":"integer","minimum":0,"example":15}},{"name":"variables","in":"query","description":"Filter data by variable.","schema":{"type":"string","example":"temperature"}},{"name":"values","in":"query","description":"Filter data by value. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"12"}},{"name":"ids","in":"query","description":"Filter data by id. Accepts single or multiple values.","schema":{"type":"string","items":{"type":"string"},"example":"6144a25e280ad80019688e689"}},{"name":"groups","in":"query","description":"Filter data by group. Accepts single or multiple values.\nFor multiple, send `groups[0]=foo&groups[1]=bar`.\n","schema":{"type":"string","items":{"type":"string"},"example":"16731887966346"}},{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "qty", + "in": "query", + "description": "Quantity of data records to delete. Default is 15.", + "schema": { "type": "integer", "minimum": 1, "default": 15, "example": 20 } + }, + { + "name": "ordination", + "in": "query", + "description": "Sort direction. Default is descending.", + "schema": { + "type": "string", + "enum": ["ascending", "descending"], + "default": "descending", + "example": "descending" + } + }, + { + "name": "skip", + "in": "query", + "description": "Number of items to skip (pagination).", + "schema": { "type": "integer", "minimum": 0, "example": 15 } + }, + { + "name": "variables", + "in": "query", + "description": "Filter data by variable.", + "schema": { "type": "string", "example": "temperature" } + }, + { + "name": "values", + "in": "query", + "description": "Filter data by value. Accepts single or multiple values.", + "schema": { "type": "string", "items": { "type": "string" }, "example": "12" } + }, + { + "name": "ids", + "in": "query", + "description": "Filter data by id. Accepts single or multiple values.", + "schema": { "type": "string", "items": { "type": "string" }, "example": "6144a25e280ad80019688e689" } + }, + { + "name": "groups", + "in": "query", + "description": "Filter data by group. Accepts single or multiple values.\nFor multiple, send `groups[0]=foo&groups[1]=bar`.\n", + "schema": { "type": "string", "items": { "type": "string" }, "example": "16731887966346" } + }, + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" }, + "description": "Device ID" + } + ] +} diff --git a/docs/api/delete-device-data.RequestSchema.json b/docs/api/delete-device-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-device-data.RequestSchema.json +++ b/docs/api/delete-device-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-device-data.StatusCodes.json b/docs/api/delete-device-data.StatusCodes.json index 78198470..65751b3f 100644 --- a/docs/api/delete-device-data.StatusCodes.json +++ b/docs/api/delete-device-data.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Delete Device Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Delete Device Data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "1 Data Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-device-data.api.mdx b/docs/api/delete-device-data.api.mdx index a84f4587..f17d281f 100644 --- a/docs/api/delete-device-data.api.mdx +++ b/docs/api/delete-device-data.api.mdx @@ -20,53 +20,21 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete specific data stored in the device. :::info This request is only available when using Mutable Storage on Devices ::: - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-device-param.ParamsDetails.json b/docs/api/delete-device-param.ParamsDetails.json index 0db0eff4..60ef5650 100644 --- a/docs/api/delete-device-param.ParamsDetails.json +++ b/docs/api/delete-device-param.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"(Type your device ID)"}},{"name":"paramID","in":"path","required":true,"schema":{"type":"string","example":"(Type your param ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your device ID)" } + }, + { + "name": "paramID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your param ID)" } + } + ] +} diff --git a/docs/api/delete-device-param.RequestSchema.json b/docs/api/delete-device-param.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-device-param.RequestSchema.json +++ b/docs/api/delete-device-param.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-device-param.StatusCodes.json b/docs/api/delete-device-param.StatusCodes.json index b10fa8e9..d9afc712 100644 --- a/docs/api/delete-device-param.StatusCodes.json +++ b/docs/api/delete-device-param.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Deleting a Device Param by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting a Device Param by ID", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-device-param.api.mdx b/docs/api/delete-device-param.api.mdx index a081a2dd..82360232 100644 --- a/docs/api/delete-device-param.api.mdx +++ b/docs/api/delete-device-param.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete param from the device - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-device.ParamsDetails.json b/docs/api/delete-device.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/delete-device.ParamsDetails.json +++ b/docs/api/delete-device.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/delete-device.RequestSchema.json b/docs/api/delete-device.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-device.RequestSchema.json +++ b/docs/api/delete-device.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-device.StatusCodes.json b/docs/api/delete-device.StatusCodes.json index 1f381d0b..ade8f1d9 100644 --- a/docs/api/delete-device.StatusCodes.json +++ b/docs/api/delete-device.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Deleting a device by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting a device by ID", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-device.api.mdx b/docs/api/delete-device.api.mdx index 2a33c425..0cb9070f 100644 --- a/docs/api/delete-device.api.mdx +++ b/docs/api/delete-device.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Deletes a device from the profile - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-dictionary.ParamsDetails.json b/docs/api/delete-dictionary.ParamsDetails.json index b8515d71..46c1fc08 100644 --- a/docs/api/delete-dictionary.ParamsDetails.json +++ b/docs/api/delete-dictionary.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dictionary_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type Dictionary ID)" }, + "description": "Can be obtained in the GET Dictionary response" + } + ] +} diff --git a/docs/api/delete-dictionary.RequestSchema.json b/docs/api/delete-dictionary.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-dictionary.RequestSchema.json +++ b/docs/api/delete-dictionary.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-dictionary.StatusCodes.json b/docs/api/delete-dictionary.StatusCodes.json index 04f0ac3e..fac91213 100644 --- a/docs/api/delete-dictionary.StatusCodes.json +++ b/docs/api/delete-dictionary.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Delete Dictionary","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Delete Dictionary", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-dictionary.api.mdx b/docs/api/delete-dictionary.api.mdx index f1c367c6..0b8814ae 100644 --- a/docs/api/delete-dictionary.api.mdx +++ b/docs/api/delete-dictionary.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete Dictionary - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-entity-data.ParamsDetails.json b/docs/api/delete-entity-data.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/delete-entity-data.ParamsDetails.json +++ b/docs/api/delete-entity-data.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/delete-entity-data.RequestSchema.json b/docs/api/delete-entity-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-entity-data.RequestSchema.json +++ b/docs/api/delete-entity-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-entity-data.StatusCodes.json b/docs/api/delete-entity-data.StatusCodes.json index 5883f9df..68b0923f 100644 --- a/docs/api/delete-entity-data.StatusCodes.json +++ b/docs/api/delete-entity-data.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Delete Entity Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"2 item(s) deleted"},"status":{"type":"boolean","example":true}}},"examples":{"Delete Entity Data":{"value":{"result":"2 item(s) deleted","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Delete Entity Data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "2 item(s) deleted" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Delete Entity Data": { "value": { "result": "2 item(s) deleted", "status": true } } } + } + } + } + } +} diff --git a/docs/api/delete-entity-data.api.mdx b/docs/api/delete-entity-data.api.mdx index 4bcd3020..84cf5946 100644 --- a/docs/api/delete-entity-data.api.mdx +++ b/docs/api/delete-entity-data.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete Entity Data - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-entity.ParamsDetails.json b/docs/api/delete-entity.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/delete-entity.ParamsDetails.json +++ b/docs/api/delete-entity.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/delete-entity.RequestSchema.json b/docs/api/delete-entity.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-entity.RequestSchema.json +++ b/docs/api/delete-entity.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-entity.StatusCodes.json b/docs/api/delete-entity.StatusCodes.json index 48e4d428..26cf474e 100644 --- a/docs/api/delete-entity.StatusCodes.json +++ b/docs/api/delete-entity.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Deleting an entity","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Entity Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting an entity":{"value":{"result":"Entity Successfully Removed","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting an entity", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Entity Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Deleting an entity": { "value": { "result": "Entity Successfully Removed", "status": true } } } + } + } + } + } +} diff --git a/docs/api/delete-entity.api.mdx b/docs/api/delete-entity.api.mdx index 5b32052c..7b0c7377 100644 --- a/docs/api/delete-entity.api.mdx +++ b/docs/api/delete-entity.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete Entity - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-notification.ParamsDetails.json b/docs/api/delete-notification.ParamsDetails.json index a1e9f650..0267e06c 100644 --- a/docs/api/delete-notification.ParamsDetails.json +++ b/docs/api/delete-notification.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"notificationID","in":"path","required":true,"schema":{"type":"string","example":"(Type your RUN notification ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "notificationID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your RUN notification ID)" } + } + ] +} diff --git a/docs/api/delete-notification.RequestSchema.json b/docs/api/delete-notification.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-notification.RequestSchema.json +++ b/docs/api/delete-notification.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-notification.StatusCodes.json b/docs/api/delete-notification.StatusCodes.json index c58cad09..fe0a6752 100644 --- a/docs/api/delete-notification.StatusCodes.json +++ b/docs/api/delete-notification.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Deleting a RUN user notification","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting a RUN user notification", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-notification.api.mdx b/docs/api/delete-notification.api.mdx index d3672f4f..3b31b9d0 100644 --- a/docs/api/delete-notification.api.mdx +++ b/docs/api/delete-notification.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete notification on Run - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-policy.ParamsDetails.json b/docs/api/delete-policy.ParamsDetails.json index 4e945104..f8e98e49 100644 --- a/docs/api/delete-policy.ParamsDetails.json +++ b/docs/api/delete-policy.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"am_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an Access Management/Policy ID)"},"description":"Can be obtained in the GET Policy request response"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "am_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an Access Management/Policy ID)" }, + "description": "Can be obtained in the GET Policy request response" + } + ] +} diff --git a/docs/api/delete-policy.RequestSchema.json b/docs/api/delete-policy.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-policy.RequestSchema.json +++ b/docs/api/delete-policy.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-policy.StatusCodes.json b/docs/api/delete-policy.StatusCodes.json index a148ae44..63a2e001 100644 --- a/docs/api/delete-policy.StatusCodes.json +++ b/docs/api/delete-policy.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Delete policy","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Access Management Successfully Deleted"},"status":{"type":"boolean","example":true}}},"examples":{"Delete policy":{"value":{"result":"Access Management Successfully Deleted","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Delete policy", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Access Management Successfully Deleted" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Delete policy": { "value": { "result": "Access Management Successfully Deleted", "status": true } } + } + } + } + } + } +} diff --git a/docs/api/delete-policy.api.mdx b/docs/api/delete-policy.api.mdx index afc9c143..0c4ceed4 100644 --- a/docs/api/delete-policy.api.mdx +++ b/docs/api/delete-policy.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete Policy - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-profile-backup.ParamsDetails.json b/docs/api/delete-profile-backup.ParamsDetails.json index 5b8b893b..fa50d8b7 100644 --- a/docs/api/delete-profile-backup.ParamsDetails.json +++ b/docs/api/delete-profile-backup.ParamsDetails.json @@ -1 +1,18 @@ -{"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"},{"name":"backup_id","in":"path","required":true,"schema":{"type":"string","example":"678abc123def456789012345"},"description":"The ID of the backup to delete"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "profile_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "description": "The ID of the profile" + }, + { + "name": "backup_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "678abc123def456789012345" }, + "description": "The ID of the backup to delete" + } + ] +} diff --git a/docs/api/delete-profile-backup.RequestSchema.json b/docs/api/delete-profile-backup.RequestSchema.json index 8cf58e9a..48b6a643 100644 --- a/docs/api/delete-profile-backup.RequestSchema.json +++ b/docs/api/delete-profile-backup.RequestSchema.json @@ -1 +1,38 @@ -{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"password":{"type":"string","description":"Your account password for verification","example":"your_account_password"},"otp_type":{"type":"string","enum":["authenticator","sms","email"],"description":"Type of OTP if 2FA is enabled (optional)","example":"authenticator"},"pin_code":{"type":"string","description":"OTP code if 2FA is enabled (optional)","example":"123456"}}},"examples":{"Without 2FA":{"value":{"password":"your_account_password"}},"With 2FA enabled":{"value":{"password":"your_account_password","otp_type":"authenticator","pin_code":"123456"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["password"], + "properties": { + "password": { + "type": "string", + "description": "Your account password for verification", + "example": "your_account_password" + }, + "otp_type": { + "type": "string", + "enum": ["authenticator", "sms", "email"], + "description": "Type of OTP if 2FA is enabled (optional)", + "example": "authenticator" + }, + "pin_code": { + "type": "string", + "description": "OTP code if 2FA is enabled (optional)", + "example": "123456" + } + } + }, + "examples": { + "Without 2FA": { "value": { "password": "your_account_password" } }, + "With 2FA enabled": { + "value": { "password": "your_account_password", "otp_type": "authenticator", "pin_code": "123456" } + } + } + } + } + } +} diff --git a/docs/api/delete-profile-backup.StatusCodes.json b/docs/api/delete-profile-backup.StatusCodes.json index f6b06c5c..9efd364e 100644 --- a/docs/api/delete-profile-backup.StatusCodes.json +++ b/docs/api/delete-profile-backup.StatusCodes.json @@ -1 +1,46 @@ -{"responses":{"200":{"description":"Backup deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Backup successfully removed"},"status":{"type":"boolean","example":true}}}}}},"401":{"description":"Unauthorized - Invalid password or OTP","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid password"}}}}}},"404":{"description":"Not found - Backup does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup not found or you don't have permission to delete it."}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Backup deleted successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Backup successfully removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + }, + "401": { + "description": "Unauthorized - Invalid password or OTP", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Invalid password" } + } + } + } + } + }, + "404": { + "description": "Not found - Backup does not exist", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Backup not found or you don't have permission to delete it." } + } + } + } + } + } + } +} diff --git a/docs/api/delete-profile-backup.api.mdx b/docs/api/delete-profile-backup.api.mdx index 8275f59a..ee9c4b9c 100644 --- a/docs/api/delete-profile-backup.api.mdx +++ b/docs/api/delete-profile-backup.api.mdx @@ -20,53 +20,24 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Permanently removes a backup from storage. This action is irreversible. **Security:** This endpoint requires account password verification to prevent accidental or unauthorized deletion. If you have Two-Factor Authentication (2FA) enabled, you must also provide the OTP code. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-token.ParamsDetails.json b/docs/api/delete-token.ParamsDetails.json index 38366912..02e7d07d 100644 --- a/docs/api/delete-token.ParamsDetails.json +++ b/docs/api/delete-token.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"tokenID","in":"path","required":true,"schema":{"type":"string","example":"(Type a token ID to be deleted)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "tokenID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a token ID to be deleted)" } + } + ] +} diff --git a/docs/api/delete-token.RequestSchema.json b/docs/api/delete-token.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-token.RequestSchema.json +++ b/docs/api/delete-token.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-token.StatusCodes.json b/docs/api/delete-token.StatusCodes.json index b4d19333..686e5815 100644 --- a/docs/api/delete-token.StatusCodes.json +++ b/docs/api/delete-token.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Delete Token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Token Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Delete Token", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Token Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-token.api.mdx b/docs/api/delete-token.api.mdx index 9a541674..b31fab95 100644 --- a/docs/api/delete-token.api.mdx +++ b/docs/api/delete-token.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete a token - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-user.ParamsDetails.json b/docs/api/delete-user.ParamsDetails.json index 25da7410..e5a194b8 100644 --- a/docs/api/delete-user.ParamsDetails.json +++ b/docs/api/delete-user.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "userID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a RUN user ID)" } + } + ] +} diff --git a/docs/api/delete-user.RequestSchema.json b/docs/api/delete-user.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-user.RequestSchema.json +++ b/docs/api/delete-user.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-user.StatusCodes.json b/docs/api/delete-user.StatusCodes.json index 8352775e..9454ae0f 100644 --- a/docs/api/delete-user.StatusCodes.json +++ b/docs/api/delete-user.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Deleting a RUN user by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting a RUN user by ID", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/delete-user.api.mdx b/docs/api/delete-user.api.mdx index 06be5771..a7a7e28e 100644 --- a/docs/api/delete-user.api.mdx +++ b/docs/api/delete-user.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Delete user from Run using userID - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/delete-widget.ParamsDetails.json b/docs/api/delete-widget.ParamsDetails.json index c53ccfe7..9e12e40f 100644 --- a/docs/api/delete-widget.ParamsDetails.json +++ b/docs/api/delete-widget.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + }, + { + "name": "widgetID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a widget ID)" } + } + ] +} diff --git a/docs/api/delete-widget.RequestSchema.json b/docs/api/delete-widget.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/delete-widget.RequestSchema.json +++ b/docs/api/delete-widget.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/delete-widget.StatusCodes.json b/docs/api/delete-widget.StatusCodes.json index 5d7f7469..2ee8e999 100644 --- a/docs/api/delete-widget.StatusCodes.json +++ b/docs/api/delete-widget.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Deleting a Widget","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Removed"},"status":{"type":"boolean","example":true}}},"examples":{"Deleting a Widget":{"value":{"result":"Successfully Removed","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Deleting a Widget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Deleting a Widget": { "value": { "result": "Successfully Removed", "status": true } } } + } + } + } + } +} diff --git a/docs/api/delete-widget.api.mdx b/docs/api/delete-widget.api.mdx index caa66579..d078de89 100644 --- a/docs/api/delete-widget.api.mdx +++ b/docs/api/delete-widget.api.mdx @@ -20,57 +20,28 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Delete a widget from the dashboard. -:::warning +:::warning -Deleting a widget does not automatically remove it from the dashboard arrangement. You must manually edit the dashboard arrangement to remove the deleted widget. +Deleting a widget does not automatically remove it from the dashboard arrangement. You must manually edit the dashboard arrangement to remove the deleted widget. ::: - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/device-data-amount.ParamsDetails.json b/docs/api/device-data-amount.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/device-data-amount.ParamsDetails.json +++ b/docs/api/device-data-amount.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/device-data-amount.RequestSchema.json b/docs/api/device-data-amount.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/device-data-amount.RequestSchema.json +++ b/docs/api/device-data-amount.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/device-data-amount.StatusCodes.json b/docs/api/device-data-amount.StatusCodes.json index 672f7165..87f2b8fd 100644 --- a/docs/api/device-data-amount.StatusCodes.json +++ b/docs/api/device-data-amount.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Getting a device data amount","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"number","example":529},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a device data amount", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "number", "example": 529 }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/device-data-amount.api.mdx b/docs/api/device-data-amount.api.mdx index a0619c5c..09f5df8f 100644 --- a/docs/api/device-data-amount.api.mdx +++ b/docs/api/device-data-amount.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get the total number of data items stored within the device. - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/device-information.ParamsDetails.json b/docs/api/device-information.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/device-information.ParamsDetails.json +++ b/docs/api/device-information.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/device-information.RequestSchema.json b/docs/api/device-information.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/device-information.RequestSchema.json +++ b/docs/api/device-information.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/device-information.StatusCodes.json b/docs/api/device-information.StatusCodes.json index 25140f78..76827cf8 100644 --- a/docs/api/device-information.StatusCodes.json +++ b/docs/api/device-information.StatusCodes.json @@ -1 +1,53 @@ -{"responses":{"200":{"description":"Getting a device information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"connector":{"type":"string","example":"60f19bda2889a60012d34167"},"created_at":{"type":"string","example":"2022-06-09T21:21:51.877Z"},"data_retention":{"type":"string","example":"forever"},"description":{"type":"string","example":"Simulates a Extrusion machine with temperature, speed and pressure"},"id":{"type":"string","example":"62a2646ffdea2f0013b1bfe7"},"last_input":{"type":"string","example":"2022-06-23T11:19:54.369Z"},"name":{"type":"string","example":"Test Chunk Monthly"},"network":{"type":"string","example":"6073cdfec79ed00011228e47"},"payload_decoder":{"example":null},"profile":{"type":"string","example":"612ea05e3cc0780012715111"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"maxTemp"},"value":{"type":"string","example":"20"}}},"example":[{"key":"maxTemp","value":"20"},{"key":"minTemp","value":"0"}]},"type":{"type":"string","example":"mutable"},"updated_at":{"type":"string","example":"2022-06-09T21:53:22.752Z"},"visible":{"type":"boolean","example":true}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a device information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "connector": { "type": "string", "example": "60f19bda2889a60012d34167" }, + "created_at": { "type": "string", "example": "2022-06-09T21:21:51.877Z" }, + "data_retention": { "type": "string", "example": "forever" }, + "description": { + "type": "string", + "example": "Simulates a Extrusion machine with temperature, speed and pressure" + }, + "id": { "type": "string", "example": "62a2646ffdea2f0013b1bfe7" }, + "last_input": { "type": "string", "example": "2022-06-23T11:19:54.369Z" }, + "name": { "type": "string", "example": "Test Chunk Monthly" }, + "network": { "type": "string", "example": "6073cdfec79ed00011228e47" }, + "payload_decoder": { "example": null }, + "profile": { "type": "string", "example": "612ea05e3cc0780012715111" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "maxTemp" }, + "value": { "type": "string", "example": "20" } + } + }, + "example": [ + { "key": "maxTemp", "value": "20" }, + { "key": "minTemp", "value": "0" } + ] + }, + "type": { "type": "string", "example": "mutable" }, + "updated_at": { "type": "string", "example": "2022-06-09T21:53:22.752Z" }, + "visible": { "type": "boolean", "example": true } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/device-information.api.mdx b/docs/api/device-information.api.mdx index 2aff7ff2..4f664295 100644 --- a/docs/api/device-information.api.mdx +++ b/docs/api/device-information.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Device information - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/download-profile-backup.ParamsDetails.json b/docs/api/download-profile-backup.ParamsDetails.json index 48bfa133..15d45f86 100644 --- a/docs/api/download-profile-backup.ParamsDetails.json +++ b/docs/api/download-profile-backup.ParamsDetails.json @@ -1 +1,18 @@ -{"parameters":[{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"},{"name":"backup_id","in":"path","required":true,"schema":{"type":"string","example":"678abc123def456789012345"},"description":"The ID of the backup to download"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "profile_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "description": "The ID of the profile" + }, + { + "name": "backup_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "678abc123def456789012345" }, + "description": "The ID of the backup to download" + } + ] +} diff --git a/docs/api/download-profile-backup.RequestSchema.json b/docs/api/download-profile-backup.RequestSchema.json index 8cf58e9a..48b6a643 100644 --- a/docs/api/download-profile-backup.RequestSchema.json +++ b/docs/api/download-profile-backup.RequestSchema.json @@ -1 +1,38 @@ -{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"password":{"type":"string","description":"Your account password for verification","example":"your_account_password"},"otp_type":{"type":"string","enum":["authenticator","sms","email"],"description":"Type of OTP if 2FA is enabled (optional)","example":"authenticator"},"pin_code":{"type":"string","description":"OTP code if 2FA is enabled (optional)","example":"123456"}}},"examples":{"Without 2FA":{"value":{"password":"your_account_password"}},"With 2FA enabled":{"value":{"password":"your_account_password","otp_type":"authenticator","pin_code":"123456"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["password"], + "properties": { + "password": { + "type": "string", + "description": "Your account password for verification", + "example": "your_account_password" + }, + "otp_type": { + "type": "string", + "enum": ["authenticator", "sms", "email"], + "description": "Type of OTP if 2FA is enabled (optional)", + "example": "authenticator" + }, + "pin_code": { + "type": "string", + "description": "OTP code if 2FA is enabled (optional)", + "example": "123456" + } + } + }, + "examples": { + "Without 2FA": { "value": { "password": "your_account_password" } }, + "With 2FA enabled": { + "value": { "password": "your_account_password", "otp_type": "authenticator", "pin_code": "123456" } + } + } + } + } + } +} diff --git a/docs/api/download-profile-backup.StatusCodes.json b/docs/api/download-profile-backup.StatusCodes.json index 2ea3373b..9327f745 100644 --- a/docs/api/download-profile-backup.StatusCodes.json +++ b/docs/api/download-profile-backup.StatusCodes.json @@ -1 +1,77 @@ -{"responses":{"200":{"description":"Download URL generated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","example":"https://s3.amazonaws.com/tago-io/...?X-Amz-Algorithm=...","description":"Pre-signed S3 URL for downloading the backup (valid for 2 hours)"},"size":{"type":"number","example":15728640,"description":"File size in bytes"},"size_unit":{"type":"string","example":"bytes"},"file_size_mb":{"type":"string","example":"15.00","description":"File size in megabytes (formatted)"},"expire_at":{"type":"string","example":"2025-01-07T16:30:00.000Z","description":"When the download URL expires"},"backup_id":{"type":"string","example":"678abc123def456789012345"},"created_at":{"type":"string","example":"2025-01-07T14:30:00.000Z"}}}}}},"400":{"description":"Bad request - Backup not ready or invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup is not ready for download. Current status: processing"}}}}}},"401":{"description":"Unauthorized - Invalid password or OTP","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid password"}}}}}},"404":{"description":"Not found - Backup does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup not found or you don't have permission to access it."}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Download URL generated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "https://s3.amazonaws.com/tago-io/...?X-Amz-Algorithm=...", + "description": "Pre-signed S3 URL for downloading the backup (valid for 2 hours)" + }, + "size": { "type": "number", "example": 15728640, "description": "File size in bytes" }, + "size_unit": { "type": "string", "example": "bytes" }, + "file_size_mb": { + "type": "string", + "example": "15.00", + "description": "File size in megabytes (formatted)" + }, + "expire_at": { + "type": "string", + "example": "2025-01-07T16:30:00.000Z", + "description": "When the download URL expires" + }, + "backup_id": { "type": "string", "example": "678abc123def456789012345" }, + "created_at": { "type": "string", "example": "2025-01-07T14:30:00.000Z" } + } + } + } + } + }, + "400": { + "description": "Bad request - Backup not ready or invalid parameters", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Backup is not ready for download. Current status: processing" } + } + } + } + } + }, + "401": { + "description": "Unauthorized - Invalid password or OTP", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Invalid password" } + } + } + } + } + }, + "404": { + "description": "Not found - Backup does not exist", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Backup not found or you don't have permission to access it." } + } + } + } + } + } + } +} diff --git a/docs/api/download-profile-backup.api.mdx b/docs/api/download-profile-backup.api.mdx index 19987da6..8e08258b 100644 --- a/docs/api/download-profile-backup.api.mdx +++ b/docs/api/download-profile-backup.api.mdx @@ -20,22 +20,13 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Generates a secure, time-limited download URL for a specific backup. The download URL is valid for **2 hours**. @@ -43,32 +34,12 @@ Generates a secure, time-limited download URL for a specific backup. The downloa **Important:** Only backups with status `completed` can be downloaded. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/duplicate-dashboard.ParamsDetails.json b/docs/api/duplicate-dashboard.ParamsDetails.json index ad79fd90..90c109ae 100644 --- a/docs/api/duplicate-dashboard.ParamsDetails.json +++ b/docs/api/duplicate-dashboard.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + } + ] +} diff --git a/docs/api/duplicate-dashboard.RequestSchema.json b/docs/api/duplicate-dashboard.RequestSchema.json index fdb6c054..1b909c3f 100644 --- a/docs/api/duplicate-dashboard.RequestSchema.json +++ b/docs/api/duplicate-dashboard.RequestSchema.json @@ -1 +1,61 @@ -{"title":"Body","body":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"new_label":{"type":"string","description":"New label for the duplicated dashboard.","example":"Ice Cream Machine and Freezer - Copy"},"setup":{"type":"object","description":"Setup configuration for the duplicated dashboard.","properties":{"is_configured":{"type":"boolean","description":"Indicates if the dashboard is configured.","example":true},"config":{"type":"array","description":"List of configuration objects for the dashboard.","items":{"type":"object","properties":{"id":{"type":"string","description":"Analysis ID, Device ID, Blueprint Device/Entity ID.","example":"68c9baabb24379000ab1c8cc"},"name":{"type":"string","description":"Reference name that will be displayed when setting up the copy.","example":"Freezer Simulator"}}}}}}}},"examples":{"Duplicate dashboard":{"value":{"setup":{"is_configured":true,"config":[{"id":"68c9baabb24379000ab1c8cc","name":"Freezer Simulator"}]},"new_label":"Ice Cream Machine and Freezer - Copy"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_label": { + "type": "string", + "description": "New label for the duplicated dashboard.", + "example": "Ice Cream Machine and Freezer - Copy" + }, + "setup": { + "type": "object", + "description": "Setup configuration for the duplicated dashboard.", + "properties": { + "is_configured": { + "type": "boolean", + "description": "Indicates if the dashboard is configured.", + "example": true + }, + "config": { + "type": "array", + "description": "List of configuration objects for the dashboard.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Analysis ID, Device ID, Blueprint Device/Entity ID.", + "example": "68c9baabb24379000ab1c8cc" + }, + "name": { + "type": "string", + "description": "Reference name that will be displayed when setting up the copy.", + "example": "Freezer Simulator" + } + } + } + } + } + } + } + }, + "examples": { + "Duplicate dashboard": { + "value": { + "setup": { + "is_configured": true, + "config": [{ "id": "68c9baabb24379000ab1c8cc", "name": "Freezer Simulator" }] + }, + "new_label": "Ice Cream Machine and Freezer - Copy" + } + } + } + } + } + } +} diff --git a/docs/api/duplicate-dashboard.StatusCodes.json b/docs/api/duplicate-dashboard.StatusCodes.json index ffcb4883..47e79e01 100644 --- a/docs/api/duplicate-dashboard.StatusCodes.json +++ b/docs/api/duplicate-dashboard.StatusCodes.json @@ -1 +1,24 @@ -{"responses":{"201":{"description":"Dashboard duplicated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"dashboard_id":{"type":"string","example":"62b0df7927ce4d0012cf3c10"},"message":{"type":"string","example":"Copy sent"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "201": { + "description": "Dashboard duplicated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "dashboard_id": { "type": "string", "example": "62b0df7927ce4d0012cf3c10" }, + "message": { "type": "string", "example": "Copy sent" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/duplicate-dashboard.api.mdx b/docs/api/duplicate-dashboard.api.mdx index 9f7bd479..b7664804 100644 --- a/docs/api/duplicate-dashboard.api.mdx +++ b/docs/api/duplicate-dashboard.api.mdx @@ -20,54 +20,21 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Duplicate an existing dashboard, including its configuration, widgets, and settings. -Optionally, set a new label for the duplicated dashboard and provide setup parameters to customize the copy. +Optionally, set a new label for the duplicated dashboard and provide setup parameters to customize the copy. Use this endpoint to quickly clone dashboards for reuse or further customization. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-a-file.RequestSchema.json b/docs/api/edit-a-file.RequestSchema.json index 4470d7cc..84865655 100644 --- a/docs/api/edit-a-file.RequestSchema.json +++ b/docs/api/edit-a-file.RequestSchema.json @@ -1 +1,21 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","example":"/layer05.png"},"to":{"type":"string","example":"/images/layer05.png"}}},"example":[{"from":"/layer05.png","to":"/images/layer05.png"}]},"examples":{"Edit a file":{"value":[{"from":"/layer05.png","to":"/images/layer05.png"}]}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "from": { "type": "string", "example": "/layer05.png" }, + "to": { "type": "string", "example": "/images/layer05.png" } + } + }, + "example": [{ "from": "/layer05.png", "to": "/images/layer05.png" }] + }, + "examples": { "Edit a file": { "value": [{ "from": "/layer05.png", "to": "/images/layer05.png" }] } } + } + } + } +} diff --git a/docs/api/edit-a-file.StatusCodes.json b/docs/api/edit-a-file.StatusCodes.json index 68ae3d50..1fcb3ea6 100644 --- a/docs/api/edit-a-file.StatusCodes.json +++ b/docs/api/edit-a-file.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Edit a file","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Edit a file":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Edit a file", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Edit a file": { "value": { "result": "Successfully Updated", "status": true } } } + } + } + } + } +} diff --git a/docs/api/edit-a-file.api.mdx b/docs/api/edit-a-file.api.mdx index 82916013..a7d00fbe 100644 --- a/docs/api/edit-a-file.api.mdx +++ b/docs/api/edit-a-file.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Move file location within your profile - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-account.RequestSchema.json b/docs/api/edit-account.RequestSchema.json index c27f756a..02cd4ef0 100644 --- a/docs/api/edit-account.RequestSchema.json +++ b/docs/api/edit-account.RequestSchema.json @@ -1 +1,54 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"string","example":"TagoIO"},"language":{"type":"string","example":"en"},"name":{"type":"string","example":"John Doee"},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"YYYY-MM-DD"},"decimal_separator":{"type":"string","example":"."},"show_last_updated_at":{"type":"string","example":"footer"},"thousand_separator":{"type":"string","example":","},"time_format":{"type":"string","example":"24"}}},"phone":{"type":"string","example":"+00000000000"},"timezone":{"type":"string","example":"America/Glace_Bay"}}},"examples":{"Edit Account":{"value":{"company":"TagoIO","language":"en","name":"John Doee","options":{"date_format":"YYYY-MM-DD","decimal_separator":".","show_last_updated_at":"footer","thousand_separator":",","time_format":"24"},"phone":"+00000000000","timezone":"America/Glace_Bay"}}}},"text/plain":{"examples":{"Edit Account":{"value":"{\n \"language\": \"en\",\n \"name\": \"Account Name\",\n \"options\": {\n \"date_format\": \"YYYY-MM-DD\", //\"YYYY-MM-DD\", \"DD-MM-YYYY\", or \"MM-DD-YYYY\"\n \"time_format\": \"12\", //\"12\" or \"24\"\n \"decimal_separator\": \".\", //must be the oposite of the \"thousand_separator value\"\n \"thousand_separator\": \",\", //must be the oposite of the \"decimal_separator value\"\n \"show_last_updated_at\": \"footer\" //widget \"footer\" or \"menu\"\n },\n \"phone\": \"+00000000000\", //type the country code plus the phone number\n \"timezone\": \"America/Glace_Bay\",\n \"company\": \"TagoIO\"\n}"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "company": { "type": "string", "example": "TagoIO" }, + "language": { "type": "string", "example": "en" }, + "name": { "type": "string", "example": "John Doee" }, + "options": { + "type": "object", + "properties": { + "date_format": { "type": "string", "example": "YYYY-MM-DD" }, + "decimal_separator": { "type": "string", "example": "." }, + "show_last_updated_at": { "type": "string", "example": "footer" }, + "thousand_separator": { "type": "string", "example": "," }, + "time_format": { "type": "string", "example": "24" } + } + }, + "phone": { "type": "string", "example": "+00000000000" }, + "timezone": { "type": "string", "example": "America/Glace_Bay" } + } + }, + "examples": { + "Edit Account": { + "value": { + "company": "TagoIO", + "language": "en", + "name": "John Doee", + "options": { + "date_format": "YYYY-MM-DD", + "decimal_separator": ".", + "show_last_updated_at": "footer", + "thousand_separator": ",", + "time_format": "24" + }, + "phone": "+00000000000", + "timezone": "America/Glace_Bay" + } + } + } + }, + "text/plain": { + "examples": { + "Edit Account": { + "value": "{\n \"language\": \"en\",\n \"name\": \"Account Name\",\n \"options\": {\n \"date_format\": \"YYYY-MM-DD\", //\"YYYY-MM-DD\", \"DD-MM-YYYY\", or \"MM-DD-YYYY\"\n \"time_format\": \"12\", //\"12\" or \"24\"\n \"decimal_separator\": \".\", //must be the oposite of the \"thousand_separator value\"\n \"thousand_separator\": \",\", //must be the oposite of the \"decimal_separator value\"\n \"show_last_updated_at\": \"footer\" //widget \"footer\" or \"menu\"\n },\n \"phone\": \"+00000000000\", //type the country code plus the phone number\n \"timezone\": \"America/Glace_Bay\",\n \"company\": \"TagoIO\"\n}" + } + } + } + } + } +} diff --git a/docs/api/edit-account.StatusCodes.json b/docs/api/edit-account.StatusCodes.json index 66f9928f..2ee31a86 100644 --- a/docs/api/edit-account.StatusCodes.json +++ b/docs/api/edit-account.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Account edited successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Account Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Account edited successfuly":{"value":{"result":"Account Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Account edited successfuly", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Account Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Account edited successfuly": { "value": { "result": "Account Successfully Updated", "status": true } } + } + } + } + } + } +} diff --git a/docs/api/edit-account.api.mdx b/docs/api/edit-account.api.mdx index 56614804..e2e1ac84 100644 --- a/docs/api/edit-account.api.mdx +++ b/docs/api/edit-account.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit current account - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-dashboard.ParamsDetails.json b/docs/api/edit-dashboard.ParamsDetails.json index ad79fd90..90c109ae 100644 --- a/docs/api/edit-dashboard.ParamsDetails.json +++ b/docs/api/edit-dashboard.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + } + ] +} diff --git a/docs/api/edit-dashboard.RequestSchema.json b/docs/api/edit-dashboard.RequestSchema.json index fa734f0c..511b3e5d 100644 --- a/docs/api/edit-dashboard.RequestSchema.json +++ b/docs/api/edit-dashboard.RequestSchema.json @@ -1 +1,178 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The Dashboard Label"},"type":{"type":"string","enum":["dashboard","blueprint"],"example":"blueprint","description":"The type of dashboard. Can be \"dashboard\" or \"blueprint\"."},"group_by":{"type":"array","items":{}},"visible":{"type":"boolean","example":true,"description":"Determines if the dashboard is visible in the sidebar. If set to false, the dashboard remains accessible from the Dashboard list."},"icon":{"type":"object","properties":{"color":{"type":"string","example":"hsl(328, 89%, 47%)"},"url":{"type":"string","example":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"}}},"tabs":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"1648142133869"},"link":{"type":"string","example":""},"value":{"type":"string","example":"new tab test"}}},"example":[{"key":"1648142133869","link":"","value":"new tab test"},{"key":"1648142564354","link":"","value":"new tab 2 "},{"key":"1648142571171","link":"","value":"new tab 3 "}]},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"updatedkey"},"value":{"type":"string","example":"updatedvalue"}}},"example":[{"key":"updatedkey","value":"updatedvalue"},{"key":"updatedkey","value":"updatedvalue"}]},"blueprint_devices":{"type":"array","description":"Only present for dashboards of type \"blueprint\".\nDefines the list of devices associated with a blueprint dashboard. Each device entry describes a device type, its conditions, and optional filter conditions.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the blueprint device.","example":"68d2f3e0a6343f0009318e4c"},"name":{"type":"string","description":"The name of the blueprint.","example":"sensor"},"type":{"type":"string","description":"The type of the blueprint.","enum":["device","entity"],"example":"device"},"conditions":{"type":"array","description":"List of tag conditions that define this blueprint's characteristics.","items":{"type":"object","properties":{"key":{"type":"string","description":"The condition key.","example":"is_sensor"},"value":{"type":"string","description":"The condition value.","example":"true"}}},"example":[{"key":"is_sensor","value":"true"}]},"filter_conditions":{"type":"array","description":"Optional filter conditions for the device.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of filter condition.","example":"tag_match"},"tag_key":{"type":"string","description":"The tag key to match.","example":"location"},"blueprint_device":{"type":"string","description":"The name of the blueprint device to match against.","example":"customer"}}},"example":[{"type":"tag_match","tag_key":"location","blueprint_device":"customer"}]}}},"example":[{"id":"68d2f3e0a6343f0009318e4c","name":"sensor","type":"device","conditions":[{"key":"is_sensor","value":"true"}],"filter_conditions":[]},{"id":"68d2f3e0a6343f0009318e4d","name":"customer","type":"device","conditions":[{"key":"company","value":"JohnDoe"}],"filter_conditions":[]}]},"arrangement":{"type":"array","description":"The arrangement property defines the layout and positioning of widgets within the dashboard grid.\n","items":{"type":"object","properties":{"height":{"type":"number","example":3,"description":"The height of the widget in grid units."},"tab":{"description":"The tab identifier if the widget is placed in a tab, or null.","example":null},"widget_id":{"type":"string","example":"6230e740f5772600124c81e1","description":"The ID of the widget."},"width":{"type":"number","example":1,"description":"The width of the widget in grid units."},"x":{"type":"number","example":0,"description":"The X (column) position of the widget in the grid."},"y":{"type":"number","example":0,"description":"The Y (row) position of the widget in the grid."}}},"example":[{"height":3,"tab":null,"widget_id":"6230e740f5772600124c81e1","width":1,"x":0,"y":0},{"height":3,"tab":null,"widget_id":"6230e75df5772600124c81e2","width":1,"x":1,"y":0},{"height":3,"tab":null,"widget_id":"6230e44cf5772600124c81de","width":1,"x":2,"y":0},{"height":3,"tab":null,"widget_id":"6230e84df5772600124c81e7","width":2.33,"x":0.33,"y":7},{"height":5,"tab":null,"widget_id":"62750cf1253eb800126aefc0","width":2,"x":2.67,"y":7}]}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "label": { "type": "string", "description": "The Dashboard Label" }, + "type": { + "type": "string", + "enum": ["dashboard", "blueprint"], + "example": "blueprint", + "description": "The type of dashboard. Can be \"dashboard\" or \"blueprint\"." + }, + "group_by": { "type": "array", "items": {} }, + "visible": { + "type": "boolean", + "example": true, + "description": "Determines if the dashboard is visible in the sidebar. If set to false, the dashboard remains accessible from the Dashboard list." + }, + "icon": { + "type": "object", + "properties": { + "color": { "type": "string", "example": "hsl(328, 89%, 47%)" }, + "url": { + "type": "string", + "example": "https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg" + } + } + }, + "tabs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "1648142133869" }, + "link": { "type": "string", "example": "" }, + "value": { "type": "string", "example": "new tab test" } + } + }, + "example": [ + { "key": "1648142133869", "link": "", "value": "new tab test" }, + { "key": "1648142564354", "link": "", "value": "new tab 2 " }, + { "key": "1648142571171", "link": "", "value": "new tab 3 " } + ] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "updatedkey" }, + "value": { "type": "string", "example": "updatedvalue" } + } + }, + "example": [ + { "key": "updatedkey", "value": "updatedvalue" }, + { "key": "updatedkey", "value": "updatedvalue" } + ] + }, + "blueprint_devices": { + "type": "array", + "description": "Only present for dashboards of type \"blueprint\".\nDefines the list of devices associated with a blueprint dashboard. Each device entry describes a device type, its conditions, and optional filter conditions.\n", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the blueprint device.", + "example": "68d2f3e0a6343f0009318e4c" + }, + "name": { "type": "string", "description": "The name of the blueprint.", "example": "sensor" }, + "type": { + "type": "string", + "description": "The type of the blueprint.", + "enum": ["device", "entity"], + "example": "device" + }, + "conditions": { + "type": "array", + "description": "List of tag conditions that define this blueprint's characteristics.", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "description": "The condition key.", "example": "is_sensor" }, + "value": { "type": "string", "description": "The condition value.", "example": "true" } + } + }, + "example": [{ "key": "is_sensor", "value": "true" }] + }, + "filter_conditions": { + "type": "array", + "description": "Optional filter conditions for the device.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of filter condition.", + "example": "tag_match" + }, + "tag_key": { "type": "string", "description": "The tag key to match.", "example": "location" }, + "blueprint_device": { + "type": "string", + "description": "The name of the blueprint device to match against.", + "example": "customer" + } + } + }, + "example": [{ "type": "tag_match", "tag_key": "location", "blueprint_device": "customer" }] + } + } + }, + "example": [ + { + "id": "68d2f3e0a6343f0009318e4c", + "name": "sensor", + "type": "device", + "conditions": [{ "key": "is_sensor", "value": "true" }], + "filter_conditions": [] + }, + { + "id": "68d2f3e0a6343f0009318e4d", + "name": "customer", + "type": "device", + "conditions": [{ "key": "company", "value": "JohnDoe" }], + "filter_conditions": [] + } + ] + }, + "arrangement": { + "type": "array", + "description": "The arrangement property defines the layout and positioning of widgets within the dashboard grid.\n", + "items": { + "type": "object", + "properties": { + "height": { + "type": "number", + "example": 3, + "description": "The height of the widget in grid units." + }, + "tab": { + "description": "The tab identifier if the widget is placed in a tab, or null.", + "example": null + }, + "widget_id": { + "type": "string", + "example": "6230e740f5772600124c81e1", + "description": "The ID of the widget." + }, + "width": { "type": "number", "example": 1, "description": "The width of the widget in grid units." }, + "x": { + "type": "number", + "example": 0, + "description": "The X (column) position of the widget in the grid." + }, + "y": { + "type": "number", + "example": 0, + "description": "The Y (row) position of the widget in the grid." + } + } + }, + "example": [ + { "height": 3, "tab": null, "widget_id": "6230e740f5772600124c81e1", "width": 1, "x": 0, "y": 0 }, + { "height": 3, "tab": null, "widget_id": "6230e75df5772600124c81e2", "width": 1, "x": 1, "y": 0 }, + { "height": 3, "tab": null, "widget_id": "6230e44cf5772600124c81de", "width": 1, "x": 2, "y": 0 }, + { "height": 3, "tab": null, "widget_id": "6230e84df5772600124c81e7", "width": 2.33, "x": 0.33, "y": 7 }, + { "height": 5, "tab": null, "widget_id": "62750cf1253eb800126aefc0", "width": 2, "x": 2.67, "y": 7 } + ] + } + } + } + } + } + } +} diff --git a/docs/api/edit-dashboard.StatusCodes.json b/docs/api/edit-dashboard.StatusCodes.json index b8ed6663..e6011ec9 100644 --- a/docs/api/edit-dashboard.StatusCodes.json +++ b/docs/api/edit-dashboard.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Updating a dashboard information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Updating a dashboard information":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Updating a dashboard information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Updating a dashboard information": { "value": { "result": "Successfully Updated", "status": true } } + } + } + } + } + } +} diff --git a/docs/api/edit-dashboard.api.mdx b/docs/api/edit-dashboard.api.mdx index ef0f007f..3c73557b 100644 --- a/docs/api/edit-dashboard.api.mdx +++ b/docs/api/edit-dashboard.api.mdx @@ -20,22 +20,9 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Modify any property of the dashboard @@ -46,32 +33,12 @@ After creating a widget, you **must manually edit the arrangement field** to inc Each item in the arrangement array represents a widget's placement and sizing. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-data.RequestSchema.json b/docs/api/edit-data.RequestSchema.json index a6d96134..e9f74ccc 100644 --- a/docs/api/edit-data.RequestSchema.json +++ b/docs/api/edit-data.RequestSchema.json @@ -1 +1,29 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"6298fcc3e0b6840012bb6abfa"},"metadata":{"type":"object","properties":{"color":{"type":"string","example":"blue"}}},"value":{"type":"string","example":"27"}}},"example":[{"id":"6298fcc3e0b6840012bb6abfa","metadata":{"color":"blue"},"value":"27"}]}},"text/plain":{"examples":{"Edit data":{"value":"[\n {\n \"id\": \"6298fcc3e0b6840012bb6abfa\",\n \"value\": \"27\", // edit the value field\n \"metadata\": { // edit the metadata field\n \"color\": \"blue\"\n }\n }\n]"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "required": ["id"], + "properties": { + "id": { "type": "string", "example": "6298fcc3e0b6840012bb6abfa" }, + "metadata": { "type": "object", "properties": { "color": { "type": "string", "example": "blue" } } }, + "value": { "type": "string", "example": "27" } + } + }, + "example": [{ "id": "6298fcc3e0b6840012bb6abfa", "metadata": { "color": "blue" }, "value": "27" }] + } + }, + "text/plain": { + "examples": { + "Edit data": { + "value": "[\n {\n \"id\": \"6298fcc3e0b6840012bb6abfa\",\n \"value\": \"27\", // edit the value field\n \"metadata\": { // edit the metadata field\n \"color\": \"blue\"\n }\n }\n]" + } + } + } + } + } +} diff --git a/docs/api/edit-data.StatusCodes.json b/docs/api/edit-data.StatusCodes.json index b489dd36..fbc0335f 100644 --- a/docs/api/edit-data.StatusCodes.json +++ b/docs/api/edit-data.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Editing data register by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 item(s) updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing data register by ID", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "1 item(s) updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/edit-data.api.mdx b/docs/api/edit-data.api.mdx index cc0dd17e..7b7bf50a 100644 --- a/docs/api/edit-data.api.mdx +++ b/docs/api/edit-data.api.mdx @@ -20,53 +20,21 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit specific data stored in the device. Same properties as the Create Data is accepted, edit requires the ID field of the data to be edited. :::info This request is only available when using Mutable Storage on Devices ::: - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-device-configuration-parameter.ParamsDetails.json b/docs/api/edit-device-configuration-parameter.ParamsDetails.json index 74a0abb9..fc7cbc7d 100644 --- a/docs/api/edit-device-configuration-parameter.ParamsDetails.json +++ b/docs/api/edit-device-configuration-parameter.ParamsDetails.json @@ -1 +1 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file +{ "parameters": [{ "name": "deviceID", "in": "path", "required": true, "schema": { "type": "string" } }] } diff --git a/docs/api/edit-device-configuration-parameter.RequestSchema.json b/docs/api/edit-device-configuration-parameter.RequestSchema.json index 58708864..1386ab53 100644 --- a/docs/api/edit-device-configuration-parameter.RequestSchema.json +++ b/docs/api/edit-device-configuration-parameter.RequestSchema.json @@ -1 +1,41 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6114b901cd09d0fa0013636afcc"},"key":{"type":"string","example":"downlink_url"},"sent":{"type":"boolean","example":true},"value":{"type":"string","example":"https://mydownlink.url.io"}}},"example":[{"id":"6114b901cd09d0fa0013636afcc","key":"downlink_url","sent":true,"value":"https://mydownlink.url.io"}]},"examples":{"Edit Device Configuration Parameter":{"value":[{"id":"6114b901cd09d0fa0013636afcc","key":"downlink_url","sent":true,"value":"https://mydownlink.url.io"}]}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "6114b901cd09d0fa0013636afcc" }, + "key": { "type": "string", "example": "downlink_url" }, + "sent": { "type": "boolean", "example": true }, + "value": { "type": "string", "example": "https://mydownlink.url.io" } + } + }, + "example": [ + { + "id": "6114b901cd09d0fa0013636afcc", + "key": "downlink_url", + "sent": true, + "value": "https://mydownlink.url.io" + } + ] + }, + "examples": { + "Edit Device Configuration Parameter": { + "value": [ + { + "id": "6114b901cd09d0fa0013636afcc", + "key": "downlink_url", + "sent": true, + "value": "https://mydownlink.url.io" + } + ] + } + } + } + } + } +} diff --git a/docs/api/edit-device-configuration-parameter.StatusCodes.json b/docs/api/edit-device-configuration-parameter.StatusCodes.json index 58624a78..8091e87e 100644 --- a/docs/api/edit-device-configuration-parameter.StatusCodes.json +++ b/docs/api/edit-device-configuration-parameter.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Edit the configuration parameter","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Device Configuration Parameter Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Edit the configuration parameter", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Device Configuration Parameter Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/edit-device-configuration-parameter.api.mdx b/docs/api/edit-device-configuration-parameter.api.mdx index 1723163e..6371238a 100644 --- a/docs/api/edit-device-configuration-parameter.api.mdx +++ b/docs/api/edit-device-configuration-parameter.api.mdx @@ -20,22 +20,9 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit a device configuration parameter using the Network-token. You must already have the device ID to use this endpoint. This is useful when your Network integration requires configuration parameters for performing downlinks, or if your decoder benefits from configuration parameters for parsing data. @@ -43,31 +30,12 @@ This is useful when your Network integration requires configuration parameters f To obtain the **Device ID**, first resolve the device-token, then use the [Device Information](/docs/api/current-device-information) endpoint to retrieve detailed information about the device. ::: - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-device-data.ParamsDetails.json b/docs/api/edit-device-data.ParamsDetails.json index 4af8f8f6..c5d99580 100644 --- a/docs/api/edit-device-data.ParamsDetails.json +++ b/docs/api/edit-device-data.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" }, + "description": "Device ID" + } + ] +} diff --git a/docs/api/edit-device-data.RequestSchema.json b/docs/api/edit-device-data.RequestSchema.json index b62bd070..b281de6d 100644 --- a/docs/api/edit-device-data.RequestSchema.json +++ b/docs/api/edit-device-data.RequestSchema.json @@ -1 +1,17 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"653aa3ab617c10000990718f"},"value":{"type":"number","example":20}}},"examples":{"Edit Device Data":{"value":{"id":"653aa3ab617c10000990718f","value":20}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "653aa3ab617c10000990718f" }, + "value": { "type": "number", "example": 20 } + } + }, + "examples": { "Edit Device Data": { "value": { "id": "653aa3ab617c10000990718f", "value": 20 } } } + } + } + } +} diff --git a/docs/api/edit-device-data.StatusCodes.json b/docs/api/edit-device-data.StatusCodes.json index 4862e0a8..e82d8b42 100644 --- a/docs/api/edit-device-data.StatusCodes.json +++ b/docs/api/edit-device-data.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Editing a device data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 item(s) updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing a device data":{"value":{"result":"1 item(s) updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing a device data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "1 item(s) updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Editing a device data": { "value": { "result": "1 item(s) updated", "status": true } } } + } + } + } + } +} diff --git a/docs/api/edit-device-data.api.mdx b/docs/api/edit-device-data.api.mdx index 3839d829..f3191e12 100644 --- a/docs/api/edit-device-data.api.mdx +++ b/docs/api/edit-device-data.api.mdx @@ -20,53 +20,21 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit specific data stored in the device. :::info This request is only available when using Mutable Storage on Devices ::: - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-device.ParamsDetails.json b/docs/api/edit-device.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/edit-device.ParamsDetails.json +++ b/docs/api/edit-device.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/edit-device.RequestSchema.json b/docs/api/edit-device.RequestSchema.json index 34ee9f95..630eb9ed 100644 --- a/docs/api/edit-device.RequestSchema.json +++ b/docs/api/edit-device.RequestSchema.json @@ -1 +1,48 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":false},"connector":{"type":"string","example":"6148de43683cae0018940d0c"},"name":{"type":"string","example":"Device #2"},"network":{"type":"string","example":"5bbd120d4051a50034cd1a05"},"payload_decoder":{"type":"string","description":"Base64 formatted javascript code"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"my_tag_key"},"value":{"type":"string","example":"my_tag_value"}}},"example":[{"key":"my_tag_key","value":"my_tag_value"}]},"visible":{"type":"boolean","example":false}}},"examples":{"Edit device":{"value":{"active":false,"connector":"6148de43683cae0018940d0c","name":"Device #2","network":"5bbd120d4051a50034cd1a05","payload_decoder":"LyogVGhpcyBpcyBhIGRlZmF1bHQgZXhhbXBsZSBmb3IgcGF5bG9hZCBwYXJzZXIuCioqIFRoZSBpZ25vcmVfdmFycyB2YXJpYWJsZSBpbiB0aGlzIGNvZGUgc2hvdWxkIGJlIHVzZWQgdG8gaWdub3JlIHZhcmlhYmxlcwoqKiBmcm9tIHRoZSBkZXZpY2UgdGhhdCB5b3UgZG9uJ3Qgd2FudC4KKioKKiogVGVzdGluZzoKKiogWW91IGNhbiBkbyBtYW51YWwgdGVzdHMgdG8gdGhpcyBwYXJzZSBieSB1c2luZyB0aGUgRGV2aWNlIEVtdWxhdG9yLiBDb3B5IGFuZCBQYXN0ZSB0aGUgZm9sbG93aW5nIGNvZGU6CioqIFt7ICJ2YXJpYWJsZSI6ICJwYXlsb2FkIiwgInZhbHVlIjogIjAxMDk2MTEzOTUiIH1dCioqCiovCi8vIEFkZCBpZ25vcmFibGUgdmFyaWFibGVzIGluIHRoaXMgYXJyYXkuCmNvbnN0IGlnbm9yZV92YXJzID0gWydyZl9jaGFpbicsICdjaGFubmVsJywgJ21vZHVsYXRpb24nLCAnYXBwX2lkJywgJ2Rldl9pZCcsICd0aW1lJywgJ2d0d190cnVzdGVkJywgJ3BvcnQnXTsKCi8vIFJlbW92ZSB1bndhbnRlZCB2YXJpYWJsZXMuCnBheWxvYWQgPSBwYXlsb2FkLmZpbHRlcih4ID0+ICFpZ25vcmVfdmFycy5pbmNsdWRlcyh4LnZhcmlhYmxlKSk7CgovLyBZb3UgY2FuIGVkaXQgYW55IHZhcmlhYmxlIHRoYXQncyBiZWluZyBhZGRlZCB0byB5b3VyIGRldmljZS4KLy8gRm9yIGV4YW1wbGUsIGlmIHlvdSBuZWVkIHRvIGNvbnZlcnQgYSB2YXJpYWJsZSBmcm9tIEZhaHJlaW50aCB0byBDZWxzaXVzLCB1bmNvbW1lbnQgdGhlIGZvbGxvd2luZyBjb2RlOgovLyBjb25zdCB0ZW1wZXJhdHVyZSA9IHBheWxvYWQuZmluZCh4ID0+IHgudmFyaWFibGUgPT09ICJ0ZW1wZXJhdHVyZSIpOwovLyBpZiAodGVtcGVyYXR1cmUpIHsKLy8gICB0ZW1wZXJhdHVyZS52YWx1ZSA9ICg1IC8gOSkgKiAodGVtcGVyYXR1cmUudmFsdWUgLSAzMik7Ci8vICAgdGVtcGVyYXR1cmUudW5pdCA9ICJDIjsKLy8gfQ==","tags":[{"key":"my_tag_key","value":"my_tag_value"}],"visible":false,"chunk_retention":20}},"Immutable Chunk retention":{"value":"{\r\n \"chunk_retention\": 20 // acceptable range by period: day(0-31), week(0-26), month(0-36), quarter(0-36)\r\n}"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": false }, + "connector": { "type": "string", "example": "6148de43683cae0018940d0c" }, + "name": { "type": "string", "example": "Device #2" }, + "network": { "type": "string", "example": "5bbd120d4051a50034cd1a05" }, + "payload_decoder": { "type": "string", "description": "Base64 formatted javascript code" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "my_tag_key" }, + "value": { "type": "string", "example": "my_tag_value" } + } + }, + "example": [{ "key": "my_tag_key", "value": "my_tag_value" }] + }, + "visible": { "type": "boolean", "example": false } + } + }, + "examples": { + "Edit device": { + "value": { + "active": false, + "connector": "6148de43683cae0018940d0c", + "name": "Device #2", + "network": "5bbd120d4051a50034cd1a05", + "payload_decoder": "LyogVGhpcyBpcyBhIGRlZmF1bHQgZXhhbXBsZSBmb3IgcGF5bG9hZCBwYXJzZXIuCioqIFRoZSBpZ25vcmVfdmFycyB2YXJpYWJsZSBpbiB0aGlzIGNvZGUgc2hvdWxkIGJlIHVzZWQgdG8gaWdub3JlIHZhcmlhYmxlcwoqKiBmcm9tIHRoZSBkZXZpY2UgdGhhdCB5b3UgZG9uJ3Qgd2FudC4KKioKKiogVGVzdGluZzoKKiogWW91IGNhbiBkbyBtYW51YWwgdGVzdHMgdG8gdGhpcyBwYXJzZSBieSB1c2luZyB0aGUgRGV2aWNlIEVtdWxhdG9yLiBDb3B5IGFuZCBQYXN0ZSB0aGUgZm9sbG93aW5nIGNvZGU6CioqIFt7ICJ2YXJpYWJsZSI6ICJwYXlsb2FkIiwgInZhbHVlIjogIjAxMDk2MTEzOTUiIH1dCioqCiovCi8vIEFkZCBpZ25vcmFibGUgdmFyaWFibGVzIGluIHRoaXMgYXJyYXkuCmNvbnN0IGlnbm9yZV92YXJzID0gWydyZl9jaGFpbicsICdjaGFubmVsJywgJ21vZHVsYXRpb24nLCAnYXBwX2lkJywgJ2Rldl9pZCcsICd0aW1lJywgJ2d0d190cnVzdGVkJywgJ3BvcnQnXTsKCi8vIFJlbW92ZSB1bndhbnRlZCB2YXJpYWJsZXMuCnBheWxvYWQgPSBwYXlsb2FkLmZpbHRlcih4ID0+ICFpZ25vcmVfdmFycy5pbmNsdWRlcyh4LnZhcmlhYmxlKSk7CgovLyBZb3UgY2FuIGVkaXQgYW55IHZhcmlhYmxlIHRoYXQncyBiZWluZyBhZGRlZCB0byB5b3VyIGRldmljZS4KLy8gRm9yIGV4YW1wbGUsIGlmIHlvdSBuZWVkIHRvIGNvbnZlcnQgYSB2YXJpYWJsZSBmcm9tIEZhaHJlaW50aCB0byBDZWxzaXVzLCB1bmNvbW1lbnQgdGhlIGZvbGxvd2luZyBjb2RlOgovLyBjb25zdCB0ZW1wZXJhdHVyZSA9IHBheWxvYWQuZmluZCh4ID0+IHgudmFyaWFibGUgPT09ICJ0ZW1wZXJhdHVyZSIpOwovLyBpZiAodGVtcGVyYXR1cmUpIHsKLy8gICB0ZW1wZXJhdHVyZS52YWx1ZSA9ICg1IC8gOSkgKiAodGVtcGVyYXR1cmUudmFsdWUgLSAzMik7Ci8vICAgdGVtcGVyYXR1cmUudW5pdCA9ICJDIjsKLy8gfQ==", + "tags": [{ "key": "my_tag_key", "value": "my_tag_value" }], + "visible": false, + "chunk_retention": 20 + } + }, + "Immutable Chunk retention": { + "value": "{\r\n \"chunk_retention\": 20 // acceptable range by period: day(0-31), week(0-26), month(0-36), quarter(0-36)\r\n}" + } + } + } + } + } +} diff --git a/docs/api/edit-device.StatusCodes.json b/docs/api/edit-device.StatusCodes.json index 841b2016..e543e74f 100644 --- a/docs/api/edit-device.StatusCodes.json +++ b/docs/api/edit-device.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Updating device settings","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Updating device settings", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/edit-device.api.mdx b/docs/api/edit-device.api.mdx index ef82f52a..97b5e052 100644 --- a/docs/api/edit-device.api.mdx +++ b/docs/api/edit-device.api.mdx @@ -20,22 +20,9 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Modify any property of the device. @@ -43,32 +30,12 @@ You're only required to send the parameters you want to edit. If changing network/connector, make sure you've deleted all tokens in the device first. Is also required to send both network and connector to edit any of both fields. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-entity-data.ParamsDetails.json b/docs/api/edit-entity-data.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/edit-entity-data.ParamsDetails.json +++ b/docs/api/edit-entity-data.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/edit-entity-data.RequestSchema.json b/docs/api/edit-entity-data.RequestSchema.json index b9f7f124..3ed33357 100644 --- a/docs/api/edit-entity-data.RequestSchema.json +++ b/docs/api/edit-entity-data.RequestSchema.json @@ -1 +1,19 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"672b5449dbac110009ce878f"},"monthly_revenue":{"type":"number","example":1239.45}}},"examples":{"Edit Entity Data":{"value":{"id":"672b5449dbac110009ce878f","monthly_revenue":1239.45}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "672b5449dbac110009ce878f" }, + "monthly_revenue": { "type": "number", "example": 1239.45 } + } + }, + "examples": { + "Edit Entity Data": { "value": { "id": "672b5449dbac110009ce878f", "monthly_revenue": 1239.45 } } + } + } + } + } +} diff --git a/docs/api/edit-entity-data.StatusCodes.json b/docs/api/edit-entity-data.StatusCodes.json index 451438c5..e0cf5917 100644 --- a/docs/api/edit-entity-data.StatusCodes.json +++ b/docs/api/edit-entity-data.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Editing an entity data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 item(s) updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing an entity data":{"value":{"result":"1 item(s) updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing an entity data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "1 item(s) updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Editing an entity data": { "value": { "result": "1 item(s) updated", "status": true } } } + } + } + } + } +} diff --git a/docs/api/edit-entity-data.api.mdx b/docs/api/edit-entity-data.api.mdx index 6f2e7403..9b8e22cd 100644 --- a/docs/api/edit-entity-data.api.mdx +++ b/docs/api/edit-entity-data.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit Entity Data - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-notification.ParamsDetails.json b/docs/api/edit-notification.ParamsDetails.json index a1e9f650..0267e06c 100644 --- a/docs/api/edit-notification.ParamsDetails.json +++ b/docs/api/edit-notification.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"notificationID","in":"path","required":true,"schema":{"type":"string","example":"(Type your RUN notification ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "notificationID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your RUN notification ID)" } + } + ] +} diff --git a/docs/api/edit-notification.RequestSchema.json b/docs/api/edit-notification.RequestSchema.json index 8137d7c5..7768324a 100644 --- a/docs/api/edit-notification.RequestSchema.json +++ b/docs/api/edit-notification.RequestSchema.json @@ -1 +1,18 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"buttons_enabled":{"type":"boolean","example":true},"message":{"type":"string","example":"new notification message"},"read":{"type":"boolean","example":true},"title":{"type":"string","example":"new notification title"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "buttons_enabled": { "type": "boolean", "example": true }, + "message": { "type": "string", "example": "new notification message" }, + "read": { "type": "boolean", "example": true }, + "title": { "type": "string", "example": "new notification title" } + } + } + } + } + } +} diff --git a/docs/api/edit-notification.StatusCodes.json b/docs/api/edit-notification.StatusCodes.json index dadbf30c..b5ac7083 100644 --- a/docs/api/edit-notification.StatusCodes.json +++ b/docs/api/edit-notification.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Editing a RUN user notification","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"TagoIO Notification User Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing a RUN user notification", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "TagoIO Notification User Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/edit-notification.api.mdx b/docs/api/edit-notification.api.mdx index 9515fc7d..1b3a0cfb 100644 --- a/docs/api/edit-notification.api.mdx +++ b/docs/api/edit-notification.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit notification on Run - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-permission.RequestSchema.json b/docs/api/edit-permission.RequestSchema.json index d0aac6a6..b6dda503 100644 --- a/docs/api/edit-permission.RequestSchema.json +++ b/docs/api/edit-permission.RequestSchema.json @@ -1 +1,21 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string","example":"/layer05.png"},"public":{"type":"boolean","example":true}}},"example":[{"file":"/layer05.png","public":true}]},"examples":{"Edit Permission":{"value":[{"file":"/layer05.png","public":true}]}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file": { "type": "string", "example": "/layer05.png" }, + "public": { "type": "boolean", "example": true } + } + }, + "example": [{ "file": "/layer05.png", "public": true }] + }, + "examples": { "Edit Permission": { "value": [{ "file": "/layer05.png", "public": true }] } } + } + } + } +} diff --git a/docs/api/edit-permission.StatusCodes.json b/docs/api/edit-permission.StatusCodes.json index 4ef313f9..a37e67a7 100644 --- a/docs/api/edit-permission.StatusCodes.json +++ b/docs/api/edit-permission.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Editing file to be public","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing file to be public":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing file to be public", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Editing file to be public": { "value": { "result": "Successfully Updated", "status": true } } } + } + } + } + } +} diff --git a/docs/api/edit-permission.api.mdx b/docs/api/edit-permission.api.mdx index c86d5c40..5561d525 100644 --- a/docs/api/edit-permission.api.mdx +++ b/docs/api/edit-permission.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit Permission - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-settings.RequestSchema.json b/docs/api/edit-settings.RequestSchema.json index a6a3e143..b28b8d6f 100644 --- a/docs/api/edit-settings.RequestSchema.json +++ b/docs/api/edit-settings.RequestSchema.json @@ -1 +1,18 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":true},"name":{"type":"string","example":"My new RUN name"},"profile":{"type":"string","example":"612ea05e3cc07803480127151133"},"url":{"type":"string","example":"612ea05e3cc07803480127151133.run.tago.io"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "name": { "type": "string", "example": "My new RUN name" }, + "profile": { "type": "string", "example": "612ea05e3cc07803480127151133" }, + "url": { "type": "string", "example": "612ea05e3cc07803480127151133.run.tago.io" } + } + } + } + } + } +} diff --git a/docs/api/edit-settings.StatusCodes.json b/docs/api/edit-settings.StatusCodes.json index 7c749c88..e23ef8f5 100644 --- a/docs/api/edit-settings.StatusCodes.json +++ b/docs/api/edit-settings.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Editing RUN information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"TagoIO Run Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing RUN information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "TagoIO Run Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/edit-settings.api.mdx b/docs/api/edit-settings.api.mdx index 45f7512f..8292dee2 100644 --- a/docs/api/edit-settings.api.mdx +++ b/docs/api/edit-settings.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit information about TagoRUN - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-user.ParamsDetails.json b/docs/api/edit-user.ParamsDetails.json index 25da7410..e5a194b8 100644 --- a/docs/api/edit-user.ParamsDetails.json +++ b/docs/api/edit-user.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "userID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a RUN user ID)" } + } + ] +} diff --git a/docs/api/edit-user.RequestSchema.json b/docs/api/edit-user.RequestSchema.json index 7e6b8ff3..b69866b2 100644 --- a/docs/api/edit-user.RequestSchema.json +++ b/docs/api/edit-user.RequestSchema.json @@ -1 +1,41 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":true},"company":{"type":"string","example":"Companyname"},"language":{"type":"string","example":"en"},"name":{"type":"string","example":"runusername"},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"MM/DD/YYYY"},"time_format":{"type":"string","example":"12"}}},"phone":{"type":"string","example":"+010001010011"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"user_type"},"value":{"type":"string","example":"enduser"}}},"example":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}]},"timezone":{"type":"string","example":"America/New_York"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "company": { "type": "string", "example": "Companyname" }, + "language": { "type": "string", "example": "en" }, + "name": { "type": "string", "example": "runusername" }, + "options": { + "type": "object", + "properties": { + "date_format": { "type": "string", "example": "MM/DD/YYYY" }, + "time_format": { "type": "string", "example": "12" } + } + }, + "phone": { "type": "string", "example": "+010001010011" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "user_type" }, + "value": { "type": "string", "example": "enduser" } + } + }, + "example": [ + { "key": "user_type", "value": "enduser" }, + { "key": "limit_login", "value": "10" } + ] + }, + "timezone": { "type": "string", "example": "America/New_York" } + } + } + } + } + } +} diff --git a/docs/api/edit-user.StatusCodes.json b/docs/api/edit-user.StatusCodes.json index 78a05ba2..22f294e0 100644 --- a/docs/api/edit-user.StatusCodes.json +++ b/docs/api/edit-user.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Editing a RUN user information by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"TagoIO Run User Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing a RUN user information by ID", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "TagoIO Run User Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/edit-user.api.mdx b/docs/api/edit-user.api.mdx index da1182b9..cdb16146 100644 --- a/docs/api/edit-user.api.mdx +++ b/docs/api/edit-user.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Edit information about an user using userID - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/edit-widget.ParamsDetails.json b/docs/api/edit-widget.ParamsDetails.json index c53ccfe7..9e12e40f 100644 --- a/docs/api/edit-widget.ParamsDetails.json +++ b/docs/api/edit-widget.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + }, + { + "name": "widgetID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a widget ID)" } + } + ] +} diff --git a/docs/api/edit-widget.RequestSchema.json b/docs/api/edit-widget.RequestSchema.json index 489a1322..38950056 100644 --- a/docs/api/edit-widget.RequestSchema.json +++ b/docs/api/edit-widget.RequestSchema.json @@ -1 +1,92 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"dashboard":{"type":"string","example":"623c74a15a13360011803f3e"},"display":{"type":"object","properties":{"header_buttons":{"type":"array","items":{}},"show_units":{"type":"boolean","example":true},"show_variables":{"type":"boolean","example":true},"theme":{"type":"object","properties":{"color":{"type":"object","properties":{"background":{"type":"string","example":"hsla(332, 33%, 73%, 1)"},"button":{"type":"string","example":"hsla(112, 91%, 58%, 1)"},"dot":{"type":"string","example":"hsla(0, 97%, 48%, 1)"},"header":{"type":"string","example":"hsla(336, 81%, 51%, 1)"}}}}},"variables":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"variable":{"type":"string","example":"temperature"}}},"example":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]}}},"label":{"type":"string","example":"Display #1"},"realtime":{"type":"boolean","example":true},"type":{"type":"string","example":"display"}}},"examples":{"Card Widget Example":{"value":{"display":{"alias":"Ice Cream Widget","header_buttons":[{"color":null,"icon":"","text":"","trigger":"widget","widget":null}],"frame_settings":{"shadow":{"hide":false},"header_visibility":"show_always"},"theme":{"color":{"background":"hsl(210, 12%, 12%)","header":"hsl(210, 65%, 60%)","text":"hsl(210, 20%, 92%)"}},"show_variables":true,"formula":{"enable":false,"unit_type":"origin","fixed_unit":"","apply_all_matching_formulas":false},"number_format":{"decimals":-1,"show_thousand":false},"max_points":10,"show_chart":true,"show_unit":true,"url":"","variable":"temperature"},"data":[{"qty":10,"origin":"68c9baabb24379000ab1c8cc","variables":["temperature"]}],"resource":[],"id":"68c9bab8fe8818000a7ec597","label":"Temperature","realtime":null,"type":"card","cache":null}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dashboard": { "type": "string", "example": "623c74a15a13360011803f3e" }, + "display": { + "type": "object", + "properties": { + "header_buttons": { "type": "array", "items": {} }, + "show_units": { "type": "boolean", "example": true }, + "show_variables": { "type": "boolean", "example": true }, + "theme": { + "type": "object", + "properties": { + "color": { + "type": "object", + "properties": { + "background": { "type": "string", "example": "hsla(332, 33%, 73%, 1)" }, + "button": { "type": "string", "example": "hsla(112, 91%, 58%, 1)" }, + "dot": { "type": "string", "example": "hsla(0, 97%, 48%, 1)" }, + "header": { "type": "string", "example": "hsla(336, 81%, 51%, 1)" } + } + } + } + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "origin": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "variable": { "type": "string", "example": "temperature" } + } + }, + "example": [ + { "origin": "6238a3a27d792400139e5b47", "variable": "temperature" }, + { "origin": "62308e38de51960019697e76", "variable": "temperature" } + ] + } + } + }, + "label": { "type": "string", "example": "Display #1" }, + "realtime": { "type": "boolean", "example": true }, + "type": { "type": "string", "example": "display" } + } + }, + "examples": { + "Card Widget Example": { + "value": { + "display": { + "alias": "Ice Cream Widget", + "header_buttons": [{ "color": null, "icon": "", "text": "", "trigger": "widget", "widget": null }], + "frame_settings": { "shadow": { "hide": false }, "header_visibility": "show_always" }, + "theme": { + "color": { + "background": "hsl(210, 12%, 12%)", + "header": "hsl(210, 65%, 60%)", + "text": "hsl(210, 20%, 92%)" + } + }, + "show_variables": true, + "formula": { + "enable": false, + "unit_type": "origin", + "fixed_unit": "", + "apply_all_matching_formulas": false + }, + "number_format": { "decimals": -1, "show_thousand": false }, + "max_points": 10, + "show_chart": true, + "show_unit": true, + "url": "", + "variable": "temperature" + }, + "data": [{ "qty": 10, "origin": "68c9baabb24379000ab1c8cc", "variables": ["temperature"] }], + "resource": [], + "id": "68c9bab8fe8818000a7ec597", + "label": "Temperature", + "realtime": null, + "type": "card", + "cache": null + } + } + } + } + } + } +} diff --git a/docs/api/edit-widget.StatusCodes.json b/docs/api/edit-widget.StatusCodes.json index 967d788e..595ccaa3 100644 --- a/docs/api/edit-widget.StatusCodes.json +++ b/docs/api/edit-widget.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Editing a widget","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Editing a widget":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Editing a widget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Editing a widget": { "value": { "result": "Successfully Updated", "status": true } } } + } + } + } + } +} diff --git a/docs/api/edit-widget.api.mdx b/docs/api/edit-widget.api.mdx index c9b50fad..7435d079 100644 --- a/docs/api/edit-widget.api.mdx +++ b/docs/api/edit-widget.api.mdx @@ -20,51 +20,22 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Edit properties of a JSON within a dashboard of your profile. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/empty-a-device-s-data.ParamsDetails.json b/docs/api/empty-a-device-s-data.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/empty-a-device-s-data.ParamsDetails.json +++ b/docs/api/empty-a-device-s-data.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/empty-a-device-s-data.RequestSchema.json b/docs/api/empty-a-device-s-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/empty-a-device-s-data.RequestSchema.json +++ b/docs/api/empty-a-device-s-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/empty-a-device-s-data.StatusCodes.json b/docs/api/empty-a-device-s-data.StatusCodes.json index 78d5854a..db90b189 100644 --- a/docs/api/empty-a-device-s-data.StatusCodes.json +++ b/docs/api/empty-a-device-s-data.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Device's Data empty","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Data Successfully Removed"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Device's Data empty", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Data Successfully Removed" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/empty-a-device-s-data.api.mdx b/docs/api/empty-a-device-s-data.api.mdx index 91a31b2b..7f7ff8b6 100644 --- a/docs/api/empty-a-device-s-data.api.mdx +++ b/docs/api/empty-a-device-s-data.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Empty a Device's Data - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json b/docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json index 10f9e29d..fc051c0a 100644 --- a/docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json +++ b/docs/api/export-a-chunk-as-csv-to-files.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":false,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": false, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json b/docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json index 96f9cd62..6d831a4e 100644 --- a/docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json +++ b/docs/api/export-a-chunk-as-csv-to-files.RequestSchema.json @@ -1 +1,26 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"chunk_id":{"type":"string","example":"1657497600_1658102399"},"file_address":{"type":"string","example":"/device/$DEVICE$/$FROM$_$TO$"},"headers":{"type":"boolean","example":true}}},"examples":{"Export a chunk as CSV to Files":{"value":{"chunk_id":"1657497600_1658102399","file_address":"/device/$DEVICE$/$FROM$_$TO$","headers":true}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "chunk_id": { "type": "string", "example": "1657497600_1658102399" }, + "file_address": { "type": "string", "example": "/device/$DEVICE$/$FROM$_$TO$" }, + "headers": { "type": "boolean", "example": true } + } + }, + "examples": { + "Export a chunk as CSV to Files": { + "value": { + "chunk_id": "1657497600_1658102399", + "file_address": "/device/$DEVICE$/$FROM$_$TO$", + "headers": true + } + } + } + } + } + } +} diff --git a/docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json b/docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json index 76a05063..11eac29f 100644 --- a/docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json +++ b/docs/api/export-a-chunk-as-csv-to-files.StatusCodes.json @@ -1 +1,27 @@ -{"responses":{"200":{"description":"Chunk exported to Files","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"chunk_id":{"type":"string","example":"1657497600_1658102399"},"file_address":{"type":"string","example":"device/62a2643dcc8dd60012eb4838/2022-07-11_2022-07-17.csv"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Chunk exported to Files", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "chunk_id": { "type": "string", "example": "1657497600_1658102399" }, + "file_address": { + "type": "string", + "example": "device/62a2643dcc8dd60012eb4838/2022-07-11_2022-07-17.csv" + } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/export-a-chunk-as-csv-to-files.api.mdx b/docs/api/export-a-chunk-as-csv-to-files.api.mdx index 3207b939..62cff077 100644 --- a/docs/api/export-a-chunk-as-csv-to-files.api.mdx +++ b/docs/api/export-a-chunk-as-csv-to-files.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Export a chunk as CSV to your TagoIO Files - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/export-data-to-csv-in-files.ParamsDetails.json b/docs/api/export-data-to-csv-in-files.ParamsDetails.json index 4af8f8f6..c5d99580 100644 --- a/docs/api/export-data-to-csv-in-files.ParamsDetails.json +++ b/docs/api/export-data-to-csv-in-files.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" }, + "description": "Device ID" + } + ] +} diff --git a/docs/api/export-data-to-csv-in-files.RequestSchema.json b/docs/api/export-data-to-csv-in-files.RequestSchema.json index 6c42387c..1c73378f 100644 --- a/docs/api/export-data-to-csv-in-files.RequestSchema.json +++ b/docs/api/export-data-to-csv-in-files.RequestSchema.json @@ -1 +1,21 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_address":{"type":"string","example":"/device/$DEVICE$/$TIMESTAMP$"},"headers":{"type":"boolean","example":true}}},"examples":{"Export data to CSV in Files":{"value":{"file_address":"/device/$DEVICE$/$TIMESTAMP$","headers":true}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file_address": { "type": "string", "example": "/device/$DEVICE$/$TIMESTAMP$" }, + "headers": { "type": "boolean", "example": true } + } + }, + "examples": { + "Export data to CSV in Files": { + "value": { "file_address": "/device/$DEVICE$/$TIMESTAMP$", "headers": true } + } + } + } + } + } +} diff --git a/docs/api/export-data-to-csv-in-files.StatusCodes.json b/docs/api/export-data-to-csv-in-files.StatusCodes.json index 796dd4d9..88ac810b 100644 --- a/docs/api/export-data-to-csv-in-files.StatusCodes.json +++ b/docs/api/export-data-to-csv-in-files.StatusCodes.json @@ -1 +1,23 @@ -{"responses":{"200":{"description":"Exporting data to Files","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"file_address":{"type":"string","example":"device/66db45b6552d1d00097956de/1732039901282.csv"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Exporting data to Files", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "file_address": { "type": "string", "example": "device/66db45b6552d1d00097956de/1732039901282.csv" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/export-data-to-csv-in-files.api.mdx b/docs/api/export-data-to-csv-in-files.api.mdx index 5db3f05e..5d6b034f 100644 --- a/docs/api/export-data-to-csv-in-files.api.mdx +++ b/docs/api/export-data-to-csv-in-files.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Export data to CSV in Files - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/export-entity-data.ParamsDetails.json b/docs/api/export-entity-data.ParamsDetails.json index 6ee13853..de9eafaa 100644 --- a/docs/api/export-entity-data.ParamsDetails.json +++ b/docs/api/export-entity-data.ParamsDetails.json @@ -1 +1,5 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"},"description":"Entity ID"}]} \ No newline at end of file +{ + "parameters": [ + { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Entity ID" } + ] +} diff --git a/docs/api/export-entity-data.RequestSchema.json b/docs/api/export-entity-data.RequestSchema.json index 73d31903..43ed3298 100644 --- a/docs/api/export-entity-data.RequestSchema.json +++ b/docs/api/export-entity-data.RequestSchema.json @@ -1 +1,25 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_address":{"type":"string","example":"/my_data/export.csv","description":"Path in the Files to save the export."},"headers":{"type":"boolean","example":true,"description":"Whether to include headers in the export."}},"required":["file_address"]}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file_address": { + "type": "string", + "example": "/my_data/export.csv", + "description": "Path in the Files to save the export." + }, + "headers": { + "type": "boolean", + "example": true, + "description": "Whether to include headers in the export." + } + }, + "required": ["file_address"] + } + } + } + } +} diff --git a/docs/api/export-entity-data.StatusCodes.json b/docs/api/export-entity-data.StatusCodes.json index 97ad019b..69b13b75 100644 --- a/docs/api/export-entity-data.StatusCodes.json +++ b/docs/api/export-entity-data.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Exporting data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"file_address":{"type":"string","example":"/my_data/export.csv"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Exporting data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "file_address": { "type": "string", "example": "/my_data/export.csv" } } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/export-entity-data.api.mdx b/docs/api/export-entity-data.api.mdx index 882614b1..432bd438 100644 --- a/docs/api/export-entity-data.api.mdx +++ b/docs/api/export-entity-data.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Export data from the entity to a file in the Files. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/file-copy.RequestSchema.json b/docs/api/file-copy.RequestSchema.json index 9dc9c84d..20f0dab3 100644 --- a/docs/api/file-copy.RequestSchema.json +++ b/docs/api/file-copy.RequestSchema.json @@ -1 +1,21 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","example":"/layer05.png"},"to":{"type":"string","example":"/layer05 - Copy.png"}}},"example":[{"from":"/layer05.png","to":"/layer05 - Copy.png"}]},"examples":{"File Copy":{"value":[{"from":"/layer05.png","to":"/layer05 - Copy.png"}]}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "from": { "type": "string", "example": "/layer05.png" }, + "to": { "type": "string", "example": "/layer05 - Copy.png" } + } + }, + "example": [{ "from": "/layer05.png", "to": "/layer05 - Copy.png" }] + }, + "examples": { "File Copy": { "value": [{ "from": "/layer05.png", "to": "/layer05 - Copy.png" }] } } + } + } + } +} diff --git a/docs/api/file-copy.StatusCodes.json b/docs/api/file-copy.StatusCodes.json index 8127825d..012c8e6d 100644 --- a/docs/api/file-copy.StatusCodes.json +++ b/docs/api/file-copy.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Making a file copy","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Making a file copy":{"value":{"result":"Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Making a file copy", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Making a file copy": { "value": { "result": "Successfully Updated", "status": true } } } + } + } + } + } +} diff --git a/docs/api/file-copy.api.mdx b/docs/api/file-copy.api.mdx index c164e415..cb06b580 100644 --- a/docs/api/file-copy.api.mdx +++ b/docs/api/file-copy.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + File Copy - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/generate-profile-token.RequestSchema.json b/docs/api/generate-profile-token.RequestSchema.json index 931667a1..2d8a4379 100644 --- a/docs/api/generate-profile-token.RequestSchema.json +++ b/docs/api/generate-profile-token.RequestSchema.json @@ -1 +1,29 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["email","name","password","profile_id"],"properties":{"email":{"type":"string","example":"example@mail.com"},"name":{"type":"string","example":"Token name"},"password":{"type":"string","example":"yourpassword"},"profile_id":{"type":"string","example":"712ea05e3cc07800127151111"}}},"examples":{"Generate Profile-Token":{"value":{"email":"example@mail.com","name":"newtoken","password":"yourpassword","profile_id":"712ea05e3cc07800127151111"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["email", "name", "password", "profile_id"], + "properties": { + "email": { "type": "string", "example": "example@mail.com" }, + "name": { "type": "string", "example": "Token name" }, + "password": { "type": "string", "example": "yourpassword" }, + "profile_id": { "type": "string", "example": "712ea05e3cc07800127151111" } + } + }, + "examples": { + "Generate Profile-Token": { + "value": { + "email": "example@mail.com", + "name": "newtoken", + "password": "yourpassword", + "profile_id": "712ea05e3cc07800127151111" + } + } + } + } + } + } +} diff --git a/docs/api/generate-profile-token.StatusCodes.json b/docs/api/generate-profile-token.StatusCodes.json index 1a16cec8..d15d9291 100644 --- a/docs/api/generate-profile-token.StatusCodes.json +++ b/docs/api/generate-profile-token.StatusCodes.json @@ -1 +1,27 @@ -{"responses":{"200":{"description":"token created successfuly","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"created_by":{"type":"string","example":"712ea05e3cc07800127151110"},"name":{"type":"string","example":"your name"},"permission":{"type":"string","example":"full"},"profile":{"type":"string","example":"712ea05e3cc07800127151111"},"token":{"type":"string","example":"ecjkfc55e-229e-4083-9667-d868h79a41e9"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "token created successfuly", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "created_by": { "type": "string", "example": "712ea05e3cc07800127151110" }, + "name": { "type": "string", "example": "your name" }, + "permission": { "type": "string", "example": "full" }, + "profile": { "type": "string", "example": "712ea05e3cc07800127151111" }, + "token": { "type": "string", "example": "ecjkfc55e-229e-4083-9667-d868h79a41e9" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/generate-profile-token.api.mdx b/docs/api/generate-profile-token.api.mdx index 2ec8232f..378825d3 100644 --- a/docs/api/generate-profile-token.api.mdx +++ b/docs/api/generate-profile-token.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Generates and retrieves a new token for the account - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/generate-public-token.ParamsDetails.json b/docs/api/generate-public-token.ParamsDetails.json index f83ca487..70929051 100644 --- a/docs/api/generate-public-token.ParamsDetails.json +++ b/docs/api/generate-public-token.ParamsDetails.json @@ -1 +1,17 @@ -{"parameters":[{"name":"expire_time","in":"query","required":true,"schema":{"type":"string","example":"1 day"},"description":"Time given in hours,days,weeks,months"},{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "expire_time", + "in": "query", + "required": true, + "schema": { "type": "string", "example": "1 day" }, + "description": "Time given in hours,days,weeks,months" + }, + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + } + ] +} diff --git a/docs/api/generate-public-token.RequestSchema.json b/docs/api/generate-public-token.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/generate-public-token.RequestSchema.json +++ b/docs/api/generate-public-token.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/generate-public-token.StatusCodes.json b/docs/api/generate-public-token.StatusCodes.json index 98606662..723f8be4 100644 --- a/docs/api/generate-public-token.StatusCodes.json +++ b/docs/api/generate-public-token.StatusCodes.json @@ -1 +1,24 @@ -{"responses":{"200":{"description":"Generating a Public Token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"expire_time":{"type":"string","example":"2022-06-20T23:10:59.285Z"},"token":{"type":"string","example":"026b43fb-b33e-477a-bf17-70d1a0498562"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Generating a Public Token", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "expire_time": { "type": "string", "example": "2022-06-20T23:10:59.285Z" }, + "token": { "type": "string", "example": "026b43fb-b33e-477a-bf17-70d1a0498562" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/generate-public-token.api.mdx b/docs/api/generate-public-token.api.mdx index 45f94ec9..788884ee 100644 --- a/docs/api/generate-public-token.api.mdx +++ b/docs/api/generate-public-token.api.mdx @@ -20,56 +20,23 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + -Make your dashboard accessible to anyone by generating a public access token. +Make your dashboard accessible to anyone by generating a public access token. -Public dashboards allow you to share live data and visualizations with users who do not have a TagoIO/TagoRUN account. -You control the expiration and can revoke access at any time. +Public dashboards allow you to share live data and visualizations with users who do not have a TagoIO/TagoRUN account. +You control the expiration and can revoke access at any time. [Learn more about sharing dashboards and public access](/docs/tagoio/dashboards/sharing-dashboards) - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/generate-token.ParamsDetails.json b/docs/api/generate-token.ParamsDetails.json index c53ccfe7..9e12e40f 100644 --- a/docs/api/generate-token.ParamsDetails.json +++ b/docs/api/generate-token.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + }, + { + "name": "widgetID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a widget ID)" } + } + ] +} diff --git a/docs/api/generate-token.RequestSchema.json b/docs/api/generate-token.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/generate-token.RequestSchema.json +++ b/docs/api/generate-token.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/generate-token.StatusCodes.json b/docs/api/generate-token.StatusCodes.json index 9f8c84e0..3497ba56 100644 --- a/docs/api/generate-token.StatusCodes.json +++ b/docs/api/generate-token.StatusCodes.json @@ -1 +1,28 @@ -{"responses":{"200":{"description":"Generating a token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"widget_token":{"type":"string","example":"ebe71a39-8f9f-4114-8bf3-6b3dcc19ad72"}}},"status":{"type":"boolean","example":true}}},"examples":{"Generating a token":{"value":{"result":{"widget_token":"ebe71a39-8f9f-4114-8bf3-6b3dcc19ad72"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Generating a token", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "widget_token": { "type": "string", "example": "ebe71a39-8f9f-4114-8bf3-6b3dcc19ad72" } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Generating a token": { + "value": { "result": { "widget_token": "ebe71a39-8f9f-4114-8bf3-6b3dcc19ad72" }, "status": true } + } + } + } + } + } + } +} diff --git a/docs/api/generate-token.api.mdx b/docs/api/generate-token.api.mdx index 2c409f0c..b677bef6 100644 --- a/docs/api/generate-token.api.mdx +++ b/docs/api/generate-token.api.mdx @@ -20,58 +20,29 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Generates a secure, public token for [embedding](/docs/tagoio/widgets/general/embedding-widgets-to-your-website) a specific widget from a dashboard. -Use this token to display the widget in external applications or websites via the TagoIO embed service. +Use this token to display the widget in external applications or websites via the TagoIO embed service. -Example embed URL: +Example embed URL: -`https://embed.REGION.tago.io?widget=YOUR-WIDGET-ID&dashboard=YOUR-DASHBOARD-ID&token=YOUR-EMBED-TOKEN` +`https://embed.REGION.tago.io?widget=YOUR-WIDGET-ID&dashboard=YOUR-DASHBOARD-ID&token=YOUR-EMBED-TOKEN` This endpoint is intended for scenarios where you want to share or display a widget outside of the TagoIO platform while maintaining access control. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-a-profile-details.ParamsDetails.json b/docs/api/get-a-profile-details.ParamsDetails.json index 44cb40c7..4ba1c5b9 100644 --- a/docs/api/get-a-profile-details.ParamsDetails.json +++ b/docs/api/get-a-profile-details.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"Type a profile ID"},"description":"Can be found in the profile's information tab \"More\""}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "Type a profile ID" }, + "description": "Can be found in the profile's information tab \"More\"" + } + ] +} diff --git a/docs/api/get-a-profile-details.RequestSchema.json b/docs/api/get-a-profile-details.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-a-profile-details.RequestSchema.json +++ b/docs/api/get-a-profile-details.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-a-profile-details.StatusCodes.json b/docs/api/get-a-profile-details.StatusCodes.json index ded31a2a..ed01697c 100644 --- a/docs/api/get-a-profile-details.StatusCodes.json +++ b/docs/api/get-a-profile-details.StatusCodes.json @@ -1 +1,67 @@ -{"responses":{"200":{"description":"Get a Profile Details","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"account_plan":{"type":"string","example":"starter"},"addons":{"type":"object","properties":{"control_tower":{"type":"boolean","example":true},"custom_dns":{"type":"boolean","example":false},"mobile":{"type":"boolean","example":false},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"updated_at":{"type":"string","example":"2023-09-06T13:47:08.192Z"}}},"allocation":{"type":"object","properties":{"analysis":{"type":"number","example":5},"data_records":{"type":"number","example":250000},"email":{"type":"number","example":10},"file_storage":{"type":"number","example":132},"input":{"type":"number","example":350000},"output":{"type":"number","example":342153},"push_notification":{"type":"number","example":58},"run_users":{"type":"number","example":5},"sms":{"type":"number","example":60}}},"info":{"type":"object","properties":{"account":{"type":"string","example":"612ea05e3cc07800127153892"},"banner_url":{"example":null},"created_at":{"type":"string","example":"2022-02-02T16:44:09.134Z"},"id":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"logo_url":{"type":"string","example":""},"name":{"type":"string","example":"Test Profile"},"region":{"type":"string","example":"us-1"},"rpm":{"type":"object","properties":{"data_input":{"type":"number","example":98283293},"data_output":{"type":"number","example":10}}},"updated_at":{"type":"string","example":"2023-10-13T11:54:20.081Z"}}}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get a Profile Details", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "account_plan": { "type": "string", "example": "starter" }, + "addons": { + "type": "object", + "properties": { + "control_tower": { "type": "boolean", "example": true }, + "custom_dns": { "type": "boolean", "example": false }, + "mobile": { "type": "boolean", "example": false }, + "profile": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "updated_at": { "type": "string", "example": "2023-09-06T13:47:08.192Z" } + } + }, + "allocation": { + "type": "object", + "properties": { + "analysis": { "type": "number", "example": 5 }, + "data_records": { "type": "number", "example": 250000 }, + "email": { "type": "number", "example": 10 }, + "file_storage": { "type": "number", "example": 132 }, + "input": { "type": "number", "example": 350000 }, + "output": { "type": "number", "example": 342153 }, + "push_notification": { "type": "number", "example": 58 }, + "run_users": { "type": "number", "example": 5 }, + "sms": { "type": "number", "example": 60 } + } + }, + "info": { + "type": "object", + "properties": { + "account": { "type": "string", "example": "612ea05e3cc07800127153892" }, + "banner_url": { "example": null }, + "created_at": { "type": "string", "example": "2022-02-02T16:44:09.134Z" }, + "id": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "logo_url": { "type": "string", "example": "" }, + "name": { "type": "string", "example": "Test Profile" }, + "region": { "type": "string", "example": "us-1" }, + "rpm": { + "type": "object", + "properties": { + "data_input": { "type": "number", "example": 98283293 }, + "data_output": { "type": "number", "example": 10 } + } + }, + "updated_at": { "type": "string", "example": "2023-10-13T11:54:20.081Z" } + } + } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-a-profile-details.api.mdx b/docs/api/get-a-profile-details.api.mdx index dd007b58..96501823 100644 --- a/docs/api/get-a-profile-details.api.mdx +++ b/docs/api/get-a-profile-details.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get your profile settings - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-a-profile-statistics.ParamsDetails.json b/docs/api/get-a-profile-statistics.ParamsDetails.json index 7b70d0b1..69caa47a 100644 --- a/docs/api/get-a-profile-statistics.ParamsDetails.json +++ b/docs/api/get-a-profile-statistics.ParamsDetails.json @@ -1 +1,23 @@ -{"parameters":[{"name":"date","in":"query","schema":{"type":"string","example":"YYYY-MM-DD"},"description":"Filter the statistics by specific date"},{"name":"timezone","in":"query","schema":{"type":"string","example":"Your account's timezone"},"description":"Filter the statiscs with the timezone applied if not it returns the UTC time"},{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"Type a Profile ID"},"description":"Can be found in the profile's information tab \"More\""}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "date", + "in": "query", + "schema": { "type": "string", "example": "YYYY-MM-DD" }, + "description": "Filter the statistics by specific date" + }, + { + "name": "timezone", + "in": "query", + "schema": { "type": "string", "example": "Your account's timezone" }, + "description": "Filter the statiscs with the timezone applied if not it returns the UTC time" + }, + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "Type a Profile ID" }, + "description": "Can be found in the profile's information tab \"More\"" + } + ] +} diff --git a/docs/api/get-a-profile-statistics.RequestSchema.json b/docs/api/get-a-profile-statistics.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-a-profile-statistics.RequestSchema.json +++ b/docs/api/get-a-profile-statistics.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-a-profile-statistics.StatusCodes.json b/docs/api/get-a-profile-statistics.StatusCodes.json index 7db724a1..bb0c12cb 100644 --- a/docs/api/get-a-profile-statistics.StatusCodes.json +++ b/docs/api/get-a-profile-statistics.StatusCodes.json @@ -1 +1,265 @@ -{"responses":{"200":{"description":"Getting a profile statistics","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"data_records":{"type":"number","example":151611},"file_storage":{"type":"number","example":49.89},"input":{"type":"number","example":39933},"output":{"type":"number","example":1272},"time":{"type":"string","example":"2023-11-08T04:01:36.124Z"}}},"example":[{"data_records":151611,"file_storage":49.89,"input":39933,"output":1272,"time":"2023-11-08T04:01:36.124Z"},{"data_records":151691,"file_storage":49.89,"input":40165,"output":1272,"time":"2023-11-08T05:01:35.986Z"},{"data_records":151863,"file_storage":49.89,"input":40397,"output":1272,"time":"2023-11-08T06:01:35.963Z"},{"data_records":152389,"file_storage":49.89,"input":40629,"output":1272,"time":"2023-11-08T07:01:36.021Z"},{"data_records":152497,"file_storage":49.89,"input":40861,"output":1272,"time":"2023-11-08T08:01:36.019Z"},{"data_records":152609,"file_storage":49.89,"input":41093,"output":1272,"time":"2023-11-08T09:01:35.908Z"},{"data_records":152981,"file_storage":49.89,"input":41325,"output":1272,"time":"2023-11-08T10:01:36.052Z"},{"data_records":153105,"file_storage":49.89,"input":41566,"output":1272,"time":"2023-11-08T11:01:36.155Z"},{"data_records":153373,"file_storage":49.89,"input":41789,"output":1272,"time":"2023-11-08T12:01:35.906Z"},{"data_records":153517,"file_storage":49.89,"input":42030,"output":1272,"time":"2023-11-08T13:01:35.873Z"},{"data_records":150262,"file_storage":49.89,"input":42253,"output":1272,"time":"2023-11-08T14:01:35.967Z"},{"data_records":150422,"file_storage":49.89,"input":42485,"output":1272,"time":"2023-11-08T15:01:35.992Z"},{"data_records":150422,"file_storage":49.89,"input":42717,"output":1272,"time":"2023-11-08T16:01:35.825Z"},{"data_records":151054,"file_storage":49.89,"input":42949,"output":1272,"time":"2023-11-08T17:01:35.903Z"},{"data_records":151242,"file_storage":49.89,"input":43181,"output":1272,"time":"2023-11-08T18:01:35.995Z"},{"data_records":151242,"file_storage":49.89,"input":43413,"output":1272,"time":"2023-11-08T19:01:35.946Z"}]},"status":{"type":"boolean","example":true}}},"examples":{"Getting a profile statistics":{"value":{"result":[{"data_records":151611,"file_storage":49.89,"input":39933,"output":1272,"time":"2023-11-08T04:01:36.124Z"},{"data_records":151691,"file_storage":49.89,"input":40165,"output":1272,"time":"2023-11-08T05:01:35.986Z"},{"data_records":151863,"file_storage":49.89,"input":40397,"output":1272,"time":"2023-11-08T06:01:35.963Z"},{"data_records":152389,"file_storage":49.89,"input":40629,"output":1272,"time":"2023-11-08T07:01:36.021Z"},{"data_records":152497,"file_storage":49.89,"input":40861,"output":1272,"time":"2023-11-08T08:01:36.019Z"},{"data_records":152609,"file_storage":49.89,"input":41093,"output":1272,"time":"2023-11-08T09:01:35.908Z"},{"data_records":152981,"file_storage":49.89,"input":41325,"output":1272,"time":"2023-11-08T10:01:36.052Z"},{"data_records":153105,"file_storage":49.89,"input":41566,"output":1272,"time":"2023-11-08T11:01:36.155Z"},{"data_records":153373,"file_storage":49.89,"input":41789,"output":1272,"time":"2023-11-08T12:01:35.906Z"},{"data_records":153517,"file_storage":49.89,"input":42030,"output":1272,"time":"2023-11-08T13:01:35.873Z"},{"data_records":150262,"file_storage":49.89,"input":42253,"output":1272,"time":"2023-11-08T14:01:35.967Z"},{"data_records":150422,"file_storage":49.89,"input":42485,"output":1272,"time":"2023-11-08T15:01:35.992Z"},{"data_records":150422,"file_storage":49.89,"input":42717,"output":1272,"time":"2023-11-08T16:01:35.825Z"},{"data_records":151054,"file_storage":49.89,"input":42949,"output":1272,"time":"2023-11-08T17:01:35.903Z"},{"data_records":151242,"file_storage":49.89,"input":43181,"output":1272,"time":"2023-11-08T18:01:35.995Z"},{"data_records":151242,"file_storage":49.89,"input":43413,"output":1272,"time":"2023-11-08T19:01:35.946Z"}],"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a profile statistics", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data_records": { "type": "number", "example": 151611 }, + "file_storage": { "type": "number", "example": 49.89 }, + "input": { "type": "number", "example": 39933 }, + "output": { "type": "number", "example": 1272 }, + "time": { "type": "string", "example": "2023-11-08T04:01:36.124Z" } + } + }, + "example": [ + { + "data_records": 151611, + "file_storage": 49.89, + "input": 39933, + "output": 1272, + "time": "2023-11-08T04:01:36.124Z" + }, + { + "data_records": 151691, + "file_storage": 49.89, + "input": 40165, + "output": 1272, + "time": "2023-11-08T05:01:35.986Z" + }, + { + "data_records": 151863, + "file_storage": 49.89, + "input": 40397, + "output": 1272, + "time": "2023-11-08T06:01:35.963Z" + }, + { + "data_records": 152389, + "file_storage": 49.89, + "input": 40629, + "output": 1272, + "time": "2023-11-08T07:01:36.021Z" + }, + { + "data_records": 152497, + "file_storage": 49.89, + "input": 40861, + "output": 1272, + "time": "2023-11-08T08:01:36.019Z" + }, + { + "data_records": 152609, + "file_storage": 49.89, + "input": 41093, + "output": 1272, + "time": "2023-11-08T09:01:35.908Z" + }, + { + "data_records": 152981, + "file_storage": 49.89, + "input": 41325, + "output": 1272, + "time": "2023-11-08T10:01:36.052Z" + }, + { + "data_records": 153105, + "file_storage": 49.89, + "input": 41566, + "output": 1272, + "time": "2023-11-08T11:01:36.155Z" + }, + { + "data_records": 153373, + "file_storage": 49.89, + "input": 41789, + "output": 1272, + "time": "2023-11-08T12:01:35.906Z" + }, + { + "data_records": 153517, + "file_storage": 49.89, + "input": 42030, + "output": 1272, + "time": "2023-11-08T13:01:35.873Z" + }, + { + "data_records": 150262, + "file_storage": 49.89, + "input": 42253, + "output": 1272, + "time": "2023-11-08T14:01:35.967Z" + }, + { + "data_records": 150422, + "file_storage": 49.89, + "input": 42485, + "output": 1272, + "time": "2023-11-08T15:01:35.992Z" + }, + { + "data_records": 150422, + "file_storage": 49.89, + "input": 42717, + "output": 1272, + "time": "2023-11-08T16:01:35.825Z" + }, + { + "data_records": 151054, + "file_storage": 49.89, + "input": 42949, + "output": 1272, + "time": "2023-11-08T17:01:35.903Z" + }, + { + "data_records": 151242, + "file_storage": 49.89, + "input": 43181, + "output": 1272, + "time": "2023-11-08T18:01:35.995Z" + }, + { + "data_records": 151242, + "file_storage": 49.89, + "input": 43413, + "output": 1272, + "time": "2023-11-08T19:01:35.946Z" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting a profile statistics": { + "value": { + "result": [ + { + "data_records": 151611, + "file_storage": 49.89, + "input": 39933, + "output": 1272, + "time": "2023-11-08T04:01:36.124Z" + }, + { + "data_records": 151691, + "file_storage": 49.89, + "input": 40165, + "output": 1272, + "time": "2023-11-08T05:01:35.986Z" + }, + { + "data_records": 151863, + "file_storage": 49.89, + "input": 40397, + "output": 1272, + "time": "2023-11-08T06:01:35.963Z" + }, + { + "data_records": 152389, + "file_storage": 49.89, + "input": 40629, + "output": 1272, + "time": "2023-11-08T07:01:36.021Z" + }, + { + "data_records": 152497, + "file_storage": 49.89, + "input": 40861, + "output": 1272, + "time": "2023-11-08T08:01:36.019Z" + }, + { + "data_records": 152609, + "file_storage": 49.89, + "input": 41093, + "output": 1272, + "time": "2023-11-08T09:01:35.908Z" + }, + { + "data_records": 152981, + "file_storage": 49.89, + "input": 41325, + "output": 1272, + "time": "2023-11-08T10:01:36.052Z" + }, + { + "data_records": 153105, + "file_storage": 49.89, + "input": 41566, + "output": 1272, + "time": "2023-11-08T11:01:36.155Z" + }, + { + "data_records": 153373, + "file_storage": 49.89, + "input": 41789, + "output": 1272, + "time": "2023-11-08T12:01:35.906Z" + }, + { + "data_records": 153517, + "file_storage": 49.89, + "input": 42030, + "output": 1272, + "time": "2023-11-08T13:01:35.873Z" + }, + { + "data_records": 150262, + "file_storage": 49.89, + "input": 42253, + "output": 1272, + "time": "2023-11-08T14:01:35.967Z" + }, + { + "data_records": 150422, + "file_storage": 49.89, + "input": 42485, + "output": 1272, + "time": "2023-11-08T15:01:35.992Z" + }, + { + "data_records": 150422, + "file_storage": 49.89, + "input": 42717, + "output": 1272, + "time": "2023-11-08T16:01:35.825Z" + }, + { + "data_records": 151054, + "file_storage": 49.89, + "input": 42949, + "output": 1272, + "time": "2023-11-08T17:01:35.903Z" + }, + { + "data_records": 151242, + "file_storage": 49.89, + "input": 43181, + "output": 1272, + "time": "2023-11-08T18:01:35.995Z" + }, + { + "data_records": 151242, + "file_storage": 49.89, + "input": 43413, + "output": 1272, + "time": "2023-11-08T19:01:35.946Z" + } + ], + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-a-profile-statistics.api.mdx b/docs/api/get-a-profile-statistics.api.mdx index acc1d5c1..647e4f39 100644 --- a/docs/api/get-a-profile-statistics.api.mdx +++ b/docs/api/get-a-profile-statistics.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get your Profile Statistics - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-a-profile-summary.ParamsDetails.json b/docs/api/get-a-profile-summary.ParamsDetails.json index 44cb40c7..4ba1c5b9 100644 --- a/docs/api/get-a-profile-summary.ParamsDetails.json +++ b/docs/api/get-a-profile-summary.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"Type a profile ID"},"description":"Can be found in the profile's information tab \"More\""}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "Type a profile ID" }, + "description": "Can be found in the profile's information tab \"More\"" + } + ] +} diff --git a/docs/api/get-a-profile-summary.RequestSchema.json b/docs/api/get-a-profile-summary.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-a-profile-summary.RequestSchema.json +++ b/docs/api/get-a-profile-summary.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-a-profile-summary.StatusCodes.json b/docs/api/get-a-profile-summary.StatusCodes.json index 3ba86b7d..2cbc431c 100644 --- a/docs/api/get-a-profile-summary.StatusCodes.json +++ b/docs/api/get-a-profile-summary.StatusCodes.json @@ -1 +1,137 @@ -{"responses":{"200":{"description":"Get a general summary of your profile resources","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"addons":{"type":"object","properties":{"control_tower":{"type":"boolean","example":true},"custom_dns":{"type":"boolean","example":false},"mobile":{"type":"boolean","example":false},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"updated_at":{"type":"string","example":"2023-09-06T13:47:08.192Z"}}},"amount":{"type":"object","properties":{"action":{"type":"number","example":37},"am":{"type":"number","example":5},"analysis":{"type":"number","example":18},"connectors":{"type":"number","example":32},"dashboard":{"type":"number","example":231},"device":{"type":"number","example":79},"dictionary":{"type":"number","example":7},"networks":{"type":"number","example":9},"run_users":{"type":"number","example":5},"tcore":{"type":"number","example":2},"tcore_cluster":{"type":"number","example":2}}},"limit":{"type":"object","properties":{"analysis":{"type":"number","example":5},"data_records":{"type":"number","example":250000},"email":{"type":"number","example":10},"file_storage":{"type":"number","example":132},"input":{"type":"number","example":350000},"output":{"type":"number","example":342153},"push_notification":{"type":"number","example":58},"run_users":{"type":"number","example":5},"sms":{"type":"number","example":60},"tcore":{"type":"number","example":1}}},"limit_used":{"type":"object","properties":{"analysis":{"type":"number","example":0},"dashboard_output":{"type":"number","example":65},"data_records":{"type":"number","example":151242},"email":{"type":"number","example":0},"file_storage":{"type":"number","example":49.89},"input":{"type":"number","example":43463},"output":{"type":"number","example":1272},"push_notification":{"type":"number","example":0},"run_users":{"type":"number","example":5},"sms":{"type":"number","example":0},"tcore":{"type":"number","example":3},"tcore_cluster":{"type":"number","example":2}}},"tago_run":{"type":"string","example":"johndoee.tago.run"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting a profile summary":{"value":{"result":{"addons":{"control_tower":true,"custom_dns":false,"mobile":false,"profile":"61fac4d9a5c9f40012a5ff92","updated_at":"2023-09-06T13:47:08.192Z"},"amount":{"action":37,"am":5,"analysis":18,"connectors":32,"dashboard":231,"device":79,"dictionary":7,"networks":9,"run_users":5,"tcore":2,"tcore_cluster":2},"limit":{"analysis":5,"data_records":250000,"email":10,"file_storage":132,"input":350000,"output":342153,"push_notification":58,"run_users":5,"sms":60,"tcore":1},"limit_used":{"analysis":0,"dashboard_output":65,"data_records":151242,"email":0,"file_storage":49.89,"input":43463,"output":1272,"push_notification":0,"run_users":5,"sms":0,"tcore":3,"tcore_cluster":2},"tago_run":"johndoee.tago.run"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get a general summary of your profile resources", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "addons": { + "type": "object", + "properties": { + "control_tower": { "type": "boolean", "example": true }, + "custom_dns": { "type": "boolean", "example": false }, + "mobile": { "type": "boolean", "example": false }, + "profile": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "updated_at": { "type": "string", "example": "2023-09-06T13:47:08.192Z" } + } + }, + "amount": { + "type": "object", + "properties": { + "action": { "type": "number", "example": 37 }, + "am": { "type": "number", "example": 5 }, + "analysis": { "type": "number", "example": 18 }, + "connectors": { "type": "number", "example": 32 }, + "dashboard": { "type": "number", "example": 231 }, + "device": { "type": "number", "example": 79 }, + "dictionary": { "type": "number", "example": 7 }, + "networks": { "type": "number", "example": 9 }, + "run_users": { "type": "number", "example": 5 }, + "tcore": { "type": "number", "example": 2 }, + "tcore_cluster": { "type": "number", "example": 2 } + } + }, + "limit": { + "type": "object", + "properties": { + "analysis": { "type": "number", "example": 5 }, + "data_records": { "type": "number", "example": 250000 }, + "email": { "type": "number", "example": 10 }, + "file_storage": { "type": "number", "example": 132 }, + "input": { "type": "number", "example": 350000 }, + "output": { "type": "number", "example": 342153 }, + "push_notification": { "type": "number", "example": 58 }, + "run_users": { "type": "number", "example": 5 }, + "sms": { "type": "number", "example": 60 }, + "tcore": { "type": "number", "example": 1 } + } + }, + "limit_used": { + "type": "object", + "properties": { + "analysis": { "type": "number", "example": 0 }, + "dashboard_output": { "type": "number", "example": 65 }, + "data_records": { "type": "number", "example": 151242 }, + "email": { "type": "number", "example": 0 }, + "file_storage": { "type": "number", "example": 49.89 }, + "input": { "type": "number", "example": 43463 }, + "output": { "type": "number", "example": 1272 }, + "push_notification": { "type": "number", "example": 0 }, + "run_users": { "type": "number", "example": 5 }, + "sms": { "type": "number", "example": 0 }, + "tcore": { "type": "number", "example": 3 }, + "tcore_cluster": { "type": "number", "example": 2 } + } + }, + "tago_run": { "type": "string", "example": "johndoee.tago.run" } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting a profile summary": { + "value": { + "result": { + "addons": { + "control_tower": true, + "custom_dns": false, + "mobile": false, + "profile": "61fac4d9a5c9f40012a5ff92", + "updated_at": "2023-09-06T13:47:08.192Z" + }, + "amount": { + "action": 37, + "am": 5, + "analysis": 18, + "connectors": 32, + "dashboard": 231, + "device": 79, + "dictionary": 7, + "networks": 9, + "run_users": 5, + "tcore": 2, + "tcore_cluster": 2 + }, + "limit": { + "analysis": 5, + "data_records": 250000, + "email": 10, + "file_storage": 132, + "input": 350000, + "output": 342153, + "push_notification": 58, + "run_users": 5, + "sms": 60, + "tcore": 1 + }, + "limit_used": { + "analysis": 0, + "dashboard_output": 65, + "data_records": 151242, + "email": 0, + "file_storage": 49.89, + "input": 43463, + "output": 1272, + "push_notification": 0, + "run_users": 5, + "sms": 0, + "tcore": 3, + "tcore_cluster": 2 + }, + "tago_run": "johndoee.tago.run" + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-a-profile-summary.api.mdx b/docs/api/get-a-profile-summary.api.mdx index 7f5bd159..51074571 100644 --- a/docs/api/get-a-profile-summary.api.mdx +++ b/docs/api/get-a-profile-summary.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get your Profile Summary - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-account-information.RequestSchema.json b/docs/api/get-account-information.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-account-information.RequestSchema.json +++ b/docs/api/get-account-information.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-account-information.StatusCodes.json b/docs/api/get-account-information.StatusCodes.json index fc4267b7..03a9b870 100644 --- a/docs/api/get-account-information.StatusCodes.json +++ b/docs/api/get-account-information.StatusCodes.json @@ -1 +1,82 @@ -{"responses":{"200":{"description":"Get information about account","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"blocked":{"type":"boolean","example":false},"company":{"type":"string","example":"companyname"},"created_at":{"type":"string","example":"2021-08-31T21:34:22.107Z"},"email":{"type":"string","example":"example@email.com"},"id":{"type":"string","example":"612ea05e3cc07800127152207"},"language":{"type":"string","example":"en"},"last_login":{"type":"string","example":"2021-09-13T17:59:30.983Z"},"name":{"type":"string","example":"Account Name"},"newsletter":{"type":"boolean","example":true},"options":{"type":"object","properties":{"decimal_separator":{"type":"string","example":","},"last_whats_new":{"type":"string","example":"2021-08-02T18:00:00.000Z"},"thousand_separator":{"type":"string","example":"."},"user_view_welcome":{"type":"boolean","example":true}}},"otp":{"type":"object","properties":{}},"phone":{"example":null},"plan":{"type":"string","example":"free"},"send_invoice":{"type":"boolean","example":false},"stripe_id":{"example":null},"timezone":{"type":"string","example":"America/Sao_Paulo"},"type":{"type":"string","example":"user"},"updated_at":{"type":"string","example":"2021-09-09T19:21:52.049Z"}}},"status":{"type":"boolean","example":true}}},"examples":{"Get information about account":{"value":{"result":{"active":true,"blocked":false,"company":"companyname","created_at":"2021-08-31T21:34:22.107Z","email":"example@email.com","id":"612ea05e3cc07800127152207","language":"en","last_login":"2021-09-13T17:59:30.983Z","name":"Account Name","newsletter":true,"options":{"decimal_separator":",","last_whats_new":"2021-08-02T18:00:00.000Z","thousand_separator":".","user_view_welcome":true},"otp":{},"phone":null,"plan":"free","send_invoice":false,"stripe_id":null,"timezone":"America/Sao_Paulo","type":"user","updated_at":"2021-09-09T19:21:52.049Z"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get information about account", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "blocked": { "type": "boolean", "example": false }, + "company": { "type": "string", "example": "companyname" }, + "created_at": { "type": "string", "example": "2021-08-31T21:34:22.107Z" }, + "email": { "type": "string", "example": "example@email.com" }, + "id": { "type": "string", "example": "612ea05e3cc07800127152207" }, + "language": { "type": "string", "example": "en" }, + "last_login": { "type": "string", "example": "2021-09-13T17:59:30.983Z" }, + "name": { "type": "string", "example": "Account Name" }, + "newsletter": { "type": "boolean", "example": true }, + "options": { + "type": "object", + "properties": { + "decimal_separator": { "type": "string", "example": "," }, + "last_whats_new": { "type": "string", "example": "2021-08-02T18:00:00.000Z" }, + "thousand_separator": { "type": "string", "example": "." }, + "user_view_welcome": { "type": "boolean", "example": true } + } + }, + "otp": { "type": "object", "properties": {} }, + "phone": { "example": null }, + "plan": { "type": "string", "example": "free" }, + "send_invoice": { "type": "boolean", "example": false }, + "stripe_id": { "example": null }, + "timezone": { "type": "string", "example": "America/Sao_Paulo" }, + "type": { "type": "string", "example": "user" }, + "updated_at": { "type": "string", "example": "2021-09-09T19:21:52.049Z" } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Get information about account": { + "value": { + "result": { + "active": true, + "blocked": false, + "company": "companyname", + "created_at": "2021-08-31T21:34:22.107Z", + "email": "example@email.com", + "id": "612ea05e3cc07800127152207", + "language": "en", + "last_login": "2021-09-13T17:59:30.983Z", + "name": "Account Name", + "newsletter": true, + "options": { + "decimal_separator": ",", + "last_whats_new": "2021-08-02T18:00:00.000Z", + "thousand_separator": ".", + "user_view_welcome": true + }, + "otp": {}, + "phone": null, + "plan": "free", + "send_invoice": false, + "stripe_id": null, + "timezone": "America/Sao_Paulo", + "type": "user", + "updated_at": "2021-09-09T19:21:52.049Z" + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-account-information.api.mdx b/docs/api/get-account-information.api.mdx index eb7db449..087f72f4 100644 --- a/docs/api/get-account-information.api.mdx +++ b/docs/api/get-account-information.api.mdx @@ -20,43 +20,14 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get all information from current account + - - - - - - - - - - - - + - \ No newline at end of file + diff --git a/docs/api/get-account-resources-allocation.RequestSchema.json b/docs/api/get-account-resources-allocation.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-account-resources-allocation.RequestSchema.json +++ b/docs/api/get-account-resources-allocation.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-account-resources-allocation.StatusCodes.json b/docs/api/get-account-resources-allocation.StatusCodes.json index a1827189..c75053b7 100644 --- a/docs/api/get-account-resources-allocation.StatusCodes.json +++ b/docs/api/get-account-resources-allocation.StatusCodes.json @@ -1 +1,125 @@ -{"responses":{"200":{"description":"Get account resources' allocation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"analysis":{"type":"number","example":200},"data_records":{"type":"number","example":6667},"email":{"type":"number","example":17},"file_storage":{"type":"number","example":80},"input":{"type":"number","example":33334},"output":{"type":"number","example":100000},"profile":{"type":"string","example":"62cdb70512b7320012dc2880"},"push_notification":{"type":"number","example":4},"run_users":{"type":"number","example":0},"sms":{"type":"number","example":5},"updated_at":{"type":"string","example":"2022-07-15T12:11:07.521Z"}}},"example":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc2880","push_notification":4,"run_users":0,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc0780012715111","push_notification":83,"run_users":8,"sms":0,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1200,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5ff93","push_notification":13,"run_users":2,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"}]},"status":{"type":"boolean","example":true}}},"examples":{"Get account resources' allocation":{"value":{"result":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc2880","push_notification":4,"run_users":0,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc0780012715111","push_notification":83,"run_users":8,"sms":0,"updated_at":"2022-07-15T12:11:07.521Z"},{"analysis":1200,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5ff93","push_notification":13,"run_users":2,"sms":5,"updated_at":"2022-07-15T12:11:07.521Z"}],"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get account resources' allocation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "analysis": { "type": "number", "example": 200 }, + "data_records": { "type": "number", "example": 6667 }, + "email": { "type": "number", "example": 17 }, + "file_storage": { "type": "number", "example": 80 }, + "input": { "type": "number", "example": 33334 }, + "output": { "type": "number", "example": 100000 }, + "profile": { "type": "string", "example": "62cdb70512b7320012dc2880" }, + "push_notification": { "type": "number", "example": 4 }, + "run_users": { "type": "number", "example": 0 }, + "sms": { "type": "number", "example": 5 }, + "updated_at": { "type": "string", "example": "2022-07-15T12:11:07.521Z" } + } + }, + "example": [ + { + "analysis": 200, + "data_records": 6667, + "email": 17, + "file_storage": 80, + "input": 33334, + "output": 100000, + "profile": "62cdb70512b7320012dc2880", + "push_notification": 4, + "run_users": 0, + "sms": 5, + "updated_at": "2022-07-15T12:11:07.521Z" + }, + { + "analysis": 1600, + "data_records": 633333, + "email": 43, + "file_storage": 100, + "input": 433333, + "output": 1800000, + "profile": "612ea05e3cc0780012715111", + "push_notification": 83, + "run_users": 8, + "sms": 0, + "updated_at": "2022-07-15T12:11:07.521Z" + }, + { + "analysis": 1200, + "data_records": 160000, + "email": 40, + "file_storage": 20, + "input": 533333, + "output": 1100000, + "profile": "61fab4d9a5c9f40012a5ff93", + "push_notification": 13, + "run_users": 2, + "sms": 5, + "updated_at": "2022-07-15T12:11:07.521Z" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Get account resources' allocation": { + "value": { + "result": [ + { + "analysis": 200, + "data_records": 6667, + "email": 17, + "file_storage": 80, + "input": 33334, + "output": 100000, + "profile": "62cdb70512b7320012dc2880", + "push_notification": 4, + "run_users": 0, + "sms": 5, + "updated_at": "2022-07-15T12:11:07.521Z" + }, + { + "analysis": 1600, + "data_records": 633333, + "email": 43, + "file_storage": 100, + "input": 433333, + "output": 1800000, + "profile": "612ea05e3cc0780012715111", + "push_notification": 83, + "run_users": 8, + "sms": 0, + "updated_at": "2022-07-15T12:11:07.521Z" + }, + { + "analysis": 1200, + "data_records": 160000, + "email": 40, + "file_storage": 20, + "input": 533333, + "output": 1100000, + "profile": "61fab4d9a5c9f40012a5ff93", + "push_notification": 13, + "run_users": 2, + "sms": 5, + "updated_at": "2022-07-15T12:11:07.521Z" + } + ], + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-account-resources-allocation.api.mdx b/docs/api/get-account-resources-allocation.api.mdx index 89901a09..242559c9 100644 --- a/docs/api/get-account-resources-allocation.api.mdx +++ b/docs/api/get-account-resources-allocation.api.mdx @@ -20,42 +20,14 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get account resources allocation - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-configuration-parameters.ParamsDetails.json b/docs/api/get-configuration-parameters.ParamsDetails.json index 2497d49d..a2506691 100644 --- a/docs/api/get-configuration-parameters.ParamsDetails.json +++ b/docs/api/get-configuration-parameters.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"sent_status","in":"query","schema":{"type":"string","example":"true"},"description":"Filter by `sent` status."}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "sent_status", + "in": "query", + "schema": { "type": "string", "example": "true" }, + "description": "Filter by `sent` status." + } + ] +} diff --git a/docs/api/get-configuration-parameters.RequestSchema.json b/docs/api/get-configuration-parameters.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-configuration-parameters.RequestSchema.json +++ b/docs/api/get-configuration-parameters.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-configuration-parameters.StatusCodes.json b/docs/api/get-configuration-parameters.StatusCodes.json index b115e9b7..11ba1432 100644 --- a/docs/api/get-configuration-parameters.StatusCodes.json +++ b/docs/api/get-configuration-parameters.StatusCodes.json @@ -1 +1,29 @@ -{"responses":{"200":{"description":"List of configuration parameters returned","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6244401fe689b90014f9b299"},"key":{"type":"string","example":"param_key"},"sent":{"type":"boolean","example":false},"value":{"type":"string","example":"param_value"}}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "List of configuration parameters returned", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "6244401fe689b90014f9b299" }, + "key": { "type": "string", "example": "param_key" }, + "sent": { "type": "boolean", "example": false }, + "value": { "type": "string", "example": "param_value" } + } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-configuration-parameters.api.mdx b/docs/api/get-configuration-parameters.api.mdx index 06f833e4..5a7bb7dc 100644 --- a/docs/api/get-configuration-parameters.api.mdx +++ b/docs/api/get-configuration-parameters.api.mdx @@ -20,53 +20,20 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Retrieve configuration parameters for the current device. This is useful for delivering settings or instructions that your device can periodically check for updates. [Configuration Parameters](/docs/tagoio/devices/configuration-parameters-for-devices) can be used to provide URLs (such as for firmware updates) or any other settings needed to control device behavior. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-data.ParamsDetails.json b/docs/api/get-data.ParamsDetails.json index 483e3f61..a9c8b9ea 100644 --- a/docs/api/get-data.ParamsDetails.json +++ b/docs/api/get-data.ParamsDetails.json @@ -1 +1,77 @@ -{"parameters":[{"name":"query","in":"query","schema":{"type":"string","enum":["count","min","max","avg","sum","last_item","last_location","aggregate","conditional"]},"description":"Select the query mode."},{"name":"qty","in":"query","schema":{"type":"integer","minimum":1,"example":20},"description":"Total quantity of data to retrieve."},{"name":"details","in":"query","schema":{"type":"boolean","example":true},"description":"Include additional fields (e.g., created_at)."},{"name":"ordination","in":"query","schema":{"type":"string","enum":["ascending","descending"],"example":"descending"},"description":"Sort order."},{"name":"skip","in":"query","schema":{"type":"integer","minimum":0,"example":15},"description":"Number of items to skip."},{"name":"variables","in":"query","schema":{"type":"string","example":"temperature"},"description":"Filter data by variable."},{"name":"values","in":"query","schema":{"type":"string","example":"25"},"description":"Filter data by value."},{"name":"groups","in":"query","schema":{"type":"string","example":"0923092039"},"description":"Filter by group identifier."},{"name":"start_date","in":"query","schema":{"type":"string","format":"date-time","example":"2022-09-09T10:28:44Z"},"description":"Start timestamp or relative date."},{"name":"end_date","in":"query","schema":{"type":"string","format":"date-time","example":"2022-09-10T10:28:44Z"},"description":"End timestamp or relative date."},{"name":"function","in":"query","schema":{"type":"string","enum":["avg","sum","min","max","gt","gte","lt","lte","eq","ne"],"example":"avg"},"description":"Allowed values depend on query mode: aggregate → avg,sum,min,max; conditional → gt,gte,lt,lte,eq,ne."}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "query", + "in": "query", + "schema": { + "type": "string", + "enum": ["count", "min", "max", "avg", "sum", "last_item", "last_location", "aggregate", "conditional"] + }, + "description": "Select the query mode." + }, + { + "name": "qty", + "in": "query", + "schema": { "type": "integer", "minimum": 1, "example": 20 }, + "description": "Total quantity of data to retrieve." + }, + { + "name": "details", + "in": "query", + "schema": { "type": "boolean", "example": true }, + "description": "Include additional fields (e.g., created_at)." + }, + { + "name": "ordination", + "in": "query", + "schema": { "type": "string", "enum": ["ascending", "descending"], "example": "descending" }, + "description": "Sort order." + }, + { + "name": "skip", + "in": "query", + "schema": { "type": "integer", "minimum": 0, "example": 15 }, + "description": "Number of items to skip." + }, + { + "name": "variables", + "in": "query", + "schema": { "type": "string", "example": "temperature" }, + "description": "Filter data by variable." + }, + { + "name": "values", + "in": "query", + "schema": { "type": "string", "example": "25" }, + "description": "Filter data by value." + }, + { + "name": "groups", + "in": "query", + "schema": { "type": "string", "example": "0923092039" }, + "description": "Filter by group identifier." + }, + { + "name": "start_date", + "in": "query", + "schema": { "type": "string", "format": "date-time", "example": "2022-09-09T10:28:44Z" }, + "description": "Start timestamp or relative date." + }, + { + "name": "end_date", + "in": "query", + "schema": { "type": "string", "format": "date-time", "example": "2022-09-10T10:28:44Z" }, + "description": "End timestamp or relative date." + }, + { + "name": "function", + "in": "query", + "schema": { + "type": "string", + "enum": ["avg", "sum", "min", "max", "gt", "gte", "lt", "lte", "eq", "ne"], + "example": "avg" + }, + "description": "Allowed values depend on query mode: aggregate → avg,sum,min,max; conditional → gt,gte,lt,lte,eq,ne." + } + ] +} diff --git a/docs/api/get-data.RequestSchema.json b/docs/api/get-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-data.RequestSchema.json +++ b/docs/api/get-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-data.StatusCodes.json b/docs/api/get-data.StatusCodes.json index ec1646f3..6069c956 100644 --- a/docs/api/get-data.StatusCodes.json +++ b/docs/api/get-data.StatusCodes.json @@ -1 +1,57 @@ -{"responses":{"200":{"description":"Success Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2021-09-16T17:51:43.672Z"},"device":{"type":"string","example":"612ea1694035dd0012f6d238"},"group":{"type":"string","example":"1631814703672"},"id":{"type":"string","example":"6143842f561c4e00199f517b"},"location":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"number","example":-78.677328},"example":[-78.677328,35.770723]},"type":{"type":"string","example":"point"}}},"time":{"type":"string","example":"2021-09-16T17:51:43.672Z"},"unit":{"type":"string","example":"°C"},"value":{"type":"number","example":-12.67},"variable":{"type":"string","example":"temperature"}}},"example":[{"created_at":"2021-09-16T17:51:43.672Z","device":"612ea1694035dd0012f6d238","group":"1631814703672","id":"6143842f561c4e00199f517b","location":{"coordinates":[-78.677328,35.770723],"type":"point"},"time":"2021-09-16T17:51:43.672Z","unit":"°C","value":-12.67,"variable":"temperature"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Success Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created_at": { "type": "string", "example": "2021-09-16T17:51:43.672Z" }, + "device": { "type": "string", "example": "612ea1694035dd0012f6d238" }, + "group": { "type": "string", "example": "1631814703672" }, + "id": { "type": "string", "example": "6143842f561c4e00199f517b" }, + "location": { + "type": "object", + "properties": { + "coordinates": { + "type": "array", + "items": { "type": "number", "example": -78.677328 }, + "example": [-78.677328, 35.770723] + }, + "type": { "type": "string", "example": "point" } + } + }, + "time": { "type": "string", "example": "2021-09-16T17:51:43.672Z" }, + "unit": { "type": "string", "example": "°C" }, + "value": { "type": "number", "example": -12.67 }, + "variable": { "type": "string", "example": "temperature" } + } + }, + "example": [ + { + "created_at": "2021-09-16T17:51:43.672Z", + "device": "612ea1694035dd0012f6d238", + "group": "1631814703672", + "id": "6143842f561c4e00199f517b", + "location": { "coordinates": [-78.677328, 35.770723], "type": "point" }, + "time": "2021-09-16T17:51:43.672Z", + "unit": "°C", + "value": -12.67, + "variable": "temperature" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-data.api.mdx b/docs/api/get-data.api.mdx index 52113169..b88a6fa2 100644 --- a/docs/api/get-data.api.mdx +++ b/docs/api/get-data.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get data from the device. - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-device-data.ParamsDetails.json b/docs/api/get-device-data.ParamsDetails.json index a4eed4cf..2eec6d82 100644 --- a/docs/api/get-device-data.ParamsDetails.json +++ b/docs/api/get-device-data.ParamsDetails.json @@ -1 +1,23 @@ -{"parameters":[{"name":"qty","in":"query","schema":{"type":"string","example":"10"},"description":"Numeric quantity of data to be returned"},{"name":"end_date","in":"query","schema":{"type":"string","example":"2023-10-10T13:17:16.290Z"},"description":"Final date to get the data returned in ISO timestamp format (Not Required)"},{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "qty", + "in": "query", + "schema": { "type": "string", "example": "10" }, + "description": "Numeric quantity of data to be returned" + }, + { + "name": "end_date", + "in": "query", + "schema": { "type": "string", "example": "2023-10-10T13:17:16.290Z" }, + "description": "Final date to get the data returned in ISO timestamp format (Not Required)" + }, + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" }, + "description": "Device ID" + } + ] +} diff --git a/docs/api/get-device-data.RequestSchema.json b/docs/api/get-device-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-device-data.RequestSchema.json +++ b/docs/api/get-device-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-device-data.StatusCodes.json b/docs/api/get-device-data.StatusCodes.json index 267b2c2e..b6f3f4e0 100644 --- a/docs/api/get-device-data.StatusCodes.json +++ b/docs/api/get-device-data.StatusCodes.json @@ -1 +1,319 @@ -{"responses":{"200":{"description":"Get Device Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2023-09-20T14:26:44.918Z"},"device":{"type":"string","example":"6307b0b1b41f1b001a45c7e3"},"group":{"type":"string","example":"63956cf0000a19e44210b056"},"id":{"type":"string","example":"650b01244e91a0000fc65937"},"location":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"number","example":-77.757328},"example":[-77.757328,36.68072299999999]},"type":{"type":"string","example":"Point"}}},"time":{"type":"string","example":"2023-09-20T14:26:44.918Z"},"unit":{"type":"string","example":"C"},"value":{"type":"string","example":"16"},"variable":{"type":"string","example":"temperature"}}},"example":[{"created_at":"2023-09-20T14:26:44.918Z","device":"6307b0b1b41f1b001a45c7e3","group":"63956cf0000a19e44210b056","id":"650b01244e91a0000fc65937","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:44.918Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:38.015Z","device":"6307b0b1b41f1b001a45c7e3","group":"f863379000439d95e110b056","id":"650b011e59d9340009733690","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:38.015Z","unit":"C","value":"86","variable":"temperature"},{"created_at":"2023-09-20T14:26:25.477Z","device":"6307b0b1b41f1b001a45c7e3","group":"aa756cf0000a19e41110b056","id":"650b01114e91a0000fc657ab","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:25.477Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:14.180Z","device":"6307b0b1b41f1b001a45c7e3","group":"b0ee2101006e7e786010b056","id":"650b010687e7e6001012ee0c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:14.180Z","unit":"C","value":"58","variable":"temperature"},{"created_at":"2023-09-20T14:26:03.199Z","device":"6307b0b1b41f1b001a45c7e3","group":"5b33379000439d95bf00b056","id":"650b00fb59d93400097333b6","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:03.199Z","unit":"C","value":"11","variable":"temperature"},{"created_at":"2023-09-20T14:25:53.034Z","device":"6307b0b1b41f1b001a45c7e3","group":"e2456cf0000a19e41f00b056","id":"650b00f14e91a0000fc6542f","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:53.034Z","unit":"C","value":"3","variable":"temperature"},{"created_at":"2023-09-20T14:25:43.099Z","device":"6307b0b1b41f1b001a45c7e3","group":"6f40e7f0001ad1107e00b056","id":"650b00e7011da1000f7e04f7","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:43.099Z","unit":"C","value":"10","variable":"test"},{"created_at":"2023-09-20T14:25:33.027Z","device":"6307b0b1b41f1b001a45c7e3","group":"b77fbff000c901bddd00b056","id":"650b00dddb109c000ffbf77c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:33.027Z","unit":"C","value":"7","variable":"temperature"},{"created_at":"2023-09-20T14:25:23.020Z","device":"6307b0b1b41f1b001a45c7e3","group":"b7e298900029919a3d00b056","id":"650b00d3a919920009892e7c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:23.020Z","unit":"C","value":"1","variable":"temperature"},{"created_at":"2023-09-20T14:25:13.079Z","device":"6307b0b1b41f1b001a45c7e3","group":"7320e7f0001ad1109c00b056","id":"650b00c9011da1000f7e0238","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:13.079Z","unit":"C","value":"12","variable":"temperature"},{"created_at":"2023-09-20T14:25:03.133Z","device":"6307b0b1b41f1b001a45c7e3","group":"c14fbff000c901bdfb00b056","id":"650b00bfdb109c000ffbf41d","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:03.133Z","unit":"C","value":"66","variable":"temperature"},{"created_at":"2023-09-20T14:24:53.135Z","device":"6307b0b1b41f1b001a45c7e3","group":"64a2379000439d955b00b056","id":"650b00b559d9340009732a47","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:24:53.134Z","unit":"C","value":"19","variable":"temperature"}]},"status":{"type":"boolean","example":true}}},"examples":{"Get Device Data":{"value":{"result":[{"created_at":"2023-09-20T14:26:44.918Z","device":"6307b0b1b41f1b001a45c7e3","group":"63956cf0000a19e44210b056","id":"650b01244e91a0000fc65937","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:44.918Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:38.015Z","device":"6307b0b1b41f1b001a45c7e3","group":"f863379000439d95e110b056","id":"650b011e59d9340009733690","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:38.015Z","unit":"C","value":"86","variable":"temperature"},{"created_at":"2023-09-20T14:26:25.477Z","device":"6307b0b1b41f1b001a45c7e3","group":"aa756cf0000a19e41110b056","id":"650b01114e91a0000fc657ab","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:25.477Z","unit":"C","value":"16","variable":"temperature"},{"created_at":"2023-09-20T14:26:14.180Z","device":"6307b0b1b41f1b001a45c7e3","group":"b0ee2101006e7e786010b056","id":"650b010687e7e6001012ee0c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:14.180Z","unit":"C","value":"58","variable":"temperature"},{"created_at":"2023-09-20T14:26:03.199Z","device":"6307b0b1b41f1b001a45c7e3","group":"5b33379000439d95bf00b056","id":"650b00fb59d93400097333b6","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:26:03.199Z","unit":"C","value":"11","variable":"temperature"},{"created_at":"2023-09-20T14:25:53.034Z","device":"6307b0b1b41f1b001a45c7e3","group":"e2456cf0000a19e41f00b056","id":"650b00f14e91a0000fc6542f","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:53.034Z","unit":"C","value":"3","variable":"temperature"},{"created_at":"2023-09-20T14:25:43.099Z","device":"6307b0b1b41f1b001a45c7e3","group":"6f40e7f0001ad1107e00b056","id":"650b00e7011da1000f7e04f7","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:43.099Z","unit":"C","value":"10","variable":"test"},{"created_at":"2023-09-20T14:25:33.027Z","device":"6307b0b1b41f1b001a45c7e3","group":"b77fbff000c901bddd00b056","id":"650b00dddb109c000ffbf77c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:33.027Z","unit":"C","value":"7","variable":"temperature"},{"created_at":"2023-09-20T14:25:23.020Z","device":"6307b0b1b41f1b001a45c7e3","group":"b7e298900029919a3d00b056","id":"650b00d3a919920009892e7c","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:23.020Z","unit":"C","value":"1","variable":"temperature"},{"created_at":"2023-09-20T14:25:13.079Z","device":"6307b0b1b41f1b001a45c7e3","group":"7320e7f0001ad1109c00b056","id":"650b00c9011da1000f7e0238","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:13.079Z","unit":"C","value":"12","variable":"temperature"},{"created_at":"2023-09-20T14:25:03.133Z","device":"6307b0b1b41f1b001a45c7e3","group":"c14fbff000c901bdfb00b056","id":"650b00bfdb109c000ffbf41d","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:25:03.133Z","unit":"C","value":"66","variable":"temperature"},{"created_at":"2023-09-20T14:24:53.135Z","device":"6307b0b1b41f1b001a45c7e3","group":"64a2379000439d955b00b056","id":"650b00b559d9340009732a47","location":{"coordinates":[-77.757328,36.68072299999999],"type":"Point"},"time":"2023-09-20T14:24:53.134Z","unit":"C","value":"19","variable":"temperature"}],"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get Device Data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created_at": { "type": "string", "example": "2023-09-20T14:26:44.918Z" }, + "device": { "type": "string", "example": "6307b0b1b41f1b001a45c7e3" }, + "group": { "type": "string", "example": "63956cf0000a19e44210b056" }, + "id": { "type": "string", "example": "650b01244e91a0000fc65937" }, + "location": { + "type": "object", + "properties": { + "coordinates": { + "type": "array", + "items": { "type": "number", "example": -77.757328 }, + "example": [-77.757328, 36.68072299999999] + }, + "type": { "type": "string", "example": "Point" } + } + }, + "time": { "type": "string", "example": "2023-09-20T14:26:44.918Z" }, + "unit": { "type": "string", "example": "C" }, + "value": { "type": "string", "example": "16" }, + "variable": { "type": "string", "example": "temperature" } + } + }, + "example": [ + { + "created_at": "2023-09-20T14:26:44.918Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "63956cf0000a19e44210b056", + "id": "650b01244e91a0000fc65937", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:44.918Z", + "unit": "C", + "value": "16", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:38.015Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "f863379000439d95e110b056", + "id": "650b011e59d9340009733690", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:38.015Z", + "unit": "C", + "value": "86", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:25.477Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "aa756cf0000a19e41110b056", + "id": "650b01114e91a0000fc657ab", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:25.477Z", + "unit": "C", + "value": "16", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:14.180Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "b0ee2101006e7e786010b056", + "id": "650b010687e7e6001012ee0c", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:14.180Z", + "unit": "C", + "value": "58", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:03.199Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "5b33379000439d95bf00b056", + "id": "650b00fb59d93400097333b6", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:03.199Z", + "unit": "C", + "value": "11", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:53.034Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "e2456cf0000a19e41f00b056", + "id": "650b00f14e91a0000fc6542f", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:53.034Z", + "unit": "C", + "value": "3", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:43.099Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "6f40e7f0001ad1107e00b056", + "id": "650b00e7011da1000f7e04f7", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:43.099Z", + "unit": "C", + "value": "10", + "variable": "test" + }, + { + "created_at": "2023-09-20T14:25:33.027Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "b77fbff000c901bddd00b056", + "id": "650b00dddb109c000ffbf77c", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:33.027Z", + "unit": "C", + "value": "7", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:23.020Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "b7e298900029919a3d00b056", + "id": "650b00d3a919920009892e7c", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:23.020Z", + "unit": "C", + "value": "1", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:13.079Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "7320e7f0001ad1109c00b056", + "id": "650b00c9011da1000f7e0238", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:13.079Z", + "unit": "C", + "value": "12", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:03.133Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "c14fbff000c901bdfb00b056", + "id": "650b00bfdb109c000ffbf41d", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:03.133Z", + "unit": "C", + "value": "66", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:24:53.135Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "64a2379000439d955b00b056", + "id": "650b00b559d9340009732a47", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:24:53.134Z", + "unit": "C", + "value": "19", + "variable": "temperature" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Get Device Data": { + "value": { + "result": [ + { + "created_at": "2023-09-20T14:26:44.918Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "63956cf0000a19e44210b056", + "id": "650b01244e91a0000fc65937", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:44.918Z", + "unit": "C", + "value": "16", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:38.015Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "f863379000439d95e110b056", + "id": "650b011e59d9340009733690", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:38.015Z", + "unit": "C", + "value": "86", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:25.477Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "aa756cf0000a19e41110b056", + "id": "650b01114e91a0000fc657ab", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:25.477Z", + "unit": "C", + "value": "16", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:14.180Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "b0ee2101006e7e786010b056", + "id": "650b010687e7e6001012ee0c", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:14.180Z", + "unit": "C", + "value": "58", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:26:03.199Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "5b33379000439d95bf00b056", + "id": "650b00fb59d93400097333b6", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:26:03.199Z", + "unit": "C", + "value": "11", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:53.034Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "e2456cf0000a19e41f00b056", + "id": "650b00f14e91a0000fc6542f", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:53.034Z", + "unit": "C", + "value": "3", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:43.099Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "6f40e7f0001ad1107e00b056", + "id": "650b00e7011da1000f7e04f7", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:43.099Z", + "unit": "C", + "value": "10", + "variable": "test" + }, + { + "created_at": "2023-09-20T14:25:33.027Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "b77fbff000c901bddd00b056", + "id": "650b00dddb109c000ffbf77c", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:33.027Z", + "unit": "C", + "value": "7", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:23.020Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "b7e298900029919a3d00b056", + "id": "650b00d3a919920009892e7c", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:23.020Z", + "unit": "C", + "value": "1", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:13.079Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "7320e7f0001ad1109c00b056", + "id": "650b00c9011da1000f7e0238", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:13.079Z", + "unit": "C", + "value": "12", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:25:03.133Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "c14fbff000c901bdfb00b056", + "id": "650b00bfdb109c000ffbf41d", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:25:03.133Z", + "unit": "C", + "value": "66", + "variable": "temperature" + }, + { + "created_at": "2023-09-20T14:24:53.135Z", + "device": "6307b0b1b41f1b001a45c7e3", + "group": "64a2379000439d955b00b056", + "id": "650b00b559d9340009732a47", + "location": { "coordinates": [-77.757328, 36.68072299999999], "type": "Point" }, + "time": "2023-09-20T14:24:53.134Z", + "unit": "C", + "value": "19", + "variable": "temperature" + } + ], + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-device-data.api.mdx b/docs/api/get-device-data.api.mdx index 6c68fd11..dabe6ec4 100644 --- a/docs/api/get-device-data.api.mdx +++ b/docs/api/get-device-data.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get Device Data for a specific Device within your profile - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json b/docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json index 708834ab..a1180e7e 100644 --- a/docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json +++ b/docs/api/get-device-token-with-serial-number-authorization.ParamsDetails.json @@ -1 +1,18 @@ -{"parameters":[{"name":"serieNumber","in":"path","required":true,"schema":{"type":"string"},"description":"Device Serial Number registered at TagoIO"},{"name":"AuthorizationKey","in":"path","required":true,"schema":{"type":"string"},"description":"Authorization key for the profile, used to resolve the device token when multiple profiles may have the same serial number."}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "serieNumber", + "in": "path", + "required": true, + "schema": { "type": "string" }, + "description": "Device Serial Number registered at TagoIO" + }, + { + "name": "AuthorizationKey", + "in": "path", + "required": true, + "schema": { "type": "string" }, + "description": "Authorization key for the profile, used to resolve the device token when multiple profiles may have the same serial number." + } + ] +} diff --git a/docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json b/docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json +++ b/docs/api/get-device-token-with-serial-number-authorization.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json b/docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json index 0a2ed955..0f19569c 100644 --- a/docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json +++ b/docs/api/get-device-token-with-serial-number-authorization.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Successfully Token Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":""},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Successfully Token Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-device-token-with-serial-number-authorization.api.mdx b/docs/api/get-device-token-with-serial-number-authorization.api.mdx index bc9eb00e..fc70211a 100644 --- a/docs/api/get-device-token-with-serial-number-authorization.api.mdx +++ b/docs/api/get-device-token-with-serial-number-authorization.api.mdx @@ -20,52 +20,24 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Retrieve a valid device token using the device's serial number and a profile authorization key. This endpoint is recommended when you need additional security or if your Network is available to multiple profiles, as it allows serial numbers to be duplicated across different profiles. You must have both a Network and a Network-Token to use this endpoint. - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-device-token-with-serial-number.ParamsDetails.json b/docs/api/get-device-token-with-serial-number.ParamsDetails.json index c40eb5e3..771ac554 100644 --- a/docs/api/get-device-token-with-serial-number.ParamsDetails.json +++ b/docs/api/get-device-token-with-serial-number.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"serieNumber","in":"path","required":true,"schema":{"type":"string"},"description":"Device Serial Number registered at TagoIO"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "serieNumber", + "in": "path", + "required": true, + "schema": { "type": "string" }, + "description": "Device Serial Number registered at TagoIO" + } + ] +} diff --git a/docs/api/get-device-token-with-serial-number.RequestSchema.json b/docs/api/get-device-token-with-serial-number.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-device-token-with-serial-number.RequestSchema.json +++ b/docs/api/get-device-token-with-serial-number.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-device-token-with-serial-number.StatusCodes.json b/docs/api/get-device-token-with-serial-number.StatusCodes.json index eea3d57a..d772a239 100644 --- a/docs/api/get-device-token-with-serial-number.StatusCodes.json +++ b/docs/api/get-device-token-with-serial-number.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"got a valid token","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":""},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "got a valid token", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-device-token-with-serial-number.api.mdx b/docs/api/get-device-token-with-serial-number.api.mdx index 44ca5834..fc85489c 100644 --- a/docs/api/get-device-token-with-serial-number.api.mdx +++ b/docs/api/get-device-token-with-serial-number.api.mdx @@ -20,22 +20,13 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Get a valid device-token using token serial number only. It will match the serial in any profile. :::warning @@ -43,31 +34,12 @@ If the serial number is duplicated between different profiles, you will get the ::: You must have a Network and a Network-Token to use this query. - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-dictionary-details.ParamsDetails.json b/docs/api/get-dictionary-details.ParamsDetails.json index b8515d71..46c1fc08 100644 --- a/docs/api/get-dictionary-details.ParamsDetails.json +++ b/docs/api/get-dictionary-details.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dictionary_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type Dictionary ID)" }, + "description": "Can be obtained in the GET Dictionary response" + } + ] +} diff --git a/docs/api/get-dictionary-details.RequestSchema.json b/docs/api/get-dictionary-details.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-dictionary-details.RequestSchema.json +++ b/docs/api/get-dictionary-details.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-dictionary-details.StatusCodes.json b/docs/api/get-dictionary-details.StatusCodes.json index 8b91f84a..6f101b29 100644 --- a/docs/api/get-dictionary-details.StatusCodes.json +++ b/docs/api/get-dictionary-details.StatusCodes.json @@ -1 +1,42 @@ -{"responses":{"200":{"description":"Getting the Dictionary details","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"created_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"},"fallback":{"type":"string","example":"en-US"},"languages":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"code":{"type":"string","example":"en-US"}}},"example":[{"active":true,"code":"en-US"},{"active":true,"code":"es-ES"},{"active":true,"code":"pt-BR"}]},"name":{"type":"string","example":"Admin Dashboard"},"slug":{"type":"string","example":"ADM"},"updated_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting the Dictionary details", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "created_at": { "type": "string", "example": "2023-02-13T16:56:53.086Z" }, + "fallback": { "type": "string", "example": "en-US" }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "code": { "type": "string", "example": "en-US" } + } + }, + "example": [ + { "active": true, "code": "en-US" }, + { "active": true, "code": "es-ES" }, + { "active": true, "code": "pt-BR" } + ] + }, + "name": { "type": "string", "example": "Admin Dashboard" }, + "slug": { "type": "string", "example": "ADM" }, + "updated_at": { "type": "string", "example": "2023-02-13T16:56:53.086Z" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-dictionary-details.api.mdx b/docs/api/get-dictionary-details.api.mdx index 85552869..88f828b3 100644 --- a/docs/api/get-dictionary-details.api.mdx +++ b/docs/api/get-dictionary-details.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get Dictionary Details - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-dictionary-language-details.ParamsDetails.json b/docs/api/get-dictionary-language-details.ParamsDetails.json index ac38cd4a..c8efb92d 100644 --- a/docs/api/get-dictionary-language-details.ParamsDetails.json +++ b/docs/api/get-dictionary-language-details.ParamsDetails.json @@ -1 +1,18 @@ -{"parameters":[{"name":"slug_or_dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Slug or Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"},{"name":"language","in":"path","required":true,"schema":{"type":"string","example":"Language Code"},"description":"Language that will be returned keys"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "slug_or_dictionary_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type Slug or Dictionary ID)" }, + "description": "Can be obtained in the GET Dictionary response" + }, + { + "name": "language", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "Language Code" }, + "description": "Language that will be returned keys" + } + ] +} diff --git a/docs/api/get-dictionary-language-details.RequestSchema.json b/docs/api/get-dictionary-language-details.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-dictionary-language-details.RequestSchema.json +++ b/docs/api/get-dictionary-language-details.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-dictionary-language-details.StatusCodes.json b/docs/api/get-dictionary-language-details.StatusCodes.json index 1967e5d1..3a40a3eb 100644 --- a/docs/api/get-dictionary-language-details.StatusCodes.json +++ b/docs/api/get-dictionary-language-details.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Getting a dictionary language details","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"key":{"type":"string","example":"value"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a dictionary language details", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "object", "properties": { "key": { "type": "string", "example": "value" } } }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-dictionary-language-details.api.mdx b/docs/api/get-dictionary-language-details.api.mdx index 0d0c8c8f..4f91f0ad 100644 --- a/docs/api/get-dictionary-language-details.api.mdx +++ b/docs/api/get-dictionary-language-details.api.mdx @@ -20,50 +20,22 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Get Dictionary Language Details - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-dictionary-list.RequestSchema.json b/docs/api/get-dictionary-list.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-dictionary-list.RequestSchema.json +++ b/docs/api/get-dictionary-list.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-dictionary-list.StatusCodes.json b/docs/api/get-dictionary-list.StatusCodes.json index 6fea8078..ef0a8c2f 100644 --- a/docs/api/get-dictionary-list.StatusCodes.json +++ b/docs/api/get-dictionary-list.StatusCodes.json @@ -1 +1,61 @@ -{"responses":{"200":{"description":"Getting the dictionary list","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"},"fallback":{"type":"string","example":"en-US"},"id":{"type":"string","example":"63ea6bd581db210009ff8f1d"},"languages":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"code":{"type":"string","example":"en-US"}}},"example":[{"active":true,"code":"en-US"},{"active":true,"code":"es-ES"},{"active":true,"code":"pt-BR"}]},"name":{"type":"string","example":"Admin Dashboard"},"slug":{"type":"string","example":"ADM"},"updated_at":{"type":"string","example":"2023-02-13T16:56:53.086Z"}}},"example":[{"created_at":"2023-02-13T16:56:53.086Z","fallback":"en-US","id":"63ea6bd581db210009ff8f1d","languages":[{"active":true,"code":"en-US"},{"active":true,"code":"es-ES"},{"active":true,"code":"pt-BR"}],"name":"Admin Dashboard","slug":"ADM","updated_at":"2023-02-13T16:56:53.086Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting the dictionary list", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created_at": { "type": "string", "example": "2023-02-13T16:56:53.086Z" }, + "fallback": { "type": "string", "example": "en-US" }, + "id": { "type": "string", "example": "63ea6bd581db210009ff8f1d" }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "code": { "type": "string", "example": "en-US" } + } + }, + "example": [ + { "active": true, "code": "en-US" }, + { "active": true, "code": "es-ES" }, + { "active": true, "code": "pt-BR" } + ] + }, + "name": { "type": "string", "example": "Admin Dashboard" }, + "slug": { "type": "string", "example": "ADM" }, + "updated_at": { "type": "string", "example": "2023-02-13T16:56:53.086Z" } + } + }, + "example": [ + { + "created_at": "2023-02-13T16:56:53.086Z", + "fallback": "en-US", + "id": "63ea6bd581db210009ff8f1d", + "languages": [ + { "active": true, "code": "en-US" }, + { "active": true, "code": "es-ES" }, + { "active": true, "code": "pt-BR" } + ], + "name": "Admin Dashboard", + "slug": "ADM", + "updated_at": "2023-02-13T16:56:53.086Z" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-dictionary-list.api.mdx b/docs/api/get-dictionary-list.api.mdx index cd2d5ae2..04bbacf5 100644 --- a/docs/api/get-dictionary-list.api.mdx +++ b/docs/api/get-dictionary-list.api.mdx @@ -20,42 +20,14 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List of Dictionaries - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-entity-data-amount.ParamsDetails.json b/docs/api/get-entity-data-amount.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/get-entity-data-amount.ParamsDetails.json +++ b/docs/api/get-entity-data-amount.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/get-entity-data-amount.RequestSchema.json b/docs/api/get-entity-data-amount.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-entity-data-amount.RequestSchema.json +++ b/docs/api/get-entity-data-amount.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-entity-data-amount.StatusCodes.json b/docs/api/get-entity-data-amount.StatusCodes.json index e40e333d..32edcb7d 100644 --- a/docs/api/get-entity-data-amount.StatusCodes.json +++ b/docs/api/get-entity-data-amount.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Getting entity data amount","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"number","example":100},"status":{"type":"boolean","example":true}}},"examples":{"Getting entity data amount":{"value":{"result":100,"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting entity data amount", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "number", "example": 100 }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Getting entity data amount": { "value": { "result": 100, "status": true } } } + } + } + } + } +} diff --git a/docs/api/get-entity-data-amount.api.mdx b/docs/api/get-entity-data-amount.api.mdx index 0f9289d9..3922a7f1 100644 --- a/docs/api/get-entity-data-amount.api.mdx +++ b/docs/api/get-entity-data-amount.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get Entity Data Amount - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-entity-data.ParamsDetails.json b/docs/api/get-entity-data.ParamsDetails.json index 80da24d9..f60c8502 100644 --- a/docs/api/get-entity-data.ParamsDetails.json +++ b/docs/api/get-entity-data.ParamsDetails.json @@ -1 +1,42 @@ -{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"number"},"description":"(default 1)"},{"name":"amount","in":"query","schema":{"type":"string","example":"number"},"description":"(default: 20, max: 1000)"},{"name":"fields","in":"query","schema":{"type":"string","example":""},"description":"comma-separated list of fields to return"},{"name":"order_by","in":"query","schema":{"type":"string","example":"asc/desc"}},{"name":"filter","in":"query","schema":{"type":"string","example":""},"description":"JSON object. Filter by an entity field. Requires the index paramenter"},{"name":"index","in":"query","required":true,"schema":{"type":"string"},"description":"First index searchable field from the entity field added to the filter parameter"},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "page", + "in": "query", + "schema": { "type": "string", "example": "number" }, + "description": "(default 1)" + }, + { + "name": "amount", + "in": "query", + "schema": { "type": "string", "example": "number" }, + "description": "(default: 20, max: 1000)" + }, + { + "name": "fields", + "in": "query", + "schema": { "type": "string", "example": "" }, + "description": "comma-separated list of fields to return" + }, + { "name": "order_by", "in": "query", "schema": { "type": "string", "example": "asc/desc" } }, + { + "name": "filter", + "in": "query", + "schema": { "type": "string", "example": "" }, + "description": "JSON object. Filter by an entity field. Requires the index paramenter" + }, + { + "name": "index", + "in": "query", + "required": true, + "schema": { "type": "string" }, + "description": "First index searchable field from the entity field added to the filter parameter" + }, + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/get-entity-data.RequestSchema.json b/docs/api/get-entity-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-entity-data.RequestSchema.json +++ b/docs/api/get-entity-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-entity-data.StatusCodes.json b/docs/api/get-entity-data.StatusCodes.json index 1dbd03b6..79afdf28 100644 --- a/docs/api/get-entity-data.StatusCodes.json +++ b/docs/api/get-entity-data.StatusCodes.json @@ -1 +1,97 @@ -{"responses":{"200":{"description":"Getting entity data by filter","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"charge_amount":{"example":null},"created_at":{"type":"string","example":"2024-11-06T11:32:36.467Z"},"id":{"type":"string","example":"672b53d43bc47400095f3831"},"int_field":{"example":null},"monthly_revenue":{"type":"number","example":2345.34},"update_date":{"type":"string","example":"2024-11-01T03:00:00.000Z"},"updated_at":{"type":"string","example":"2024-11-06T11:32:36.467Z"}}},"example":[{"charge_amount":null,"created_at":"2024-11-06T11:32:36.467Z","id":"672b53d43bc47400095f3831","int_field":null,"monthly_revenue":2345.34,"update_date":"2024-11-01T03:00:00.000Z","updated_at":"2024-11-06T11:32:36.467Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:33.380Z","id":"672b5449dbac110009ce878f","int_field":null,"monthly_revenue":2193.43,"update_date":"2024-10-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:33.380Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:47.772Z","id":"672b54573bc47400095f4634","int_field":null,"monthly_revenue":2889.23,"update_date":"2024-09-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:47.772Z"}]},"status":{"type":"boolean","example":true}}},"examples":{"Getting entity data by filter":{"value":{"result":[{"charge_amount":null,"created_at":"2024-11-06T11:32:36.467Z","id":"672b53d43bc47400095f3831","int_field":null,"monthly_revenue":2345.34,"update_date":"2024-11-01T03:00:00.000Z","updated_at":"2024-11-06T11:32:36.467Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:33.380Z","id":"672b5449dbac110009ce878f","int_field":null,"monthly_revenue":2193.43,"update_date":"2024-10-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:33.380Z"},{"charge_amount":null,"created_at":"2024-11-06T11:34:47.772Z","id":"672b54573bc47400095f4634","int_field":null,"monthly_revenue":2889.23,"update_date":"2024-09-01T03:00:00.000Z","updated_at":"2024-11-06T11:34:47.772Z"}],"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting entity data by filter", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "charge_amount": { "example": null }, + "created_at": { "type": "string", "example": "2024-11-06T11:32:36.467Z" }, + "id": { "type": "string", "example": "672b53d43bc47400095f3831" }, + "int_field": { "example": null }, + "monthly_revenue": { "type": "number", "example": 2345.34 }, + "update_date": { "type": "string", "example": "2024-11-01T03:00:00.000Z" }, + "updated_at": { "type": "string", "example": "2024-11-06T11:32:36.467Z" } + } + }, + "example": [ + { + "charge_amount": null, + "created_at": "2024-11-06T11:32:36.467Z", + "id": "672b53d43bc47400095f3831", + "int_field": null, + "monthly_revenue": 2345.34, + "update_date": "2024-11-01T03:00:00.000Z", + "updated_at": "2024-11-06T11:32:36.467Z" + }, + { + "charge_amount": null, + "created_at": "2024-11-06T11:34:33.380Z", + "id": "672b5449dbac110009ce878f", + "int_field": null, + "monthly_revenue": 2193.43, + "update_date": "2024-10-01T03:00:00.000Z", + "updated_at": "2024-11-06T11:34:33.380Z" + }, + { + "charge_amount": null, + "created_at": "2024-11-06T11:34:47.772Z", + "id": "672b54573bc47400095f4634", + "int_field": null, + "monthly_revenue": 2889.23, + "update_date": "2024-09-01T03:00:00.000Z", + "updated_at": "2024-11-06T11:34:47.772Z" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting entity data by filter": { + "value": { + "result": [ + { + "charge_amount": null, + "created_at": "2024-11-06T11:32:36.467Z", + "id": "672b53d43bc47400095f3831", + "int_field": null, + "monthly_revenue": 2345.34, + "update_date": "2024-11-01T03:00:00.000Z", + "updated_at": "2024-11-06T11:32:36.467Z" + }, + { + "charge_amount": null, + "created_at": "2024-11-06T11:34:33.380Z", + "id": "672b5449dbac110009ce878f", + "int_field": null, + "monthly_revenue": 2193.43, + "update_date": "2024-10-01T03:00:00.000Z", + "updated_at": "2024-11-06T11:34:33.380Z" + }, + { + "charge_amount": null, + "created_at": "2024-11-06T11:34:47.772Z", + "id": "672b54573bc47400095f4634", + "int_field": null, + "monthly_revenue": 2889.23, + "update_date": "2024-09-01T03:00:00.000Z", + "updated_at": "2024-11-06T11:34:47.772Z" + } + ], + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-entity-data.api.mdx b/docs/api/get-entity-data.api.mdx index 1805706d..1c0a0018 100644 --- a/docs/api/get-entity-data.api.mdx +++ b/docs/api/get-entity-data.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get Entity Data - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-entity-info.ParamsDetails.json b/docs/api/get-entity-info.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/get-entity-info.ParamsDetails.json +++ b/docs/api/get-entity-info.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/get-entity-info.RequestSchema.json b/docs/api/get-entity-info.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-entity-info.RequestSchema.json +++ b/docs/api/get-entity-info.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-entity-info.StatusCodes.json b/docs/api/get-entity-info.StatusCodes.json index 587364ad..5873e326 100644 --- a/docs/api/get-entity-info.StatusCodes.json +++ b/docs/api/get-entity-info.StatusCodes.json @@ -1 +1,163 @@ -{"responses":{"200":{"description":"Getting an entity information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"created_at":{"type":"string","example":"2024-11-05T18:32:25.522Z"},"database":{"type":"string","example":"6229032d0620c89169acbdc0"},"id":{"type":"string","example":"672a64b91807cd0008baa4d5"},"index":{"type":"object","properties":{"id_created_at_idx":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"id"},"example":["id","created_at"]}}},"id_idx":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"id"},"example":["id"]}}},"id_updated_at_idx":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"id"},"example":["id","updated_at"]}}},"index_charge_amount":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"charge_amount"},"example":["charge_amount"]}}}}},"name":{"type":"string","example":"Control Entity"},"payload_decoder":{"example":null},"profile":{"type":"string","example":"63c82c9e6a7fb4000a1f95a0"},"schema":{"type":"object","properties":{"charge_amount":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"int"}}},"created_at":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"timestamp"}}},"id":{"type":"object","properties":{"required":{"type":"boolean","example":true},"type":{"type":"string","example":"uuid"}}},"int_field":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"int"}}},"update_date":{"type":"object","properties":{"required":{"type":"boolean","example":true},"type":{"type":"string","example":"timestamp"}}},"updated_at":{"type":"object","properties":{"required":{"type":"boolean","example":false},"type":{"type":"string","example":"timestamp"}}}}},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"yes"}}},"example":[{"key":"active","value":"yes"}]},"updated_at":{"type":"string","example":"2024-11-05T20:21:40.797Z"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting an entity information":{"value":{"result":{"created_at":"2024-11-05T18:32:25.522Z","database":"6229032d0620c89169acbdc0","id":"672a64b91807cd0008baa4d5","index":{"id_created_at_idx":{"fields":["id","created_at"]},"id_idx":{"fields":["id"]},"id_updated_at_idx":{"fields":["id","updated_at"]},"index_charge_amount":{"fields":["charge_amount"]}},"name":"Control Entity","payload_decoder":null,"profile":"63c82c9e6a7fb4000a1f95a0","schema":{"charge_amount":{"required":false,"type":"int"},"created_at":{"required":false,"type":"timestamp"},"id":{"required":true,"type":"uuid"},"int_field":{"required":false,"type":"int"},"update_date":{"required":true,"type":"timestamp"},"updated_at":{"required":false,"type":"timestamp"}},"tags":[{"key":"active","value":"yes"}],"updated_at":"2024-11-05T20:21:40.797Z"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting an entity information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "created_at": { "type": "string", "example": "2024-11-05T18:32:25.522Z" }, + "database": { "type": "string", "example": "6229032d0620c89169acbdc0" }, + "id": { "type": "string", "example": "672a64b91807cd0008baa4d5" }, + "index": { + "type": "object", + "properties": { + "id_created_at_idx": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { "type": "string", "example": "id" }, + "example": ["id", "created_at"] + } + } + }, + "id_idx": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { "type": "string", "example": "id" }, + "example": ["id"] + } + } + }, + "id_updated_at_idx": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { "type": "string", "example": "id" }, + "example": ["id", "updated_at"] + } + } + }, + "index_charge_amount": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { "type": "string", "example": "charge_amount" }, + "example": ["charge_amount"] + } + } + } + } + }, + "name": { "type": "string", "example": "Control Entity" }, + "payload_decoder": { "example": null }, + "profile": { "type": "string", "example": "63c82c9e6a7fb4000a1f95a0" }, + "schema": { + "type": "object", + "properties": { + "charge_amount": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": false }, + "type": { "type": "string", "example": "int" } + } + }, + "created_at": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": false }, + "type": { "type": "string", "example": "timestamp" } + } + }, + "id": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": true }, + "type": { "type": "string", "example": "uuid" } + } + }, + "int_field": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": false }, + "type": { "type": "string", "example": "int" } + } + }, + "update_date": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": true }, + "type": { "type": "string", "example": "timestamp" } + } + }, + "updated_at": { + "type": "object", + "properties": { + "required": { "type": "boolean", "example": false }, + "type": { "type": "string", "example": "timestamp" } + } + } + } + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "active" }, + "value": { "type": "string", "example": "yes" } + } + }, + "example": [{ "key": "active", "value": "yes" }] + }, + "updated_at": { "type": "string", "example": "2024-11-05T20:21:40.797Z" } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting an entity information": { + "value": { + "result": { + "created_at": "2024-11-05T18:32:25.522Z", + "database": "6229032d0620c89169acbdc0", + "id": "672a64b91807cd0008baa4d5", + "index": { + "id_created_at_idx": { "fields": ["id", "created_at"] }, + "id_idx": { "fields": ["id"] }, + "id_updated_at_idx": { "fields": ["id", "updated_at"] }, + "index_charge_amount": { "fields": ["charge_amount"] } + }, + "name": "Control Entity", + "payload_decoder": null, + "profile": "63c82c9e6a7fb4000a1f95a0", + "schema": { + "charge_amount": { "required": false, "type": "int" }, + "created_at": { "required": false, "type": "timestamp" }, + "id": { "required": true, "type": "uuid" }, + "int_field": { "required": false, "type": "int" }, + "update_date": { "required": true, "type": "timestamp" }, + "updated_at": { "required": false, "type": "timestamp" } + }, + "tags": [{ "key": "active", "value": "yes" }], + "updated_at": "2024-11-05T20:21:40.797Z" + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-entity-info.api.mdx b/docs/api/get-entity-info.api.mdx index f89ca4b0..b5281677 100644 --- a/docs/api/get-entity-info.api.mdx +++ b/docs/api/get-entity-info.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get Entity Details - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-information.ParamsDetails.json b/docs/api/get-information.ParamsDetails.json index ad79fd90..90c109ae 100644 --- a/docs/api/get-information.ParamsDetails.json +++ b/docs/api/get-information.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + } + ] +} diff --git a/docs/api/get-information.RequestSchema.json b/docs/api/get-information.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-information.RequestSchema.json +++ b/docs/api/get-information.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-information.StatusCodes.json b/docs/api/get-information.StatusCodes.json index ed105b47..dc687448 100644 --- a/docs/api/get-information.StatusCodes.json +++ b/docs/api/get-information.StatusCodes.json @@ -1 +1,181 @@ -{"responses":{"200":{"description":"Getting a dashboard information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"arrangement":{"type":"array","items":{"type":"object","properties":{"height":{"type":"number","example":3},"tab":{"example":null},"widget_id":{"type":"string","example":"6230e740f5772600124c81e1"},"width":{"type":"number","example":1},"x":{"type":"number","example":0},"y":{"type":"number","example":0}}},"example":[{"height":3,"tab":null,"widget_id":"6230e740f5772600124c81e1","width":1,"x":0,"y":0},{"height":3,"tab":null,"widget_id":"6230e75df5772600124c81e2","width":1,"x":1,"y":0},{"height":3,"tab":null,"widget_id":"6230e44cf5772600124c81de","width":1,"x":2,"y":0},{"height":3,"tab":null,"widget_id":"6230e84df5772600124c81e7","width":2.3333333333333335,"x":0.3333333333333333,"y":7},{"height":5,"tab":null,"widget_id":"62750cf1253eb800126aefc0","width":2,"x":2.666666666666667,"y":7}]},"background":{"type":"object","properties":{}},"blueprint_device_behavior":{"example":null},"blueprint_devices":{"type":"array","items":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"kmutable"},"value":{"type":"string","example":"vmutable"}}},"example":[{"key":"kmutable","value":"vmutable"}]},"filter_conditions":{"type":"array","items":{},"example":[]},"id":{"type":"string","example":"6230e392f5772600124c81db"},"name":{"type":"string","example":"mutable_device"}}},"example":[{"conditions":[{"key":"kmutable","value":"vmutable"}],"filter_conditions":[],"id":"6230e392f5772600124c81db","name":"mutable_device"},{"conditions":[{"key":"kimmutable","value":"vimmutable"}],"filter_conditions":[],"id":"6230e42af5772600124c81dc","name":"immutable_device"},{"conditions":[{"key":"klegacy","value":"vlegacy"}],"filter_conditions":[],"id":"6230e42af5772600124c81dd","name":"legacy_device"}]},"blueprint_selector_behavior":{"example":null},"created_at":{"type":"string","example":"2022-03-15T19:05:54.839Z"},"group_by":{"type":"array","items":{},"example":[]},"icon":{"type":"object","properties":{}},"id":{"type":"string","example":"6230e392f5772600124c81da"},"label":{"type":"string","example":"Device Types Blueprint"},"last_access":{"type":"string","example":"2022-06-21T11:51:07.642Z"},"setup":{"type":"object","properties":{}},"tabs":{"type":"array","items":{},"example":[]},"tags":{"type":"array","items":{},"example":[]},"theme":{"example":null},"type":{"type":"string","example":"blueprint"},"updated_at":{"type":"string","example":"2022-06-21T11:51:07.642Z"},"visible":{"type":"boolean","example":true}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting a dashboard information":{"value":{"result":{"arrangement":[{"height":3,"tab":null,"widget_id":"6230e740f5772600124c81e1","width":1,"x":0,"y":0},{"height":3,"tab":null,"widget_id":"6230e75df5772600124c81e2","width":1,"x":1,"y":0},{"height":3,"tab":null,"widget_id":"6230e44cf5772600124c81de","width":1,"x":2,"y":0},{"height":3,"tab":null,"widget_id":"6230e84df5772600124c81e7","width":2.3333333333333335,"x":0.3333333333333333,"y":7},{"height":5,"tab":null,"widget_id":"62750cf1253eb800126aefc0","width":2,"x":2.666666666666667,"y":7}],"background":{},"blueprint_device_behavior":null,"blueprint_devices":[{"conditions":[{"key":"kmutable","value":"vmutable"}],"filter_conditions":[],"id":"6230e392f5772600124c81db","name":"mutable_device"},{"conditions":[{"key":"kimmutable","value":"vimmutable"}],"filter_conditions":[],"id":"6230e42af5772600124c81dc","name":"immutable_device"},{"conditions":[{"key":"klegacy","value":"vlegacy"}],"filter_conditions":[],"id":"6230e42af5772600124c81dd","name":"legacy_device"}],"blueprint_selector_behavior":null,"created_at":"2022-03-15T19:05:54.839Z","group_by":[],"icon":{},"id":"6230e392f5772600124c81da","label":"Device Types Blueprint","last_access":"2022-06-21T11:51:07.642Z","setup":{},"tabs":[],"tags":[],"theme":null,"type":"blueprint","updated_at":"2022-06-21T11:51:07.642Z","visible":true},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a dashboard information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "arrangement": { + "type": "array", + "items": { + "type": "object", + "properties": { + "height": { "type": "number", "example": 3 }, + "tab": { "example": null }, + "widget_id": { "type": "string", "example": "6230e740f5772600124c81e1" }, + "width": { "type": "number", "example": 1 }, + "x": { "type": "number", "example": 0 }, + "y": { "type": "number", "example": 0 } + } + }, + "example": [ + { "height": 3, "tab": null, "widget_id": "6230e740f5772600124c81e1", "width": 1, "x": 0, "y": 0 }, + { "height": 3, "tab": null, "widget_id": "6230e75df5772600124c81e2", "width": 1, "x": 1, "y": 0 }, + { "height": 3, "tab": null, "widget_id": "6230e44cf5772600124c81de", "width": 1, "x": 2, "y": 0 }, + { + "height": 3, + "tab": null, + "widget_id": "6230e84df5772600124c81e7", + "width": 2.3333333333333335, + "x": 0.3333333333333333, + "y": 7 + }, + { + "height": 5, + "tab": null, + "widget_id": "62750cf1253eb800126aefc0", + "width": 2, + "x": 2.666666666666667, + "y": 7 + } + ] + }, + "background": { "type": "object", "properties": {} }, + "blueprint_device_behavior": { "example": null }, + "blueprint_devices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conditions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "kmutable" }, + "value": { "type": "string", "example": "vmutable" } + } + }, + "example": [{ "key": "kmutable", "value": "vmutable" }] + }, + "filter_conditions": { "type": "array", "items": {}, "example": [] }, + "id": { "type": "string", "example": "6230e392f5772600124c81db" }, + "name": { "type": "string", "example": "mutable_device" } + } + }, + "example": [ + { + "conditions": [{ "key": "kmutable", "value": "vmutable" }], + "filter_conditions": [], + "id": "6230e392f5772600124c81db", + "name": "mutable_device" + }, + { + "conditions": [{ "key": "kimmutable", "value": "vimmutable" }], + "filter_conditions": [], + "id": "6230e42af5772600124c81dc", + "name": "immutable_device" + }, + { + "conditions": [{ "key": "klegacy", "value": "vlegacy" }], + "filter_conditions": [], + "id": "6230e42af5772600124c81dd", + "name": "legacy_device" + } + ] + }, + "blueprint_selector_behavior": { "example": null }, + "created_at": { "type": "string", "example": "2022-03-15T19:05:54.839Z" }, + "group_by": { "type": "array", "items": {}, "example": [] }, + "icon": { "type": "object", "properties": {} }, + "id": { "type": "string", "example": "6230e392f5772600124c81da" }, + "label": { "type": "string", "example": "Device Types Blueprint" }, + "last_access": { "type": "string", "example": "2022-06-21T11:51:07.642Z" }, + "setup": { "type": "object", "properties": {} }, + "tabs": { "type": "array", "items": {}, "example": [] }, + "tags": { "type": "array", "items": {}, "example": [] }, + "theme": { "example": null }, + "type": { "type": "string", "example": "blueprint" }, + "updated_at": { "type": "string", "example": "2022-06-21T11:51:07.642Z" }, + "visible": { "type": "boolean", "example": true } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting a dashboard information": { + "value": { + "result": { + "arrangement": [ + { "height": 3, "tab": null, "widget_id": "6230e740f5772600124c81e1", "width": 1, "x": 0, "y": 0 }, + { "height": 3, "tab": null, "widget_id": "6230e75df5772600124c81e2", "width": 1, "x": 1, "y": 0 }, + { "height": 3, "tab": null, "widget_id": "6230e44cf5772600124c81de", "width": 1, "x": 2, "y": 0 }, + { + "height": 3, + "tab": null, + "widget_id": "6230e84df5772600124c81e7", + "width": 2.3333333333333335, + "x": 0.3333333333333333, + "y": 7 + }, + { + "height": 5, + "tab": null, + "widget_id": "62750cf1253eb800126aefc0", + "width": 2, + "x": 2.666666666666667, + "y": 7 + } + ], + "background": {}, + "blueprint_device_behavior": null, + "blueprint_devices": [ + { + "conditions": [{ "key": "kmutable", "value": "vmutable" }], + "filter_conditions": [], + "id": "6230e392f5772600124c81db", + "name": "mutable_device" + }, + { + "conditions": [{ "key": "kimmutable", "value": "vimmutable" }], + "filter_conditions": [], + "id": "6230e42af5772600124c81dc", + "name": "immutable_device" + }, + { + "conditions": [{ "key": "klegacy", "value": "vlegacy" }], + "filter_conditions": [], + "id": "6230e42af5772600124c81dd", + "name": "legacy_device" + } + ], + "blueprint_selector_behavior": null, + "created_at": "2022-03-15T19:05:54.839Z", + "group_by": [], + "icon": {}, + "id": "6230e392f5772600124c81da", + "label": "Device Types Blueprint", + "last_access": "2022-06-21T11:51:07.642Z", + "setup": {}, + "tabs": [], + "tags": [], + "theme": null, + "type": "blueprint", + "updated_at": "2022-06-21T11:51:07.642Z", + "visible": true + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-information.api.mdx b/docs/api/get-information.api.mdx index 0bef1754..d2e548e8 100644 --- a/docs/api/get-information.api.mdx +++ b/docs/api/get-information.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get settings information of the dashboard. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-policy-list.ParamsDetails.json b/docs/api/get-policy-list.ParamsDetails.json index e2bb094a..7b2cad1e 100644 --- a/docs/api/get-policy-list.ParamsDetails.json +++ b/docs/api/get-policy-list.ParamsDetails.json @@ -1 +1,5 @@ -{"parameters":[{"name":"orderBy","in":"query","required":true,"schema":{"type":"string","example":"created_at"}}]} \ No newline at end of file +{ + "parameters": [ + { "name": "orderBy", "in": "query", "required": true, "schema": { "type": "string", "example": "created_at" } } + ] +} diff --git a/docs/api/get-policy-list.RequestSchema.json b/docs/api/get-policy-list.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-policy-list.RequestSchema.json +++ b/docs/api/get-policy-list.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-policy-list.StatusCodes.json b/docs/api/get-policy-list.StatusCodes.json index b1ef2bed..65f443a6 100644 --- a/docs/api/get-policy-list.StatusCodes.json +++ b/docs/api/get-policy-list.StatusCodes.json @@ -1 +1,39 @@ -{"responses":{"200":{"description":"Getting Policy List","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","description":"Indicates if the policy is active","example":true},"id":{"type":"string","example":"654a7e62a34b9c000006886c2"},"profile":{"type":"string","example":"62fa9e65e0badb0019200"},"name":{"type":"string","example":"My Analysis Policy"},"created_at":{"type":"string","description":"Date and time when the policy was created","example":"2023-11-01T12:34:56.789Z"},"tags":{"type":"array","items":{},"example":[]}}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting Policy List", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "active": { + "type": "boolean", + "description": "Indicates if the policy is active", + "example": true + }, + "id": { "type": "string", "example": "654a7e62a34b9c000006886c2" }, + "profile": { "type": "string", "example": "62fa9e65e0badb0019200" }, + "name": { "type": "string", "example": "My Analysis Policy" }, + "created_at": { + "type": "string", + "description": "Date and time when the policy was created", + "example": "2023-11-01T12:34:56.789Z" + }, + "tags": { "type": "array", "items": {}, "example": [] } + } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-policy-list.api.mdx b/docs/api/get-policy-list.api.mdx index a2793c63..d72908c9 100644 --- a/docs/api/get-policy-list.api.mdx +++ b/docs/api/get-policy-list.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List all access policies in your profile - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-profile-file-list.ParamsDetails.json b/docs/api/get-profile-file-list.ParamsDetails.json index aee22233..c837b0cd 100644 --- a/docs/api/get-profile-file-list.ParamsDetails.json +++ b/docs/api/get-profile-file-list.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"qty","in":"query","schema":{"type":"string","example":"number"},"description":"Quantity of files to be returned in the response"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "qty", + "in": "query", + "schema": { "type": "string", "example": "number" }, + "description": "Quantity of files to be returned in the response" + } + ] +} diff --git a/docs/api/get-profile-file-list.RequestSchema.json b/docs/api/get-profile-file-list.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-profile-file-list.RequestSchema.json +++ b/docs/api/get-profile-file-list.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-profile-file-list.StatusCodes.json b/docs/api/get-profile-file-list.StatusCodes.json index 0ebf18ef..ffc560a7 100644 --- a/docs/api/get-profile-file-list.StatusCodes.json +++ b/docs/api/get-profile-file-list.StatusCodes.json @@ -1 +1,81 @@ -{"responses":{"200":{"description":"Get Profile's Files List","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","example":"layer01.png"},"last_modified":{"type":"string","example":"2023-10-16T13:25:04.000Z"},"public":{"type":"boolean","example":true},"size":{"type":"number","example":63480}}},"example":[{"filename":"layer01.png","last_modified":"2023-10-16T13:25:04.000Z","public":true,"size":63480},{"filename":"layer02.png","last_modified":"2023-10-16T13:23:58.000Z","public":true,"size":233444}]},"folders":{"type":"array","items":{"type":"string","example":"reports"},"example":["reports","image"]},"total":{"type":"number","example":50},"usage":{"type":"number","example":6.02}}},"status":{"type":"boolean","example":true}}},"examples":{"Get Profile's Files List":{"value":{"result":{"files":[{"filename":"layer01.png","last_modified":"2023-10-16T13:25:04.000Z","public":true,"size":63480},{"filename":"layer02.png","last_modified":"2023-10-16T13:23:58.000Z","public":true,"size":233444}],"folders":["reports","image"],"total":50,"usage":6.02},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get Profile's Files List", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filename": { "type": "string", "example": "layer01.png" }, + "last_modified": { "type": "string", "example": "2023-10-16T13:25:04.000Z" }, + "public": { "type": "boolean", "example": true }, + "size": { "type": "number", "example": 63480 } + } + }, + "example": [ + { + "filename": "layer01.png", + "last_modified": "2023-10-16T13:25:04.000Z", + "public": true, + "size": 63480 + }, + { + "filename": "layer02.png", + "last_modified": "2023-10-16T13:23:58.000Z", + "public": true, + "size": 233444 + } + ] + }, + "folders": { + "type": "array", + "items": { "type": "string", "example": "reports" }, + "example": ["reports", "image"] + }, + "total": { "type": "number", "example": 50 }, + "usage": { "type": "number", "example": 6.02 } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Get Profile's Files List": { + "value": { + "result": { + "files": [ + { + "filename": "layer01.png", + "last_modified": "2023-10-16T13:25:04.000Z", + "public": true, + "size": 63480 + }, + { + "filename": "layer02.png", + "last_modified": "2023-10-16T13:23:58.000Z", + "public": true, + "size": 233444 + } + ], + "folders": ["reports", "image"], + "total": 50, + "usage": 6.02 + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-profile-file-list.api.mdx b/docs/api/get-profile-file-list.api.mdx index aa8f1346..2fac53b2 100644 --- a/docs/api/get-profile-file-list.api.mdx +++ b/docs/api/get-profile-file-list.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get profile file list - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-run-settings.RequestSchema.json b/docs/api/get-run-settings.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-run-settings.RequestSchema.json +++ b/docs/api/get-run-settings.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-run-settings.StatusCodes.json b/docs/api/get-run-settings.StatusCodes.json index d8ac68b7..4696fa44 100644 --- a/docs/api/get-run-settings.StatusCodes.json +++ b/docs/api/get-run-settings.StatusCodes.json @@ -1 +1,369 @@ -{"responses":{"200":{"description":"RUN settings retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"active":{"type":"boolean","example":true},"auth_token_ttl":{"type":"string","example":"3 months"},"created_at":{"type":"string","example":"2022-06-17T00:02:20.531Z"},"dictionary":{"example":null},"email_domain":{"example":null},"email_templates":{"type":"object","properties":{"password_recover":{"type":"object","properties":{"subject":{"type":"string","example":"Password Recovery"},"value":{"type":"string","example":"### Hi $name$.\n\nYou have requested to reset your password on $application.name$.\n\nClick [here]($recover_link$) and you'll be redirected to a secure site where you can set a new password."}}},"welcome_actived":{"type":"object","properties":{"subject":{"type":"string","example":"Your account was activated!"},"value":{"type":"string","example":"### Hi $name$.\n\nYour account was successfully confirmed. You are now able to log in!"}}},"welcome_adminconfirm":{"type":"object","properties":{"subject":{"type":"string","example":"Your account is being analysed"},"value":{"type":"string","example":"### Hi $name$.\n\nWelcome!\n\nYour account creation has been submitted, but is currently being analysed. We'll keep you posted."}}},"welcome_autoconfirm":{"type":"object","properties":{"subject":{"type":"string","example":"Welcome $name$!"},"value":{"type":"string","example":"### Hi $name$.\n\nWelcome!\n\nBefore you start to enjoy all the features, click [here]($confirmation_link$) to confirm your email."}}}}},"favicon":{"example":null},"feature_devicewifisetup":{"type":"object","properties":{"background_color":{"type":"string","example":"white"},"button_cancel_background_color":{"type":"string","example":"white"},"button_cancel_text_color":{"type":"string","example":"black"},"button_confirm_background_color":{"type":"string","example":"hsl(229, 100%, 23%)"},"button_confirm_text_color":{"type":"string","example":"white"},"enabled":{"type":"boolean","example":false},"ip":{"type":"string","example":""},"language":{"type":"string","example":"EN"},"name":{"type":"string","example":""},"port":{"type":"string","example":""},"protocol":{"type":"string","example":"http"},"text_color":{"type":"string","example":"rgb(60, 60, 60)"},"translations":{"type":"object","properties":{"EN":{"type":"object","properties":{"done_desc":{"type":"string","example":""},"done_title":{"type":"string","example":"Device configured!"},"intro_desc":{"type":"string","example":"Let's connect your device to Wi-Fi for you to start using it."},"intro_img":{"type":"string","example":""},"intro_title":{"type":"string","example":"Begin device setup"},"param_title":{"type":"string","example":"Device found!"},"wait_desc":{"type":"string","example":""},"wait_title":{"type":"string","example":"Waiting for device..."},"wifi_config_desc":{"type":"string","example":"Go to the Wi-Fi settings on your phone and select the AcmeTracking-XXX network. It may take up to a minute to appear on the list. After connecting your phone to the AcmeTracking-XXX network via Wi-Fi, return to the TagoRun app to continue the setup."},"wifi_config_title":{"type":"string","example":"Manually connect to the Device Network"}}}}}}},"feature_geolocation":{"example":null},"integration":{"type":"object","properties":{"google_analytics":{"type":"string","example":""},"zoho_salesiq":{"type":"string","example":""}}},"logo":{"example":null},"logo_options":{"type":"object","properties":{"tooltip":{"type":"string","example":""},"type":{"type":"string","example":""},"value":{"type":"string","example":""}}},"name":{"type":"string","example":"John Doe Run"},"profile":{"type":"string","example":"62ab4302ee089b00134f33ff"},"security":{"type":"object","properties":{}},"sidebar_buttons":{"type":"array","items":{"type":"object","properties":{"color":{"type":"string","example":"grey"},"href":{"type":"string","example":"/"},"iconUrl":{"type":"string","example":"https://svg.internal.tago.io/home.svg"},"isInNewLine":{"type":"boolean","example":true},"text":{"type":"string","example":"Home"},"type":{"type":"string","example":""}}},"example":[{"color":"grey","href":"/","iconUrl":"https://svg.internal.tago.io/home.svg","text":"Home","type":""},{"color":"red","href":"users","iconUrl":"https://svg.internal.tago.io/group-profile-users.svg","text":"Users","type":""},{"color":"hsl(208, 56%, 46%)","href":"connections","iconUrl":"https://svg.internal.tago.io/wifi.svg","isInNewLine":true,"text":"Connections","type":""}]},"signup_fields":{"type":"array","items":{},"example":[]},"signup_logo":{"example":null},"signup_logo_options":{"type":"object","properties":{}},"signup_method":{"type":"string","example":"default"},"sso_saml_active":{"type":"boolean","example":false},"sub_title":{"type":"string","example":"Machine Management"},"theme":{"type":"object","properties":{"actionSchedule":{"type":"string","example":"#e6431e"},"actionTriggerByData":{"type":"string","example":"rgb(85, 107, 47)"},"actionTriggerByMQTT":{"type":"string","example":"hsl(296, 32%, 43%)"},"actionTriggerByResource":{"type":"string","example":"hsl(208, 56%, 45%)"},"alertActionDangerBackground":{"type":"string","example":"hsl(0, 49%, 54%)"},"alertActionInfoBackground":{"type":"string","example":"hsl(200, 74%, 88%)"},"alertActionWarningBackground":{"type":"string","example":"hsl(50, 100%, 86%)"},"alertDangerBackground":{"type":"string","example":"hsl(0, 60%, 92%)"},"alertInfoBackground":{"type":"string","example":"hsl(200, 65%, 91%)"},"alertWarningBackground":{"type":"string","example":"hsl(50, 100%, 94%)"},"analysisExternal":{"type":"string","example":"hsl(27, 80%, 49%)"},"analysisInternal":{"type":"string","example":"hsl(208, 56%, 46%)"},"auth_bg_opacity":{"type":"number","example":100},"auth_bg_src":{"type":"string","example":""},"auth_bg_type":{"type":"string","example":"default"},"auth_form_opacity":{"example":null},"blueprint":{"type":"string","example":"hsl(230, 100%, 32%)"},"buttonDanger":{"type":"string","example":"#e40000"},"buttonDangerText":{"type":"string","example":"hsl(0, 100%, 100%)"},"buttonDefault":{"type":"string","example":"hsl(0, 0%, 100%)"},"buttonDefaultText":{"type":"string","example":"hsl(0, 0%, 0%)"},"buttonDisabled":{"type":"string","example":"hsl(0, 0%, 90%)"},"buttonDisabledText":{"type":"string","example":"hsl(0, 0%, 0%)"},"buttonIconLabel":{"type":"string","example":"hsl(0, 4%, 29%)"},"buttonPrimary":{"type":"string","example":"hsl(229, 100%, 23%)"},"buttonPrimaryText":{"type":"string","example":"hsl(0, 0%, 100%)"},"buttonSuccess":{"type":"string","example":"#007d05"},"buttonSuccessText":{"type":"string","example":"hsl(0, 0%, 100%)"},"buttonUpgrade":{"type":"string","example":"hsl(31, 92%, 66%)"},"buttonUpgradeText":{"type":"string","example":"hsl(0, 0%, 0%)"},"buttonWarning":{"type":"string","example":"hsl(31, 92%, 66%)"},"buttonWarningText":{"type":"string","example":"hsl(0, 0%, 100%)"},"contentBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"contentHeader":{"type":"string","example":"hsl(0, 0%, 100%)"},"contentHeaderGradient":{"type":"string","example":"rgb(218, 218, 220)"},"contentHeaderSeparator":{"type":"string","example":"hsl(0, 4%, 29%)"},"contentHeaderText":{"type":"string","example":"hsl(0, 4%, 29%)"},"dataStorageImmutable":{"type":"string","example":"hsl(82, 39%, 30%)"},"dataStorageMutable":{"type":"string","example":"hsl(180, 100%, 27%)"},"deviceInputOutput1Day":{"type":"string","example":"hsl(298, 74%, 37%)"},"deviceInputOutput3Days":{"type":"string","example":"hsl(341, 74%, 36%)"},"deviceInputOutput3Hours":{"type":"string","example":"hsl(121, 84%, 40%)"},"deviceInputOutput6Hours":{"type":"string","example":"hsl(29, 98%, 48%)"},"deviceInputOutputRest":{"type":"string","example":"hsl(0, 0%, 50%)"},"deviceListAlternateRow":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"deviceListColumn":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"dictionaryAlertIcon":{"type":"string","example":"hsl(0, 95%, 70%)"},"dictionaryPrimary":{"type":"string","example":"hsl(208, 56%, 46%)"},"dottedBorder":{"type":"string","example":"hsl(0, 4%, 29%)"},"dropdownAccent":{"type":"string","example":"hsl(229, 100%, 23%)"},"dropdownBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"dynamicTableAlternateRow":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"dynamicTableColumn":{"type":"string","example":"hsla(0, 0%, 0%, .05)"},"filesSelection":{"type":"string","example":"hsl(207, 56%, 93%)"},"floatingSidebarTitle":{"type":"string","example":"hsl(229, 100%, 23%)"},"footerBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"formControlBorder":{"type":"string","example":"hsla(0, 0%, 0%, 0.07)"},"formControlFocus":{"type":"string","example":"hsl(208, 56%, 46%)"},"gaugeDanger":{"type":"string","example":"#C02416"},"gaugeEmpty":{"type":"string","example":"hsl(0, 0%, 80%)"},"gaugeFill":{"type":"string","example":"hsl(208, 56%, 46%)"},"gaugePrimaryText":{"type":"string","example":"hsl(0, 0%, 0%)"},"gaugeSecondaryText":{"type":"string","example":"hsl(0, 0%, 45%)"},"gaugeTick":{"type":"string","example":"hsl(0, 0%, 57%)"},"html5":{"type":"string","example":"hsl(14, 93%, 54%)"},"iconRadioSelected":{"type":"string","example":"hsl(0, 0%, 33%)"},"iconRadioSubTitle":{"type":"string","example":"hsl(0, 0%, 45%)"},"informationIcon":{"type":"string","example":"hsl(229, 100%, 23%)"},"inputBackground":{"type":"string","example":"hsl(0, 0%, 99%)"},"inputBackgroundReadOnly":{"type":"string","example":"hsl(0, 0%, 95%)"},"inputError":{"type":"string","example":"#e40000"},"inputForeground":{"type":"string","example":"hsl(225, 6%, 13%)"},"inputForegroundReadOnly":{"type":"string","example":"hsl(0, 0%, 45%)"},"lightBorder":{"type":"string","example":"hsla(0, 0%, 0%, 0.1)"},"limitAlert":{"type":"string","example":"hsl(0, 49%, 54%)"},"link":{"type":"string","example":"hsl(208, 56%, 46%)"},"listNavColor":{"type":"string","example":"hsl(0, 0%, 100%)"},"listTitleLabel":{"type":"string","example":"hsl(0, 0%, 33%)"},"loading":{"type":"string","example":"hsl(0, 0%, 20%)"},"loginButton":{"type":"string","example":"hsl(229, 81%, 54%)"},"loginButtonText":{"type":"string","example":"hsl(0, 100%, 100%)"},"loginForeground":{"type":"string","example":"hsl(0, 4%, 29%)"},"loginForm":{"type":"string","example":"hsla(0, 100%, 100%, 1)"},"modalContainer":{"type":"string","example":"hsl(0, 0%, 100%)"},"modalOverlay":{"type":"string","example":"hsla(0, 0%, 0%, 0.5)"},"navDescription":{"type":"string","example":"hsl(0, 0%, 55%)"},"navbar":{"type":"string","example":"hsl(229, 100%, 23%)"},"navbarBetaDeveloperBorder":{"type":"string","example":"rgb(0, 255, 126)"},"navbarButton":{"type":"string","example":"hsl(229, 100%, 23%)"},"navbarDropdownBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"navbarDropdownBorder":{"type":"string","example":"hsl(0, 0%, 80%)"},"navbarDropdownOption":{"type":"string","example":"hsl(0, 0%, 30%)"},"navbarDropdownOptionBackground":{"type":"string","example":"hsl(0, 0%, 98%)"},"navbarDropdownOptionBorder":{"type":"string","example":"rgb(225, 225, 225)"},"navbarDropdownOptionHover":{"type":"string","example":"hsl(0, 0%, 94%)"},"navbarDropdownSecondaryText":{"type":"string","example":"rgb(150, 150, 150)"},"navbarDropdownSignoutButton":{"type":"string","example":"hsl(0, 0%, 100%)"},"navbarSettings":{"type":"string","example":"hsl(0, 0%, 55%)"},"navbarText":{"type":"string","example":"hsl(0, 100%, 100%)"},"notificationButtonAmount":{"type":"string","example":"hsl(354, 81%, 60%)"},"notificationButtonAmountText":{"type":"string","example":"hsl(0, 100%, 100%)"},"notificationEmptyIcon":{"type":"string","example":"hsl(0, 0%, 78%)"},"notificationEmptyTitle":{"type":"string","example":"hsl(0, 0%, 62%)"},"notificationFilterBackground":{"type":"string","example":"hsl(240,4%,95%)"},"notificationFilterMessageIcon":{"type":"string","example":"rgba(0, 0, 0, 0.2)"},"notificationFooter":{"type":"string","example":"hsl(0, 0%, 98%)"},"notificationIconContainer":{"type":"string","example":"rgba(0, 0, 0, 0.04)"},"notificationItem":{"type":"string","example":"hsl(0, 0%, 100%)"},"notificationItemBorder":{"type":"string","example":"hsl(0, 0%, 90%)"},"notificationItemDate":{"type":"string","example":"rgba(0, 0, 0, 0.4)"},"notificationItemTextAccepted":{"type":"string","example":"hsl(0, 0%, 62%)"},"notificationItemUnread":{"type":"string","example":"hsla(0, 0%, 97%, 1)"},"notificationText":{"type":"string","example":"hsl(0, 4%, 29%)"},"pdf":{"type":"string","example":"hsl(3, 97%, 48%)"},"primary":{"type":"string","example":"hsl(229, 100%, 23%)"},"publicPageNavigationBar":{"type":"string","example":"#007d05"},"quickstart":{"type":"string","example":"hsl(233, 45%, 50%)"},"quickstartSidebarBackground":{"type":"string","example":"hsl(220, 16%, 96%)"},"quickstartTask":{"type":"string","example":"hsl(223, 12%, 89%)"},"quickstartTaskFinished":{"type":"string","example":"hsl(155, 54%, 46%)"},"quickstartText":{"type":"string","example":"hsl(0, 100%, 100%)"},"regularText":{"type":"string","example":"hsl(0, 4%, 29%)"},"sidebarAccessSelected":{"type":"string","example":"hsl(300, 100%, 25%)"},"sidebarAccountSelected":{"type":"string","example":"hsl(43, 94%, 37%)"},"sidebarActionSelected":{"type":"string","example":"#e6431e"},"sidebarAnalysisSelected":{"type":"string","example":"#294E80"},"sidebarBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"sidebarBillingSelected":{"type":"string","example":"rgb(28, 117, 8)"},"sidebarConnector":{"type":"string","example":"hsl(208, 56%, 46%)"},"sidebarDashboardSelected":{"type":"string","example":"hsl(321, 84%, 38%)"},"sidebarDeviceSelected":{"type":"string","example":"#118c8c"},"sidebarExploreSelected":{"type":"string","example":"hsl(206, 74%, 52%)"},"sidebarFileSelected":{"type":"string","example":"#ea8d13"},"sidebarForegroundIcon":{"type":"string","example":"hsl(0, 4%, 29%)"},"sidebarHomeSelected":{"type":"string","example":"hsl(208, 56%, 46%)"},"sidebarIntegration":{"type":"string","example":"hsl(0, 0%, 25%)"},"sidebarItem":{"type":"string","example":"hsl(240, 4%, 100%)"},"sidebarItemHover":{"type":"string","example":"hsl(240, 4%, 95%)"},"sidebarItemOdd":{"type":"string","example":"rgba(0, 0, 0, .015)"},"sidebarItemSelected":{"type":"string","example":"hsl(240, 4%, 97%)"},"sidebarNetwork":{"type":"string","example":"hsl(156, 74%, 25%)"},"sidebarRibbon":{"type":"string","example":"hsl(0, 0%, 97%)"},"sidebarRunSelected":{"type":"string","example":"rgb(120, 90, 255)"},"sidebarSecondBackground":{"type":"string","example":"hsl(240, 4%, 95%)"},"sidebarSeparator":{"type":"string","example":"hsl(0, 0%, 100%)"},"sidebarSeparatorForeground":{"type":"string","example":"hsla(0, 0%, 0%, .5)"},"sidebarTagoCoreSelected":{"type":"string","example":"hsl(0, 0%, 0%)"},"sidebarText":{"type":"string","example":"hsl(0, 4%, 29%)"},"sidebarUserSelected":{"type":"string","example":"rgb(113, 20, 20)"},"snakeButtonOutline":{"type":"string","example":"hsl(0, 0%, 60%)"},"svgTagoFont":{"type":"string","example":"hsl(208, 56%, 46%)"},"svgTagoIOHole":{"type":"string","example":"hsl(0, 0%, 100%)"},"switchDisabledBackground":{"type":"string","example":"hsl(0, 0%, 77%)"},"switchLabelDark":{"type":"string","example":"hsl(0, 0%, 97%)"},"switchLabelWhite":{"type":"string","example":"hsla(0, 0%, 0%, .5)"},"switchSlider":{"type":"string","example":"hsl(0, 0%, 100%)"},"tabLabelActive":{"type":"string","example":"hsl(208, 56%, 46%)"},"tabLabelBackground":{"type":"string","example":"hsl(240, 4%, 95%)"},"tabLabelBorder":{"type":"string","example":"hsl(204, 12%, 92%)"},"tabLabelHover":{"type":"string","example":"hsl(0, 0%, 100%)"},"tabText":{"type":"string","example":"hsl(0, 4%, 29%)"},"tableBackground":{"type":"string","example":"hsl(0, 100%, 100%)"},"tableBorder":{"type":"string","example":"hsla(0, 0%, 0%, 0.1)"},"tableEvenRowBackground":{"type":"string","example":"hsla(0, 0%, 0%, 0.03)"},"tableFooterBackground":{"type":"string","example":"hsl(240, 4%, 95%)"},"tableOddRowBackground":{"type":"string","example":"hsl(0, 100%, 100%)"},"toast":{"type":"string","example":"hsl(0,0%,100%)"},"toastText":{"type":"string","example":"hsl(0, 4%, 29%)"},"tooltipContainer":{"type":"string","example":"hsl(229, 100%, 23%)"},"tooltipText":{"type":"string","example":"hsl(0, 0%, 100%)"},"verticalTabItem":{"type":"string","example":"hsl(240, 20%, 98%)"},"verticalTabItemBorder":{"type":"string","example":"hsl(204, 12%, 92%)"},"widgetCardBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"widgetColors":{"type":"string","example":"hsl(208, 56%, 46%)"},"widgetIconsAccent":{"type":"string","example":"hsl(229, 100%, 23%)"},"widgetIconsBackground":{"type":"string","example":"hsl(0, 0%, 100%)"},"widgetIconsColor":{"type":"string","example":"hsl(0, 4%, 29%)"},"widgetIconsFooterBasic":{"type":"string","example":"hsl(0, 0%, 97%)"},"widgetIconsFooterPremium":{"type":"string","example":"hsl(53, 100%, 55%)"}}},"updated_at":{"type":"string","example":"2022-06-17T00:02:20.531Z"},"url":{"type":"string","example":"62ab4302ee089b00134f33ff.run.tago.io"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "RUN settings retrieved", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "auth_token_ttl": { "type": "string", "example": "3 months" }, + "created_at": { "type": "string", "example": "2022-06-17T00:02:20.531Z" }, + "dictionary": { "example": null }, + "email_domain": { "example": null }, + "email_templates": { + "type": "object", + "properties": { + "password_recover": { + "type": "object", + "properties": { + "subject": { "type": "string", "example": "Password Recovery" }, + "value": { + "type": "string", + "example": "### Hi $name$.\n\nYou have requested to reset your password on $application.name$.\n\nClick [here]($recover_link$) and you'll be redirected to a secure site where you can set a new password." + } + } + }, + "welcome_actived": { + "type": "object", + "properties": { + "subject": { "type": "string", "example": "Your account was activated!" }, + "value": { + "type": "string", + "example": "### Hi $name$.\n\nYour account was successfully confirmed. You are now able to log in!" + } + } + }, + "welcome_adminconfirm": { + "type": "object", + "properties": { + "subject": { "type": "string", "example": "Your account is being analysed" }, + "value": { + "type": "string", + "example": "### Hi $name$.\n\nWelcome!\n\nYour account creation has been submitted, but is currently being analysed. We'll keep you posted." + } + } + }, + "welcome_autoconfirm": { + "type": "object", + "properties": { + "subject": { "type": "string", "example": "Welcome $name$!" }, + "value": { + "type": "string", + "example": "### Hi $name$.\n\nWelcome!\n\nBefore you start to enjoy all the features, click [here]($confirmation_link$) to confirm your email." + } + } + } + } + }, + "favicon": { "example": null }, + "feature_devicewifisetup": { + "type": "object", + "properties": { + "background_color": { "type": "string", "example": "white" }, + "button_cancel_background_color": { "type": "string", "example": "white" }, + "button_cancel_text_color": { "type": "string", "example": "black" }, + "button_confirm_background_color": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "button_confirm_text_color": { "type": "string", "example": "white" }, + "enabled": { "type": "boolean", "example": false }, + "ip": { "type": "string", "example": "" }, + "language": { "type": "string", "example": "EN" }, + "name": { "type": "string", "example": "" }, + "port": { "type": "string", "example": "" }, + "protocol": { "type": "string", "example": "http" }, + "text_color": { "type": "string", "example": "rgb(60, 60, 60)" }, + "translations": { + "type": "object", + "properties": { + "EN": { + "type": "object", + "properties": { + "done_desc": { "type": "string", "example": "" }, + "done_title": { "type": "string", "example": "Device configured!" }, + "intro_desc": { + "type": "string", + "example": "Let's connect your device to Wi-Fi for you to start using it." + }, + "intro_img": { "type": "string", "example": "" }, + "intro_title": { "type": "string", "example": "Begin device setup" }, + "param_title": { "type": "string", "example": "Device found!" }, + "wait_desc": { "type": "string", "example": "" }, + "wait_title": { "type": "string", "example": "Waiting for device..." }, + "wifi_config_desc": { + "type": "string", + "example": "Go to the Wi-Fi settings on your phone and select the AcmeTracking-XXX network. It may take up to a minute to appear on the list. After connecting your phone to the AcmeTracking-XXX network via Wi-Fi, return to the TagoRun app to continue the setup." + }, + "wifi_config_title": { + "type": "string", + "example": "Manually connect to the Device Network" + } + } + } + } + } + } + }, + "feature_geolocation": { "example": null }, + "integration": { + "type": "object", + "properties": { + "google_analytics": { "type": "string", "example": "" }, + "zoho_salesiq": { "type": "string", "example": "" } + } + }, + "logo": { "example": null }, + "logo_options": { + "type": "object", + "properties": { + "tooltip": { "type": "string", "example": "" }, + "type": { "type": "string", "example": "" }, + "value": { "type": "string", "example": "" } + } + }, + "name": { "type": "string", "example": "John Doe Run" }, + "profile": { "type": "string", "example": "62ab4302ee089b00134f33ff" }, + "security": { "type": "object", "properties": {} }, + "sidebar_buttons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "color": { "type": "string", "example": "grey" }, + "href": { "type": "string", "example": "/" }, + "iconUrl": { "type": "string", "example": "https://svg.internal.tago.io/home.svg" }, + "isInNewLine": { "type": "boolean", "example": true }, + "text": { "type": "string", "example": "Home" }, + "type": { "type": "string", "example": "" } + } + }, + "example": [ + { + "color": "grey", + "href": "/", + "iconUrl": "https://svg.internal.tago.io/home.svg", + "text": "Home", + "type": "" + }, + { + "color": "red", + "href": "users", + "iconUrl": "https://svg.internal.tago.io/group-profile-users.svg", + "text": "Users", + "type": "" + }, + { + "color": "hsl(208, 56%, 46%)", + "href": "connections", + "iconUrl": "https://svg.internal.tago.io/wifi.svg", + "isInNewLine": true, + "text": "Connections", + "type": "" + } + ] + }, + "signup_fields": { "type": "array", "items": {}, "example": [] }, + "signup_logo": { "example": null }, + "signup_logo_options": { "type": "object", "properties": {} }, + "signup_method": { "type": "string", "example": "default" }, + "sso_saml_active": { "type": "boolean", "example": false }, + "sub_title": { "type": "string", "example": "Machine Management" }, + "theme": { + "type": "object", + "properties": { + "actionSchedule": { "type": "string", "example": "#e6431e" }, + "actionTriggerByData": { "type": "string", "example": "rgb(85, 107, 47)" }, + "actionTriggerByMQTT": { "type": "string", "example": "hsl(296, 32%, 43%)" }, + "actionTriggerByResource": { "type": "string", "example": "hsl(208, 56%, 45%)" }, + "alertActionDangerBackground": { "type": "string", "example": "hsl(0, 49%, 54%)" }, + "alertActionInfoBackground": { "type": "string", "example": "hsl(200, 74%, 88%)" }, + "alertActionWarningBackground": { "type": "string", "example": "hsl(50, 100%, 86%)" }, + "alertDangerBackground": { "type": "string", "example": "hsl(0, 60%, 92%)" }, + "alertInfoBackground": { "type": "string", "example": "hsl(200, 65%, 91%)" }, + "alertWarningBackground": { "type": "string", "example": "hsl(50, 100%, 94%)" }, + "analysisExternal": { "type": "string", "example": "hsl(27, 80%, 49%)" }, + "analysisInternal": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "auth_bg_opacity": { "type": "number", "example": 100 }, + "auth_bg_src": { "type": "string", "example": "" }, + "auth_bg_type": { "type": "string", "example": "default" }, + "auth_form_opacity": { "example": null }, + "blueprint": { "type": "string", "example": "hsl(230, 100%, 32%)" }, + "buttonDanger": { "type": "string", "example": "#e40000" }, + "buttonDangerText": { "type": "string", "example": "hsl(0, 100%, 100%)" }, + "buttonDefault": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "buttonDefaultText": { "type": "string", "example": "hsl(0, 0%, 0%)" }, + "buttonDisabled": { "type": "string", "example": "hsl(0, 0%, 90%)" }, + "buttonDisabledText": { "type": "string", "example": "hsl(0, 0%, 0%)" }, + "buttonIconLabel": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "buttonPrimary": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "buttonPrimaryText": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "buttonSuccess": { "type": "string", "example": "#007d05" }, + "buttonSuccessText": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "buttonUpgrade": { "type": "string", "example": "hsl(31, 92%, 66%)" }, + "buttonUpgradeText": { "type": "string", "example": "hsl(0, 0%, 0%)" }, + "buttonWarning": { "type": "string", "example": "hsl(31, 92%, 66%)" }, + "buttonWarningText": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "contentBackground": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "contentHeader": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "contentHeaderGradient": { "type": "string", "example": "rgb(218, 218, 220)" }, + "contentHeaderSeparator": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "contentHeaderText": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "dataStorageImmutable": { "type": "string", "example": "hsl(82, 39%, 30%)" }, + "dataStorageMutable": { "type": "string", "example": "hsl(180, 100%, 27%)" }, + "deviceInputOutput1Day": { "type": "string", "example": "hsl(298, 74%, 37%)" }, + "deviceInputOutput3Days": { "type": "string", "example": "hsl(341, 74%, 36%)" }, + "deviceInputOutput3Hours": { "type": "string", "example": "hsl(121, 84%, 40%)" }, + "deviceInputOutput6Hours": { "type": "string", "example": "hsl(29, 98%, 48%)" }, + "deviceInputOutputRest": { "type": "string", "example": "hsl(0, 0%, 50%)" }, + "deviceListAlternateRow": { "type": "string", "example": "hsla(0, 0%, 0%, .05)" }, + "deviceListColumn": { "type": "string", "example": "hsla(0, 0%, 0%, .05)" }, + "dictionaryAlertIcon": { "type": "string", "example": "hsl(0, 95%, 70%)" }, + "dictionaryPrimary": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "dottedBorder": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "dropdownAccent": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "dropdownBackground": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "dynamicTableAlternateRow": { "type": "string", "example": "hsla(0, 0%, 0%, .05)" }, + "dynamicTableColumn": { "type": "string", "example": "hsla(0, 0%, 0%, .05)" }, + "filesSelection": { "type": "string", "example": "hsl(207, 56%, 93%)" }, + "floatingSidebarTitle": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "footerBackground": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "formControlBorder": { "type": "string", "example": "hsla(0, 0%, 0%, 0.07)" }, + "formControlFocus": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "gaugeDanger": { "type": "string", "example": "#C02416" }, + "gaugeEmpty": { "type": "string", "example": "hsl(0, 0%, 80%)" }, + "gaugeFill": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "gaugePrimaryText": { "type": "string", "example": "hsl(0, 0%, 0%)" }, + "gaugeSecondaryText": { "type": "string", "example": "hsl(0, 0%, 45%)" }, + "gaugeTick": { "type": "string", "example": "hsl(0, 0%, 57%)" }, + "html5": { "type": "string", "example": "hsl(14, 93%, 54%)" }, + "iconRadioSelected": { "type": "string", "example": "hsl(0, 0%, 33%)" }, + "iconRadioSubTitle": { "type": "string", "example": "hsl(0, 0%, 45%)" }, + "informationIcon": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "inputBackground": { "type": "string", "example": "hsl(0, 0%, 99%)" }, + "inputBackgroundReadOnly": { "type": "string", "example": "hsl(0, 0%, 95%)" }, + "inputError": { "type": "string", "example": "#e40000" }, + "inputForeground": { "type": "string", "example": "hsl(225, 6%, 13%)" }, + "inputForegroundReadOnly": { "type": "string", "example": "hsl(0, 0%, 45%)" }, + "lightBorder": { "type": "string", "example": "hsla(0, 0%, 0%, 0.1)" }, + "limitAlert": { "type": "string", "example": "hsl(0, 49%, 54%)" }, + "link": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "listNavColor": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "listTitleLabel": { "type": "string", "example": "hsl(0, 0%, 33%)" }, + "loading": { "type": "string", "example": "hsl(0, 0%, 20%)" }, + "loginButton": { "type": "string", "example": "hsl(229, 81%, 54%)" }, + "loginButtonText": { "type": "string", "example": "hsl(0, 100%, 100%)" }, + "loginForeground": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "loginForm": { "type": "string", "example": "hsla(0, 100%, 100%, 1)" }, + "modalContainer": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "modalOverlay": { "type": "string", "example": "hsla(0, 0%, 0%, 0.5)" }, + "navDescription": { "type": "string", "example": "hsl(0, 0%, 55%)" }, + "navbar": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "navbarBetaDeveloperBorder": { "type": "string", "example": "rgb(0, 255, 126)" }, + "navbarButton": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "navbarDropdownBackground": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "navbarDropdownBorder": { "type": "string", "example": "hsl(0, 0%, 80%)" }, + "navbarDropdownOption": { "type": "string", "example": "hsl(0, 0%, 30%)" }, + "navbarDropdownOptionBackground": { "type": "string", "example": "hsl(0, 0%, 98%)" }, + "navbarDropdownOptionBorder": { "type": "string", "example": "rgb(225, 225, 225)" }, + "navbarDropdownOptionHover": { "type": "string", "example": "hsl(0, 0%, 94%)" }, + "navbarDropdownSecondaryText": { "type": "string", "example": "rgb(150, 150, 150)" }, + "navbarDropdownSignoutButton": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "navbarSettings": { "type": "string", "example": "hsl(0, 0%, 55%)" }, + "navbarText": { "type": "string", "example": "hsl(0, 100%, 100%)" }, + "notificationButtonAmount": { "type": "string", "example": "hsl(354, 81%, 60%)" }, + "notificationButtonAmountText": { "type": "string", "example": "hsl(0, 100%, 100%)" }, + "notificationEmptyIcon": { "type": "string", "example": "hsl(0, 0%, 78%)" }, + "notificationEmptyTitle": { "type": "string", "example": "hsl(0, 0%, 62%)" }, + "notificationFilterBackground": { "type": "string", "example": "hsl(240,4%,95%)" }, + "notificationFilterMessageIcon": { "type": "string", "example": "rgba(0, 0, 0, 0.2)" }, + "notificationFooter": { "type": "string", "example": "hsl(0, 0%, 98%)" }, + "notificationIconContainer": { "type": "string", "example": "rgba(0, 0, 0, 0.04)" }, + "notificationItem": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "notificationItemBorder": { "type": "string", "example": "hsl(0, 0%, 90%)" }, + "notificationItemDate": { "type": "string", "example": "rgba(0, 0, 0, 0.4)" }, + "notificationItemTextAccepted": { "type": "string", "example": "hsl(0, 0%, 62%)" }, + "notificationItemUnread": { "type": "string", "example": "hsla(0, 0%, 97%, 1)" }, + "notificationText": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "pdf": { "type": "string", "example": "hsl(3, 97%, 48%)" }, + "primary": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "publicPageNavigationBar": { "type": "string", "example": "#007d05" }, + "quickstart": { "type": "string", "example": "hsl(233, 45%, 50%)" }, + "quickstartSidebarBackground": { "type": "string", "example": "hsl(220, 16%, 96%)" }, + "quickstartTask": { "type": "string", "example": "hsl(223, 12%, 89%)" }, + "quickstartTaskFinished": { "type": "string", "example": "hsl(155, 54%, 46%)" }, + "quickstartText": { "type": "string", "example": "hsl(0, 100%, 100%)" }, + "regularText": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "sidebarAccessSelected": { "type": "string", "example": "hsl(300, 100%, 25%)" }, + "sidebarAccountSelected": { "type": "string", "example": "hsl(43, 94%, 37%)" }, + "sidebarActionSelected": { "type": "string", "example": "#e6431e" }, + "sidebarAnalysisSelected": { "type": "string", "example": "#294E80" }, + "sidebarBackground": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "sidebarBillingSelected": { "type": "string", "example": "rgb(28, 117, 8)" }, + "sidebarConnector": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "sidebarDashboardSelected": { "type": "string", "example": "hsl(321, 84%, 38%)" }, + "sidebarDeviceSelected": { "type": "string", "example": "#118c8c" }, + "sidebarExploreSelected": { "type": "string", "example": "hsl(206, 74%, 52%)" }, + "sidebarFileSelected": { "type": "string", "example": "#ea8d13" }, + "sidebarForegroundIcon": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "sidebarHomeSelected": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "sidebarIntegration": { "type": "string", "example": "hsl(0, 0%, 25%)" }, + "sidebarItem": { "type": "string", "example": "hsl(240, 4%, 100%)" }, + "sidebarItemHover": { "type": "string", "example": "hsl(240, 4%, 95%)" }, + "sidebarItemOdd": { "type": "string", "example": "rgba(0, 0, 0, .015)" }, + "sidebarItemSelected": { "type": "string", "example": "hsl(240, 4%, 97%)" }, + "sidebarNetwork": { "type": "string", "example": "hsl(156, 74%, 25%)" }, + "sidebarRibbon": { "type": "string", "example": "hsl(0, 0%, 97%)" }, + "sidebarRunSelected": { "type": "string", "example": "rgb(120, 90, 255)" }, + "sidebarSecondBackground": { "type": "string", "example": "hsl(240, 4%, 95%)" }, + "sidebarSeparator": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "sidebarSeparatorForeground": { "type": "string", "example": "hsla(0, 0%, 0%, .5)" }, + "sidebarTagoCoreSelected": { "type": "string", "example": "hsl(0, 0%, 0%)" }, + "sidebarText": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "sidebarUserSelected": { "type": "string", "example": "rgb(113, 20, 20)" }, + "snakeButtonOutline": { "type": "string", "example": "hsl(0, 0%, 60%)" }, + "svgTagoFont": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "svgTagoIOHole": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "switchDisabledBackground": { "type": "string", "example": "hsl(0, 0%, 77%)" }, + "switchLabelDark": { "type": "string", "example": "hsl(0, 0%, 97%)" }, + "switchLabelWhite": { "type": "string", "example": "hsla(0, 0%, 0%, .5)" }, + "switchSlider": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "tabLabelActive": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "tabLabelBackground": { "type": "string", "example": "hsl(240, 4%, 95%)" }, + "tabLabelBorder": { "type": "string", "example": "hsl(204, 12%, 92%)" }, + "tabLabelHover": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "tabText": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "tableBackground": { "type": "string", "example": "hsl(0, 100%, 100%)" }, + "tableBorder": { "type": "string", "example": "hsla(0, 0%, 0%, 0.1)" }, + "tableEvenRowBackground": { "type": "string", "example": "hsla(0, 0%, 0%, 0.03)" }, + "tableFooterBackground": { "type": "string", "example": "hsl(240, 4%, 95%)" }, + "tableOddRowBackground": { "type": "string", "example": "hsl(0, 100%, 100%)" }, + "toast": { "type": "string", "example": "hsl(0,0%,100%)" }, + "toastText": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "tooltipContainer": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "tooltipText": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "verticalTabItem": { "type": "string", "example": "hsl(240, 20%, 98%)" }, + "verticalTabItemBorder": { "type": "string", "example": "hsl(204, 12%, 92%)" }, + "widgetCardBackground": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "widgetColors": { "type": "string", "example": "hsl(208, 56%, 46%)" }, + "widgetIconsAccent": { "type": "string", "example": "hsl(229, 100%, 23%)" }, + "widgetIconsBackground": { "type": "string", "example": "hsl(0, 0%, 100%)" }, + "widgetIconsColor": { "type": "string", "example": "hsl(0, 4%, 29%)" }, + "widgetIconsFooterBasic": { "type": "string", "example": "hsl(0, 0%, 97%)" }, + "widgetIconsFooterPremium": { "type": "string", "example": "hsl(53, 100%, 55%)" } + } + }, + "updated_at": { "type": "string", "example": "2022-06-17T00:02:20.531Z" }, + "url": { "type": "string", "example": "62ab4302ee089b00134f33ff.run.tago.io" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-run-settings.api.mdx b/docs/api/get-run-settings.api.mdx index ca59eebc..112af986 100644 --- a/docs/api/get-run-settings.api.mdx +++ b/docs/api/get-run-settings.api.mdx @@ -20,43 +20,14 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Retrieve information about TagoRUN + - - - - - - - - - - - - + - \ No newline at end of file + diff --git a/docs/api/get-tags.ParamsDetails.json b/docs/api/get-tags.ParamsDetails.json index cbb9085e..179b9a77 100644 --- a/docs/api/get-tags.ParamsDetails.json +++ b/docs/api/get-tags.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","example":"Device"},"description":"(Accepts Analysis, Device, User, Dashboard, Action)"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "type", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "Device" }, + "description": "(Accepts Analysis, Device, User, Dashboard, Action)" + } + ] +} diff --git a/docs/api/get-tags.RequestSchema.json b/docs/api/get-tags.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-tags.RequestSchema.json +++ b/docs/api/get-tags.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-tags.StatusCodes.json b/docs/api/get-tags.StatusCodes.json index fce75960..942a5673 100644 --- a/docs/api/get-tags.StatusCodes.json +++ b/docs/api/get-tags.StatusCodes.json @@ -1 +1,36 @@ -{"responses":{"200":{"description":"Get Device Tags","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"string","example":"numbervalue"},"example":["numbervalue","vumeter","test","bp","area","block","horizontal","multiple","user","problem","formula","chart","BP"]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get Device Tags", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { "type": "string", "example": "numbervalue" }, + "example": [ + "numbervalue", + "vumeter", + "test", + "bp", + "area", + "block", + "horizontal", + "multiple", + "user", + "problem", + "formula", + "chart", + "BP" + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/get-tags.api.mdx b/docs/api/get-tags.api.mdx index 718537d6..efcf4408 100644 --- a/docs/api/get-tags.api.mdx +++ b/docs/api/get-tags.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get a list containing all device tags in use on your profile - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-the-account-plan.RequestSchema.json b/docs/api/get-the-account-plan.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-the-account-plan.RequestSchema.json +++ b/docs/api/get-the-account-plan.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-the-account-plan.StatusCodes.json b/docs/api/get-the-account-plan.StatusCodes.json index d6165f3c..500fa455 100644 --- a/docs/api/get-the-account-plan.StatusCodes.json +++ b/docs/api/get-the-account-plan.StatusCodes.json @@ -1 +1,19 @@ -{"responses":{"200":{"description":"Getting the account plan","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"plan":{"type":"string","example":"starter"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting the account plan":{"value":{"result":{"plan":"starter"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting the account plan", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "object", "properties": { "plan": { "type": "string", "example": "starter" } } }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { "Getting the account plan": { "value": { "result": { "plan": "starter" }, "status": true } } } + } + } + } + } +} diff --git a/docs/api/get-the-account-plan.api.mdx b/docs/api/get-the-account-plan.api.mdx index 35baf1aa..7703fd4c 100644 --- a/docs/api/get-the-account-plan.api.mdx +++ b/docs/api/get-the-account-plan.api.mdx @@ -20,42 +20,14 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get the Account Plan - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-widget-data.ParamsDetails.json b/docs/api/get-widget-data.ParamsDetails.json index c53ccfe7..9e12e40f 100644 --- a/docs/api/get-widget-data.ParamsDetails.json +++ b/docs/api/get-widget-data.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + }, + { + "name": "widgetID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a widget ID)" } + } + ] +} diff --git a/docs/api/get-widget-data.RequestSchema.json b/docs/api/get-widget-data.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-widget-data.RequestSchema.json +++ b/docs/api/get-widget-data.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-widget-data.StatusCodes.json b/docs/api/get-widget-data.StatusCodes.json index 79918b70..d14529de 100644 --- a/docs/api/get-widget-data.StatusCodes.json +++ b/docs/api/get-widget-data.StatusCodes.json @@ -1 +1,256 @@ -{"responses":{"200":{"description":"Getting widget Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"query":{"type":"string","example":"last_value"},"variables":{"type":"array","items":{"type":"string","example":"temperature"},"example":["temperature"]}}},"result":{"type":"array","items":{"type":"object","properties":{"device":{"type":"string","example":"6238a3a27d792400139e5b47"},"group":{"type":"string","example":"3ac3e21100e473e57d9a1b26"},"id":{"type":"string","example":"62b1a9d75e374e00112e3ca4"},"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"serie":{"type":"string","example":"3ac3e21100e473e57d9a1b26"},"time":{"type":"string","example":"2022-06-21T11:21:59.415Z"},"value":{"type":"number","example":71},"variable":{"type":"string","example":"temperature"}}},"example":[{"device":"6238a3a27d792400139e5b47","group":"3ac3e21100e473e57d9a1b26","id":"62b1a9d75e374e00112e3ca4","origin":"6238a3a27d792400139e5b47","serie":"3ac3e21100e473e57d9a1b26","time":"2022-06-21T11:21:59.415Z","value":71,"variable":"temperature"}]}}},"example":[{"data":{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},"result":[{"device":"6238a3a27d792400139e5b47","group":"3ac3e21100e473e57d9a1b26","id":"62b1a9d75e374e00112e3ca4","origin":"6238a3a27d792400139e5b47","serie":"3ac3e21100e473e57d9a1b26","time":"2022-06-21T11:21:59.415Z","value":71,"variable":"temperature"}]},{"data":{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]},"result":[{"device":"62308e38de51960019697e76","id":"62309cb173cb3b001a031db5","metadata":{"old_value":"45"},"origin":"62308e38de51960019697e76","time":"2022-03-15T14:03:29.476Z","unit":"C","value":"33","variable":"temperature"}]}]},"widget":{"type":"object","properties":{"analysis_run":{"example":null},"dashboard":{"type":"string","example":"623c74a15a13360011803f3e"},"data":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"query":{"type":"string","example":"last_value"},"variables":{"type":"array","items":{"type":"string","example":"temperature"},"example":["temperature"]}}},"example":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}]},"display":{"type":"object","properties":{"header_buttons":{"type":"array","items":{},"example":[]},"show_units":{"type":"boolean","example":true},"show_variables":{"type":"boolean","example":true},"theme":{"type":"object","properties":{"color":{"type":"object","properties":{"background":{"type":"string","example":"hsla(332, 33%, 73%, 1)"},"button":{"type":"string","example":"hsla(112, 91%, 58%, 1)"},"dot":{"type":"string","example":"hsla(0, 97%, 48%, 1)"},"header":{"type":"string","example":"hsla(336, 81%, 51%, 1)"}}}}},"variables":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"variable":{"type":"string","example":"temperature"}}},"example":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]}}},"id":{"type":"string","example":"623c79da5a13360011819b1d"},"label":{"type":"string","example":"Display #1"},"realtime":{"type":"string","example":"true"},"resource":{"type":"array","items":{},"example":[]},"type":{"type":"string","example":"display"}}}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting widget Data":{"value":{"result":{"content":[{"data":{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},"result":[{"device":"6238a3a27d792400139e5b47","group":"3ac3e21100e473e57d9a1b26","id":"62b1a9d75e374e00112e3ca4","origin":"6238a3a27d792400139e5b47","serie":"3ac3e21100e473e57d9a1b26","time":"2022-06-21T11:21:59.415Z","value":71,"variable":"temperature"}]},{"data":{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]},"result":[{"device":"62308e38de51960019697e76","id":"62309cb173cb3b001a031db5","metadata":{"old_value":"45"},"origin":"62308e38de51960019697e76","time":"2022-03-15T14:03:29.476Z","unit":"C","value":"33","variable":"temperature"}]}],"widget":{"analysis_run":null,"dashboard":"623c74a15a13360011803f3e","data":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}],"display":{"header_buttons":[],"show_units":true,"show_variables":true,"theme":{"color":{"background":"hsla(332, 33%, 73%, 1)","button":"hsla(112, 91%, 58%, 1)","dot":"hsla(0, 97%, 48%, 1)","header":"hsla(336, 81%, 51%, 1)"}},"variables":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]},"id":"623c79da5a13360011819b1d","label":"Display #1","realtime":"true","resource":[],"type":"display"}},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting widget Data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "content": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "origin": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "query": { "type": "string", "example": "last_value" }, + "variables": { + "type": "array", + "items": { "type": "string", "example": "temperature" }, + "example": ["temperature"] + } + } + }, + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "device": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "group": { "type": "string", "example": "3ac3e21100e473e57d9a1b26" }, + "id": { "type": "string", "example": "62b1a9d75e374e00112e3ca4" }, + "origin": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "serie": { "type": "string", "example": "3ac3e21100e473e57d9a1b26" }, + "time": { "type": "string", "example": "2022-06-21T11:21:59.415Z" }, + "value": { "type": "number", "example": 71 }, + "variable": { "type": "string", "example": "temperature" } + } + }, + "example": [ + { + "device": "6238a3a27d792400139e5b47", + "group": "3ac3e21100e473e57d9a1b26", + "id": "62b1a9d75e374e00112e3ca4", + "origin": "6238a3a27d792400139e5b47", + "serie": "3ac3e21100e473e57d9a1b26", + "time": "2022-06-21T11:21:59.415Z", + "value": 71, + "variable": "temperature" + } + ] + } + } + }, + "example": [ + { + "data": { + "origin": "6238a3a27d792400139e5b47", + "query": "last_value", + "variables": ["temperature"] + }, + "result": [ + { + "device": "6238a3a27d792400139e5b47", + "group": "3ac3e21100e473e57d9a1b26", + "id": "62b1a9d75e374e00112e3ca4", + "origin": "6238a3a27d792400139e5b47", + "serie": "3ac3e21100e473e57d9a1b26", + "time": "2022-06-21T11:21:59.415Z", + "value": 71, + "variable": "temperature" + } + ] + }, + { + "data": { + "origin": "62308e38de51960019697e76", + "query": "last_value", + "variables": ["temperature"] + }, + "result": [ + { + "device": "62308e38de51960019697e76", + "id": "62309cb173cb3b001a031db5", + "metadata": { "old_value": "45" }, + "origin": "62308e38de51960019697e76", + "time": "2022-03-15T14:03:29.476Z", + "unit": "C", + "value": "33", + "variable": "temperature" + } + ] + } + ] + }, + "widget": { + "type": "object", + "properties": { + "analysis_run": { "example": null }, + "dashboard": { "type": "string", "example": "623c74a15a13360011803f3e" }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "origin": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "query": { "type": "string", "example": "last_value" }, + "variables": { + "type": "array", + "items": { "type": "string", "example": "temperature" }, + "example": ["temperature"] + } + } + }, + "example": [ + { "origin": "6238a3a27d792400139e5b47", "query": "last_value", "variables": ["temperature"] }, + { "origin": "62308e38de51960019697e76", "query": "last_value", "variables": ["temperature"] } + ] + }, + "display": { + "type": "object", + "properties": { + "header_buttons": { "type": "array", "items": {}, "example": [] }, + "show_units": { "type": "boolean", "example": true }, + "show_variables": { "type": "boolean", "example": true }, + "theme": { + "type": "object", + "properties": { + "color": { + "type": "object", + "properties": { + "background": { "type": "string", "example": "hsla(332, 33%, 73%, 1)" }, + "button": { "type": "string", "example": "hsla(112, 91%, 58%, 1)" }, + "dot": { "type": "string", "example": "hsla(0, 97%, 48%, 1)" }, + "header": { "type": "string", "example": "hsla(336, 81%, 51%, 1)" } + } + } + } + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "origin": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "variable": { "type": "string", "example": "temperature" } + } + }, + "example": [ + { "origin": "6238a3a27d792400139e5b47", "variable": "temperature" }, + { "origin": "62308e38de51960019697e76", "variable": "temperature" } + ] + } + } + }, + "id": { "type": "string", "example": "623c79da5a13360011819b1d" }, + "label": { "type": "string", "example": "Display #1" }, + "realtime": { "type": "string", "example": "true" }, + "resource": { "type": "array", "items": {}, "example": [] }, + "type": { "type": "string", "example": "display" } + } + } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting widget Data": { + "value": { + "result": { + "content": [ + { + "data": { + "origin": "6238a3a27d792400139e5b47", + "query": "last_value", + "variables": ["temperature"] + }, + "result": [ + { + "device": "6238a3a27d792400139e5b47", + "group": "3ac3e21100e473e57d9a1b26", + "id": "62b1a9d75e374e00112e3ca4", + "origin": "6238a3a27d792400139e5b47", + "serie": "3ac3e21100e473e57d9a1b26", + "time": "2022-06-21T11:21:59.415Z", + "value": 71, + "variable": "temperature" + } + ] + }, + { + "data": { + "origin": "62308e38de51960019697e76", + "query": "last_value", + "variables": ["temperature"] + }, + "result": [ + { + "device": "62308e38de51960019697e76", + "id": "62309cb173cb3b001a031db5", + "metadata": { "old_value": "45" }, + "origin": "62308e38de51960019697e76", + "time": "2022-03-15T14:03:29.476Z", + "unit": "C", + "value": "33", + "variable": "temperature" + } + ] + } + ], + "widget": { + "analysis_run": null, + "dashboard": "623c74a15a13360011803f3e", + "data": [ + { "origin": "6238a3a27d792400139e5b47", "query": "last_value", "variables": ["temperature"] }, + { "origin": "62308e38de51960019697e76", "query": "last_value", "variables": ["temperature"] } + ], + "display": { + "header_buttons": [], + "show_units": true, + "show_variables": true, + "theme": { + "color": { + "background": "hsla(332, 33%, 73%, 1)", + "button": "hsla(112, 91%, 58%, 1)", + "dot": "hsla(0, 97%, 48%, 1)", + "header": "hsla(336, 81%, 51%, 1)" + } + }, + "variables": [ + { "origin": "6238a3a27d792400139e5b47", "variable": "temperature" }, + { "origin": "62308e38de51960019697e76", "variable": "temperature" } + ] + }, + "id": "623c79da5a13360011819b1d", + "label": "Display #1", + "realtime": "true", + "resource": [], + "type": "display" + } + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-widget-data.api.mdx b/docs/api/get-widget-data.api.mdx index 59624332..bec84e41 100644 --- a/docs/api/get-widget-data.api.mdx +++ b/docs/api/get-widget-data.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Retrieve all the data necessary to display a widget, according to its configuration in the `data` and `resource` fields. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/get-widget-information.ParamsDetails.json b/docs/api/get-widget-information.ParamsDetails.json index c53ccfe7..9e12e40f 100644 --- a/docs/api/get-widget-information.ParamsDetails.json +++ b/docs/api/get-widget-information.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type a dashboard ID)"}},{"name":"widgetID","in":"path","required":true,"schema":{"type":"string","example":"(Type a widget ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a dashboard ID)" } + }, + { + "name": "widgetID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a widget ID)" } + } + ] +} diff --git a/docs/api/get-widget-information.RequestSchema.json b/docs/api/get-widget-information.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/get-widget-information.RequestSchema.json +++ b/docs/api/get-widget-information.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/get-widget-information.StatusCodes.json b/docs/api/get-widget-information.StatusCodes.json index d4d43a9c..284f39ea 100644 --- a/docs/api/get-widget-information.StatusCodes.json +++ b/docs/api/get-widget-information.StatusCodes.json @@ -1 +1,125 @@ -{"responses":{"200":{"description":"Getting a widget information","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"analysis_run":{"example":null},"dashboard":{"type":"string","example":"623c74a15a13360011803f3e"},"data":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"query":{"type":"string","example":"last_value"},"variables":{"type":"array","items":{"type":"string","example":"temperature"},"example":["temperature"]}}},"example":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}]},"display":{"type":"object","properties":{"header_buttons":{"type":"array","items":{},"example":[]},"help":{"type":"string","example":""},"show_units":{"type":"boolean","example":true},"show_variables":{"type":"boolean","example":true},"theme":{"type":"object","properties":{"color":{"type":"object","properties":{"background":{"type":"string","example":"hsla(332, 33%, 73%, 1)"},"button":{"type":"string","example":"hsla(112, 91%, 58%, 1)"},"dot":{"type":"string","example":"hsla(0, 97%, 48%, 1)"},"header":{"type":"string","example":"hsla(336, 81%, 51%, 1)"}}}}},"variables":{"type":"array","items":{"type":"object","properties":{"origin":{"type":"string","example":"6238a3a27d792400139e5b47"},"variable":{"type":"string","example":"temperature"}}},"example":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]}}},"id":{"type":"string","example":"623c79da5a13360011819b1d"},"label":{"type":"string","example":"Display #1"},"realtime":{"type":"boolean","example":true},"resource":{"type":"array","items":{},"example":[]},"token":{"example":null},"type":{"type":"string","example":"display"}}},"status":{"type":"boolean","example":true}}},"examples":{"Getting a widget information":{"value":{"result":{"analysis_run":null,"dashboard":"623c74a15a13360011803f3e","data":[{"origin":"6238a3a27d792400139e5b47","query":"last_value","variables":["temperature"]},{"origin":"62308e38de51960019697e76","query":"last_value","variables":["temperature"]}],"display":{"header_buttons":[],"help":"","show_units":true,"show_variables":true,"theme":{"color":{"background":"hsla(332, 33%, 73%, 1)","button":"hsla(112, 91%, 58%, 1)","dot":"hsla(0, 97%, 48%, 1)","header":"hsla(336, 81%, 51%, 1)"}},"variables":[{"origin":"6238a3a27d792400139e5b47","variable":"temperature"},{"origin":"62308e38de51960019697e76","variable":"temperature"}]},"id":"623c79da5a13360011819b1d","label":"Display #1","realtime":true,"resource":[],"token":null,"type":"display"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a widget information", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "analysis_run": { "example": null }, + "dashboard": { "type": "string", "example": "623c74a15a13360011803f3e" }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "origin": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "query": { "type": "string", "example": "last_value" }, + "variables": { + "type": "array", + "items": { "type": "string", "example": "temperature" }, + "example": ["temperature"] + } + } + }, + "example": [ + { "origin": "6238a3a27d792400139e5b47", "query": "last_value", "variables": ["temperature"] }, + { "origin": "62308e38de51960019697e76", "query": "last_value", "variables": ["temperature"] } + ] + }, + "display": { + "type": "object", + "properties": { + "header_buttons": { "type": "array", "items": {}, "example": [] }, + "help": { "type": "string", "example": "" }, + "show_units": { "type": "boolean", "example": true }, + "show_variables": { "type": "boolean", "example": true }, + "theme": { + "type": "object", + "properties": { + "color": { + "type": "object", + "properties": { + "background": { "type": "string", "example": "hsla(332, 33%, 73%, 1)" }, + "button": { "type": "string", "example": "hsla(112, 91%, 58%, 1)" }, + "dot": { "type": "string", "example": "hsla(0, 97%, 48%, 1)" }, + "header": { "type": "string", "example": "hsla(336, 81%, 51%, 1)" } + } + } + } + }, + "variables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "origin": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "variable": { "type": "string", "example": "temperature" } + } + }, + "example": [ + { "origin": "6238a3a27d792400139e5b47", "variable": "temperature" }, + { "origin": "62308e38de51960019697e76", "variable": "temperature" } + ] + } + } + }, + "id": { "type": "string", "example": "623c79da5a13360011819b1d" }, + "label": { "type": "string", "example": "Display #1" }, + "realtime": { "type": "boolean", "example": true }, + "resource": { "type": "array", "items": {}, "example": [] }, + "token": { "example": null }, + "type": { "type": "string", "example": "display" } + } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting a widget information": { + "value": { + "result": { + "analysis_run": null, + "dashboard": "623c74a15a13360011803f3e", + "data": [ + { "origin": "6238a3a27d792400139e5b47", "query": "last_value", "variables": ["temperature"] }, + { "origin": "62308e38de51960019697e76", "query": "last_value", "variables": ["temperature"] } + ], + "display": { + "header_buttons": [], + "help": "", + "show_units": true, + "show_variables": true, + "theme": { + "color": { + "background": "hsla(332, 33%, 73%, 1)", + "button": "hsla(112, 91%, 58%, 1)", + "dot": "hsla(0, 97%, 48%, 1)", + "header": "hsla(336, 81%, 51%, 1)" + } + }, + "variables": [ + { "origin": "6238a3a27d792400139e5b47", "variable": "temperature" }, + { "origin": "62308e38de51960019697e76", "variable": "temperature" } + ] + }, + "id": "623c79da5a13360011819b1d", + "label": "Display #1", + "realtime": true, + "resource": [], + "token": null, + "type": "display" + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/get-widget-information.api.mdx b/docs/api/get-widget-information.api.mdx index 59e80eda..0401eb10 100644 --- a/docs/api/get-widget-information.api.mdx +++ b/docs/api/get-widget-information.api.mdx @@ -20,51 +20,22 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Retrieve the complete JSON structure of the dashboard widget, including all settings and data/resource instructions used to populate the widget's data. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/import-data-from-a-csv-in-files.ParamsDetails.json b/docs/api/import-data-from-a-csv-in-files.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/import-data-from-a-csv-in-files.ParamsDetails.json +++ b/docs/api/import-data-from-a-csv-in-files.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/import-data-from-a-csv-in-files.RequestSchema.json b/docs/api/import-data-from-a-csv-in-files.RequestSchema.json index 5520ceb6..05a9fe18 100644 --- a/docs/api/import-data-from-a-csv-in-files.RequestSchema.json +++ b/docs/api/import-data-from-a-csv-in-files.RequestSchema.json @@ -1 +1,16 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_address":{"type":"string","example":"/July_data/31072024_data.csv"}}},"examples":{"Import Data from a CSV in Files":{"value":{"file_address":"/July_data/31072024_data.csv"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { "file_address": { "type": "string", "example": "/July_data/31072024_data.csv" } } + }, + "examples": { + "Import Data from a CSV in Files": { "value": { "file_address": "/July_data/31072024_data.csv" } } + } + } + } + } +} diff --git a/docs/api/import-data-from-a-csv-in-files.StatusCodes.json b/docs/api/import-data-from-a-csv-in-files.StatusCodes.json index 0bbd9584..b8e2ee9e 100644 --- a/docs/api/import-data-from-a-csv-in-files.StatusCodes.json +++ b/docs/api/import-data-from-a-csv-in-files.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Importing data from Files","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Data import added to the queue successfully!"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Importing data from Files", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Data import added to the queue successfully!" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/import-data-from-a-csv-in-files.api.mdx b/docs/api/import-data-from-a-csv-in-files.api.mdx index 3111c909..9322731e 100644 --- a/docs/api/import-data-from-a-csv-in-files.api.mdx +++ b/docs/api/import-data-from-a-csv-in-files.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Import Data from a CSV in Files - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-analysis-related-to-dashboard.ParamsDetails.json b/docs/api/list-analysis-related-to-dashboard.ParamsDetails.json index 19e3a3c8..d2d9d0f9 100644 --- a/docs/api/list-analysis-related-to-dashboard.ParamsDetails.json +++ b/docs/api/list-analysis-related-to-dashboard.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"5f3e782ba1d6300027315c0e"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "5f3e782ba1d6300027315c0e" } + } + ] +} diff --git a/docs/api/list-analysis-related-to-dashboard.RequestSchema.json b/docs/api/list-analysis-related-to-dashboard.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-analysis-related-to-dashboard.RequestSchema.json +++ b/docs/api/list-analysis-related-to-dashboard.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-analysis-related-to-dashboard.StatusCodes.json b/docs/api/list-analysis-related-to-dashboard.StatusCodes.json index d864bfb3..5ec26482 100644 --- a/docs/api/list-analysis-related-to-dashboard.StatusCodes.json +++ b/docs/api/list-analysis-related-to-dashboard.StatusCodes.json @@ -1 +1,31 @@ -{"responses":{"200":{"description":"Getting a list of analysis related to the dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"61969a2c87160b00189326e9"},"name":{"type":"string","example":"Analysis 001"}}},"example":[{"id":"61969a2c87160b00189326e9","name":"Analysis 001"},{"id":"61969a2c87160b00189326d2","name":"Analysis 002"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a list of analysis related to the dashboard", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "61969a2c87160b00189326e9" }, + "name": { "type": "string", "example": "Analysis 001" } + } + }, + "example": [ + { "id": "61969a2c87160b00189326e9", "name": "Analysis 001" }, + { "id": "61969a2c87160b00189326d2", "name": "Analysis 002" } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/list-analysis-related-to-dashboard.api.mdx b/docs/api/list-analysis-related-to-dashboard.api.mdx index 795dd066..8afdb96e 100644 --- a/docs/api/list-analysis-related-to-dashboard.api.mdx +++ b/docs/api/list-analysis-related-to-dashboard.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List of analysis related to this dashboard - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-dashboards.ParamsDetails.json b/docs/api/list-dashboards.ParamsDetails.json index b864c23c..68a2ce37 100644 --- a/docs/api/list-dashboards.ParamsDetails.json +++ b/docs/api/list-dashboards.ParamsDetails.json @@ -1 +1,28 @@ -{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number."},{"name":"amount","in":"query","schema":{"type":"string","example":"5"},"description":"Amount of dashboards per page."},{"name":"orderBy","in":"query","schema":{"type":"string","example":"name"},"description":"Order dashboard by name."},{"name":"fields[]","in":"query","description":"Select which properties to include for each dashboard in the response.\nPass the parameter multiple times to include more than one field.\n\nExample: `?fields[]=label&fields[]=id&fields[]=type`\n","schema":{"type":"array","items":{"type":"string","enum":["label","id","type","tags","visible","created_at","last_access"]}},"style":"form","explode":true}]} \ No newline at end of file +{ + "parameters": [ + { "name": "page", "in": "query", "schema": { "type": "string", "example": "1" }, "description": "Page number." }, + { + "name": "amount", + "in": "query", + "schema": { "type": "string", "example": "5" }, + "description": "Amount of dashboards per page." + }, + { + "name": "orderBy", + "in": "query", + "schema": { "type": "string", "example": "name" }, + "description": "Order dashboard by name." + }, + { + "name": "fields[]", + "in": "query", + "description": "Select which properties to include for each dashboard in the response.\nPass the parameter multiple times to include more than one field.\n\nExample: `?fields[]=label&fields[]=id&fields[]=type`\n", + "schema": { + "type": "array", + "items": { "type": "string", "enum": ["label", "id", "type", "tags", "visible", "created_at", "last_access"] } + }, + "style": "form", + "explode": true + } + ] +} diff --git a/docs/api/list-dashboards.RequestSchema.json b/docs/api/list-dashboards.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-dashboards.RequestSchema.json +++ b/docs/api/list-dashboards.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-dashboards.StatusCodes.json b/docs/api/list-dashboards.StatusCodes.json index 7aa158bf..91de4974 100644 --- a/docs/api/list-dashboards.StatusCodes.json +++ b/docs/api/list-dashboards.StatusCodes.json @@ -1 +1,84 @@ -{"responses":{"200":{"description":"Get a list of dashboards","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Dashboard ID","example":"623c74a15a13360011803f3e"},"label":{"type":"string","description":"Dashboard title label","example":"Door Sensor"},"tags":{"type":"array","description":"Dashboard tags","items":{"type":"object","properties":{"key":{"type":"string","example":"vehicle"},"value":{"type":"string","example":"gas"}}},"example":[]},"profile":{"type":"string","description":"Profile ID","example":"612ea05e3cc0780012715111"},"visible":{"type":"boolean","description":"Visibility status","example":true},"group_by":{"type":"array","description":"List of tags to group in the sidebar","items":{"type":"string"},"example":[]},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp","example":"2022-03-24T13:39:45.504Z"},"icon":{"type":"object","description":"Dashboard icon","properties":{"color":{"type":"string","example":"hsl(328, 89%, 47%)"},"url":{"type":"string","example":"https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg"}},"example":{}},"last_access":{"type":"string","format":"date-time","description":"Last access timestamp","example":"2022-06-13T20:53:32.583Z"},"type":{"type":"string","description":"Dashboard type","enum":["dashboard","blueprint"],"example":"dashboard"},"tabs":{"type":"array","description":"Dashboard tabs","items":{"type":"object","properties":{"key":{"type":"string","example":"1648142133869"},"link":{"type":"string","example":""},"value":{"type":"string","example":"tab test"}}},"example":[]}}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Get a list of dashboards", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "description": "Dashboard ID", "example": "623c74a15a13360011803f3e" }, + "label": { "type": "string", "description": "Dashboard title label", "example": "Door Sensor" }, + "tags": { + "type": "array", + "description": "Dashboard tags", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "vehicle" }, + "value": { "type": "string", "example": "gas" } + } + }, + "example": [] + }, + "profile": { "type": "string", "description": "Profile ID", "example": "612ea05e3cc0780012715111" }, + "visible": { "type": "boolean", "description": "Visibility status", "example": true }, + "group_by": { + "type": "array", + "description": "List of tags to group in the sidebar", + "items": { "type": "string" }, + "example": [] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp", + "example": "2022-03-24T13:39:45.504Z" + }, + "icon": { + "type": "object", + "description": "Dashboard icon", + "properties": { + "color": { "type": "string", "example": "hsl(328, 89%, 47%)" }, + "url": { + "type": "string", + "example": "https://svg.internal.tago.io/arrowheads-pointing-to-the-left.svg" + } + }, + "example": {} + }, + "last_access": { + "type": "string", + "format": "date-time", + "description": "Last access timestamp", + "example": "2022-06-13T20:53:32.583Z" + }, + "type": { + "type": "string", + "description": "Dashboard type", + "enum": ["dashboard", "blueprint"], + "example": "dashboard" + }, + "tabs": { + "type": "array", + "description": "Dashboard tabs", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "1648142133869" }, + "link": { "type": "string", "example": "" }, + "value": { "type": "string", "example": "tab test" } + } + }, + "example": [] + } + } + } + } + } + } + } + } +} diff --git a/docs/api/list-dashboards.api.mdx b/docs/api/list-dashboards.api.mdx index e9949612..8d33d9f0 100644 --- a/docs/api/list-dashboards.api.mdx +++ b/docs/api/list-dashboards.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Retrieves a list with all dashboards from the profile - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-device-params.ParamsDetails.json b/docs/api/list-device-params.ParamsDetails.json index a7c298ec..4cc3d8c5 100644 --- a/docs/api/list-device-params.ParamsDetails.json +++ b/docs/api/list-device-params.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"sent_status","in":"query","schema":{"type":"string","example":"false"},"description":"Filter by Boolean."},{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"(Type your device ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "sent_status", + "in": "query", + "schema": { "type": "string", "example": "false" }, + "description": "Filter by Boolean." + }, + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your device ID)" } + } + ] +} diff --git a/docs/api/list-device-params.RequestSchema.json b/docs/api/list-device-params.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-device-params.RequestSchema.json +++ b/docs/api/list-device-params.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-device-params.StatusCodes.json b/docs/api/list-device-params.StatusCodes.json index 28aea9a9..27aff623 100644 --- a/docs/api/list-device-params.StatusCodes.json +++ b/docs/api/list-device-params.StatusCodes.json @@ -1 +1,33 @@ -{"responses":{"200":{"description":"List Device Params","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"62ab8294c1ac39001361e11b"},"key":{"type":"string","example":"param1"},"sent":{"type":"boolean","example":false},"value":{"type":"string","example":"value1"}}},"example":[{"id":"62ab8294c1ac39001361e11b","key":"param1","sent":false,"value":"value1"},{"id":"62ab8294c1ac39001361e11c","key":"param2","sent":false,"value":"value2"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "List Device Params", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "62ab8294c1ac39001361e11b" }, + "key": { "type": "string", "example": "param1" }, + "sent": { "type": "boolean", "example": false }, + "value": { "type": "string", "example": "value1" } + } + }, + "example": [ + { "id": "62ab8294c1ac39001361e11b", "key": "param1", "sent": false, "value": "value1" }, + { "id": "62ab8294c1ac39001361e11c", "key": "param2", "sent": false, "value": "value2" } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/list-device-params.api.mdx b/docs/api/list-device-params.api.mdx index 2efe9d4d..40bb406c 100644 --- a/docs/api/list-device-params.api.mdx +++ b/docs/api/list-device-params.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List params for the device - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-devices-related-to-dashboard.ParamsDetails.json b/docs/api/list-devices-related-to-dashboard.ParamsDetails.json index e93a3002..8a893e27 100644 --- a/docs/api/list-devices-related-to-dashboard.ParamsDetails.json +++ b/docs/api/list-devices-related-to-dashboard.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"dashboardID","in":"path","required":true,"schema":{"type":"string","example":"(Type your dashboard ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dashboardID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your dashboard ID)" } + } + ] +} diff --git a/docs/api/list-devices-related-to-dashboard.RequestSchema.json b/docs/api/list-devices-related-to-dashboard.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-devices-related-to-dashboard.RequestSchema.json +++ b/docs/api/list-devices-related-to-dashboard.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-devices-related-to-dashboard.StatusCodes.json b/docs/api/list-devices-related-to-dashboard.StatusCodes.json index 80ae3b5c..edfa9d84 100644 --- a/docs/api/list-devices-related-to-dashboard.StatusCodes.json +++ b/docs/api/list-devices-related-to-dashboard.StatusCodes.json @@ -1 +1,46 @@ -{"responses":{"200":{"description":"Getting a list of devices related to a dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6238a3a27d792400139e5b47"},"name":{"type":"string","example":"Device 001"}}},"example":[{"id":"6238a3a27d792400139e5b47","name":"Device 001"},{"id":"6238a294ea60bc00120f0371","name":"Device 002"},{"id":"6230e64df5772600124c81df","name":"Device 003"},{"id":"62322173635f730011d1874c","name":"Device 004"}]},"status":{"type":"boolean","example":true}}},"examples":{"Getting a list of devices related to a dashboard":{"value":{"result":[{"id":"6238a3a27d792400139e5b47","name":"Device 001"},{"id":"6238a294ea60bc00120f0371","name":"Device 002"},{"id":"6230e64df5772600124c81df","name":"Device 003"},{"id":"62322173635f730011d1874c","name":"Device 004"}],"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a list of devices related to a dashboard", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "6238a3a27d792400139e5b47" }, + "name": { "type": "string", "example": "Device 001" } + } + }, + "example": [ + { "id": "6238a3a27d792400139e5b47", "name": "Device 001" }, + { "id": "6238a294ea60bc00120f0371", "name": "Device 002" }, + { "id": "6230e64df5772600124c81df", "name": "Device 003" }, + { "id": "62322173635f730011d1874c", "name": "Device 004" } + ] + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Getting a list of devices related to a dashboard": { + "value": { + "result": [ + { "id": "6238a3a27d792400139e5b47", "name": "Device 001" }, + { "id": "6238a294ea60bc00120f0371", "name": "Device 002" }, + { "id": "6230e64df5772600124c81df", "name": "Device 003" }, + { "id": "62322173635f730011d1874c", "name": "Device 004" } + ], + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/list-devices-related-to-dashboard.api.mdx b/docs/api/list-devices-related-to-dashboard.api.mdx index 5dd35566..8aea760d 100644 --- a/docs/api/list-devices-related-to-dashboard.api.mdx +++ b/docs/api/list-devices-related-to-dashboard.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List of devices related to this dashboard - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-entities.ParamsDetails.json b/docs/api/list-entities.ParamsDetails.json index 2fe48dac..9127289b 100644 --- a/docs/api/list-entities.ParamsDetails.json +++ b/docs/api/list-entities.ParamsDetails.json @@ -1 +1,24 @@ -{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"number"},"description":"(default 1)"},{"name":"amount","in":"query","schema":{"type":"string","example":"number"},"description":"(default: 20, max: 100)"},{"name":"filter","in":"query","schema":{"type":"string","example":"[name]"},"description":"string"},{"name":"orderBy","in":"query","schema":{"type":"string","example":"created_at | updated_at"}},{"name":"fields","in":"query","schema":{"type":"string"},"description":"comma-separated list of fields to return"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "page", + "in": "query", + "schema": { "type": "string", "example": "number" }, + "description": "(default 1)" + }, + { + "name": "amount", + "in": "query", + "schema": { "type": "string", "example": "number" }, + "description": "(default: 20, max: 100)" + }, + { "name": "filter", "in": "query", "schema": { "type": "string", "example": "[name]" }, "description": "string" }, + { "name": "orderBy", "in": "query", "schema": { "type": "string", "example": "created_at | updated_at" } }, + { + "name": "fields", + "in": "query", + "schema": { "type": "string" }, + "description": "comma-separated list of fields to return" + } + ] +} diff --git a/docs/api/list-entities.RequestSchema.json b/docs/api/list-entities.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-entities.RequestSchema.json +++ b/docs/api/list-entities.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-entities.StatusCodes.json b/docs/api/list-entities.StatusCodes.json index 4c23a858..dff441d0 100644 --- a/docs/api/list-entities.StatusCodes.json +++ b/docs/api/list-entities.StatusCodes.json @@ -1 +1,59 @@ -{"responses":{"200":{"description":"Listing entity by field / Listing entity by tags","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"created_at":{"type":"string","example":"2024-11-05T18:32:25.522Z"},"id":{"type":"string","example":"672a64b91807cd0008baa4d5"},"name":{"type":"string","example":"Control Entity"},"profile":{"type":"string","example":"63c82c9e6a7fb4000a1f95a0"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"yes"}}},"example":[{"key":"active","value":"yes"}]},"updated_at":{"type":"string","example":"2024-11-05T18:32:25.522Z"}}},"example":[{"created_at":"2024-11-05T18:32:25.522Z","id":"672a64b91807cd0008baa4d5","name":"Control Entity","profile":"63c82c9e6a7fb4000a1f95a0","tags":[{"key":"active","value":"yes"}],"updated_at":"2024-11-05T18:32:25.522Z"},{"created_at":"2024-11-05T18:49:16.438Z","id":"672a68ac640f330009872ca3","name":"Test Entity","profile":"63c82c9e6a7fb4000a1f95a0","tags":[],"updated_at":"2024-11-05T18:49:16.438Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Listing entity by field / Listing entity by tags", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "created_at": { "type": "string", "example": "2024-11-05T18:32:25.522Z" }, + "id": { "type": "string", "example": "672a64b91807cd0008baa4d5" }, + "name": { "type": "string", "example": "Control Entity" }, + "profile": { "type": "string", "example": "63c82c9e6a7fb4000a1f95a0" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "active" }, + "value": { "type": "string", "example": "yes" } + } + }, + "example": [{ "key": "active", "value": "yes" }] + }, + "updated_at": { "type": "string", "example": "2024-11-05T18:32:25.522Z" } + } + }, + "example": [ + { + "created_at": "2024-11-05T18:32:25.522Z", + "id": "672a64b91807cd0008baa4d5", + "name": "Control Entity", + "profile": "63c82c9e6a7fb4000a1f95a0", + "tags": [{ "key": "active", "value": "yes" }], + "updated_at": "2024-11-05T18:32:25.522Z" + }, + { + "created_at": "2024-11-05T18:49:16.438Z", + "id": "672a68ac640f330009872ca3", + "name": "Test Entity", + "profile": "63c82c9e6a7fb4000a1f95a0", + "tags": [], + "updated_at": "2024-11-05T18:49:16.438Z" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/list-entities.api.mdx b/docs/api/list-entities.api.mdx index a4eb00c5..dd3ebe8f 100644 --- a/docs/api/list-entities.api.mdx +++ b/docs/api/list-entities.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List Entities - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-of-chunks.ParamsDetails.json b/docs/api/list-of-chunks.ParamsDetails.json index 8d2ad668..d2f38d96 100644 --- a/docs/api/list-of-chunks.ParamsDetails.json +++ b/docs/api/list-of-chunks.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" } + } + ] +} diff --git a/docs/api/list-of-chunks.RequestSchema.json b/docs/api/list-of-chunks.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-of-chunks.RequestSchema.json +++ b/docs/api/list-of-chunks.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-of-chunks.StatusCodes.json b/docs/api/list-of-chunks.StatusCodes.json index daf10cec..87c5ceb7 100644 --- a/docs/api/list-of-chunks.StatusCodes.json +++ b/docs/api/list-of-chunks.StatusCodes.json @@ -1 +1,61 @@ -{"responses":{"200":{"description":"Getting a list of chunks by device","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","example":1584},"from":{"type":"string","example":"2022-07-18T00:00:00.000+00:00"},"id":{"type":"string","example":"1658102400_1658707199"},"to":{"type":"string","example":"2022-07-24T23:59:59.999+00:00"}}},"example":[{"amount":1584,"from":"2022-07-18T00:00:00.000+00:00","id":"1658102400_1658707199","to":"2022-07-24T23:59:59.999+00:00"},{"amount":13383,"from":"2022-07-11T00:00:00.000+00:00","id":"1657497600_1658102399","to":"2022-07-17T23:59:59.999+00:00"},{"amount":12788,"from":"2022-07-04T00:00:00.000+00:00","id":"1656892800_1657497599","to":"2022-07-10T23:59:59.999+00:00"},{"amount":12784,"from":"2022-06-27T00:00:00.000+00:00","id":"1656288000_1656892799","to":"2022-07-03T23:59:59.999+00:00"},{"amount":4179,"from":"2022-03-07T00:00:00.000+00:00","id":"1646611200_1647215999","to":"2022-03-13T23:59:59.999+00:00"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a list of chunks by device", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "amount": { "type": "number", "example": 1584 }, + "from": { "type": "string", "example": "2022-07-18T00:00:00.000+00:00" }, + "id": { "type": "string", "example": "1658102400_1658707199" }, + "to": { "type": "string", "example": "2022-07-24T23:59:59.999+00:00" } + } + }, + "example": [ + { + "amount": 1584, + "from": "2022-07-18T00:00:00.000+00:00", + "id": "1658102400_1658707199", + "to": "2022-07-24T23:59:59.999+00:00" + }, + { + "amount": 13383, + "from": "2022-07-11T00:00:00.000+00:00", + "id": "1657497600_1658102399", + "to": "2022-07-17T23:59:59.999+00:00" + }, + { + "amount": 12788, + "from": "2022-07-04T00:00:00.000+00:00", + "id": "1656892800_1657497599", + "to": "2022-07-10T23:59:59.999+00:00" + }, + { + "amount": 12784, + "from": "2022-06-27T00:00:00.000+00:00", + "id": "1656288000_1656892799", + "to": "2022-07-03T23:59:59.999+00:00" + }, + { + "amount": 4179, + "from": "2022-03-07T00:00:00.000+00:00", + "id": "1646611200_1647215999", + "to": "2022-03-13T23:59:59.999+00:00" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/list-of-chunks.api.mdx b/docs/api/list-of-chunks.api.mdx index eec70717..0bbb80f3 100644 --- a/docs/api/list-of-chunks.api.mdx +++ b/docs/api/list-of-chunks.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List of chunks - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-of-devices.ParamsDetails.json b/docs/api/list-of-devices.ParamsDetails.json index a2af6db8..05b37965 100644 --- a/docs/api/list-of-devices.ParamsDetails.json +++ b/docs/api/list-of-devices.ParamsDetails.json @@ -1 +1,66 @@ -{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number."},{"name":"amount","in":"query","schema":{"type":"string","example":"10"},"description":"Amount of devices by page."},{"name":"filter[id]","in":"query","schema":{"type":"string","example":""},"description":"Filter the device by ID."},{"name":"filter[name]","in":"query","schema":{"type":"string","example":""},"description":"Filter the device name."},{"name":"filter[visible]","in":"query","schema":{"type":"string","example":"true / false"},"description":"Filter the device visible status."},{"name":"filter[active]","in":"query","schema":{"type":"string","example":"true / false"},"description":"Filter the device active status."},{"name":"filter[connector]","in":"query","schema":{"type":"string","example":""},"description":"Filter the devices by the Connector ID."},{"name":"filter[network]","in":"query","schema":{"type":"string","example":""},"description":"Filter the devices by the Network ID."},{"name":"filter[tags]","in":"query","schema":{"type":"string","example":""},"description":"Filter device by it's tag. Check the example."},{"name":"filter[updated_at]","in":"query","schema":{"type":"string","example":"1 day"},"description":"Filter by time the device was received data. Can be an ISO-8601 or a relative date"},{"name":"filter[created_at]","in":"query","schema":{"type":"string","example":"1 day"},"description":"Filter by time the device was created. Can be an ISO-8601 or a relative date"},{"name":"orderBy","in":"query","schema":{"type":"string","example":"created_at"}}]} \ No newline at end of file +{ + "parameters": [ + { "name": "page", "in": "query", "schema": { "type": "string", "example": "1" }, "description": "Page number." }, + { + "name": "amount", + "in": "query", + "schema": { "type": "string", "example": "10" }, + "description": "Amount of devices by page." + }, + { + "name": "filter[id]", + "in": "query", + "schema": { "type": "string", "example": "" }, + "description": "Filter the device by ID." + }, + { + "name": "filter[name]", + "in": "query", + "schema": { "type": "string", "example": "" }, + "description": "Filter the device name." + }, + { + "name": "filter[visible]", + "in": "query", + "schema": { "type": "string", "example": "true / false" }, + "description": "Filter the device visible status." + }, + { + "name": "filter[active]", + "in": "query", + "schema": { "type": "string", "example": "true / false" }, + "description": "Filter the device active status." + }, + { + "name": "filter[connector]", + "in": "query", + "schema": { "type": "string", "example": "" }, + "description": "Filter the devices by the Connector ID." + }, + { + "name": "filter[network]", + "in": "query", + "schema": { "type": "string", "example": "" }, + "description": "Filter the devices by the Network ID." + }, + { + "name": "filter[tags]", + "in": "query", + "schema": { "type": "string", "example": "" }, + "description": "Filter device by it's tag. Check the example." + }, + { + "name": "filter[updated_at]", + "in": "query", + "schema": { "type": "string", "example": "1 day" }, + "description": "Filter by time the device was received data. Can be an ISO-8601 or a relative date" + }, + { + "name": "filter[created_at]", + "in": "query", + "schema": { "type": "string", "example": "1 day" }, + "description": "Filter by time the device was created. Can be an ISO-8601 or a relative date" + }, + { "name": "orderBy", "in": "query", "schema": { "type": "string", "example": "created_at" } } + ] +} diff --git a/docs/api/list-of-devices.RequestSchema.json b/docs/api/list-of-devices.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-of-devices.RequestSchema.json +++ b/docs/api/list-of-devices.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-of-devices.StatusCodes.json b/docs/api/list-of-devices.StatusCodes.json index 97af6ba5..ce48aa45 100644 --- a/docs/api/list-of-devices.StatusCodes.json +++ b/docs/api/list-of-devices.StatusCodes.json @@ -1 +1,79 @@ -{"responses":{"200":{"description":"List of devices retrieved using query params","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"connector":{"type":"string","example":"5f5a8f3351d4db99c40ded2d"},"id":{"type":"string","example":"5dcad1c216174c001ca23ab9"},"name":{"type":"string","example":"Device #1"},"network":{"type":"string","example":"5bbd120d4051a50034cd1a05"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"type"},"value":{"type":"string","example":"Smoke Detector"}}},"example":[{"key":"type","value":"Smoke Detector"}]}}},"example":[{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad1c216174c001ca23ab9","name":"Device #1","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]},{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad25016174c001ca24a09","name":"Device #2","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]}]},"status":{"type":"boolean","example":true}}},"examples":{"List of devices retrieved using query params":{"value":{"result":[{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad1c216174c001ca23ab9","name":"Device #1","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]},{"connector":"5f5a8f3351d4db99c40ded2d","id":"5dcad25016174c001ca24a09","name":"Device #2","network":"5bbd120d4051a50034cd1a05","tags":[{"key":"type","value":"Smoke Detector"}]}],"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "List of devices retrieved using query params", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "connector": { "type": "string", "example": "5f5a8f3351d4db99c40ded2d" }, + "id": { "type": "string", "example": "5dcad1c216174c001ca23ab9" }, + "name": { "type": "string", "example": "Device #1" }, + "network": { "type": "string", "example": "5bbd120d4051a50034cd1a05" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "type" }, + "value": { "type": "string", "example": "Smoke Detector" } + } + }, + "example": [{ "key": "type", "value": "Smoke Detector" }] + } + } + }, + "example": [ + { + "connector": "5f5a8f3351d4db99c40ded2d", + "id": "5dcad1c216174c001ca23ab9", + "name": "Device #1", + "network": "5bbd120d4051a50034cd1a05", + "tags": [{ "key": "type", "value": "Smoke Detector" }] + }, + { + "connector": "5f5a8f3351d4db99c40ded2d", + "id": "5dcad25016174c001ca24a09", + "name": "Device #2", + "network": "5bbd120d4051a50034cd1a05", + "tags": [{ "key": "type", "value": "Smoke Detector" }] + } + ] + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "List of devices retrieved using query params": { + "value": { + "result": [ + { + "connector": "5f5a8f3351d4db99c40ded2d", + "id": "5dcad1c216174c001ca23ab9", + "name": "Device #1", + "network": "5bbd120d4051a50034cd1a05", + "tags": [{ "key": "type", "value": "Smoke Detector" }] + }, + { + "connector": "5f5a8f3351d4db99c40ded2d", + "id": "5dcad25016174c001ca24a09", + "name": "Device #2", + "network": "5bbd120d4051a50034cd1a05", + "tags": [{ "key": "type", "value": "Smoke Detector" }] + } + ], + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/list-of-devices.api.mdx b/docs/api/list-of-devices.api.mdx index 38959538..b1050df6 100644 --- a/docs/api/list-of-devices.api.mdx +++ b/docs/api/list-of-devices.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Retrieves a list with all devices from the profile - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-of-notifications.ParamsDetails.json b/docs/api/list-of-notifications.ParamsDetails.json index 25da7410..e5a194b8 100644 --- a/docs/api/list-of-notifications.ParamsDetails.json +++ b/docs/api/list-of-notifications.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "userID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a RUN user ID)" } + } + ] +} diff --git a/docs/api/list-of-notifications.RequestSchema.json b/docs/api/list-of-notifications.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-of-notifications.RequestSchema.json +++ b/docs/api/list-of-notifications.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-of-notifications.StatusCodes.json b/docs/api/list-of-notifications.StatusCodes.json index 7d5999a4..4777baaf 100644 --- a/docs/api/list-of-notifications.StatusCodes.json +++ b/docs/api/list-of-notifications.StatusCodes.json @@ -1 +1,55 @@ -{"responses":{"200":{"description":"List of the Run user notifications","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"buttons":{"type":"array","items":{},"example":[]},"buttons_autodisable":{"type":"boolean","example":true},"buttons_enabled":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2022-06-20T17:35:26.753Z"},"id":{"type":"string","example":"62b0afde27ce4d0012c62256"},"message":{"type":"string","example":"Your device has retuned to the regular temperature"},"read":{"type":"boolean","example":false},"title":{"type":"string","example":"Temperature back to normal"}}},"example":[{"buttons":[],"buttons_autodisable":true,"buttons_enabled":true,"created_at":"2022-06-20T17:35:26.753Z","id":"62b0afde27ce4d0012c62256","message":"Your device has retuned to the regular temperature","read":false,"title":"Temperature back to normal"},{"buttons":[],"buttons_autodisable":true,"buttons_enabled":true,"created_at":"2022-05-26T13:12:06.753Z","id":"62b0afde27ce4d0012c62286","message":"The temperature is lower than 18ºC.","read":true,"title":"Low Temperature"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "List of the Run user notifications", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "buttons": { "type": "array", "items": {}, "example": [] }, + "buttons_autodisable": { "type": "boolean", "example": true }, + "buttons_enabled": { "type": "boolean", "example": true }, + "created_at": { "type": "string", "example": "2022-06-20T17:35:26.753Z" }, + "id": { "type": "string", "example": "62b0afde27ce4d0012c62256" }, + "message": { "type": "string", "example": "Your device has retuned to the regular temperature" }, + "read": { "type": "boolean", "example": false }, + "title": { "type": "string", "example": "Temperature back to normal" } + } + }, + "example": [ + { + "buttons": [], + "buttons_autodisable": true, + "buttons_enabled": true, + "created_at": "2022-06-20T17:35:26.753Z", + "id": "62b0afde27ce4d0012c62256", + "message": "Your device has retuned to the regular temperature", + "read": false, + "title": "Temperature back to normal" + }, + { + "buttons": [], + "buttons_autodisable": true, + "buttons_enabled": true, + "created_at": "2022-05-26T13:12:06.753Z", + "id": "62b0afde27ce4d0012c62286", + "message": "The temperature is lower than 18ºC.", + "read": true, + "title": "Low Temperature" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/list-of-notifications.api.mdx b/docs/api/list-of-notifications.api.mdx index b2ecfca1..a51c1006 100644 --- a/docs/api/list-of-notifications.api.mdx +++ b/docs/api/list-of-notifications.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List of notifications for an user - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-of-tokens.ParamsDetails.json b/docs/api/list-of-tokens.ParamsDetails.json index 74a0abb9..fc7cbc7d 100644 --- a/docs/api/list-of-tokens.ParamsDetails.json +++ b/docs/api/list-of-tokens.ParamsDetails.json @@ -1 +1 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string"}}]} \ No newline at end of file +{ "parameters": [{ "name": "deviceID", "in": "path", "required": true, "schema": { "type": "string" } }] } diff --git a/docs/api/list-of-tokens.RequestSchema.json b/docs/api/list-of-tokens.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-of-tokens.RequestSchema.json +++ b/docs/api/list-of-tokens.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-of-tokens.StatusCodes.json b/docs/api/list-of-tokens.StatusCodes.json index b57cc020..d8fc1553 100644 --- a/docs/api/list-of-tokens.StatusCodes.json +++ b/docs/api/list-of-tokens.StatusCodes.json @@ -1 +1 @@ -{"responses":{"200":{"description":""}}} \ No newline at end of file +{ "responses": { "200": { "description": "" } } } diff --git a/docs/api/list-of-tokens.api.mdx b/docs/api/list-of-tokens.api.mdx index bc997422..828f2bc5 100644 --- a/docs/api/list-of-tokens.api.mdx +++ b/docs/api/list-of-tokens.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Retrieves list of all tokens from device - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-profile-backups.ParamsDetails.json b/docs/api/list-profile-backups.ParamsDetails.json index 2e2d1ef8..d1214439 100644 --- a/docs/api/list-profile-backups.ParamsDetails.json +++ b/docs/api/list-profile-backups.ParamsDetails.json @@ -1 +1,32 @@ -{"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number for pagination (default 1)"},{"name":"amount","in":"query","required":false,"schema":{"type":"integer","example":20},"description":"Number of items per page (default 20)"},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string","example":"created_at,desc"},"description":"Sort order (e.g., 'created_at,desc' or 'created_at,asc')"},{"name":"profile_id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "page", + "in": "query", + "required": false, + "schema": { "type": "integer", "example": 1 }, + "description": "Page number for pagination (default 1)" + }, + { + "name": "amount", + "in": "query", + "required": false, + "schema": { "type": "integer", "example": 20 }, + "description": "Number of items per page (default 20)" + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "schema": { "type": "string", "example": "created_at,desc" }, + "description": "Sort order (e.g., 'created_at,desc' or 'created_at,asc')" + }, + { + "name": "profile_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "description": "The ID of the profile" + } + ] +} diff --git a/docs/api/list-profile-backups.RequestSchema.json b/docs/api/list-profile-backups.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-profile-backups.RequestSchema.json +++ b/docs/api/list-profile-backups.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-profile-backups.StatusCodes.json b/docs/api/list-profile-backups.StatusCodes.json index cd07dc70..edaf1733 100644 --- a/docs/api/list-profile-backups.StatusCodes.json +++ b/docs/api/list-profile-backups.StatusCodes.json @@ -1 +1,61 @@ -{"responses":{"200":{"description":"List of backups retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":true},"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"678abc123def456789012345"},"profile":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"file_path":{"type":"string","example":"profile/61fac4d9a5c9f40012a5ff92/versioning/backup/backup-61fac4d9a5c9f40012a5ff92.zip"},"version_id":{"type":"string","example":"abc123def456"},"file_size":{"type":"number","example":15728640,"description":"File size in bytes"},"status":{"type":"string","enum":["queued","processing","completed","failed"],"example":"completed"},"error_message":{"type":"string","example":null,"description":"Error message if status is 'failed'"},"created_at":{"type":"string","example":"2025-01-07T14:30:00.000Z"}}}}}}}}},"403":{"description":"Forbidden - Free plan users cannot access backup features","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Backup feature is not available on the free plan. Please upgrade your plan to access backup functionality."}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "List of backups retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": true }, + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "678abc123def456789012345" }, + "profile": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "file_path": { + "type": "string", + "example": "profile/61fac4d9a5c9f40012a5ff92/versioning/backup/backup-61fac4d9a5c9f40012a5ff92.zip" + }, + "version_id": { "type": "string", "example": "abc123def456" }, + "file_size": { "type": "number", "example": 15728640, "description": "File size in bytes" }, + "status": { + "type": "string", + "enum": ["queued", "processing", "completed", "failed"], + "example": "completed" + }, + "error_message": { + "type": "string", + "example": null, + "description": "Error message if status is 'failed'" + }, + "created_at": { "type": "string", "example": "2025-01-07T14:30:00.000Z" } + } + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden - Free plan users cannot access backup features", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { + "type": "string", + "example": "Backup feature is not available on the free plan. Please upgrade your plan to access backup functionality." + } + } + } + } + } + } + } +} diff --git a/docs/api/list-profile-backups.api.mdx b/docs/api/list-profile-backups.api.mdx index eff0bfca..2ce866ab 100644 --- a/docs/api/list-profile-backups.api.mdx +++ b/docs/api/list-profile-backups.api.mdx @@ -20,57 +20,25 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Retrieves a paginated list of all backups for the specified profile. Use this endpoint to check backup status and find backup IDs for download or deletion. **Backup statuses:** + - `queued` - Backup request received, waiting for processing - `processing` - Backup generation in progress - `completed` - Backup ready for download - `failed` - Backup generation failed (check error_message) - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/list-users.ParamsDetails.json b/docs/api/list-users.ParamsDetails.json index 9cc6aad1..bb655dfc 100644 --- a/docs/api/list-users.ParamsDetails.json +++ b/docs/api/list-users.ParamsDetails.json @@ -1 +1,83 @@ -{"parameters":[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number."},{"name":"name","in":"query","schema":{"type":"string","example":"John Doe"},"description":"Filter by the RUN user's name."},{"name":"email","in":"query","schema":{"type":"string","example":"runuser@email.com"},"description":"Filter by the RUN user's email."},{"name":"timezone","in":"query","schema":{"type":"string","example":"America/New_York"},"description":"Filter by the RUN user's timezone."},{"name":"company","in":"query","schema":{"type":"string","example":"Companyname"},"description":"Filter by the RUN user's company."},{"name":"phone","in":"query","schema":{"type":"string","example":"+010001010011"},"description":"Filter by the RUN user's phone number."},{"name":"language","in":"query","schema":{"type":"string","example":"En"},"description":"Filter by the RUN user's language."},{"name":"tags","in":"query","schema":{"type":"string","example":"[{\"key\":\"tag_key\",\"value\":\"tag value\"}]"},"description":"Filter by the RUN user's tags and keys."},{"name":"active","in":"query","schema":{"type":"string","example":"true"},"description":"Filter by the RUN user's activation status."},{"name":"id","in":"query","schema":{"type":"string","example":"614889df6a302639012a7caef"},"description":"Filter by the RUN user's id."},{"name":"last_login","in":"query","schema":{"type":"string","example":"2021-04-15T15:52:01.102Z"},"description":"Filter by the RUN user's last login."},{"name":"created_at","in":"query","schema":{"type":"string","example":"2021-07-26T13:10:39.314Z"},"description":"Filter by the RUN user's creation timestamp."},{"name":"amount","in":"query","schema":{"type":"string","example":"5"},"description":"Amount of RUN users by page."},{"name":"orderBy","in":"query","schema":{"type":"string","example":"name,asc"},"description":"Order by the RUN users name/ascending/descending."}]} \ No newline at end of file +{ + "parameters": [ + { "name": "page", "in": "query", "schema": { "type": "string", "example": "1" }, "description": "Page number." }, + { + "name": "name", + "in": "query", + "schema": { "type": "string", "example": "John Doe" }, + "description": "Filter by the RUN user's name." + }, + { + "name": "email", + "in": "query", + "schema": { "type": "string", "example": "runuser@email.com" }, + "description": "Filter by the RUN user's email." + }, + { + "name": "timezone", + "in": "query", + "schema": { "type": "string", "example": "America/New_York" }, + "description": "Filter by the RUN user's timezone." + }, + { + "name": "company", + "in": "query", + "schema": { "type": "string", "example": "Companyname" }, + "description": "Filter by the RUN user's company." + }, + { + "name": "phone", + "in": "query", + "schema": { "type": "string", "example": "+010001010011" }, + "description": "Filter by the RUN user's phone number." + }, + { + "name": "language", + "in": "query", + "schema": { "type": "string", "example": "En" }, + "description": "Filter by the RUN user's language." + }, + { + "name": "tags", + "in": "query", + "schema": { "type": "string", "example": "[{\"key\":\"tag_key\",\"value\":\"tag value\"}]" }, + "description": "Filter by the RUN user's tags and keys." + }, + { + "name": "active", + "in": "query", + "schema": { "type": "string", "example": "true" }, + "description": "Filter by the RUN user's activation status." + }, + { + "name": "id", + "in": "query", + "schema": { "type": "string", "example": "614889df6a302639012a7caef" }, + "description": "Filter by the RUN user's id." + }, + { + "name": "last_login", + "in": "query", + "schema": { "type": "string", "example": "2021-04-15T15:52:01.102Z" }, + "description": "Filter by the RUN user's last login." + }, + { + "name": "created_at", + "in": "query", + "schema": { "type": "string", "example": "2021-07-26T13:10:39.314Z" }, + "description": "Filter by the RUN user's creation timestamp." + }, + { + "name": "amount", + "in": "query", + "schema": { "type": "string", "example": "5" }, + "description": "Amount of RUN users by page." + }, + { + "name": "orderBy", + "in": "query", + "schema": { "type": "string", "example": "name,asc" }, + "description": "Order by the RUN users name/ascending/descending." + } + ] +} diff --git a/docs/api/list-users.RequestSchema.json b/docs/api/list-users.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/list-users.RequestSchema.json +++ b/docs/api/list-users.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/list-users.StatusCodes.json b/docs/api/list-users.StatusCodes.json index 1035ccd7..ff362af9 100644 --- a/docs/api/list-users.StatusCodes.json +++ b/docs/api/list-users.StatusCodes.json @@ -1 +1,83 @@ -{"responses":{"200":{"description":"Getting a list of RUN users","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"company":{"type":"string","example":"Companyname"},"created_at":{"type":"string","example":"2022-01-21T21:29:08.957Z"},"email":{"type":"string","example":"runuser@email"},"id":{"type":"string","example":"614889df6a302639012a7caef"},"language":{"type":"string","example":"en"},"last_login":{"type":"string","example":"2022-06-10T17:59:26.879Z"},"name":{"type":"string","example":"runusername"},"newsletter":{"example":null},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"MM/DD/YYYY"},"time_format":{"type":"string","example":"12"}}},"otp":{"type":"object","properties":{}},"phone":{"type":"string","example":"+010001010011"},"profile":{"type":"string","example":"612ea05e3cc07803480127151133"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"user_type"},"value":{"type":"string","example":"enduser"}}},"example":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}]},"timezone":{"type":"string","example":"America/New_York"},"updated_at":{"type":"string","example":"2022-06-14T14:16:52.377Z"}}},"example":[{"active":true,"company":"Companyname","created_at":"2022-01-21T21:29:08.957Z","email":"runuser@email","id":"614889df6a302639012a7caef","language":"en","last_login":"2022-06-10T17:59:26.879Z","name":"runusername","newsletter":null,"options":{"date_format":"MM/DD/YYYY","time_format":"12"},"otp":{},"phone":"+010001010011","profile":"612ea05e3cc07803480127151133","tags":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}],"timezone":"America/New_York","updated_at":"2022-06-14T14:16:52.377Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting a list of RUN users", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "company": { "type": "string", "example": "Companyname" }, + "created_at": { "type": "string", "example": "2022-01-21T21:29:08.957Z" }, + "email": { "type": "string", "example": "runuser@email" }, + "id": { "type": "string", "example": "614889df6a302639012a7caef" }, + "language": { "type": "string", "example": "en" }, + "last_login": { "type": "string", "example": "2022-06-10T17:59:26.879Z" }, + "name": { "type": "string", "example": "runusername" }, + "newsletter": { "example": null }, + "options": { + "type": "object", + "properties": { + "date_format": { "type": "string", "example": "MM/DD/YYYY" }, + "time_format": { "type": "string", "example": "12" } + } + }, + "otp": { "type": "object", "properties": {} }, + "phone": { "type": "string", "example": "+010001010011" }, + "profile": { "type": "string", "example": "612ea05e3cc07803480127151133" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "user_type" }, + "value": { "type": "string", "example": "enduser" } + } + }, + "example": [ + { "key": "user_type", "value": "enduser" }, + { "key": "limit_login", "value": "10" } + ] + }, + "timezone": { "type": "string", "example": "America/New_York" }, + "updated_at": { "type": "string", "example": "2022-06-14T14:16:52.377Z" } + } + }, + "example": [ + { + "active": true, + "company": "Companyname", + "created_at": "2022-01-21T21:29:08.957Z", + "email": "runuser@email", + "id": "614889df6a302639012a7caef", + "language": "en", + "last_login": "2022-06-10T17:59:26.879Z", + "name": "runusername", + "newsletter": null, + "options": { "date_format": "MM/DD/YYYY", "time_format": "12" }, + "otp": {}, + "phone": "+010001010011", + "profile": "612ea05e3cc07803480127151133", + "tags": [ + { "key": "user_type", "value": "enduser" }, + { "key": "limit_login", "value": "10" } + ], + "timezone": "America/New_York", + "updated_at": "2022-06-14T14:16:52.377Z" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/list-users.api.mdx b/docs/api/list-users.api.mdx index 342bb6de..02c89e05 100644 --- a/docs/api/list-users.api.mdx +++ b/docs/api/list-users.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + List users from Run - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/login-as-user.ParamsDetails.json b/docs/api/login-as-user.ParamsDetails.json index aa959f8b..4f7df0b0 100644 --- a/docs/api/login-as-user.ParamsDetails.json +++ b/docs/api/login-as-user.ParamsDetails.json @@ -1 +1,16 @@ -{"parameters":[{"name":"expire_time","in":"query","schema":{"type":"string","example":"3 months"},"description":"hours,days,months."},{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "expire_time", + "in": "query", + "schema": { "type": "string", "example": "3 months" }, + "description": "hours,days,months." + }, + { + "name": "userID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a RUN user ID)" } + } + ] +} diff --git a/docs/api/login-as-user.RequestSchema.json b/docs/api/login-as-user.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/login-as-user.RequestSchema.json +++ b/docs/api/login-as-user.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/login-as-user.StatusCodes.json b/docs/api/login-as-user.StatusCodes.json index b9af8a7b..78c47d1c 100644 --- a/docs/api/login-as-user.StatusCodes.json +++ b/docs/api/login-as-user.StatusCodes.json @@ -1 +1,26 @@ -{"responses":{"200":{"description":"Login as a RUN User","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"expire_time":{"type":"string","example":"2022-06-21T03:01:10.908Z"},"name":{"type":"string","example":"Login by Run Administrator(runadmin@mail.com)"},"run_user":{"type":"string","example":"61eb25a4d6a4a20011d4cd3c"},"token":{"type":"string","example":"fe82f846-d19c-42b3-863a-7e7dgcd519e6"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Login as a RUN User", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "expire_time": { "type": "string", "example": "2022-06-21T03:01:10.908Z" }, + "name": { "type": "string", "example": "Login by Run Administrator(runadmin@mail.com)" }, + "run_user": { "type": "string", "example": "61eb25a4d6a4a20011d4cd3c" }, + "token": { "type": "string", "example": "fe82f846-d19c-42b3-863a-7e7dgcd519e6" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/login-as-user.api.mdx b/docs/api/login-as-user.api.mdx index b0fdb22f..ea342f6c 100644 --- a/docs/api/login-as-user.api.mdx +++ b/docs/api/login-as-user.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get TagoRUN User Token and allow to perform request to TagoRUN specific endpoints (not available). - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/login-to-account.RequestSchema.json b/docs/api/login-to-account.RequestSchema.json index 397ce25a..bbdf8ef9 100644 --- a/docs/api/login-to-account.RequestSchema.json +++ b/docs/api/login-to-account.RequestSchema.json @@ -1 +1,18 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","example":"example@mail.com"},"password":{"type":"string","example":"yourpassword"}}},"examples":{"Login to Account":{"value":{"email":"example@mail.com","password":"yourpassword"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["email", "password"], + "properties": { + "email": { "type": "string", "example": "example@mail.com" }, + "password": { "type": "string", "example": "yourpassword" } + } + }, + "examples": { "Login to Account": { "value": { "email": "example@mail.com", "password": "yourpassword" } } } + } + } + } +} diff --git a/docs/api/login-to-account.StatusCodes.json b/docs/api/login-to-account.StatusCodes.json index da353084..e6f99813 100644 --- a/docs/api/login-to-account.StatusCodes.json +++ b/docs/api/login-to-account.StatusCodes.json @@ -1 +1,48 @@ -{"responses":{"200":{"description":"Login","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"company":{"type":"string","example":"companyname"},"email":{"type":"string","example":"example@mail.com"},"id":{"type":"string","example":"612ea05e3cc078001371895110"},"name":{"type":"string","example":"Your Name"},"phone":{"type":"string","example":"+9396363457126"},"profiles":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","example":"612ea05e3cc078001371895110"},"id":{"type":"string","example":"612ea05e3cc078001371895111"},"logo_url":{"example":null},"name":{"type":"string","example":"profilename"}}},"example":[{"account":"612ea05e3cc078001371895110","id":"612ea05e3cc078001371895111","logo_url":null,"name":"profilename"}]},"type":{"type":"string","example":"user"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Login", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "company": { "type": "string", "example": "companyname" }, + "email": { "type": "string", "example": "example@mail.com" }, + "id": { "type": "string", "example": "612ea05e3cc078001371895110" }, + "name": { "type": "string", "example": "Your Name" }, + "phone": { "type": "string", "example": "+9396363457126" }, + "profiles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "account": { "type": "string", "example": "612ea05e3cc078001371895110" }, + "id": { "type": "string", "example": "612ea05e3cc078001371895111" }, + "logo_url": { "example": null }, + "name": { "type": "string", "example": "profilename" } + } + }, + "example": [ + { + "account": "612ea05e3cc078001371895110", + "id": "612ea05e3cc078001371895111", + "logo_url": null, + "name": "profilename" + } + ] + }, + "type": { "type": "string", "example": "user" } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/login-to-account.api.mdx b/docs/api/login-to-account.api.mdx index 2eb46f68..0ea246a9 100644 --- a/docs/api/login-to-account.api.mdx +++ b/docs/api/login-to-account.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Login to account using email and password - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json b/docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json index 0b3235fb..97f96172 100644 --- a/docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json +++ b/docs/api/mark-a-configuration-parameter-as-read.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"paramID","in":"path","required":true,"schema":{"type":"string","example":"(Type your param ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "paramID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type your param ID)" } + } + ] +} diff --git a/docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json b/docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json +++ b/docs/api/mark-a-configuration-parameter-as-read.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json b/docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json index 7cb37046..7d51b4c4 100644 --- a/docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json +++ b/docs/api/mark-a-configuration-parameter-as-read.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Success Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Params Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Success Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Params Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/mark-a-configuration-parameter-as-read.api.mdx b/docs/api/mark-a-configuration-parameter-as-read.api.mdx index 958abbb3..3ef7600c 100644 --- a/docs/api/mark-a-configuration-parameter-as-read.api.mdx +++ b/docs/api/mark-a-configuration-parameter-as-read.api.mdx @@ -20,53 +20,20 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + -Marks a configuration parameter as read on the current device. +Marks a configuration parameter as read on the current device. This is useful when collecting settings from Configuration Parameters and you need to track whether you have already processed the current value. Use this endpoint to set the `sent` field to `true`. - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/send-data-to-device.ParamsDetails.json b/docs/api/send-data-to-device.ParamsDetails.json index 4af8f8f6..c5d99580 100644 --- a/docs/api/send-data-to-device.ParamsDetails.json +++ b/docs/api/send-data-to-device.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"deviceID","in":"path","required":true,"schema":{"type":"string","example":"67aa1f9135b1a7000a9db33c"},"description":"Device ID"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "deviceID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "67aa1f9135b1a7000a9db33c" }, + "description": "Device ID" + } + ] +} diff --git a/docs/api/send-data-to-device.RequestSchema.json b/docs/api/send-data-to-device.RequestSchema.json index ce0cebaa..b33a0b14 100644 --- a/docs/api/send-data-to-device.RequestSchema.json +++ b/docs/api/send-data-to-device.RequestSchema.json @@ -1 +1,127 @@ -{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Accepts a single item or an array of items when sent as application/json.\nFor text/plain content, use the [Payload Parser](/docs/tagoio/devices/payload-parser/) to normalize the data into TagoIO JSON format.\n","oneOf":[{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},{"type":"array","items":{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},"description":"Accepts a single item or an array of items.","title":"DeviceDataArray"}],"title":"DeviceData"},"examples":{"Send data (object)":{"value":{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}}},"Send data (array)":{"value":[{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}},{"variable":"location","value":"New York Office","location":{"lat":40.712776,"lng":-74.005974}}]}}},"text/plain":{"schema":{"type":"string","description":"Raw text data that will be processed by the device's Payload Parser to normalize into TagoIO JSON format."},"examples":{"Raw sensor data":{"value":"temperature:23.5,humidity:45.2,battery:87"},"HEX payload":{"value":"41BC7E1F2A"},"Custom format":{"value":"sensor_id=123&temp=25.6&status=ok"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": true, + "content": { + "application/json": { + "schema": { + "description": "Accepts a single item or an array of items when sent as application/json.\nFor text/plain content, use the [Payload Parser](/docs/tagoio/devices/payload-parser/) to normalize the data into TagoIO JSON format.\n", + "oneOf": [ + { + "type": "object", + "required": ["variable"], + "properties": { + "variable": { "type": "string", "example": "location" }, + "location": { + "type": "object", + "properties": { + "lat": { "type": "number", "example": 35.770723 }, + "lng": { "type": "number", "example": -78.677328 } + } + }, + "value": { "type": "string", "example": "TagoIO Headquarters" }, + "time": { + "type": "string", + "description": "ISO 8601 string or Unix timestamp", + "example": "2023-12-01T12:34:56.000Z" + }, + "group": { + "type": "string", + "description": "Unique grouping ID for your data. Widgets often group by this." + }, + "unit": { + "type": "string", + "example": "%", + "description": "Provide a unit of measurement to the data. Most widgets will display the unit." + }, + "metadata": { + "type": "object", + "description": "Can be attached to the data to influence widget behavior and store additional information.", + "additionalProperties": true, + "example": { "color": "red", "icon": "car" } + } + }, + "title": "DeviceDataItem" + }, + { + "type": "array", + "items": { + "type": "object", + "required": ["variable"], + "properties": { + "variable": { "type": "string", "example": "location" }, + "location": { + "type": "object", + "properties": { + "lat": { "type": "number", "example": 35.770723 }, + "lng": { "type": "number", "example": -78.677328 } + } + }, + "value": { "type": "string", "example": "TagoIO Headquarters" }, + "time": { + "type": "string", + "description": "ISO 8601 string or Unix timestamp", + "example": "2023-12-01T12:34:56.000Z" + }, + "group": { + "type": "string", + "description": "Unique grouping ID for your data. Widgets often group by this." + }, + "unit": { + "type": "string", + "example": "%", + "description": "Provide a unit of measurement to the data. Most widgets will display the unit." + }, + "metadata": { + "type": "object", + "description": "Can be attached to the data to influence widget behavior and store additional information.", + "additionalProperties": true, + "example": { "color": "red", "icon": "car" } + } + }, + "title": "DeviceDataItem" + }, + "description": "Accepts a single item or an array of items.", + "title": "DeviceDataArray" + } + ], + "title": "DeviceData" + }, + "examples": { + "Send data (object)": { + "value": { + "variable": "location", + "value": "TagoIO Headquarters", + "location": { "lat": 35.770723, "lng": -78.677328 } + } + }, + "Send data (array)": { + "value": [ + { + "variable": "location", + "value": "TagoIO Headquarters", + "location": { "lat": 35.770723, "lng": -78.677328 } + }, + { + "variable": "location", + "value": "New York Office", + "location": { "lat": 40.712776, "lng": -74.005974 } + } + ] + } + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Raw text data that will be processed by the device's Payload Parser to normalize into TagoIO JSON format." + }, + "examples": { + "Raw sensor data": { "value": "temperature:23.5,humidity:45.2,battery:87" }, + "HEX payload": { "value": "41BC7E1F2A" }, + "Custom format": { "value": "sensor_id=123&temp=25.6&status=ok" } + } + } + } + } +} diff --git a/docs/api/send-data-to-device.StatusCodes.json b/docs/api/send-data-to-device.StatusCodes.json index 5e4bbb85..ee9dd680 100644 --- a/docs/api/send-data-to-device.StatusCodes.json +++ b/docs/api/send-data-to-device.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Sending data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"2 Data Added"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Sending data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "2 Data Added" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/send-data-to-device.api.mdx b/docs/api/send-data-to-device.api.mdx index afa0f2a1..e8e3f60a 100644 --- a/docs/api/send-data-to-device.api.mdx +++ b/docs/api/send-data-to-device.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Send data to a specific Device within your profile - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/send-data-using-network.ParamsDetails.json b/docs/api/send-data-using-network.ParamsDetails.json index f601ed53..09b0639c 100644 --- a/docs/api/send-data-using-network.ParamsDetails.json +++ b/docs/api/send-data-using-network.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"authorization_token","in":"query","required":true,"description":"Authorization_Token\n","schema":{"type":"string","example":"at72fb69a8dc714059b6cebee41693eb0"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "authorization_token", + "in": "query", + "required": true, + "description": "Authorization_Token\n", + "schema": { "type": "string", "example": "at72fb69a8dc714059b6cebee41693eb0" } + } + ] +} diff --git a/docs/api/send-data-using-network.RequestSchema.json b/docs/api/send-data-using-network.RequestSchema.json index 7e9fd429..e192815c 100644 --- a/docs/api/send-data-using-network.RequestSchema.json +++ b/docs/api/send-data-using-network.RequestSchema.json @@ -1 +1,38 @@ -{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"payload"},"value":{"type":"string","description":"Hexadecimal string payload","example":"41BC7E1F2A"},"metadata":{"type":"object","properties":{"serial":{"type":"string","description":"Device serial number","example":"SN123456789"}},"additionalProperties":false}},"description":"Network device data format with payload and serial metadata.","title":"NetworkDeviceData"}},"text/plain":{"schema":{"type":"string","description":"Arbitrary payload. Your [Network Payload Parser](/docs/tagoio/devices/payload-parser/) must normalize this text to the TagoIO array format accepted by application/json.\n"},"examples":{"Send Data using Network":{"value":"Any format data that your Payload Parser can normalize to TagoIO format.\n"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["variable"], + "properties": { + "variable": { "type": "string", "example": "payload" }, + "value": { "type": "string", "description": "Hexadecimal string payload", "example": "41BC7E1F2A" }, + "metadata": { + "type": "object", + "properties": { + "serial": { "type": "string", "description": "Device serial number", "example": "SN123456789" } + }, + "additionalProperties": false + } + }, + "description": "Network device data format with payload and serial metadata.", + "title": "NetworkDeviceData" + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Arbitrary payload. Your [Network Payload Parser](/docs/tagoio/devices/payload-parser/) must normalize this text to the TagoIO array format accepted by application/json.\n" + }, + "examples": { + "Send Data using Network": { + "value": "Any format data that your Payload Parser can normalize to TagoIO format.\n" + } + } + } + } + } +} diff --git a/docs/api/send-data-using-network.StatusCodes.json b/docs/api/send-data-using-network.StatusCodes.json index ef288aae..32c729c2 100644 --- a/docs/api/send-data-using-network.StatusCodes.json +++ b/docs/api/send-data-using-network.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Send Data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"1 Data Added"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Send Data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "1 Data Added" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/send-data-using-network.api.mdx b/docs/api/send-data-using-network.api.mdx index b6dedf2b..f3c52fd8 100644 --- a/docs/api/send-data-using-network.api.mdx +++ b/docs/api/send-data-using-network.api.mdx @@ -20,22 +20,9 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Send data to TagoIO using the Network instead. @@ -43,39 +30,19 @@ This endpoint allows the [Network Payload Parser](/docs/tagoio/devices/payload-p The Network's Payload Parser is required to set the serial within the network parser. For example: -``` javascript - if (Array.isArray(payload)) { - const payload_received = payload.find(x => x.variable === "payload"); - serial = payload_received?.metadata?.serial; - } +```javascript +if (Array.isArray(payload)) { + const payload_received = payload.find((x) => x.variable === "payload"); + serial = payload_received?.metadata?.serial; +} +``` - ``` - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/send-data.RequestSchema.json b/docs/api/send-data.RequestSchema.json index ce0cebaa..b33a0b14 100644 --- a/docs/api/send-data.RequestSchema.json +++ b/docs/api/send-data.RequestSchema.json @@ -1 +1,127 @@ -{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Accepts a single item or an array of items when sent as application/json.\nFor text/plain content, use the [Payload Parser](/docs/tagoio/devices/payload-parser/) to normalize the data into TagoIO JSON format.\n","oneOf":[{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},{"type":"array","items":{"type":"object","required":["variable"],"properties":{"variable":{"type":"string","example":"location"},"location":{"type":"object","properties":{"lat":{"type":"number","example":35.770723},"lng":{"type":"number","example":-78.677328}}},"value":{"type":"string","example":"TagoIO Headquarters"},"time":{"type":"string","description":"ISO 8601 string or Unix timestamp","example":"2023-12-01T12:34:56.000Z"},"group":{"type":"string","description":"Unique grouping ID for your data. Widgets often group by this."},"unit":{"type":"string","example":"%","description":"Provide a unit of measurement to the data. Most widgets will display the unit."},"metadata":{"type":"object","description":"Can be attached to the data to influence widget behavior and store additional information.","additionalProperties":true,"example":{"color":"red","icon":"car"}}},"title":"DeviceDataItem"},"description":"Accepts a single item or an array of items.","title":"DeviceDataArray"}],"title":"DeviceData"},"examples":{"Send data (object)":{"value":{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}}},"Send data (array)":{"value":[{"variable":"location","value":"TagoIO Headquarters","location":{"lat":35.770723,"lng":-78.677328}},{"variable":"location","value":"New York Office","location":{"lat":40.712776,"lng":-74.005974}}]}}},"text/plain":{"schema":{"type":"string","description":"Raw text data that will be processed by the device's Payload Parser to normalize into TagoIO JSON format."},"examples":{"Raw sensor data":{"value":"temperature:23.5,humidity:45.2,battery:87"},"HEX payload":{"value":"41BC7E1F2A"},"Custom format":{"value":"sensor_id=123&temp=25.6&status=ok"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": true, + "content": { + "application/json": { + "schema": { + "description": "Accepts a single item or an array of items when sent as application/json.\nFor text/plain content, use the [Payload Parser](/docs/tagoio/devices/payload-parser/) to normalize the data into TagoIO JSON format.\n", + "oneOf": [ + { + "type": "object", + "required": ["variable"], + "properties": { + "variable": { "type": "string", "example": "location" }, + "location": { + "type": "object", + "properties": { + "lat": { "type": "number", "example": 35.770723 }, + "lng": { "type": "number", "example": -78.677328 } + } + }, + "value": { "type": "string", "example": "TagoIO Headquarters" }, + "time": { + "type": "string", + "description": "ISO 8601 string or Unix timestamp", + "example": "2023-12-01T12:34:56.000Z" + }, + "group": { + "type": "string", + "description": "Unique grouping ID for your data. Widgets often group by this." + }, + "unit": { + "type": "string", + "example": "%", + "description": "Provide a unit of measurement to the data. Most widgets will display the unit." + }, + "metadata": { + "type": "object", + "description": "Can be attached to the data to influence widget behavior and store additional information.", + "additionalProperties": true, + "example": { "color": "red", "icon": "car" } + } + }, + "title": "DeviceDataItem" + }, + { + "type": "array", + "items": { + "type": "object", + "required": ["variable"], + "properties": { + "variable": { "type": "string", "example": "location" }, + "location": { + "type": "object", + "properties": { + "lat": { "type": "number", "example": 35.770723 }, + "lng": { "type": "number", "example": -78.677328 } + } + }, + "value": { "type": "string", "example": "TagoIO Headquarters" }, + "time": { + "type": "string", + "description": "ISO 8601 string or Unix timestamp", + "example": "2023-12-01T12:34:56.000Z" + }, + "group": { + "type": "string", + "description": "Unique grouping ID for your data. Widgets often group by this." + }, + "unit": { + "type": "string", + "example": "%", + "description": "Provide a unit of measurement to the data. Most widgets will display the unit." + }, + "metadata": { + "type": "object", + "description": "Can be attached to the data to influence widget behavior and store additional information.", + "additionalProperties": true, + "example": { "color": "red", "icon": "car" } + } + }, + "title": "DeviceDataItem" + }, + "description": "Accepts a single item or an array of items.", + "title": "DeviceDataArray" + } + ], + "title": "DeviceData" + }, + "examples": { + "Send data (object)": { + "value": { + "variable": "location", + "value": "TagoIO Headquarters", + "location": { "lat": 35.770723, "lng": -78.677328 } + } + }, + "Send data (array)": { + "value": [ + { + "variable": "location", + "value": "TagoIO Headquarters", + "location": { "lat": 35.770723, "lng": -78.677328 } + }, + { + "variable": "location", + "value": "New York Office", + "location": { "lat": 40.712776, "lng": -74.005974 } + } + ] + } + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Raw text data that will be processed by the device's Payload Parser to normalize into TagoIO JSON format." + }, + "examples": { + "Raw sensor data": { "value": "temperature:23.5,humidity:45.2,battery:87" }, + "HEX payload": { "value": "41BC7E1F2A" }, + "Custom format": { "value": "sensor_id=123&temp=25.6&status=ok" } + } + } + } + } +} diff --git a/docs/api/send-data.StatusCodes.json b/docs/api/send-data.StatusCodes.json index 5e4bbb85..ee9dd680 100644 --- a/docs/api/send-data.StatusCodes.json +++ b/docs/api/send-data.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Sending data","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"2 Data Added"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Sending data", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "2 Data Added" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/send-data.api.mdx b/docs/api/send-data.api.mdx index 75ccbaa6..d17fce9f 100644 --- a/docs/api/send-data.api.mdx +++ b/docs/api/send-data.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Send Device Data - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/tagoio-api.info.mdx b/docs/api/tagoio-api.info.mdx index 5c51df09..010c44b5 100644 --- a/docs/api/tagoio-api.info.mdx +++ b/docs/api/tagoio-api.info.mdx @@ -14,42 +14,32 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export"; - - - - - - + + #### **How to use this documentation** + The documentation is split by which token you're required to use in the request. TagoIO provides 4 different tokens: + - **Device-Token**: The token from your device, which you can get from the device's page. - - **Profile-Token**: Also know as Account-Token. You get from your profile settings page. - - **Network-Token**: Is the token from your Network. Only available if you're owner of the network in your integrations page. - - **Analysis-Token:** The token from your analysis, available in the analysis page. + --- + #### Setting the API Endpoint Region + When making a request to the TagoIO API, you must also specify the appropriate regional endpoint. Choose one of the following endpoints based on your geographical region: - **United States East 1:** - Use this endpoint when your application is based in the eastern United States. - **URL:** `https://api.us-e1.tago.io/` - + Use this endpoint when your application is based in the eastern United States. + **URL:** `https://api.us-e1.tago.io/` - **Europe West 1:** - Use this endpoint when your application is based in Western Europe. - **URL:** `https://api.eu-w1.tago.io/` + Use this endpoint when your application is based in Western Europe. + **URL:** `https://api.eu-w1.tago.io/` - **Tago Deploy:** You should use your own API URL that is available in your Domains section of the TagoDeploy. @@ -150,4 +140,3 @@ When making a request to the TagoIO API, you must also specify the appropriate r - \ No newline at end of file diff --git a/docs/api/test-profile-service.ParamsDetails.json b/docs/api/test-profile-service.ParamsDetails.json index 12ad4f3a..8ce7d143 100644 --- a/docs/api/test-profile-service.ParamsDetails.json +++ b/docs/api/test-profile-service.ParamsDetails.json @@ -1 +1,18 @@ -{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"61fac4d9a5c9f40012a5ff92"},"description":"The ID of the profile"},{"name":"service_type","in":"path","required":true,"schema":{"type":"string","enum":["sms","email"],"example":"sms"},"description":"The type of service to test (sms or email)"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "61fac4d9a5c9f40012a5ff92" }, + "description": "The ID of the profile" + }, + { + "name": "service_type", + "in": "path", + "required": true, + "schema": { "type": "string", "enum": ["sms", "email"], "example": "sms" }, + "description": "The type of service to test (sms or email)" + } + ] +} diff --git a/docs/api/test-profile-service.RequestSchema.json b/docs/api/test-profile-service.RequestSchema.json index c9846e48..08fa9d0d 100644 --- a/docs/api/test-profile-service.RequestSchema.json +++ b/docs/api/test-profile-service.RequestSchema.json @@ -1 +1,41 @@ -{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to"],"properties":{"to":{"type":"string","description":"The recipient address for the test message.\n- For SMS: Phone number in E.164 format (e.g., +15551234567)\n- For Email: Email address (e.g., user@example.com)\n","example":"+15559876543"},"message":{"type":"string","description":"Custom test message content (optional). If not provided, a default test message will be sent.","example":"This is a test message from TagoIO"},"subject":{"type":"string","description":"Email subject line (only for email service type, optional)","example":"Test Email from TagoIO"}}},"examples":{"Test SMS":{"value":{"to":"+15559876543","message":"This is a test SMS from TagoIO"}},"Test Email":{"value":{"to":"user@example.com","subject":"Test Email from TagoIO","message":"This is a test email from TagoIO to verify your email service configuration."}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["to"], + "properties": { + "to": { + "type": "string", + "description": "The recipient address for the test message.\n- For SMS: Phone number in E.164 format (e.g., +15551234567)\n- For Email: Email address (e.g., user@example.com)\n", + "example": "+15559876543" + }, + "message": { + "type": "string", + "description": "Custom test message content (optional). If not provided, a default test message will be sent.", + "example": "This is a test message from TagoIO" + }, + "subject": { + "type": "string", + "description": "Email subject line (only for email service type, optional)", + "example": "Test Email from TagoIO" + } + } + }, + "examples": { + "Test SMS": { "value": { "to": "+15559876543", "message": "This is a test SMS from TagoIO" } }, + "Test Email": { + "value": { + "to": "user@example.com", + "subject": "Test Email from TagoIO", + "message": "This is a test email from TagoIO to verify your email service configuration." + } + } + } + } + } + } +} diff --git a/docs/api/test-profile-service.StatusCodes.json b/docs/api/test-profile-service.StatusCodes.json index 7c60abac..c2fc0a99 100644 --- a/docs/api/test-profile-service.StatusCodes.json +++ b/docs/api/test-profile-service.StatusCodes.json @@ -1 +1,76 @@ -{"responses":{"200":{"description":"Test message sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"message":{"type":"string","example":"Test message sent successfully"},"message_id":{"type":"string","description":"Provider's message ID for tracking (if available)","example":"SM1234567890abcdef1234567890abcdef"}}},"status":{"type":"boolean","example":true}}}}}},"400":{"description":"Bad request - Invalid recipient or message format","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid phone number format. Use E.164 format (e.g., +15551234567)"}}}}}},"404":{"description":"Service provider not configured","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"No service provider configured for the specified service type"}}}}}},"500":{"description":"Provider error - Failed to send test message","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false},"message":{"type":"string","example":"Failed to send test message: Invalid credentials"}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Test message sent successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { + "message": { "type": "string", "example": "Test message sent successfully" }, + "message_id": { + "type": "string", + "description": "Provider's message ID for tracking (if available)", + "example": "SM1234567890abcdef1234567890abcdef" + } + } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + }, + "400": { + "description": "Bad request - Invalid recipient or message format", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { + "type": "string", + "example": "Invalid phone number format. Use E.164 format (e.g., +15551234567)" + } + } + } + } + } + }, + "404": { + "description": "Service provider not configured", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { + "type": "string", + "example": "No service provider configured for the specified service type" + } + } + } + } + } + }, + "500": { + "description": "Provider error - Failed to send test message", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { "type": "boolean", "example": false }, + "message": { "type": "string", "example": "Failed to send test message: Invalid credentials" } + } + } + } + } + } + } +} diff --git a/docs/api/test-profile-service.api.mdx b/docs/api/test-profile-service.api.mdx index a27760c0..e166023e 100644 --- a/docs/api/test-profile-service.api.mdx +++ b/docs/api/test-profile-service.api.mdx @@ -20,60 +20,33 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - + - - - - +> Test a configured service provider by sending a test message. This helps verify that your service provider configuration is working correctly before using it in production. **Supported service types:** + - `sms` - Sends a test SMS message to the specified phone number - `email` - Sends a test email to the specified email address **Important notes:** + - A service provider must be configured before testing - Test messages will consume your provider's quota/credits - For SMS, ensure the recipient number is in E.164 format (e.g., +15551234567) - - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/update-dictionary-language.ParamsDetails.json b/docs/api/update-dictionary-language.ParamsDetails.json index 89bc5982..41dc68cc 100644 --- a/docs/api/update-dictionary-language.ParamsDetails.json +++ b/docs/api/update-dictionary-language.ParamsDetails.json @@ -1 +1,18 @@ -{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"},{"name":"language","in":"path","required":true,"schema":{"type":"string","example":"Language Code"},"description":"Language that will be updated"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dictionary_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type Dictionary ID)" }, + "description": "Can be obtained in the GET Dictionary response" + }, + { + "name": "language", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "Language Code" }, + "description": "Language that will be updated" + } + ] +} diff --git a/docs/api/update-dictionary-language.RequestSchema.json b/docs/api/update-dictionary-language.RequestSchema.json index 7abe2136..188b3cd1 100644 --- a/docs/api/update-dictionary-language.RequestSchema.json +++ b/docs/api/update-dictionary-language.RequestSchema.json @@ -1 +1,16 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"dictionary":{"type":"object","properties":{"test":{"type":"string","example":"teste"}}}}},"examples":{"Update Dictionary Language":{"value":{"dictionary":{"test":"teste"}}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dictionary": { "type": "object", "properties": { "test": { "type": "string", "example": "teste" } } } + } + }, + "examples": { "Update Dictionary Language": { "value": { "dictionary": { "test": "teste" } } } } + } + } + } +} diff --git a/docs/api/update-dictionary-language.StatusCodes.json b/docs/api/update-dictionary-language.StatusCodes.json index 79d34ee7..a271d2e7 100644 --- a/docs/api/update-dictionary-language.StatusCodes.json +++ b/docs/api/update-dictionary-language.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Put Dictionary Language","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Dictionary language Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Put Dictionary Language", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Dictionary language Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/update-dictionary-language.api.mdx b/docs/api/update-dictionary-language.api.mdx index cc3d150c..598471f4 100644 --- a/docs/api/update-dictionary-language.api.mdx +++ b/docs/api/update-dictionary-language.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Update Dictionary Language - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/update-dictionary.ParamsDetails.json b/docs/api/update-dictionary.ParamsDetails.json index b8515d71..46c1fc08 100644 --- a/docs/api/update-dictionary.ParamsDetails.json +++ b/docs/api/update-dictionary.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"dictionary_id","in":"path","required":true,"schema":{"type":"string","example":"(Type Dictionary ID)"},"description":"Can be obtained in the GET Dictionary response"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "dictionary_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type Dictionary ID)" }, + "description": "Can be obtained in the GET Dictionary response" + } + ] +} diff --git a/docs/api/update-dictionary.RequestSchema.json b/docs/api/update-dictionary.RequestSchema.json index 9ee6e420..7f4766dc 100644 --- a/docs/api/update-dictionary.RequestSchema.json +++ b/docs/api/update-dictionary.RequestSchema.json @@ -1 +1,44 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"fallback":{"type":"string","example":"fr-FR"},"languages":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"code":{"type":"string","example":"fr-FR"}}},"example":[{"active":true,"code":"fr-FR"},{"active":true,"code":"pt-BR"}]},"name":{"type":"string","example":"updated.test"},"slug":{"type":"string","example":"TEEEE"}}},"examples":{"Update Dictionary":{"value":{"fallback":"fr-FR","languages":[{"active":true,"code":"fr-FR"},{"active":true,"code":"pt-BR"}],"name":"updated.test","slug":"TEEEE"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fallback": { "type": "string", "example": "fr-FR" }, + "languages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "code": { "type": "string", "example": "fr-FR" } + } + }, + "example": [ + { "active": true, "code": "fr-FR" }, + { "active": true, "code": "pt-BR" } + ] + }, + "name": { "type": "string", "example": "updated.test" }, + "slug": { "type": "string", "example": "TEEEE" } + } + }, + "examples": { + "Update Dictionary": { + "value": { + "fallback": "fr-FR", + "languages": [ + { "active": true, "code": "fr-FR" }, + { "active": true, "code": "pt-BR" } + ], + "name": "updated.test", + "slug": "TEEEE" + } + } + } + } + } + } +} diff --git a/docs/api/update-dictionary.StatusCodes.json b/docs/api/update-dictionary.StatusCodes.json index 6df93b92..89c3a901 100644 --- a/docs/api/update-dictionary.StatusCodes.json +++ b/docs/api/update-dictionary.StatusCodes.json @@ -1 +1,18 @@ -{"responses":{"200":{"description":"Updating a Dictionary name","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Successfully Updated"},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Updating a Dictionary name", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/update-dictionary.api.mdx b/docs/api/update-dictionary.api.mdx index 47e9c6bf..aece41e7 100644 --- a/docs/api/update-dictionary.api.mdx +++ b/docs/api/update-dictionary.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Update Dictionary - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/update-entity-schema.ParamsDetails.json b/docs/api/update-entity-schema.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/update-entity-schema.ParamsDetails.json +++ b/docs/api/update-entity-schema.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/update-entity-schema.RequestSchema.json b/docs/api/update-entity-schema.RequestSchema.json index b1271f55..6eff543f 100644 --- a/docs/api/update-entity-schema.RequestSchema.json +++ b/docs/api/update-entity-schema.RequestSchema.json @@ -1 +1,24 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"object","properties":{"update_new_date":{"type":"object","properties":{"action":{"type":"string","example":"delete"}}}}}}},"examples":{"Update Entity Schema":{"value":{"schema":{"update_new_date":{"action":"delete"}}}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schema": { + "type": "object", + "properties": { + "update_new_date": { + "type": "object", + "properties": { "action": { "type": "string", "example": "delete" } } + } + } + } + } + }, + "examples": { "Update Entity Schema": { "value": { "schema": { "update_new_date": { "action": "delete" } } } } } + } + } + } +} diff --git a/docs/api/update-entity-schema.StatusCodes.json b/docs/api/update-entity-schema.StatusCodes.json index 8aca82d2..f6bec285 100644 --- a/docs/api/update-entity-schema.StatusCodes.json +++ b/docs/api/update-entity-schema.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Updating any entity field","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"message":{"type":"string","example":"Entity Successfully Updated"}}},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Updating any entity field", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "message": { "type": "string", "example": "Entity Successfully Updated" } } + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/update-entity-schema.api.mdx b/docs/api/update-entity-schema.api.mdx index fec3bee3..6ff2aa6f 100644 --- a/docs/api/update-entity-schema.api.mdx +++ b/docs/api/update-entity-schema.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Update Entity Schema - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/update-entity.ParamsDetails.json b/docs/api/update-entity.ParamsDetails.json index 3eba60a2..575f5319 100644 --- a/docs/api/update-entity.ParamsDetails.json +++ b/docs/api/update-entity.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"(Type an entity ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "entity_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type an entity ID)" } + } + ] +} diff --git a/docs/api/update-entity.RequestSchema.json b/docs/api/update-entity.RequestSchema.json index 57267399..acd0270e 100644 --- a/docs/api/update-entity.RequestSchema.json +++ b/docs/api/update-entity.RequestSchema.json @@ -1 +1,29 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Updated Entity"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"active"},"value":{"type":"string","example":"no"}}},"example":[{"key":"active","value":"no"}]}}},"examples":{"Update Entity":{"value":{"name":"Updated Entity","tags":[{"key":"active","value":"no"}]}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { "type": "string", "example": "Updated Entity" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "active" }, + "value": { "type": "string", "example": "no" } + } + }, + "example": [{ "key": "active", "value": "no" }] + } + } + }, + "examples": { + "Update Entity": { "value": { "name": "Updated Entity", "tags": [{ "key": "active", "value": "no" }] } } + } + } + } + } +} diff --git a/docs/api/update-entity.StatusCodes.json b/docs/api/update-entity.StatusCodes.json index ac533ea9..41448145 100644 --- a/docs/api/update-entity.StatusCodes.json +++ b/docs/api/update-entity.StatusCodes.json @@ -1 +1,26 @@ -{"responses":{"200":{"description":"Updating entity name and tag","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"message":{"type":"string","example":"Entity Successfully Updated"}}},"status":{"type":"boolean","example":true}}},"examples":{"Updating entity name and tag":{"value":{"result":{"message":"Entity Successfully Updated"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Updating entity name and tag", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "object", + "properties": { "message": { "type": "string", "example": "Entity Successfully Updated" } } + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Updating entity name and tag": { + "value": { "result": { "message": "Entity Successfully Updated" }, "status": true } + } + } + } + } + } + } +} diff --git a/docs/api/update-entity.api.mdx b/docs/api/update-entity.api.mdx index ee670aa8..24e2f419 100644 --- a/docs/api/update-entity.api.mdx +++ b/docs/api/update-entity.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Update Entity - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/update-policy.ParamsDetails.json b/docs/api/update-policy.ParamsDetails.json index 751f58ce..0a09dc5b 100644 --- a/docs/api/update-policy.ParamsDetails.json +++ b/docs/api/update-policy.ParamsDetails.json @@ -1 +1,11 @@ -{"parameters":[{"name":"am_id","in":"path","required":true,"schema":{"type":"string","example":"(Type a Access Management/Policy ID)"},"description":"Can be obtained in the GET Policy response"}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "am_id", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a Access Management/Policy ID)" }, + "description": "Can be obtained in the GET Policy response" + } + ] +} diff --git a/docs/api/update-policy.RequestSchema.json b/docs/api/update-policy.RequestSchema.json index dbc9893f..1be5e9d3 100644 --- a/docs/api/update-policy.RequestSchema.json +++ b/docs/api/update-policy.RequestSchema.json @@ -1 +1,74 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","example":true},"name":{"type":"string","example":"Updated policy name"},"permissions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"array","items":{"type":"string","example":"access"},"example":["access"]},"effect":{"type":"string","example":"denied"},"resource":{"type":"array","items":{"type":"string","example":"device"},"example":["device"]}}},"example":[{"action":["access"],"effect":"denied","resource":["device"]}]},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"access"},"value":{"type":"string","example":"blocked"}}},"example":[{"key":"access","value":"blocked"}]},"targets":{"type":"array","items":{"type":"array","items":{"type":"string","example":"run_user"},"example":["run_user"]},"example":[["run_user"]]}}},"examples":{"Update policy":{"value":{"active":true,"name":"Updated policy name","permissions":[{"action":["access"],"effect":"denied","resource":["device"]}],"tags":[{"key":"access","value":"blocked"}],"targets":[["run_user"]]}}}},"text/plain":{"examples":{"Update policy":{"value":"{\n \"name\": \"Updated Policy Name\", //edit the policy name\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\n \"access\"\n ],\n \"resource\": [\n \"device\"\n ] //updating resouces, they can be \"device\", \"dashboard\" and \"run_user\" types\n }\n ],\n \"targets\": [\n [\n \"run_user\"\n ] // update the target, possible \"run_user\" and \"analysis\" types\n ],\n \"tags\": [\n {\n \"key\": \"access\",\n \"value\": \"admin\"\n }\n ], //able to update tags \n \"active\": true //able to active and deactive policy (true or false)\n}"}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "name": { "type": "string", "example": "Updated policy name" }, + "permissions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "type": "array", + "items": { "type": "string", "example": "access" }, + "example": ["access"] + }, + "effect": { "type": "string", "example": "denied" }, + "resource": { + "type": "array", + "items": { "type": "string", "example": "device" }, + "example": ["device"] + } + } + }, + "example": [{ "action": ["access"], "effect": "denied", "resource": ["device"] }] + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "access" }, + "value": { "type": "string", "example": "blocked" } + } + }, + "example": [{ "key": "access", "value": "blocked" }] + }, + "targets": { + "type": "array", + "items": { + "type": "array", + "items": { "type": "string", "example": "run_user" }, + "example": ["run_user"] + }, + "example": [["run_user"]] + } + } + }, + "examples": { + "Update policy": { + "value": { + "active": true, + "name": "Updated policy name", + "permissions": [{ "action": ["access"], "effect": "denied", "resource": ["device"] }], + "tags": [{ "key": "access", "value": "blocked" }], + "targets": [["run_user"]] + } + } + } + }, + "text/plain": { + "examples": { + "Update policy": { + "value": "{\n \"name\": \"Updated Policy Name\", //edit the policy name\n \"permissions\": [\n {\n \"effect\": \"allow\",\n \"action\": [\n \"access\"\n ],\n \"resource\": [\n \"device\"\n ] //updating resouces, they can be \"device\", \"dashboard\" and \"run_user\" types\n }\n ],\n \"targets\": [\n [\n \"run_user\"\n ] // update the target, possible \"run_user\" and \"analysis\" types\n ],\n \"tags\": [\n {\n \"key\": \"access\",\n \"value\": \"admin\"\n }\n ], //able to update tags \n \"active\": true //able to active and deactive policy (true or false)\n}" + } + } + } + } + } +} diff --git a/docs/api/update-policy.StatusCodes.json b/docs/api/update-policy.StatusCodes.json index 7563952b..f3589cc5 100644 --- a/docs/api/update-policy.StatusCodes.json +++ b/docs/api/update-policy.StatusCodes.json @@ -1 +1,21 @@ -{"responses":{"200":{"description":"Updating a policy","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Access Management Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Updating a policy":{"value":{"result":"Access Management Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Updating a policy", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Access Management Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Updating a policy": { "value": { "result": "Access Management Successfully Updated", "status": true } } + } + } + } + } + } +} diff --git a/docs/api/update-policy.api.mdx b/docs/api/update-policy.api.mdx index 8ab4450b..4b0a0b8c 100644 --- a/docs/api/update-policy.api.mdx +++ b/docs/api/update-policy.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Update policy - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/update-the-account-resources-allocation.RequestSchema.json b/docs/api/update-the-account-resources-allocation.RequestSchema.json index d81f5c78..a0251f39 100644 --- a/docs/api/update-the-account-resources-allocation.RequestSchema.json +++ b/docs/api/update-the-account-resources-allocation.RequestSchema.json @@ -1 +1,108 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["profile"],"properties":{"profile":{"type":"string","example":"62cdb70512b7320012dc0880"},"analysis":{"type":"number","example":200},"data_records":{"type":"number","example":6667},"email":{"type":"number","example":17},"file_storage":{"type":"number","example":80},"input":{"type":"number","example":33334},"output":{"type":"number","example":100000},"push_notification":{"type":"number","example":4},"run_users":{"type":"number","example":0},"sms":{"type":"number","example":5}}},"example":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc0880","push_notification":4,"run_users":0,"sms":5},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc07800127u5111","push_notification":83,"run_users":8,"sms":0},{"analysis":1100,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5wf93","push_notification":13,"run_users":2,"sms":5}]},"examples":{"Update the account resources allocation":{"value":[{"analysis":200,"data_records":6667,"email":17,"file_storage":80,"input":33334,"output":100000,"profile":"62cdb70512b7320012dc0880","push_notification":4,"run_users":0,"sms":5},{"analysis":1600,"data_records":633333,"email":43,"file_storage":100,"input":433333,"output":1800000,"profile":"612ea05e3cc07800127u5111","push_notification":83,"run_users":8,"sms":0},{"analysis":1100,"data_records":160000,"email":40,"file_storage":20,"input":533333,"output":1100000,"profile":"61fab4d9a5c9f40012a5wf93","push_notification":13,"run_users":2,"sms":5}]}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "required": ["profile"], + "properties": { + "profile": { "type": "string", "example": "62cdb70512b7320012dc0880" }, + "analysis": { "type": "number", "example": 200 }, + "data_records": { "type": "number", "example": 6667 }, + "email": { "type": "number", "example": 17 }, + "file_storage": { "type": "number", "example": 80 }, + "input": { "type": "number", "example": 33334 }, + "output": { "type": "number", "example": 100000 }, + "push_notification": { "type": "number", "example": 4 }, + "run_users": { "type": "number", "example": 0 }, + "sms": { "type": "number", "example": 5 } + } + }, + "example": [ + { + "analysis": 200, + "data_records": 6667, + "email": 17, + "file_storage": 80, + "input": 33334, + "output": 100000, + "profile": "62cdb70512b7320012dc0880", + "push_notification": 4, + "run_users": 0, + "sms": 5 + }, + { + "analysis": 1600, + "data_records": 633333, + "email": 43, + "file_storage": 100, + "input": 433333, + "output": 1800000, + "profile": "612ea05e3cc07800127u5111", + "push_notification": 83, + "run_users": 8, + "sms": 0 + }, + { + "analysis": 1100, + "data_records": 160000, + "email": 40, + "file_storage": 20, + "input": 533333, + "output": 1100000, + "profile": "61fab4d9a5c9f40012a5wf93", + "push_notification": 13, + "run_users": 2, + "sms": 5 + } + ] + }, + "examples": { + "Update the account resources allocation": { + "value": [ + { + "analysis": 200, + "data_records": 6667, + "email": 17, + "file_storage": 80, + "input": 33334, + "output": 100000, + "profile": "62cdb70512b7320012dc0880", + "push_notification": 4, + "run_users": 0, + "sms": 5 + }, + { + "analysis": 1600, + "data_records": 633333, + "email": 43, + "file_storage": 100, + "input": 433333, + "output": 1800000, + "profile": "612ea05e3cc07800127u5111", + "push_notification": 83, + "run_users": 8, + "sms": 0 + }, + { + "analysis": 1100, + "data_records": 160000, + "email": 40, + "file_storage": 20, + "input": 533333, + "output": 1100000, + "profile": "61fab4d9a5c9f40012a5wf93", + "push_notification": 13, + "run_users": 2, + "sms": 5 + } + ] + } + } + } + } + } +} diff --git a/docs/api/update-the-account-resources-allocation.StatusCodes.json b/docs/api/update-the-account-resources-allocation.StatusCodes.json index 09b84085..a0afa8a1 100644 --- a/docs/api/update-the-account-resources-allocation.StatusCodes.json +++ b/docs/api/update-the-account-resources-allocation.StatusCodes.json @@ -1 +1,23 @@ -{"responses":{"200":{"description":"Update the account's allocation","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"Profile resource allocation Successfully Updated"},"status":{"type":"boolean","example":true}}},"examples":{"Update the account's allocation":{"value":{"result":"Profile resource allocation Successfully Updated","status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Update the account's allocation", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { "type": "string", "example": "Profile resource allocation Successfully Updated" }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Update the account's allocation": { + "value": { "result": "Profile resource allocation Successfully Updated", "status": true } + } + } + } + } + } + } +} diff --git a/docs/api/update-the-account-resources-allocation.api.mdx b/docs/api/update-the-account-resources-allocation.api.mdx index 35e7b4b3..f0eaa6f6 100644 --- a/docs/api/update-the-account-resources-allocation.api.mdx +++ b/docs/api/update-the-account-resources-allocation.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Update the account resources allocation - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/upload-file-part.RequestSchema.json b/docs/api/upload-file-part.RequestSchema.json index 78360f66..56fa05a0 100644 --- a/docs/api/upload-file-part.RequestSchema.json +++ b/docs/api/upload-file-part.RequestSchema.json @@ -1 +1,58 @@ -{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","example":"/Screenshot 2023-11-03 at 16.35.29.png"},"multipart_action":{"type":"string","example":"end"},"parts":{"type":"array","items":{"type":"object","properties":{"ETag":{"type":"string","example":"\"0f75e3da7675ca382dac146ed1247162\""},"PartNumber":{"type":"number","example":1}}},"example":[{"ETag":"\"0f75e3da7675ca382dac146ed1247162\"","PartNumber":1}]},"upload_id":{"type":"string","example":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"}}},"examples":{"Upload file part 1":{"value":{"contentType":"image/png","filename":"/Screenshot 2023-11-03 at 16.35.29.png","multipart_action":"start","public":true}},"Upload file part 2":{"value":{"file":"(binary)","filename":"/Screenshot 2023-11-03 at 16.35.29.png","multipart_action":"upload","part":1,"upload_id":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW. k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"}},"Upload file part 3":{"value":{"filename":"/Screenshot 2023-11-03 at 16.35.29.png","multipart_action":"end","parts":[{"ETag":"\"0f75e3da7675ca382dac146ed1247162\"","PartNumber":1}],"upload_id":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"}}}}}}} \ No newline at end of file +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filename": { "type": "string", "example": "/Screenshot 2023-11-03 at 16.35.29.png" }, + "multipart_action": { "type": "string", "example": "end" }, + "parts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ETag": { "type": "string", "example": "\"0f75e3da7675ca382dac146ed1247162\"" }, + "PartNumber": { "type": "number", "example": 1 } + } + }, + "example": [{ "ETag": "\"0f75e3da7675ca382dac146ed1247162\"", "PartNumber": 1 }] + }, + "upload_id": { + "type": "string", + "example": "TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-" + } + } + }, + "examples": { + "Upload file part 1": { + "value": { + "contentType": "image/png", + "filename": "/Screenshot 2023-11-03 at 16.35.29.png", + "multipart_action": "start", + "public": true + } + }, + "Upload file part 2": { + "value": { + "file": "(binary)", + "filename": "/Screenshot 2023-11-03 at 16.35.29.png", + "multipart_action": "upload", + "part": 1, + "upload_id": "TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW. k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-" + } + }, + "Upload file part 3": { + "value": { + "filename": "/Screenshot 2023-11-03 at 16.35.29.png", + "multipart_action": "end", + "parts": [{ "ETag": "\"0f75e3da7675ca382dac146ed1247162\"", "PartNumber": 1 }], + "upload_id": "TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-" + } + } + } + } + } + } +} diff --git a/docs/api/upload-file-part.StatusCodes.json b/docs/api/upload-file-part.StatusCodes.json index eb76f313..a12e6a6a 100644 --- a/docs/api/upload-file-part.StatusCodes.json +++ b/docs/api/upload-file-part.StatusCodes.json @@ -1 +1,88 @@ -{"responses":{"200":{"description":"Upload file part 1 / Upload file part 2 / Upload file part 3","headers":{"Etag":{"schema":{"type":"string","example":"W/\"12e-fdk/2Vt3///sBaogLtoHsVN43c0\""}}},"content":{"application/json":{"schema":{"type":"object","properties":{"result":{"example":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-","anyOf":[{"type":"string","example":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-"},{"type":"object","properties":{"$metadata":{"type":"object","properties":{"attempts":{"type":"number","example":1},"extendedRequestId":{"type":"string","example":"etfQlHP3vxwKW5DnCMCxnNvqHxmq8YxostIXn3qP0GwM34BtB11KAKuU7it4+REbO7iJKMobqZI="},"httpStatusCode":{"type":"number","example":200},"requestId":{"type":"string","example":"7V63NVZWY2EZFVQJ"},"totalRetryDelay":{"type":"number","example":0}}},"ETag":{"type":"string","example":"\"0f75e3da7675ca382dac146ed1247162\""},"ServerSideEncryption":{"type":"string","example":"AES256"}}},{"type":"object","properties":{"file":{"type":"string","example":"https://api.tago.io/file/61fab40aa5c9f40012a5ff93/Screenshot%202023-11-03%20at%2016.35.29.png"}}}]},"status":{"type":"boolean","example":true}}},"examples":{"Upload file part 1":{"value":{"result":"TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-","status":true}},"Upload file part 2":{"value":{"result":{"$metadata":{"attempts":1,"extendedRequestId":"etfQlHP3vxwKW5DnCMCxnNvqHxmq8YxostIXn3qP0GwM34BtB11KAKuU7it4+REbO7iJKMobqZI=","httpStatusCode":200,"requestId":"7V63NVZWY2EZFVQJ","totalRetryDelay":0},"ETag":"\"0f75e3da7675ca382dac146ed1247162\"","ServerSideEncryption":"AES256"},"status":true}},"Upload file part 3":{"value":{"result":{"file":"https://api.tago.io/file/61fab40aa5c9f40012a5ff93/Screenshot%202023-11-03%20at%2016.35.29.png"},"status":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Upload file part 1 / Upload file part 2 / Upload file part 3", + "headers": { "Etag": { "schema": { "type": "string", "example": "W/\"12e-fdk/2Vt3///sBaogLtoHsVN43c0\"" } } }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "example": "TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-", + "anyOf": [ + { + "type": "string", + "example": "TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-" + }, + { + "type": "object", + "properties": { + "$metadata": { + "type": "object", + "properties": { + "attempts": { "type": "number", "example": 1 }, + "extendedRequestId": { + "type": "string", + "example": "etfQlHP3vxwKW5DnCMCxnNvqHxmq8YxostIXn3qP0GwM34BtB11KAKuU7it4+REbO7iJKMobqZI=" + }, + "httpStatusCode": { "type": "number", "example": 200 }, + "requestId": { "type": "string", "example": "7V63NVZWY2EZFVQJ" }, + "totalRetryDelay": { "type": "number", "example": 0 } + } + }, + "ETag": { "type": "string", "example": "\"0f75e3da7675ca382dac146ed1247162\"" }, + "ServerSideEncryption": { "type": "string", "example": "AES256" } + } + }, + { + "type": "object", + "properties": { + "file": { + "type": "string", + "example": "https://api.tago.io/file/61fab40aa5c9f40012a5ff93/Screenshot%202023-11-03%20at%2016.35.29.png" + } + } + } + ] + }, + "status": { "type": "boolean", "example": true } + } + }, + "examples": { + "Upload file part 1": { + "value": { + "result": "TJdGVdXNEdTQq9yIdclq8z3wPZ9dSA8NiLkDAhPb54H2FxW.k2jpsr1nmh7UeaWIYi7DdNllhDAv0JTvLWwEggYkWXhW8W7foUdlemg0aeQcj95D0yJJN65hdv9_RXYvzg7g4SiJ9YIj.y1R5LN.wvwznXnrzbOQ5hLjQ2eOqMI-", + "status": true + } + }, + "Upload file part 2": { + "value": { + "result": { + "$metadata": { + "attempts": 1, + "extendedRequestId": "etfQlHP3vxwKW5DnCMCxnNvqHxmq8YxostIXn3qP0GwM34BtB11KAKuU7it4+REbO7iJKMobqZI=", + "httpStatusCode": 200, + "requestId": "7V63NVZWY2EZFVQJ", + "totalRetryDelay": 0 + }, + "ETag": "\"0f75e3da7675ca382dac146ed1247162\"", + "ServerSideEncryption": "AES256" + }, + "status": true + } + }, + "Upload file part 3": { + "value": { + "result": { + "file": "https://api.tago.io/file/61fab40aa5c9f40012a5ff93/Screenshot%202023-11-03%20at%2016.35.29.png" + }, + "status": true + } + } + } + } + } + } + } +} diff --git a/docs/api/upload-file-part.api.mdx b/docs/api/upload-file-part.api.mdx index 0bfc8b5b..79fe1f8a 100644 --- a/docs/api/upload-file-part.api.mdx +++ b/docs/api/upload-file-part.api.mdx @@ -20,50 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Upload file - + Request - - - - - - - - - - - + + - \ No newline at end of file + diff --git a/docs/api/user-information.ParamsDetails.json b/docs/api/user-information.ParamsDetails.json index 25da7410..e5a194b8 100644 --- a/docs/api/user-information.ParamsDetails.json +++ b/docs/api/user-information.ParamsDetails.json @@ -1 +1,10 @@ -{"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","example":"(Type a RUN user ID)"}}]} \ No newline at end of file +{ + "parameters": [ + { + "name": "userID", + "in": "path", + "required": true, + "schema": { "type": "string", "example": "(Type a RUN user ID)" } + } + ] +} diff --git a/docs/api/user-information.RequestSchema.json b/docs/api/user-information.RequestSchema.json index c96bcede..e9fcb6db 100644 --- a/docs/api/user-information.RequestSchema.json +++ b/docs/api/user-information.RequestSchema.json @@ -1 +1 @@ -{"title":"Body"} \ No newline at end of file +{ "title": "Body" } diff --git a/docs/api/user-information.StatusCodes.json b/docs/api/user-information.StatusCodes.json index 2d524280..db2a41cf 100644 --- a/docs/api/user-information.StatusCodes.json +++ b/docs/api/user-information.StatusCodes.json @@ -1 +1,83 @@ -{"responses":{"200":{"description":"Getting RUN user information by ID","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","example":true},"company":{"type":"string","example":"Companyname"},"created_at":{"type":"string","example":"2022-01-21T21:29:08.957Z"},"email":{"type":"string","example":"runuser@email"},"id":{"type":"string","example":"614889df6a302639012a7caef"},"language":{"type":"string","example":"en"},"last_login":{"type":"string","example":"2022-06-10T17:59:26.879Z"},"name":{"type":"string","example":"runusername"},"newsletter":{"example":null},"options":{"type":"object","properties":{"date_format":{"type":"string","example":"MM/DD/YYYY"},"time_format":{"type":"string","example":"12"}}},"otp":{"type":"object","properties":{}},"phone":{"type":"string","example":"+010001010011"},"profile":{"type":"string","example":"612ea05e3cc07803480127151133"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"user_type"},"value":{"type":"string","example":"enduser"}}},"example":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}]},"timezone":{"type":"string","example":"America/New_York"},"updated_at":{"type":"string","example":"2022-06-14T14:16:52.377Z"}}},"example":[{"active":true,"company":"Companyname","created_at":"2022-01-21T21:29:08.957Z","email":"runuser@email","id":"614889df6a302639012a7caef","language":"en","last_login":"2022-06-10T17:59:26.879Z","name":"runusername","newsletter":null,"options":{"date_format":"MM/DD/YYYY","time_format":"12"},"otp":{},"phone":"+010001010011","profile":"612ea05e3cc07803480127151133","tags":[{"key":"user_type","value":"enduser"},{"key":"limit_login","value":"10"}],"timezone":"America/New_York","updated_at":"2022-06-14T14:16:52.377Z"}]},"status":{"type":"boolean","example":true}}}}}}}} \ No newline at end of file +{ + "responses": { + "200": { + "description": "Getting RUN user information by ID", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "active": { "type": "boolean", "example": true }, + "company": { "type": "string", "example": "Companyname" }, + "created_at": { "type": "string", "example": "2022-01-21T21:29:08.957Z" }, + "email": { "type": "string", "example": "runuser@email" }, + "id": { "type": "string", "example": "614889df6a302639012a7caef" }, + "language": { "type": "string", "example": "en" }, + "last_login": { "type": "string", "example": "2022-06-10T17:59:26.879Z" }, + "name": { "type": "string", "example": "runusername" }, + "newsletter": { "example": null }, + "options": { + "type": "object", + "properties": { + "date_format": { "type": "string", "example": "MM/DD/YYYY" }, + "time_format": { "type": "string", "example": "12" } + } + }, + "otp": { "type": "object", "properties": {} }, + "phone": { "type": "string", "example": "+010001010011" }, + "profile": { "type": "string", "example": "612ea05e3cc07803480127151133" }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { "type": "string", "example": "user_type" }, + "value": { "type": "string", "example": "enduser" } + } + }, + "example": [ + { "key": "user_type", "value": "enduser" }, + { "key": "limit_login", "value": "10" } + ] + }, + "timezone": { "type": "string", "example": "America/New_York" }, + "updated_at": { "type": "string", "example": "2022-06-14T14:16:52.377Z" } + } + }, + "example": [ + { + "active": true, + "company": "Companyname", + "created_at": "2022-01-21T21:29:08.957Z", + "email": "runuser@email", + "id": "614889df6a302639012a7caef", + "language": "en", + "last_login": "2022-06-10T17:59:26.879Z", + "name": "runusername", + "newsletter": null, + "options": { "date_format": "MM/DD/YYYY", "time_format": "12" }, + "otp": {}, + "phone": "+010001010011", + "profile": "612ea05e3cc07803480127151133", + "tags": [ + { "key": "user_type", "value": "enduser" }, + { "key": "limit_login", "value": "10" } + ], + "timezone": "America/New_York", + "updated_at": "2022-06-14T14:16:52.377Z" + } + ] + }, + "status": { "type": "boolean", "example": true } + } + } + } + } + } + } +} diff --git a/docs/api/user-information.api.mdx b/docs/api/user-information.api.mdx index f3373ecb..624be679 100644 --- a/docs/api/user-information.api.mdx +++ b/docs/api/user-information.api.mdx @@ -20,51 +20,18 @@ import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; import Translate from "@docusaurus/Translate"; - - - - - - - + + Get information about an user using userID - - + Request - - - - - - - - - - - + + - \ No newline at end of file +