Added API call to fetch usage data

Author: svenefftinge

components/usage-api/go/v1/usage.pb.go

@@ -19,6 +19,7 @@ interface IUsageServiceService extends grpc.ServiceDefinition<grpc.UntypedServic
     reconcileUsage: IUsageServiceService_IReconcileUsage;
     getCostCenter: IUsageServiceService_IGetCostCenter;
     reconcileUsageWithLedger: IUsageServiceService_IReconcileUsageWithLedger;
+    listUsage: IUsageServiceService_IListUsage;
 }
 
 interface IUsageServiceService_IListBilledUsage extends grpc.MethodDefinition<usage_v1_usage_pb.ListBilledUsageRequest, usage_v1_usage_pb.ListBilledUsageResponse> {
@@ -57,6 +58,15 @@ interface IUsageServiceService_IReconcileUsageWithLedger extends grpc.MethodDefi
     responseSerialize: grpc.serialize<usage_v1_usage_pb.ReconcileUsageWithLedgerResponse>;
     responseDeserialize: grpc.deserialize<usage_v1_usage_pb.ReconcileUsageWithLedgerResponse>;
 }
+interface IUsageServiceService_IListUsage extends grpc.MethodDefinition<usage_v1_usage_pb.ListUsageRequest, usage_v1_usage_pb.ListUsageResponse> {
+    path: "/usage.v1.UsageService/ListUsage";
+    requestStream: false;
+    responseStream: false;
+    requestSerialize: grpc.serialize<usage_v1_usage_pb.ListUsageRequest>;
+    requestDeserialize: grpc.deserialize<usage_v1_usage_pb.ListUsageRequest>;
+    responseSerialize: grpc.serialize<usage_v1_usage_pb.ListUsageResponse>;
+    responseDeserialize: grpc.deserialize<usage_v1_usage_pb.ListUsageResponse>;
+}
 
 export const UsageServiceService: IUsageServiceService;
 
@@ -65,6 +75,7 @@ export interface IUsageServiceServer extends grpc.UntypedServiceImplementation {
     reconcileUsage: grpc.handleUnaryCall<usage_v1_usage_pb.ReconcileUsageRequest, usage_v1_usage_pb.ReconcileUsageResponse>;
     getCostCenter: grpc.handleUnaryCall<usage_v1_usage_pb.GetCostCenterRequest, usage_v1_usage_pb.GetCostCenterResponse>;
     reconcileUsageWithLedger: grpc.handleUnaryCall<usage_v1_usage_pb.ReconcileUsageWithLedgerRequest, usage_v1_usage_pb.ReconcileUsageWithLedgerResponse>;
+    listUsage: grpc.handleUnaryCall<usage_v1_usage_pb.ListUsageRequest, usage_v1_usage_pb.ListUsageResponse>;
 }
 
 export interface IUsageServiceClient {
@@ -80,6 +91,9 @@ export interface IUsageServiceClient {
     reconcileUsageWithLedger(request: usage_v1_usage_pb.ReconcileUsageWithLedgerRequest, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ReconcileUsageWithLedgerResponse) => void): grpc.ClientUnaryCall;
     reconcileUsageWithLedger(request: usage_v1_usage_pb.ReconcileUsageWithLedgerRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ReconcileUsageWithLedgerResponse) => void): grpc.ClientUnaryCall;
     reconcileUsageWithLedger(request: usage_v1_usage_pb.ReconcileUsageWithLedgerRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ReconcileUsageWithLedgerResponse) => void): grpc.ClientUnaryCall;
+    listUsage(request: usage_v1_usage_pb.ListUsageRequest, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ListUsageResponse) => void): grpc.ClientUnaryCall;
+    listUsage(request: usage_v1_usage_pb.ListUsageRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ListUsageResponse) => void): grpc.ClientUnaryCall;
+    listUsage(request: usage_v1_usage_pb.ListUsageRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ListUsageResponse) => void): grpc.ClientUnaryCall;
 }
 
 export class UsageServiceClient extends grpc.Client implements IUsageServiceClient {
@@ -96,4 +110,7 @@ export class UsageServiceClient extends grpc.Client implements IUsageServiceClie
     public reconcileUsageWithLedger(request: usage_v1_usage_pb.ReconcileUsageWithLedgerRequest, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ReconcileUsageWithLedgerResponse) => void): grpc.ClientUnaryCall;
     public reconcileUsageWithLedger(request: usage_v1_usage_pb.ReconcileUsageWithLedgerRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ReconcileUsageWithLedgerResponse) => void): grpc.ClientUnaryCall;
     public reconcileUsageWithLedger(request: usage_v1_usage_pb.ReconcileUsageWithLedgerRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ReconcileUsageWithLedgerResponse) => void): grpc.ClientUnaryCall;
+    public listUsage(request: usage_v1_usage_pb.ListUsageRequest, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ListUsageResponse) => void): grpc.ClientUnaryCall;
+    public listUsage(request: usage_v1_usage_pb.ListUsageRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ListUsageResponse) => void): grpc.ClientUnaryCall;
+    public listUsage(request: usage_v1_usage_pb.ListUsageRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: usage_v1_usage_pb.ListUsageResponse) => void): grpc.ClientUnaryCall;
 }

components/usage-api/go/v1/usage_grpc.pb.go

@@ -55,6 +55,28 @@ function deserialize_usage_v1_ListBilledUsageResponse(buffer_arg) {
   return usage_v1_usage_pb.ListBilledUsageResponse.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_usage_v1_ListUsageRequest(arg) {
+  if (!(arg instanceof usage_v1_usage_pb.ListUsageRequest)) {
+    throw new Error('Expected argument of type usage.v1.ListUsageRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_usage_v1_ListUsageRequest(buffer_arg) {
+  return usage_v1_usage_pb.ListUsageRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_usage_v1_ListUsageResponse(arg) {
+  if (!(arg instanceof usage_v1_usage_pb.ListUsageResponse)) {
+    throw new Error('Expected argument of type usage.v1.ListUsageResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_usage_v1_ListUsageResponse(buffer_arg) {
+  return usage_v1_usage_pb.ListUsageResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_usage_v1_ReconcileUsageRequest(arg) {
   if (!(arg instanceof usage_v1_usage_pb.ReconcileUsageRequest)) {
     throw new Error('Expected argument of type usage.v1.ReconcileUsageRequest');
@@ -149,6 +171,18 @@ reconcileUsageWithLedger: {
     responseSerialize: serialize_usage_v1_ReconcileUsageWithLedgerResponse,
     responseDeserialize: deserialize_usage_v1_ReconcileUsageWithLedgerResponse,
   },
+  // ListUsage retrieves all usage for the specified attributionId and theb given time range
+listUsage: {
+    path: '/usage.v1.UsageService/ListUsage',
+    requestStream: false,
+    responseStream: false,
+    requestType: usage_v1_usage_pb.ListUsageRequest,
+    responseType: usage_v1_usage_pb.ListUsageResponse,
+    requestSerialize: serialize_usage_v1_ListUsageRequest,
+    requestDeserialize: deserialize_usage_v1_ListUsageRequest,
+    responseSerialize: serialize_usage_v1_ListUsageResponse,
+    responseDeserialize: deserialize_usage_v1_ListUsageResponse,
+  },
 };
 
 exports.UsageServiceClient = grpc.makeGenericClientConstructor(UsageServiceService);

components/usage-api/typescript/src/usage/v1/usage_grpc_pb.d.ts

@@ -189,6 +189,140 @@ export namespace PaginatedResponse {
     }
 }
 
+export class ListUsageRequest extends jspb.Message {
+    getAttributionId(): string;
+    setAttributionId(value: string): ListUsageRequest;
+
+    hasFrom(): boolean;
+    clearFrom(): void;
+    getFrom(): google_protobuf_timestamp_pb.Timestamp | undefined;
+    setFrom(value?: google_protobuf_timestamp_pb.Timestamp): ListUsageRequest;
+
+    hasTo(): boolean;
+    clearTo(): void;
+    getTo(): google_protobuf_timestamp_pb.Timestamp | undefined;
+    setTo(value?: google_protobuf_timestamp_pb.Timestamp): ListUsageRequest;
+    getOrder(): ListUsageRequest.Ordering;
+    setOrder(value: ListUsageRequest.Ordering): ListUsageRequest;
+
+    hasPagination(): boolean;
+    clearPagination(): void;
+    getPagination(): PaginatedRequest | undefined;
+    setPagination(value?: PaginatedRequest): ListUsageRequest;
+
+    serializeBinary(): Uint8Array;
+    toObject(includeInstance?: boolean): ListUsageRequest.AsObject;
+    static toObject(includeInstance: boolean, msg: ListUsageRequest): ListUsageRequest.AsObject;
+    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+    static serializeBinaryToWriter(message: ListUsageRequest, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): ListUsageRequest;
+    static deserializeBinaryFromReader(message: ListUsageRequest, reader: jspb.BinaryReader): ListUsageRequest;
+}
+
+export namespace ListUsageRequest {
+    export type AsObject = {
+        attributionId: string,
+        from?: google_protobuf_timestamp_pb.Timestamp.AsObject,
+        to?: google_protobuf_timestamp_pb.Timestamp.AsObject,
+        order: ListUsageRequest.Ordering,
+        pagination?: PaginatedRequest.AsObject,
+    }
+
+    export enum Ordering {
+    ORDERING_DESCENDING = 0,
+    ORDERING_ASCENDING = 1,
+    }
+
+}
+
+export class ListUsageResponse extends jspb.Message {
+    clearUsageEntriesList(): void;
+    getUsageEntriesList(): Array<Usage>;
+    setUsageEntriesList(value: Array<Usage>): ListUsageResponse;
+    addUsageEntries(value?: Usage, index?: number): Usage;
+
+    hasPagination(): boolean;
+    clearPagination(): void;
+    getPagination(): PaginatedResponse | undefined;
+    setPagination(value?: PaginatedResponse): ListUsageResponse;
+    getCreditBalanceAtStart(): number;
+    setCreditBalanceAtStart(value: number): ListUsageResponse;
+    getCreditBalanceAtEnd(): number;
+    setCreditBalanceAtEnd(value: number): ListUsageResponse;
+
+    serializeBinary(): Uint8Array;
+    toObject(includeInstance?: boolean): ListUsageResponse.AsObject;
+    static toObject(includeInstance: boolean, msg: ListUsageResponse): ListUsageResponse.AsObject;
+    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+    static serializeBinaryToWriter(message: ListUsageResponse, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): ListUsageResponse;
+    static deserializeBinaryFromReader(message: ListUsageResponse, reader: jspb.BinaryReader): ListUsageResponse;
+}
+
+export namespace ListUsageResponse {
+    export type AsObject = {
+        usageEntriesList: Array<Usage.AsObject>,
+        pagination?: PaginatedResponse.AsObject,
+        creditBalanceAtStart: number,
+        creditBalanceAtEnd: number,
+    }
+}
+
+export class Usage extends jspb.Message {
+    getId(): string;
+    setId(value: string): Usage;
+    getAttributionId(): string;
+    setAttributionId(value: string): Usage;
+    getDescription(): string;
+    setDescription(value: string): Usage;
+    getCredits(): number;
+    setCredits(value: number): Usage;
+
+    hasEffectiveTime(): boolean;
+    clearEffectiveTime(): void;
+    getEffectiveTime(): google_protobuf_timestamp_pb.Timestamp | undefined;
+    setEffectiveTime(value?: google_protobuf_timestamp_pb.Timestamp): Usage;
+    getKind(): Usage.Kind;
+    setKind(value: Usage.Kind): Usage;
+    getWorkspaceInstanceId(): string;
+    setWorkspaceInstanceId(value: string): Usage;
+    getDraft(): boolean;
+    setDraft(value: boolean): Usage;
+    getMetadata(): string;
+    setMetadata(value: string): Usage;
+
+    serializeBinary(): Uint8Array;
+    toObject(includeInstance?: boolean): Usage.AsObject;
+    static toObject(includeInstance: boolean, msg: Usage): Usage.AsObject;
+    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+    static serializeBinaryToWriter(message: Usage, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): Usage;
+    static deserializeBinaryFromReader(message: Usage, reader: jspb.BinaryReader): Usage;
+}
+
+export namespace Usage {
+    export type AsObject = {
+        id: string,
+        attributionId: string,
+        description: string,
+        credits: number,
+        effectiveTime?: google_protobuf_timestamp_pb.Timestamp.AsObject,
+        kind: Usage.Kind,
+        workspaceInstanceId: string,
+        draft: boolean,
+        metadata: string,
+    }
+
+    export enum Kind {
+    KIND_WORKSPACE_INSTANCE = 0,
+    KIND_INVOICE = 1,
+    }
+
+}
+
 export class BilledSession extends jspb.Message {
     getAttributionId(): string;
     setAttributionId(value: string): BilledSession;