Skip to content

artikcloud/artikcloud-csharp-dev

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits

docs

docs

 
 

src

src

 
 

.gitignore

.gitignore

 
 

.swagger-codegen-ignore

.swagger-codegen-ignore

 
 

.travis.yml

.travis.yml

 
 

CLOUD.Artik.sln

CLOUD.Artik.sln

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

build.bat

build.bat

 
 

build.sh

build.sh

 
 

git_push.sh

git_push.sh

 
 

mono_nunit_test.sh

mono_nunit_test.sh

 
 

Repository files navigation

CLOUD.Artik - the C# library for the ARTIK Cloud API

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This C# SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0.0
  • SDK version: 2.0.6
  • Build date: 2016-10-29T01:58:18.311-02:00
  • Build package: class io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using CLOUD.Artik.Api;
using CLOUD.Artik.Client;
using Model;

Getting Started

using System;
using System.Diagnostics;
using CLOUD.Artik.Api;
using CLOUD.Artik.Client;
using Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: artikcloud_oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DeviceTypesApi();
            var deviceTypeId = deviceTypeId_example;  // string | deviceTypeId

            try
            {
                // Get Available Manifest Versions
                ManifestVersionsEnvelope result = apiInstance.GetAvailableManifestVersions(deviceTypeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceTypesApi.GetAvailableManifestVersions: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.artik.cloud/v1.1

Class Method HTTP request Description
DeviceTypesApi GetAvailableManifestVersions GET /devicetypes/{deviceTypeId}/availablemanifestversions Get Available Manifest Versions
DeviceTypesApi GetDeviceType GET /devicetypes/{deviceTypeId} Get Device Type
DeviceTypesApi GetDeviceTypes GET /devicetypes Get Device Types
DeviceTypesApi GetDeviceTypesByApplication GET /applications/{appId}/devicetypes Get Device Types by Application
DeviceTypesApi GetLatestManifestProperties GET /devicetypes/{deviceTypeId}/manifests/latest/properties Get Latest Manifest Properties
DeviceTypesApi GetManifestProperties GET /devicetypes/{deviceTypeId}/manifests/{version}/properties Get manifest properties
DevicesApi AddDevice POST /devices Add Device
DevicesApi DeleteDevice DELETE /devices/{deviceId} Delete Device
DevicesApi DeleteDeviceToken DELETE /devices/{deviceId}/tokens Delete Device Token
DevicesApi GetDevice GET /devices/{deviceId} Get Device
DevicesApi GetDevicePresence GET /devices/{deviceId}/presence Get device presence information
DevicesApi GetDeviceToken GET /devices/{deviceId}/tokens Get Device Token
DevicesApi UpdateDevice PUT /devices/{deviceId} Update Device
DevicesApi UpdateDeviceToken PUT /devices/{deviceId}/tokens Update Device Token
DevicesManagementApi CreateTasks POST /devicemgmt/tasks Create a new task for one or more devices
DevicesManagementApi DeleteServerProperties DELETE /devicemgmt/devices/{did}/serverproperties Deletes a device's properties.
DevicesManagementApi GetAllByDid GET /devicemgmt/devices/{did}/tasks Returns the list of tasks for a particular device id with optional status filter.
DevicesManagementApi GetDeviceTypesInfo GET /devicemgmt/devicetypes/{dtid} Read a device type device management information.
DevicesManagementApi GetManifestProperties GET /devicemgmt/devicetypes/{dtid}/manifest/properties Get a device type's device management manifest properties
DevicesManagementApi GetProperties GET /devicemgmt/devices/{did}/properties Read a device's properties.
DevicesManagementApi GetStatuses GET /devicemgmt/tasks/{tid}/statuses Returns the details and status of a task id and the individual statuses of each device id in the list.
DevicesManagementApi GetStatusesHistory GET /devicemgmt/tasks/{tid}/statuses/history Returns the history of the status changes for a specific task id, or for a specific device id in that task.
DevicesManagementApi GetTaskByID GET /devicemgmt/tasks/{tid} Returns the details and global status of a specific task id.
DevicesManagementApi GetTasks GET /devicemgmt/tasks Returns the all the tasks for a device type.
DevicesManagementApi QueryProperties GET /devicemgmt/devices/properties Query device properties across devices.
DevicesManagementApi UpdateDeviceTypesInfo PUT /devicemgmt/devicetypes/{dtid} Updates a device type information
DevicesManagementApi UpdateServerProperties POST /devicemgmt/devices/{did}/serverproperties Updates a device's server properties.
DevicesManagementApi UpdateTask PUT /devicemgmt/tasks/{tid} Updates a task for all devices - For now just allows changing the state to cancelled.
DevicesManagementApi UpdateTaskForDevice PUT /devicemgmt/tasks/{tid}/devices/{did} Updates a task for a specific device - For now just allows changing the state to cancelled.
ExportApi ExportRequest POST /messages/export Create Export Request
ExportApi GetExportHistory GET /messages/export/history Get Export History
ExportApi GetExportResult GET /messages/export/{exportId}/result Get Export Result
ExportApi GetExportStatus GET /messages/export/{exportId}/status Check Export Status
MessagesApi GetAggregatesHistogram GET /messages/analytics/histogram Get Normalized Message Histogram
MessagesApi GetFieldPresence GET /messages/presence Get normalized message presence
MessagesApi GetLastNormalizedMessages GET /messages/last Get Last Normalized Message
MessagesApi GetMessageAggregates GET /messages/analytics/aggregates Get Normalized Message Aggregates
MessagesApi GetMessageSnapshots GET /messages/snapshots Get Message Snapshots
MessagesApi GetNormalizedActions GET /actions Get Normalized Actions
MessagesApi GetNormalizedMessages GET /messages Get Normalized Messages
MessagesApi SendActions POST /actions Send Actions
MessagesApi SendMessage POST /messages Send Message
RegistrationsApi ConfirmUser PUT /devices/registrations/pin Confirm User
RegistrationsApi GetRequestStatusForUser GET /devices/registrations/{requestId}/status Get Request Status For User
RegistrationsApi UnregisterDevice DELETE /devices/{deviceId}/registrations Unregister Device
RulesApi CreateRule POST /rules Create Rule
RulesApi DeleteRule DELETE /rules/{ruleId} Delete Rule
RulesApi GetRule GET /rules/{ruleId} Get Rule
RulesApi UpdateRule PUT /rules/{ruleId} Update Rule
TagsApi GetTagCategories GET /tags/categories Get all categories
TagsApi GetTagSuggestions GET /tags/suggestions Get tag suggestions
TagsApi GetTagsByCategories GET /tags Get all tags of categories
TokensApi CheckToken POST /accounts/checkToken Check Token
TokensApi RefreshToken POST /accounts/token Refresh Token
TokensApi TokenInfo GET /accounts/tokenInfo Token Info
UsersApi CreateUserProperties POST /users/{userId}/properties Create User Application Properties
UsersApi DeleteUserProperties DELETE /users/{userId}/properties Delete User Application Properties
UsersApi GetSelf GET /users/self Get Current User Profile
UsersApi GetUserDeviceTypes GET /users/{userId}/devicetypes Get User Device Types
UsersApi GetUserDevices GET /users/{userId}/devices Get User Devices
UsersApi GetUserProperties GET /users/{userId}/properties Get User application properties
UsersApi GetUserRules GET /users/{userId}/rules Get User Rules
UsersApi UpdateUserProperties PUT /users/{userId}/properties Update User Application Properties

Documentation for Models

Documentation for Authorization

artikcloud_oauth

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

13 watching

Forks

1 fork
Report repository

Releases

2 tags

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages