Files
npm-core-sdk/messaging.ts
2026-06-16 13:54:11 +00:00

367 lines
19 KiB
TypeScript

// @generated by protobuf-ts 2.11.1 with parameter use_proto_field_name,keep_enum_prefix
// @generated from protobuf file "messaging.proto" (package "api", syntax proto3)
// tslint:disable
import { ServiceType } from "@protobuf-ts/runtime-rpc";
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import { WireType } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import { UnknownFieldHandler } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { reflectionMergePartial } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { RequestProjectHeader } from "./shared";
/**
* @generated from protobuf message api.SendSMSRequest
*/
export interface SendSMSRequest {
/**
* @generated from protobuf field: api.RequestProjectHeader Header = 1
*/
Header?: RequestProjectHeader;
/**
* @generated from protobuf field: repeated string Recipients = 3
*/
Recipients: string[]; // The recipient's phone number in E.164 format (e.g., +1234567890).
/**
* @generated from protobuf field: string Payload = 4
*/
Payload: string; // The content of the SMS message to be sent. It must be a non-empty string with a maximum length of 160 characters, which is the standard limit for a single SMS message.
}
/**
* @generated from protobuf message api.SendSMSResponse
*/
export interface SendSMSResponse {
}
/**
* @generated from protobuf message api.GetMessagingUsageRequest
*/
export interface GetMessagingUsageRequest {
/**
* @generated from protobuf field: api.RequestProjectHeader Header = 1
*/
Header?: RequestProjectHeader;
}
/**
* @generated from protobuf message api.GetMessagingUsageResponse
*/
export interface GetMessagingUsageResponse {
/**
* @generated from protobuf field: float Usage = 1
*/
Usage: number;
}
/**
* @generated from protobuf message api.IsMessagingMaxUsageReachedRequest
*/
export interface IsMessagingMaxUsageReachedRequest {
/**
* @generated from protobuf field: api.RequestProjectHeader Header = 1
*/
Header?: RequestProjectHeader;
}
/**
* @generated from protobuf message api.IsMessagingMaxUsageReachedResponse
*/
export interface IsMessagingMaxUsageReachedResponse {
/**
* @generated from protobuf field: bool MaxUsageReached = 1
*/
MaxUsageReached: boolean;
}
// @generated message type with reflection information, may provide speed optimized methods
class SendSMSRequest$Type extends MessageType<SendSMSRequest> {
constructor() {
super("api.SendSMSRequest", [
{ no: 1, name: "Header", kind: "message", localName: "Header", jsonName: "Header", T: () => RequestProjectHeader, options: { "n1validate.rules": { message: { required: true } } } },
{ no: 3, name: "Recipients", kind: "scalar", localName: "Recipients", jsonName: "Recipients", repeat: 2 /*RepeatType.UNPACKED*/, T: 9 /*ScalarType.STRING*/, options: { "n1validate.rules": { repeated: { minItems: "1", items: { string: { minLen: "1", maxLen: "15", pattern: "^\\+[1-9]\\d{1,14}$" } } } }, "grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field": { description: "The recipient's phone number in E.164 format (e.g., +1234567890)." } } },
{ no: 4, name: "Payload", kind: "scalar", localName: "Payload", jsonName: "Payload", T: 9 /*ScalarType.STRING*/, options: { "n1validate.rules": { string: { minLen: "1", maxLen: "160" } } } }
], { "grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema": { jsonSchema: { required: ["Header"] } } });
}
create(value?: PartialMessage<SendSMSRequest>): SendSMSRequest {
const message = globalThis.Object.create((this.messagePrototype!));
message.Recipients = [];
message.Payload = "";
if (value !== undefined)
reflectionMergePartial<SendSMSRequest>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SendSMSRequest): SendSMSRequest {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* api.RequestProjectHeader Header */ 1:
message.Header = RequestProjectHeader.internalBinaryRead(reader, reader.uint32(), options, message.Header);
break;
case /* repeated string Recipients */ 3:
message.Recipients.push(reader.string());
break;
case /* string Payload */ 4:
message.Payload = reader.string();
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: SendSMSRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* api.RequestProjectHeader Header = 1; */
if (message.Header)
RequestProjectHeader.internalBinaryWrite(message.Header, writer.tag(1, WireType.LengthDelimited).fork(), options).join();
/* repeated string Recipients = 3; */
for (let i = 0; i < message.Recipients.length; i++)
writer.tag(3, WireType.LengthDelimited).string(message.Recipients[i]);
/* string Payload = 4; */
if (message.Payload !== "")
writer.tag(4, WireType.LengthDelimited).string(message.Payload);
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message api.SendSMSRequest
*/
export const SendSMSRequest = new SendSMSRequest$Type();
// @generated message type with reflection information, may provide speed optimized methods
class SendSMSResponse$Type extends MessageType<SendSMSResponse> {
constructor() {
super("api.SendSMSResponse", []);
}
create(value?: PartialMessage<SendSMSResponse>): SendSMSResponse {
const message = globalThis.Object.create((this.messagePrototype!));
if (value !== undefined)
reflectionMergePartial<SendSMSResponse>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SendSMSResponse): SendSMSResponse {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: SendSMSResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message api.SendSMSResponse
*/
export const SendSMSResponse = new SendSMSResponse$Type();
// @generated message type with reflection information, may provide speed optimized methods
class GetMessagingUsageRequest$Type extends MessageType<GetMessagingUsageRequest> {
constructor() {
super("api.GetMessagingUsageRequest", [
{ no: 1, name: "Header", kind: "message", localName: "Header", jsonName: "Header", T: () => RequestProjectHeader, options: { "n1validate.rules": { message: { required: true } } } }
], { "grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema": { jsonSchema: { required: ["Header"] } } });
}
create(value?: PartialMessage<GetMessagingUsageRequest>): GetMessagingUsageRequest {
const message = globalThis.Object.create((this.messagePrototype!));
if (value !== undefined)
reflectionMergePartial<GetMessagingUsageRequest>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: GetMessagingUsageRequest): GetMessagingUsageRequest {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* api.RequestProjectHeader Header */ 1:
message.Header = RequestProjectHeader.internalBinaryRead(reader, reader.uint32(), options, message.Header);
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: GetMessagingUsageRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* api.RequestProjectHeader Header = 1; */
if (message.Header)
RequestProjectHeader.internalBinaryWrite(message.Header, writer.tag(1, WireType.LengthDelimited).fork(), options).join();
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message api.GetMessagingUsageRequest
*/
export const GetMessagingUsageRequest = new GetMessagingUsageRequest$Type();
// @generated message type with reflection information, may provide speed optimized methods
class GetMessagingUsageResponse$Type extends MessageType<GetMessagingUsageResponse> {
constructor() {
super("api.GetMessagingUsageResponse", [
{ no: 1, name: "Usage", kind: "scalar", localName: "Usage", jsonName: "Usage", T: 2 /*ScalarType.FLOAT*/ }
]);
}
create(value?: PartialMessage<GetMessagingUsageResponse>): GetMessagingUsageResponse {
const message = globalThis.Object.create((this.messagePrototype!));
message.Usage = 0;
if (value !== undefined)
reflectionMergePartial<GetMessagingUsageResponse>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: GetMessagingUsageResponse): GetMessagingUsageResponse {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* float Usage */ 1:
message.Usage = reader.float();
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: GetMessagingUsageResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* float Usage = 1; */
if (message.Usage !== 0)
writer.tag(1, WireType.Bit32).float(message.Usage);
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message api.GetMessagingUsageResponse
*/
export const GetMessagingUsageResponse = new GetMessagingUsageResponse$Type();
// @generated message type with reflection information, may provide speed optimized methods
class IsMessagingMaxUsageReachedRequest$Type extends MessageType<IsMessagingMaxUsageReachedRequest> {
constructor() {
super("api.IsMessagingMaxUsageReachedRequest", [
{ no: 1, name: "Header", kind: "message", localName: "Header", jsonName: "Header", T: () => RequestProjectHeader, options: { "n1validate.rules": { message: { required: true } } } }
], { "grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema": { jsonSchema: { required: ["Header"] } } });
}
create(value?: PartialMessage<IsMessagingMaxUsageReachedRequest>): IsMessagingMaxUsageReachedRequest {
const message = globalThis.Object.create((this.messagePrototype!));
if (value !== undefined)
reflectionMergePartial<IsMessagingMaxUsageReachedRequest>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: IsMessagingMaxUsageReachedRequest): IsMessagingMaxUsageReachedRequest {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* api.RequestProjectHeader Header */ 1:
message.Header = RequestProjectHeader.internalBinaryRead(reader, reader.uint32(), options, message.Header);
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: IsMessagingMaxUsageReachedRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* api.RequestProjectHeader Header = 1; */
if (message.Header)
RequestProjectHeader.internalBinaryWrite(message.Header, writer.tag(1, WireType.LengthDelimited).fork(), options).join();
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message api.IsMessagingMaxUsageReachedRequest
*/
export const IsMessagingMaxUsageReachedRequest = new IsMessagingMaxUsageReachedRequest$Type();
// @generated message type with reflection information, may provide speed optimized methods
class IsMessagingMaxUsageReachedResponse$Type extends MessageType<IsMessagingMaxUsageReachedResponse> {
constructor() {
super("api.IsMessagingMaxUsageReachedResponse", [
{ no: 1, name: "MaxUsageReached", kind: "scalar", localName: "MaxUsageReached", jsonName: "MaxUsageReached", T: 8 /*ScalarType.BOOL*/ }
]);
}
create(value?: PartialMessage<IsMessagingMaxUsageReachedResponse>): IsMessagingMaxUsageReachedResponse {
const message = globalThis.Object.create((this.messagePrototype!));
message.MaxUsageReached = false;
if (value !== undefined)
reflectionMergePartial<IsMessagingMaxUsageReachedResponse>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: IsMessagingMaxUsageReachedResponse): IsMessagingMaxUsageReachedResponse {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* bool MaxUsageReached */ 1:
message.MaxUsageReached = reader.bool();
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: IsMessagingMaxUsageReachedResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* bool MaxUsageReached = 1; */
if (message.MaxUsageReached !== false)
writer.tag(1, WireType.Varint).bool(message.MaxUsageReached);
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message api.IsMessagingMaxUsageReachedResponse
*/
export const IsMessagingMaxUsageReachedResponse = new IsMessagingMaxUsageReachedResponse$Type();
/**
* @generated ServiceType for protobuf service api.MessagingService
*/
export const MessagingService = new ServiceType("api.MessagingService", [
{ name: "SendSMS", options: { "grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation": { tags: ["Messages"], description: "Send a SMS message to a recipient" }, "api.rscType": "Project", "api.roles": "", "google.api.method_visibility": { restriction: "SDK" } }, I: SendSMSRequest, O: SendSMSResponse },
{ name: "GetUsage", options: { "grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation": { tags: ["Messages"], description: "Retrieve the current messaging usage for a Project" }, "api.rscType": "Project", "api.roles": "", "google.api.method_visibility": { restriction: "SDK" } }, I: GetMessagingUsageRequest, O: GetMessagingUsageResponse },
{ name: "IsMaxUsageReached", options: { "grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation": { tags: ["Messages"], description: "Check if the maximum messaging usage has been reached for a Project" }, "api.rscType": "Project", "api.roles": "", "google.api.method_visibility": { restriction: "SDK" } }, I: IsMessagingMaxUsageReachedRequest, O: IsMessagingMaxUsageReachedResponse }
], { "api.k8sService": "messaging-server" });