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`
`PAYMENT_METHOD_TYPE_USBANKACCOUNT`
`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`
`USAGE_COST_TYPE_TABULAR_DATA_CLOUD_STORAGE`
`USAGE_COST_TYPE_CONFIG_HISTORY_CLOUD_STORAGE`
`USAGE_COST_TYPE_LOGS_CLOUD_STORAGE`
`USAGE_COST_TYPE_TRAINING_LOGS_CLOUD_STORAGE`
`USAGE_COST_TYPE_PACKAGES_CLOUD_STORAGE`
`USAGE_COST_TYPE_BINARY_DATA_UPLOAD`
`USAGE_COST_TYPE_TABULAR_DATA_UPLOAD`
`USAGE_COST_TYPE_LOGS_UPLOAD`
`USAGE_COST_TYPE_BINARY_DATA_EGRESS`
`USAGE_COST_TYPE_TABULAR_DATA_EGRESS`
`USAGE_COST_TYPE_LOGS_EGRESS`
`USAGE_COST_TYPE_TRAINING_LOGS_EGRESS`
`USAGE_COST_TYPE_TABULAR_DATA_DATABASE_CLOUD_STORAGE`
`USAGE_COST_TYPE_TABULAR_DATA_DATABASE_COMPUTE`
`USAGE_COST_TYPE_BINARY_DATA_CROSS_REGION_EGRESS`
`USAGE_COST_TYPE_PIPELINE_SINK_CLOUD_STORAGE`
`USAGE_COST_TYPE_PIPELINE_SINK_COMPUTE`
`Global___UsageCostType`
`SOURCE_TYPE_UNSPECIFIED`
`SOURCE_TYPE_ORG`
`SOURCE_TYPE_FRAGMENT`
`Global___SourceType`
`Global___InvoiceSummary`
`Global___PaymentMethodCard`
`Global___VerificationInfo`
`Global___PaymentMethodUSBankAccount`
`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`
`Global___GetAvailableBillingTiersRequest`
`Global___GetAvailableBillingTiersResponse`
`Global___UpdateOrganizationBillingTierRequest`
`Global___UpdateOrganizationBillingTierResponse`
`Global___GetLocationBillingOrganizationRequest`
`Global___GetLocationBillingOrganizationResponse`
`Global___UpdateLocationBillingOrganizationRequest`
`Global___UpdateLocationBillingOrganizationResponse`
`Global___ChargeOrganizationRequest`
`Global___ChargeOrganizationResponse`
`Global___CreateInvoiceAndChargeImmediatelyRequest`
`Global___CreateInvoiceAndChargeImmediatelyResponse`

Classes

`PaymentMethodType`
`UsageCostType`
`SourceType`
`InvoiceSummary`	Abstract base class for protocol messages.
`PaymentMethodCard`	Abstract base class for protocol messages.
`VerificationInfo`	Abstract base class for protocol messages.
`PaymentMethodUSBankAccount`	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.
`GetAvailableBillingTiersRequest`	Abstract base class for protocol messages.
`GetAvailableBillingTiersResponse`	Abstract base class for protocol messages.
`UpdateOrganizationBillingTierRequest`	Abstract base class for protocol messages.
`UpdateOrganizationBillingTierResponse`	Abstract base class for protocol messages.
`GetLocationBillingOrganizationRequest`	Abstract base class for protocol messages.
`GetLocationBillingOrganizationResponse`	Abstract base class for protocol messages.
`UpdateLocationBillingOrganizationRequest`	Abstract base class for protocol messages.
`UpdateLocationBillingOrganizationResponse`	Abstract base class for protocol messages.
`ChargeOrganizationRequest`	Abstract base class for protocol messages.
`ChargeOrganizationResponse`	Abstract base class for protocol messages.
`CreateInvoiceAndChargeImmediatelyRequest`	Deprecated: Use ChargeOrganizationRequest instead
`CreateInvoiceAndChargeImmediatelyResponse`	Deprecated: Use ChargeOrganizationResponse instead

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.PAYMENT_METHOD_TYPE_USBANKACCOUNT: PaymentMethodType

type viam.gen.app.v1.billing_pb2.Global___PaymentMethodType = 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.USAGE_COST_TYPE_TABULAR_DATA_CLOUD_STORAGE: UsageCostType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type viam.gen.app.v1.billing_pb2.Global___UsageCostType = 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

type viam.gen.app.v1.billing_pb2.Global___SourceType = 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

invoice_date() → google.protobuf.timestamp_pb2.Timestamp

due_date() → google.protobuf.timestamp_pb2.Timestamp

paid_date() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.v1.billing_pb2.Global___InvoiceSummary = 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

type viam.gen.app.v1.billing_pb2.Global___PaymentMethodCard = PaymentMethodCard

class viam.gen.app.v1.billing_pb2.VerificationInfo(*, arrival_date: int = ..., hosted_verification_page_url: 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.

arrival_date: int

hosted_verification_page_url: str

type viam.gen.app.v1.billing_pb2.Global___VerificationInfo = VerificationInfo

class viam.gen.app.v1.billing_pb2.PaymentMethodUSBankAccount(*, bank_name: str = ..., last_four_digits_account_number: str = ..., routing_number: str = ..., account_type: str = ..., verification_info: Global___VerificationInfo | 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.

bank_name: str

last_four_digits_account_number: str

routing_number: str

account_type: str

verification_info() → Global___VerificationInfo: this is only set if the account is not verified

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__verification_info) → _WhichOneofReturnType__verification_info | 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

type viam.gen.app.v1.billing_pb2.Global___PaymentMethodUSBankAccount = PaymentMethodUSBankAccount

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

type viam.gen.app.v1.billing_pb2.Global___GetCurrentMonthUsageRequest = 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

type viam.gen.app.v1.billing_pb2.Global___UsageCost = 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

resource_usage_costs() → Global___ResourceUsageCosts

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.v1.billing_pb2.Global___ResourceUsageCostsBySource = 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

usage_costs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___UsageCost]

type viam.gen.app.v1.billing_pb2.Global___ResourceUsageCosts = 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

start_date() → google.protobuf.timestamp_pb2.Timestamp

end_date() → google.protobuf.timestamp_pb2.Timestamp

resource_usage_costs_by_source() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ResourceUsageCostsBySource]

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.app.v1.billing_pb2.Global___GetCurrentMonthUsageResponse = 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

type viam.gen.app.v1.billing_pb2.Global___GetOrgBillingInformationRequest = GetOrgBillingInformationRequest

class viam.gen.app.v1.billing_pb2.GetOrgBillingInformationResponse(*, type: Global___PaymentMethodType = ..., billing_email: str = ..., method: Global___PaymentMethodCard | None = ..., billing_tier: str | None = ..., method_us_bank_account: Global___PaymentMethodUSBankAccount | 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

method() → Global___PaymentMethodCard: defined if type is PAYMENT_METHOD_TYPE_CARD

method_us_bank_account() → Global___PaymentMethodUSBankAccount: defined if type is PAYMENT_METHOD_TYPE_USBANKACCOUNT

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__billing_tier) → _WhichOneofReturnType__billing_tier | None

WhichOneof(oneof_group: _WhichOneofArgType__method) → _WhichOneofReturnType__method | None

WhichOneof(oneof_group: _WhichOneofArgType__method_us_bank_account) → _WhichOneofReturnType__method_us_bank_account | 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

type viam.gen.app.v1.billing_pb2.Global___GetOrgBillingInformationResponse = 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

type viam.gen.app.v1.billing_pb2.Global___GetInvoicesSummaryRequest = 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

invoices() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___InvoiceSummary]: all previous invoices

type viam.gen.app.v1.billing_pb2.Global___GetInvoicesSummaryResponse = 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

type viam.gen.app.v1.billing_pb2.Global___GetInvoicePdfRequest = 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

type viam.gen.app.v1.billing_pb2.Global___GetInvoicePdfResponse = 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

type viam.gen.app.v1.billing_pb2.Global___SendPaymentRequiredEmailRequest = 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.

type viam.gen.app.v1.billing_pb2.Global___SendPaymentRequiredEmailResponse = SendPaymentRequiredEmailResponse

class viam.gen.app.v1.billing_pb2.GetAvailableBillingTiersRequest

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 viam.gen.app.v1.billing_pb2.Global___GetAvailableBillingTiersRequest = GetAvailableBillingTiersRequest

class viam.gen.app.v1.billing_pb2.GetAvailableBillingTiersResponse(*, tiers: collections.abc.Iterable[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.

tiers() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.v1.billing_pb2.Global___GetAvailableBillingTiersResponse = GetAvailableBillingTiersResponse

class viam.gen.app.v1.billing_pb2.UpdateOrganizationBillingTierRequest(*, organization_id: str = ..., billing_tier: 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.

organization_id: str

billing_tier: str

type viam.gen.app.v1.billing_pb2.Global___UpdateOrganizationBillingTierRequest = UpdateOrganizationBillingTierRequest

class viam.gen.app.v1.billing_pb2.UpdateOrganizationBillingTierResponse

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 viam.gen.app.v1.billing_pb2.Global___UpdateOrganizationBillingTierResponse = UpdateOrganizationBillingTierResponse

class viam.gen.app.v1.billing_pb2.GetLocationBillingOrganizationRequest(*, location_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.

location_id: str

type viam.gen.app.v1.billing_pb2.Global___GetLocationBillingOrganizationRequest = GetLocationBillingOrganizationRequest

class viam.gen.app.v1.billing_pb2.GetLocationBillingOrganizationResponse(*, billing_organization_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.

billing_organization_id: str

type viam.gen.app.v1.billing_pb2.Global___GetLocationBillingOrganizationResponse = GetLocationBillingOrganizationResponse

class viam.gen.app.v1.billing_pb2.UpdateLocationBillingOrganizationRequest(*, location_id: str = ..., billing_organization_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.

location_id: str

billing_organization_id: str

type viam.gen.app.v1.billing_pb2.Global___UpdateLocationBillingOrganizationRequest = UpdateLocationBillingOrganizationRequest

class viam.gen.app.v1.billing_pb2.UpdateLocationBillingOrganizationResponse

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 viam.gen.app.v1.billing_pb2.Global___UpdateLocationBillingOrganizationResponse = UpdateLocationBillingOrganizationResponse

class viam.gen.app.v1.billing_pb2.ChargeOrganizationRequest(*, org_id_to_charge: str = ..., description: str | None = ..., subtotal: float = ..., tax: float = ..., org_id_for_branding: str | None = ..., disable_confirmation_email: bool = ...)

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_to_charge: str

description: str

subtotal: float

tax: float

org_id_for_branding: str

disable_confirmation_email: bool

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__description) → _WhichOneofReturnType__description | None

WhichOneof(oneof_group: _WhichOneofArgType__org_id_for_branding) → _WhichOneofReturnType__org_id_for_branding | 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

type viam.gen.app.v1.billing_pb2.Global___ChargeOrganizationRequest = ChargeOrganizationRequest

class viam.gen.app.v1.billing_pb2.ChargeOrganizationResponse(*, invoice_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.

invoice_id: str

type viam.gen.app.v1.billing_pb2.Global___ChargeOrganizationResponse = ChargeOrganizationResponse

class viam.gen.app.v1.billing_pb2.CreateInvoiceAndChargeImmediatelyRequest(*, org_id_to_charge: str = ..., amount: float = ..., description: str | None = ..., org_id_for_branding: str | None = ..., disable_email: bool = ...)

Bases: google.protobuf.message.Message

Deprecated: Use ChargeOrganizationRequest instead

org_id_to_charge: str

amount: float

description: str

org_id_for_branding: str

disable_email: bool

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__description) → _WhichOneofReturnType__description | None

WhichOneof(oneof_group: _WhichOneofArgType__org_id_for_branding) → _WhichOneofReturnType__org_id_for_branding | 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

type viam.gen.app.v1.billing_pb2.Global___CreateInvoiceAndChargeImmediatelyRequest = CreateInvoiceAndChargeImmediatelyRequest

class viam.gen.app.v1.billing_pb2.CreateInvoiceAndChargeImmediatelyResponse(*, invoice_id: str = ...)

Bases: google.protobuf.message.Message

Deprecated: Use ChargeOrganizationResponse instead

invoice_id: str

type viam.gen.app.v1.billing_pb2.Global___CreateInvoiceAndChargeImmediatelyResponse = CreateInvoiceAndChargeImmediatelyResponse