viam.proto.app.billing

@generated by Viam. Do not edit manually!

Classes

`BillingServiceBase`	Helper class that provides a standard way to create an ABC using
`BillingServiceStub`
`UnimplementedBillingServiceBase`	Helper class that provides a standard way to create an ABC using
`GetCurrentMonthUsageRequest`	Abstract base class for protocol messages.
`GetCurrentMonthUsageResponse`	Abstract base class for protocol messages.
`GetInvoicePdfRequest`	Abstract base class for protocol messages.
`GetInvoicePdfResponse`	Abstract base class for protocol messages.
`GetInvoicesSummaryRequest`	Abstract base class for protocol messages.
`GetInvoicesSummaryResponse`	Abstract base class for protocol messages.
`GetOrgBillingInformationRequest`	Abstract base class for protocol messages.
`GetOrgBillingInformationResponse`	Abstract base class for protocol messages.
`InvoiceSummary`	Abstract base class for protocol messages.
`PaymentMethodCard`	Abstract base class for protocol messages.
`PaymentMethodType`
`ResourceUsageCosts`	Abstract base class for protocol messages.
`ResourceUsageCostsBySource`	Abstract base class for protocol messages.
`SendPaymentRequiredEmailRequest`	Abstract base class for protocol messages.
`SendPaymentRequiredEmailResponse`	Abstract base class for protocol messages.
`SourceType`
`UsageCost`	Abstract base class for protocol messages.
`UsageCostType`

Module Contents

class viam.proto.app.billing.BillingServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract GetCurrentMonthUsage(stream: grpclib.server.Stream[app.v1.billing_pb2.GetCurrentMonthUsageRequest, app.v1.billing_pb2.GetCurrentMonthUsageResponse]) → None[source]

Async:

abstract GetOrgBillingInformation(stream: grpclib.server.Stream[app.v1.billing_pb2.GetOrgBillingInformationRequest, app.v1.billing_pb2.GetOrgBillingInformationResponse]) → None[source]

Async:

abstract GetInvoicesSummary(stream: grpclib.server.Stream[app.v1.billing_pb2.GetInvoicesSummaryRequest, app.v1.billing_pb2.GetInvoicesSummaryResponse]) → None[source]

Async:

abstract GetInvoicePdf(stream: grpclib.server.Stream[app.v1.billing_pb2.GetInvoicePdfRequest, app.v1.billing_pb2.GetInvoicePdfResponse]) → None[source]

Async:

abstract SendPaymentRequiredEmail(stream: grpclib.server.Stream[app.v1.billing_pb2.SendPaymentRequiredEmailRequest, app.v1.billing_pb2.SendPaymentRequiredEmailResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.app.billing.BillingServiceStub(channel: grpclib.client.Channel)[source]

GetCurrentMonthUsage

GetOrgBillingInformation

GetInvoicesSummary

GetInvoicePdf

SendPaymentRequiredEmail

class viam.proto.app.billing.UnimplementedBillingServiceBase[source]

Bases: BillingServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async GetCurrentMonthUsage(stream: grpclib.server.Stream[app.v1.billing_pb2.GetCurrentMonthUsageRequest, app.v1.billing_pb2.GetCurrentMonthUsageResponse]) → None[source]

async GetOrgBillingInformation(stream: grpclib.server.Stream[app.v1.billing_pb2.GetOrgBillingInformationRequest, app.v1.billing_pb2.GetOrgBillingInformationResponse]) → None[source]

async GetInvoicesSummary(stream: grpclib.server.Stream[app.v1.billing_pb2.GetInvoicesSummaryRequest, app.v1.billing_pb2.GetInvoicesSummaryResponse]) → None[source]

async GetInvoicePdf(stream: grpclib.server.Stream[app.v1.billing_pb2.GetInvoicePdfRequest, app.v1.billing_pb2.GetInvoicePdfResponse]) → None[source]

async SendPaymentRequiredEmail(stream: grpclib.server.Stream[app.v1.billing_pb2.SendPaymentRequiredEmailRequest, app.v1.billing_pb2.SendPaymentRequiredEmailResponse]) → None[source]

class viam.proto.app.billing.GetCurrentMonthUsageRequest(*, org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

org_id: str

class viam.proto.app.billing.GetCurrentMonthUsageResponse(*, start_date: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_date: google.protobuf.timestamp_pb2.Timestamp | None = ..., resource_usage_costs_by_source: collections.abc.Iterable[global___ResourceUsageCostsBySource] | None = ..., subtotal: float = ..., cloud_storage_usage_cost: float = ..., data_upload_usage_cost: float = ..., data_egres_usage_cost: float = ..., remote_control_usage_cost: float = ..., standard_compute_usage_cost: float = ..., discount_amount: float = ..., total_usage_with_discount: float = ..., total_usage_without_discount: float = ..., per_machine_usage_cost: float = ..., binary_data_cloud_storage_usage_cost: float = ..., other_cloud_storage_usage_cost: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

subtotal: float

cloud_storage_usage_cost: float: all fields below are deprecated

data_upload_usage_cost: float

data_egres_usage_cost: float

remote_control_usage_cost: float

standard_compute_usage_cost: float

discount_amount: float

total_usage_with_discount: float

total_usage_without_discount: float

per_machine_usage_cost: float

binary_data_cloud_storage_usage_cost: float

other_cloud_storage_usage_cost: float

property start_date: google.protobuf.timestamp_pb2.Timestamp

property end_date: google.protobuf.timestamp_pb2.Timestamp

property resource_usage_costs_by_source: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResourceUsageCostsBySource]

HasField(field_name: Literal['end_date', b'end_date', 'start_date', b'start_date']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.app.billing.GetInvoicePdfRequest(*, id: str = ..., org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

org_id: str

class viam.proto.app.billing.GetInvoicePdfResponse(*, chunk: bytes = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

chunk: bytes

class viam.proto.app.billing.GetInvoicesSummaryRequest(*, org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

org_id: str

class viam.proto.app.billing.GetInvoicesSummaryResponse(*, outstanding_balance: float = ..., invoices: collections.abc.Iterable[global___InvoiceSummary] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

outstanding_balance: float: all unpaid balances at the end of the last billing cycle

property invoices: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___InvoiceSummary]: all previous invoices

class viam.proto.app.billing.GetOrgBillingInformationRequest(*, org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

org_id: str

class viam.proto.app.billing.GetOrgBillingInformationResponse(*, type: global___PaymentMethodType = ..., billing_email: str = ..., method: global___PaymentMethodCard | None = ..., billing_tier: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

type: global___PaymentMethodType

billing_email: str

billing_tier: str: Only return billing_tier for billing dashboard admin users

property method: global___PaymentMethodCard: defined if type is PAYMENT_METHOD_TYPE_CARD

HasField(field_name: Literal['_billing_tier', b'_billing_tier', '_method', b'_method', 'billing_tier', b'billing_tier', 'method', b'method']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_billing_tier', b'_billing_tier']) → Literal['billing_tier'] | None

WhichOneof(oneof_group: Literal['_method', b'_method']) → Literal['method'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

class viam.proto.app.billing.InvoiceSummary(*, id: str = ..., invoice_date: google.protobuf.timestamp_pb2.Timestamp | None = ..., invoice_amount: float = ..., status: str = ..., due_date: google.protobuf.timestamp_pb2.Timestamp | None = ..., paid_date: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

invoice_amount: float

status: str

property invoice_date: google.protobuf.timestamp_pb2.Timestamp

property due_date: google.protobuf.timestamp_pb2.Timestamp

property paid_date: google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: Literal['due_date', b'due_date', 'invoice_date', b'invoice_date', 'paid_date', b'paid_date']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.app.billing.PaymentMethodCard(*, brand: str = ..., last_four_digits: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

brand: str

last_four_digits: str

class viam.proto.app.billing.PaymentMethodType: Bases: _PaymentMethodType

class viam.proto.app.billing.ResourceUsageCosts(*, usage_costs: collections.abc.Iterable[global___UsageCost] | None = ..., discount: float = ..., total_with_discount: float = ..., total_without_discount: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

discount: float

total_with_discount: float

total_without_discount: float

property usage_costs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___UsageCost]

class viam.proto.app.billing.ResourceUsageCostsBySource(*, source_type: global___SourceType = ..., resource_usage_costs: global___ResourceUsageCosts | None = ..., tier_name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

source_type: global___SourceType

tier_name: str

property resource_usage_costs: global___ResourceUsageCosts

HasField(field_name: Literal['resource_usage_costs', b'resource_usage_costs']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.app.billing.SendPaymentRequiredEmailRequest(*, customer_org_id: str = ..., billing_owner_org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

customer_org_id: str

billing_owner_org_id: str

class viam.proto.app.billing.SendPaymentRequiredEmailResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.billing.SourceType: Bases: _SourceType

class viam.proto.app.billing.UsageCost(*, resource_type: global___UsageCostType = ..., cost: float = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

resource_type: global___UsageCostType

cost: float

class viam.proto.app.billing.UsageCostType: Bases: _UsageCostType