viam.gen.app.v1.billing_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes

`DESCRIPTOR`
`PAYMENT_METHOD_TYPE_UNSPECIFIED`
`PAYMENT_METHOD_TYPE_CARD`
`global___PaymentMethodType`
`USAGE_COST_TYPE_UNSPECIFIED`
`USAGE_COST_TYPE_DATA_UPLOAD`
`USAGE_COST_TYPE_DATA_EGRESS`
`USAGE_COST_TYPE_REMOTE_CONTROL`
`USAGE_COST_TYPE_STANDARD_COMPUTE`
`USAGE_COST_TYPE_CLOUD_STORAGE`
`USAGE_COST_TYPE_BINARY_DATA_CLOUD_STORAGE`
`USAGE_COST_TYPE_OTHER_CLOUD_STORAGE`
`USAGE_COST_TYPE_PER_MACHINE`
`USAGE_COST_TYPE_TRIGGER_NOTIFICATION`
`global___UsageCostType`
`SOURCE_TYPE_UNSPECIFIED`
`SOURCE_TYPE_ORG`
`SOURCE_TYPE_FRAGMENT`
`global___SourceType`
`global___InvoiceSummary`
`global___PaymentMethodCard`
`global___GetCurrentMonthUsageRequest`
`global___UsageCost`
`global___ResourceUsageCostsBySource`
`global___ResourceUsageCosts`
`global___GetCurrentMonthUsageResponse`
`global___GetOrgBillingInformationRequest`
`global___GetOrgBillingInformationResponse`
`global___GetInvoicesSummaryRequest`
`global___GetInvoicesSummaryResponse`
`global___GetInvoicePdfRequest`
`global___GetInvoicePdfResponse`
`global___SendPaymentRequiredEmailRequest`
`global___SendPaymentRequiredEmailResponse`

Classes

`PaymentMethodType`
`UsageCostType`
`SourceType`
`InvoiceSummary`	Abstract base class for protocol messages.
`PaymentMethodCard`	Abstract base class for protocol messages.
`GetCurrentMonthUsageRequest`	Abstract base class for protocol messages.
`UsageCost`	Abstract base class for protocol messages.
`ResourceUsageCostsBySource`	Abstract base class for protocol messages.
`ResourceUsageCosts`	Abstract base class for protocol messages.
`GetCurrentMonthUsageResponse`	Abstract base class for protocol messages.
`GetOrgBillingInformationRequest`	Abstract base class for protocol messages.
`GetOrgBillingInformationResponse`	Abstract base class for protocol messages.
`GetInvoicesSummaryRequest`	Abstract base class for protocol messages.
`GetInvoicesSummaryResponse`	Abstract base class for protocol messages.
`GetInvoicePdfRequest`	Abstract base class for protocol messages.
`GetInvoicePdfResponse`	Abstract base class for protocol messages.
`SendPaymentRequiredEmailRequest`	Abstract base class for protocol messages.
`SendPaymentRequiredEmailResponse`	Abstract base class for protocol messages.

Module Contents

viam.gen.app.v1.billing_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.app.v1.billing_pb2.PaymentMethodType: Bases: _PaymentMethodType

viam.gen.app.v1.billing_pb2.PAYMENT_METHOD_TYPE_UNSPECIFIED: PaymentMethodType

viam.gen.app.v1.billing_pb2.PAYMENT_METHOD_TYPE_CARD: PaymentMethodType

viam.gen.app.v1.billing_pb2.global___PaymentMethodType

class viam.gen.app.v1.billing_pb2.UsageCostType: Bases: _UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_UNSPECIFIED: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_DATA_UPLOAD: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_DATA_EGRESS: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_REMOTE_CONTROL: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_STANDARD_COMPUTE: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_CLOUD_STORAGE: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_BINARY_DATA_CLOUD_STORAGE: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_OTHER_CLOUD_STORAGE: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_PER_MACHINE: UsageCostType

viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TRIGGER_NOTIFICATION: UsageCostType

viam.gen.app.v1.billing_pb2.global___UsageCostType

class viam.gen.app.v1.billing_pb2.SourceType: Bases: _SourceType

viam.gen.app.v1.billing_pb2.SOURCE_TYPE_UNSPECIFIED: SourceType

viam.gen.app.v1.billing_pb2.SOURCE_TYPE_ORG: SourceType

viam.gen.app.v1.billing_pb2.SOURCE_TYPE_FRAGMENT: SourceType

viam.gen.app.v1.billing_pb2.global___SourceType

class viam.gen.app.v1.billing_pb2.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.

viam.gen.app.v1.billing_pb2.global___InvoiceSummary

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___PaymentMethodCard

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___GetCurrentMonthUsageRequest

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___UsageCost

class viam.gen.app.v1.billing_pb2.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.

viam.gen.app.v1.billing_pb2.global___ResourceUsageCostsBySource

class viam.gen.app.v1.billing_pb2.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]

viam.gen.app.v1.billing_pb2.global___ResourceUsageCosts

class viam.gen.app.v1.billing_pb2.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.

viam.gen.app.v1.billing_pb2.global___GetCurrentMonthUsageResponse

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___GetOrgBillingInformationRequest

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___GetOrgBillingInformationResponse

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___GetInvoicesSummaryRequest

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___GetInvoicesSummaryResponse

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___GetInvoicePdfRequest

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___GetInvoicePdfResponse

class viam.gen.app.v1.billing_pb2.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

viam.gen.app.v1.billing_pb2.global___SendPaymentRequiredEmailRequest

class viam.gen.app.v1.billing_pb2.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.

viam.gen.app.v1.billing_pb2.global___SendPaymentRequiredEmailResponse