GET /v1/account/settings

Request:

curl -u username:password -X GET "https://api.reporting.cloud/v1/account/settings"

Results:

{
  "serialNumber": "Trial",
  "createdDocuments": 13,
  "uploadedTemplates": 4,
  "maxDocuments": 1000,
  "maxTemplates": 20,
  "validUntil": null,
  "proofingTransactions": 10,
  "maxProofingTransactions": 10000
}

Request:

using System;
using System.Collections.Generic;
using System.Drawing;
using System.IO;
using TXTextControl.ReportingCloud;

class RCSamples
{
    public static void AccountSettings()
    {
        ReportingCloud rc = new ReportingCloud(
            "username",
            "password",
            new Uri("https://api.reporting.cloud"));

        try
        {
            AccountSettings settings = rc.GetAccountSettings();
            Console.WriteLine("Serial number: " + settings.SerialNumber);
            Console.WriteLine("Uploaded templates: " + settings.UploadedTemplates);
        }
        catch (Exception e)
        {
            Console.WriteLine("An error occurred: " + e.Message);
        }
    }
}

Results:

Serial number: Trial
Uploaded templates: 4

Request:

import com.textcontrol.reportingcloud.AccountSettings;
import com.textcontrol.reportingcloud.ReportingCloud;

import java.io.IOException;

public class ReportingCloudSample {
    public static void main(String[] args) throws IOException {
        ReportingCloud r = new ReportingCloud("username", "password");
        AccountSettings settings = r.getAccountSettings();

        System.out.println("Serial number: " + settings.getSerialNumber());
        System.out.println("Uploaded templates: " + settings.getUploadedTemplates());
        System.out.println("Max documents: " + settings.getMaxDocuments());
        System.out.println("Max templates: " + settings.getMaxTemplates());
        System.out.println("Valid until: " + settings.getValidUntil());
    }
}

Results:

Serial number: XX-XXXXXXXXXX
Uploaded templates: 2
Max documents: 100000
Max templates: 500
Valid until: 2020-01-01T00:00Z

On an account whose validUntil is null, such as a trial account, getAccountSettings() throws a JsonParseException: SDK 1.3 reads the date with getAsString(), which a JSON null refuses.

Request:

#!/usr/bin/env ruby

require "txtextcontrol/reportingcloud"

reporting_cloud = TXTextControl::ReportingCloud::ReportingCloud.new("username", "password")
account_settings = reporting_cloud.get_account_settings

puts "Serial number: #{account_settings.serial_number}"
puts "Uploaded templates: #{account_settings.uploaded_templates}"
puts "Max documents: #{account_settings.max_documents}"
puts "Max templates: #{account_settings.max_templates}"
puts "Valid until: #{account_settings.valid_until.to_s}"

Results:

Serial number: XX-XXXXXXXXXX
Uploaded templates: 2
Max documents: 100000
Max templates: 500
Valid until: 2020-01-01T00:00:00+00:00

Request:

<?php

require_once __DIR__ . '/vendor/autoload.php';

use TextControl\ReportingCloud\ReportingCloud;

$reportingCloud = new ReportingCloud([
    'api_key' => (string) getenv('REPORTINGCLOUD_API_KEY'),
]);

var_dump($reportingCloud->getAccountSettings());

Results:

array(8) {
  ["serial_number"]=>
  string(13) "XX-0000000000"
  ["created_documents"]=>
  int(131)
  ["uploaded_templates"]=>
  int(2)
  ["max_documents"]=>
  int(20000)
  ["max_templates"]=>
  int(100)
  ["valid_until"]=>
  int(1517785200)
  ["proofing_transactions"]=>
  int(12)
  ["max_proofing_transactions"]=>
  int(50000)
}