Skip to content

Latest commit

 

History

History
288 lines (209 loc) · 8.68 KB

MonetizationApi.md

File metadata and controls

288 lines (209 loc) · 8.68 KB

MonetizationApi

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

Method HTTP request Description
createPricingTiers POST /pricing/devicetypes/{dtid}/pricingtiers Define devicetype's pricing tiers.
getPricingTiers GET /pricing/devices/{did}/pricingtiers Get a device's pricing tiers
getThePricingTiers GET /pricing/devicetypes/{dtid}/pricingtiers Get devicetype's pricing tiers.
getUpgradePath GET /pricing/devices/{did}/revenueshare/upgradepath Get upgrade path
setPricingTier PUT /pricing/devices/{did}/pricingtiers Set a device's pricing tier

createPricingTiers

DeviceTypePricingTier createPricingTiers(dtid, pricingTierInfo)

Define devicetype's pricing tiers.

Define devicetype's pricing tiers.

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.MonetizationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

MonetizationApi apiInstance = new MonetizationApi();
String dtid = "dtid_example"; // String | DeviceType ID
DeviceTypePricingTier pricingTierInfo = new DeviceTypePricingTier(); // DeviceTypePricingTier | Pricing tier info
try {
    DeviceTypePricingTier result = apiInstance.createPricingTiers(dtid, pricingTierInfo);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MonetizationApi#createPricingTiers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
dtid String DeviceType ID
pricingTierInfo DeviceTypePricingTier Pricing tier info

Return type

DeviceTypePricingTier

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getPricingTiers

DevicePricingTiersEnvelope getPricingTiers(did, active)

Get a device's pricing tiers

Get a device's pricing tiers

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.MonetizationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

MonetizationApi apiInstance = new MonetizationApi();
String did = "did_example"; // String | Device ID
Boolean active = true; // Boolean | Filter by active
try {
    DevicePricingTiersEnvelope result = apiInstance.getPricingTiers(did, active);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MonetizationApi#getPricingTiers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
did String Device ID
active Boolean Filter by active [optional]

Return type

DevicePricingTiersEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getThePricingTiers

DeviceTypePricingTiersEnvelope getThePricingTiers(dtid, version)

Get devicetype's pricing tiers.

Get devicetype's pricing tiers.

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.MonetizationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

MonetizationApi apiInstance = new MonetizationApi();
String dtid = "dtid_example"; // String | DeviceType ID
Integer version = 56; // Integer | Version
try {
    DeviceTypePricingTiersEnvelope result = apiInstance.getThePricingTiers(dtid, version);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MonetizationApi#getThePricingTiers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
dtid String DeviceType ID
version Integer Version

Return type

DeviceTypePricingTiersEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getUpgradePath

UpgradePathEnvelope getUpgradePath(did, action)

Get upgrade path

Get upgrade path

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.MonetizationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

MonetizationApi apiInstance = new MonetizationApi();
String did = "did_example"; // String | Device ID
String action = "action_example"; // String | Action to perform
try {
    UpgradePathEnvelope result = apiInstance.getUpgradePath(did, action);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MonetizationApi#getUpgradePath");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
did String Device ID
action String Action to perform

Return type

UpgradePathEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

setPricingTier

DevicePricingTierEnvelope setPricingTier(did, pricingTier)

Set a device's pricing tier

Set a device's pricing tier

Example

// Import classes:
//import cloud.artik.client.ApiClient;
//import cloud.artik.client.ApiException;
//import cloud.artik.client.Configuration;
//import cloud.artik.client.auth.*;
//import cloud.artik.api.MonetizationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: artikcloud_oauth
OAuth artikcloud_oauth = (OAuth) defaultClient.getAuthentication("artikcloud_oauth");
artikcloud_oauth.setAccessToken("YOUR ACCESS TOKEN");

MonetizationApi apiInstance = new MonetizationApi();
String did = "did_example"; // String | Device ID
DevicePricingTierRequest pricingTier = new DevicePricingTierRequest(); // DevicePricingTierRequest | Pricing tier
try {
    DevicePricingTierEnvelope result = apiInstance.setPricingTier(did, pricingTier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MonetizationApi#setPricingTier");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
did String Device ID
pricingTier DevicePricingTierRequest Pricing tier

Return type

DevicePricingTierEnvelope

Authorization

artikcloud_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json