`viam.proto.app.billing`

@generated by Viam. Do not edit manually!

Module Contents

Classes

`BillingServiceBase`	Helper class that provides a standard way to create an ABC using
`BillingServiceStub`
`BillableResourceEvent`	Abstract base class for protocol messages.
`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.
`Invoice`	Abstract base class for protocol messages.
`InvoiceSummary`	Abstract base class for protocol messages.
`PaymentMethodCard`	Abstract base class for protocol messages.
`PaymentMethodType`

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

Bases: abc.ABC

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

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

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

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

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

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

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

class viam.proto.app.billing.BillableResourceEvent(*, id: str = ..., type: str = ..., usage_quantity: float = ..., usage_quantity_unit: str = ..., usage_cost: str = ..., occurred_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., user_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.

property occurred_at: google.protobuf.timestamp_pb2.Timestamp

id: str

type: str

usage_quantity: float

usage_quantity_unit: str

usage_cost: str

user_name: str

HasField(field_name: Literal[occurred_at, b'occurred_at']) → 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.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 = ..., 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.

property start_date: google.protobuf.timestamp_pb2.Timestamp

property end_date: google.protobuf.timestamp_pb2.Timestamp

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

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.

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

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

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.

property method: global___PaymentMethodCard: defined if type is PAYMENT_METHOD_TYPE_CARD

type: global___PaymentMethodType

billing_email: str

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

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.Invoice(*, id: str = ..., invoice_date: google.protobuf.timestamp_pb2.Timestamp | None = ..., invoice_amount: float = ..., status: str = ..., due_date: google.protobuf.timestamp_pb2.Timestamp | None = ..., items: collections.abc.Iterable[global___BillableResourceEvent] | None = ..., emailed_to: 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.

property invoice_date: google.protobuf.timestamp_pb2.Timestamp

property due_date: google.protobuf.timestamp_pb2.Timestamp

property items: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BillableResourceEvent]

id: str

invoice_amount: float

status: str

emailed_to: str

HasField(field_name: Literal[due_date, b'due_date', invoice_date, b'invoice_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.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.

property invoice_date: google.protobuf.timestamp_pb2.Timestamp

property due_date: google.protobuf.timestamp_pb2.Timestamp

property paid_date: google.protobuf.timestamp_pb2.Timestamp

id: str

invoice_amount: float

status: str

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

viam.proto.app.billing

Module Contents

Classes

`viam.proto.app.billing`