BokaMera.API.Host

GetAiChatUsage

The following routes are available for this service:
GET	/assistant/ai-chat/usage	Get the AI assistant token usage and limit for a company	Returns how many AI assistant tokens the company has consumed in the current rolling window, the configured limit and whether the company is still within budget. Defaults to the logged-in user's company when no CompanyId is supplied.

import 'package:servicestack/servicestack.dart';

class AiChatUsageResponse implements IConvertible
{
    /**
    * The company the usage applies to.
    */
    // @ApiMember(Description="The company the usage applies to.")
    String CompanyId = "";

    /**
    * Tokens consumed within the current rolling window.
    */
    // @ApiMember(Description="Tokens consumed within the current rolling window.")
    int TokensUsed = 0;

    /**
    * The company's token limit for the window.
    */
    // @ApiMember(Description="The company's token limit for the window.")
    int TokenLimit = 0;

    /**
    * Tokens remaining before the limit is reached (never negative).
    */
    // @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
    int TokensRemaining = 0;

    /**
    * True while the company is still below its token limit.
    */
    // @ApiMember(Description="True while the company is still below its token limit.")
    bool IsWithinBudget;

    /**
    * Length of the rolling usage window, in days.
    */
    // @ApiMember(Description="Length of the rolling usage window, in days.")
    int WindowDays = 0;

    ResponseStatus ResponseStatus;

    AiChatUsageResponse({this.CompanyId,this.TokensUsed,this.TokenLimit,this.TokensRemaining,this.IsWithinBudget,this.WindowDays,this.ResponseStatus});
    AiChatUsageResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        TokensUsed = json['TokensUsed'];
        TokenLimit = json['TokenLimit'];
        TokensRemaining = json['TokensRemaining'];
        IsWithinBudget = json['IsWithinBudget'];
        WindowDays = json['WindowDays'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'TokensUsed': TokensUsed,
        'TokenLimit': TokenLimit,
        'TokensRemaining': TokensRemaining,
        'IsWithinBudget': IsWithinBudget,
        'WindowDays': WindowDays,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "AiChatUsageResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class GetAiChatUsage implements ICompany, IConvertible
{
    /**
    * The company id. Defaults to the logged-in user's company when omitted.
    */
    // @ApiMember(DataType="string", Description="The company id. Defaults to the logged-in user's company when omitted.", ParameterType="query")
    String? CompanyId;

    GetAiChatUsage({this.CompanyId});
    GetAiChatUsage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId
    };

    getTypeName() => "GetAiChatUsage";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
    'AiChatUsageResponse': TypeInfo(TypeOf.Class, create:() => AiChatUsageResponse()),
    'GetAiChatUsage': TypeInfo(TypeOf.Class, create:() => GetAiChatUsage()),
});

Dart GetAiChatUsage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /assistant/ai-chat/usage HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AiChatUsageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <IsWithinBudget>false</IsWithinBudget>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TokenLimit>0</TokenLimit>
  <TokensRemaining>0</TokensRemaining>
  <TokensUsed>0</TokensUsed>
  <WindowDays>0</WindowDays>
</AiChatUsageResponse>