viam.gen.app.v1.billing_pb2 =========================== .. py:module:: viam.gen.app.v1.billing_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Attributes ---------- .. autoapisummary:: viam.gen.app.v1.billing_pb2.DESCRIPTOR viam.gen.app.v1.billing_pb2.PAYMENT_METHOD_TYPE_UNSPECIFIED viam.gen.app.v1.billing_pb2.PAYMENT_METHOD_TYPE_CARD viam.gen.app.v1.billing_pb2.PAYMENT_METHOD_TYPE_USBANKACCOUNT viam.gen.app.v1.billing_pb2.Global___PaymentMethodType viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_UNSPECIFIED viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_DATA_UPLOAD viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_DATA_EGRESS viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_REMOTE_CONTROL viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_STANDARD_COMPUTE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_BINARY_DATA_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_OTHER_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_PER_MACHINE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TRIGGER_NOTIFICATION viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TABULAR_DATA_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_CONFIG_HISTORY_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_LOGS_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TRAINING_LOGS_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_PACKAGES_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_BINARY_DATA_UPLOAD viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TABULAR_DATA_UPLOAD viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_LOGS_UPLOAD viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_BINARY_DATA_EGRESS viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TABULAR_DATA_EGRESS viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_LOGS_EGRESS viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TRAINING_LOGS_EGRESS viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TABULAR_DATA_DATABASE_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_TABULAR_DATA_DATABASE_COMPUTE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_BINARY_DATA_CROSS_REGION_EGRESS viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_PIPELINE_SINK_CLOUD_STORAGE viam.gen.app.v1.billing_pb2.USAGE_COST_TYPE_PIPELINE_SINK_COMPUTE viam.gen.app.v1.billing_pb2.Global___UsageCostType viam.gen.app.v1.billing_pb2.SOURCE_TYPE_UNSPECIFIED viam.gen.app.v1.billing_pb2.SOURCE_TYPE_ORG viam.gen.app.v1.billing_pb2.SOURCE_TYPE_FRAGMENT viam.gen.app.v1.billing_pb2.Global___SourceType viam.gen.app.v1.billing_pb2.Global___InvoiceSummary viam.gen.app.v1.billing_pb2.Global___PaymentMethodCard viam.gen.app.v1.billing_pb2.Global___VerificationInfo viam.gen.app.v1.billing_pb2.Global___PaymentMethodUSBankAccount viam.gen.app.v1.billing_pb2.Global___GetCurrentMonthUsageRequest viam.gen.app.v1.billing_pb2.Global___UsageCost viam.gen.app.v1.billing_pb2.Global___ResourceUsageCostsBySource viam.gen.app.v1.billing_pb2.Global___ResourceUsageCosts viam.gen.app.v1.billing_pb2.Global___GetCurrentMonthUsageResponse viam.gen.app.v1.billing_pb2.Global___GetOrgBillingInformationRequest viam.gen.app.v1.billing_pb2.Global___GetOrgBillingInformationResponse viam.gen.app.v1.billing_pb2.Global___GetInvoicesSummaryRequest viam.gen.app.v1.billing_pb2.Global___GetInvoicesSummaryResponse viam.gen.app.v1.billing_pb2.Global___GetInvoicePdfRequest viam.gen.app.v1.billing_pb2.Global___GetInvoicePdfResponse viam.gen.app.v1.billing_pb2.Global___SendPaymentRequiredEmailRequest viam.gen.app.v1.billing_pb2.Global___SendPaymentRequiredEmailResponse viam.gen.app.v1.billing_pb2.Global___GetAvailableBillingTiersRequest viam.gen.app.v1.billing_pb2.Global___GetAvailableBillingTiersResponse viam.gen.app.v1.billing_pb2.Global___UpdateOrganizationBillingTierRequest viam.gen.app.v1.billing_pb2.Global___UpdateOrganizationBillingTierResponse viam.gen.app.v1.billing_pb2.Global___GetLocationBillingOrganizationRequest viam.gen.app.v1.billing_pb2.Global___GetLocationBillingOrganizationResponse viam.gen.app.v1.billing_pb2.Global___UpdateLocationBillingOrganizationRequest viam.gen.app.v1.billing_pb2.Global___UpdateLocationBillingOrganizationResponse viam.gen.app.v1.billing_pb2.Global___ChargeOrganizationRequest viam.gen.app.v1.billing_pb2.Global___ChargeOrganizationResponse viam.gen.app.v1.billing_pb2.Global___CreateInvoiceAndChargeImmediatelyRequest viam.gen.app.v1.billing_pb2.Global___CreateInvoiceAndChargeImmediatelyResponse Classes ------- .. autoapisummary:: viam.gen.app.v1.billing_pb2.PaymentMethodType viam.gen.app.v1.billing_pb2.UsageCostType viam.gen.app.v1.billing_pb2.SourceType viam.gen.app.v1.billing_pb2.InvoiceSummary viam.gen.app.v1.billing_pb2.PaymentMethodCard viam.gen.app.v1.billing_pb2.VerificationInfo viam.gen.app.v1.billing_pb2.PaymentMethodUSBankAccount viam.gen.app.v1.billing_pb2.GetCurrentMonthUsageRequest viam.gen.app.v1.billing_pb2.UsageCost viam.gen.app.v1.billing_pb2.ResourceUsageCostsBySource viam.gen.app.v1.billing_pb2.ResourceUsageCosts viam.gen.app.v1.billing_pb2.GetCurrentMonthUsageResponse viam.gen.app.v1.billing_pb2.GetOrgBillingInformationRequest viam.gen.app.v1.billing_pb2.GetOrgBillingInformationResponse viam.gen.app.v1.billing_pb2.GetInvoicesSummaryRequest viam.gen.app.v1.billing_pb2.GetInvoicesSummaryResponse viam.gen.app.v1.billing_pb2.GetInvoicePdfRequest viam.gen.app.v1.billing_pb2.GetInvoicePdfResponse viam.gen.app.v1.billing_pb2.SendPaymentRequiredEmailRequest viam.gen.app.v1.billing_pb2.SendPaymentRequiredEmailResponse viam.gen.app.v1.billing_pb2.GetAvailableBillingTiersRequest viam.gen.app.v1.billing_pb2.GetAvailableBillingTiersResponse viam.gen.app.v1.billing_pb2.UpdateOrganizationBillingTierRequest viam.gen.app.v1.billing_pb2.UpdateOrganizationBillingTierResponse viam.gen.app.v1.billing_pb2.GetLocationBillingOrganizationRequest viam.gen.app.v1.billing_pb2.GetLocationBillingOrganizationResponse viam.gen.app.v1.billing_pb2.UpdateLocationBillingOrganizationRequest viam.gen.app.v1.billing_pb2.UpdateLocationBillingOrganizationResponse viam.gen.app.v1.billing_pb2.ChargeOrganizationRequest viam.gen.app.v1.billing_pb2.ChargeOrganizationResponse viam.gen.app.v1.billing_pb2.CreateInvoiceAndChargeImmediatelyRequest viam.gen.app.v1.billing_pb2.CreateInvoiceAndChargeImmediatelyResponse Module Contents --------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: PaymentMethodType Bases: :py:obj:`_PaymentMethodType` .. py:data:: PAYMENT_METHOD_TYPE_UNSPECIFIED :type: PaymentMethodType .. py:data:: PAYMENT_METHOD_TYPE_CARD :type: PaymentMethodType .. py:data:: PAYMENT_METHOD_TYPE_USBANKACCOUNT :type: PaymentMethodType .. py:type:: Global___PaymentMethodType :canonical: PaymentMethodType .. py:class:: UsageCostType Bases: :py:obj:`_UsageCostType` .. py:data:: USAGE_COST_TYPE_UNSPECIFIED :type: UsageCostType .. py:data:: USAGE_COST_TYPE_DATA_UPLOAD :type: UsageCostType .. py:data:: USAGE_COST_TYPE_DATA_EGRESS :type: UsageCostType .. py:data:: USAGE_COST_TYPE_REMOTE_CONTROL :type: UsageCostType .. py:data:: USAGE_COST_TYPE_STANDARD_COMPUTE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_BINARY_DATA_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_OTHER_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_PER_MACHINE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TRIGGER_NOTIFICATION :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TABULAR_DATA_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_CONFIG_HISTORY_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_LOGS_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TRAINING_LOGS_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_PACKAGES_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_BINARY_DATA_UPLOAD :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TABULAR_DATA_UPLOAD :type: UsageCostType .. py:data:: USAGE_COST_TYPE_LOGS_UPLOAD :type: UsageCostType .. py:data:: USAGE_COST_TYPE_BINARY_DATA_EGRESS :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TABULAR_DATA_EGRESS :type: UsageCostType .. py:data:: USAGE_COST_TYPE_LOGS_EGRESS :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TRAINING_LOGS_EGRESS :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TABULAR_DATA_DATABASE_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_TABULAR_DATA_DATABASE_COMPUTE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_BINARY_DATA_CROSS_REGION_EGRESS :type: UsageCostType .. py:data:: USAGE_COST_TYPE_PIPELINE_SINK_CLOUD_STORAGE :type: UsageCostType .. py:data:: USAGE_COST_TYPE_PIPELINE_SINK_COMPUTE :type: UsageCostType .. py:type:: Global___UsageCostType :canonical: UsageCostType .. py:class:: SourceType Bases: :py:obj:`_SourceType` .. py:data:: SOURCE_TYPE_UNSPECIFIED :type: SourceType .. py:data:: SOURCE_TYPE_ORG :type: SourceType .. py:data:: SOURCE_TYPE_FRAGMENT :type: SourceType .. py:type:: Global___SourceType :canonical: SourceType .. py:class:: 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: :py:obj:`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. .. py:attribute:: id :type: str .. py:attribute:: invoice_amount :type: float .. py:attribute:: status :type: str .. py:method:: invoice_date() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: due_date() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: paid_date() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___InvoiceSummary :canonical: InvoiceSummary .. py:class:: PaymentMethodCard(*, brand: str = ..., last_four_digits: str = ...) Bases: :py:obj:`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. .. py:attribute:: brand :type: str .. py:attribute:: last_four_digits :type: str .. py:type:: Global___PaymentMethodCard :canonical: PaymentMethodCard .. py:class:: VerificationInfo(*, arrival_date: int = ..., hosted_verification_page_url: str = ...) Bases: :py:obj:`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. .. py:attribute:: arrival_date :type: int .. py:attribute:: hosted_verification_page_url :type: str .. py:type:: Global___VerificationInfo :canonical: VerificationInfo .. py:class:: PaymentMethodUSBankAccount(*, bank_name: str = ..., last_four_digits_account_number: str = ..., routing_number: str = ..., account_type: str = ..., verification_info: Global___VerificationInfo | None = ...) Bases: :py:obj:`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. .. py:attribute:: bank_name :type: str .. py:attribute:: last_four_digits_account_number :type: str .. py:attribute:: routing_number :type: str .. py:attribute:: account_type :type: str .. py:method:: verification_info() -> Global___VerificationInfo this is only set if the account is not verified .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___PaymentMethodUSBankAccount :canonical: PaymentMethodUSBankAccount .. py:class:: GetCurrentMonthUsageRequest(*, org_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: org_id :type: str .. py:type:: Global___GetCurrentMonthUsageRequest :canonical: GetCurrentMonthUsageRequest .. py:class:: UsageCost(*, resource_type: Global___UsageCostType = ..., cost: float = ...) Bases: :py:obj:`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. .. py:attribute:: resource_type :type: Global___UsageCostType .. py:attribute:: cost :type: float .. py:type:: Global___UsageCost :canonical: UsageCost .. py:class:: ResourceUsageCostsBySource(*, source_type: Global___SourceType = ..., resource_usage_costs: Global___ResourceUsageCosts | None = ..., tier_name: str = ...) Bases: :py:obj:`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. .. py:attribute:: source_type :type: Global___SourceType .. py:attribute:: tier_name :type: str .. py:method:: resource_usage_costs() -> Global___ResourceUsageCosts .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___ResourceUsageCostsBySource :canonical: ResourceUsageCostsBySource .. py:class:: ResourceUsageCosts(*, usage_costs: collections.abc.Iterable[Global___UsageCost] | None = ..., discount: float = ..., total_with_discount: float = ..., total_without_discount: float = ...) Bases: :py:obj:`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. .. py:attribute:: discount :type: float .. py:attribute:: total_with_discount :type: float .. py:attribute:: total_without_discount :type: float .. py:method:: usage_costs() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___UsageCost] .. py:type:: Global___ResourceUsageCosts :canonical: ResourceUsageCosts .. py:class:: 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: :py:obj:`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. .. py:attribute:: subtotal :type: float .. py:method:: cloud_storage_usage_cost() -> float all fields below are deprecated .. py:method:: data_upload_usage_cost() -> float .. py:method:: data_egres_usage_cost() -> float .. py:method:: remote_control_usage_cost() -> float .. py:method:: standard_compute_usage_cost() -> float .. py:method:: discount_amount() -> float .. py:method:: total_usage_with_discount() -> float .. py:method:: total_usage_without_discount() -> float .. py:method:: per_machine_usage_cost() -> float .. py:method:: binary_data_cloud_storage_usage_cost() -> float .. py:method:: other_cloud_storage_usage_cost() -> float .. py:method:: start_date() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: end_date() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: resource_usage_costs_by_source() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ResourceUsageCostsBySource] .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___GetCurrentMonthUsageResponse :canonical: GetCurrentMonthUsageResponse .. py:class:: GetOrgBillingInformationRequest(*, org_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: org_id :type: str .. py:type:: Global___GetOrgBillingInformationRequest :canonical: GetOrgBillingInformationRequest .. py:class:: GetOrgBillingInformationResponse(*, type: Global___PaymentMethodType = ..., billing_email: str = ..., method: Global___PaymentMethodCard | None = ..., billing_tier: str | None = ..., method_us_bank_account: Global___PaymentMethodUSBankAccount | None = ...) Bases: :py:obj:`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. .. py:attribute:: type :type: Global___PaymentMethodType .. py:attribute:: billing_email :type: str .. py:attribute:: billing_tier :type: str Only return billing_tier for billing dashboard admin users .. py:method:: method() -> Global___PaymentMethodCard defined if type is PAYMENT_METHOD_TYPE_CARD .. py:method:: method_us_bank_account() -> Global___PaymentMethodUSBankAccount defined if type is PAYMENT_METHOD_TYPE_USBANKACCOUNT .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___GetOrgBillingInformationResponse :canonical: GetOrgBillingInformationResponse .. py:class:: GetInvoicesSummaryRequest(*, org_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: org_id :type: str .. py:type:: Global___GetInvoicesSummaryRequest :canonical: GetInvoicesSummaryRequest .. py:class:: GetInvoicesSummaryResponse(*, outstanding_balance: float = ..., invoices: collections.abc.Iterable[Global___InvoiceSummary] | None = ...) Bases: :py:obj:`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. .. py:attribute:: outstanding_balance :type: float all unpaid balances at the end of the last billing cycle .. py:method:: invoices() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___InvoiceSummary] all previous invoices .. py:type:: Global___GetInvoicesSummaryResponse :canonical: GetInvoicesSummaryResponse .. py:class:: GetInvoicePdfRequest(*, id: str = ..., org_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str .. py:attribute:: org_id :type: str .. py:type:: Global___GetInvoicePdfRequest :canonical: GetInvoicePdfRequest .. py:class:: GetInvoicePdfResponse(*, chunk: bytes = ...) Bases: :py:obj:`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. .. py:attribute:: chunk :type: bytes .. py:type:: Global___GetInvoicePdfResponse :canonical: GetInvoicePdfResponse .. py:class:: SendPaymentRequiredEmailRequest(*, customer_org_id: str = ..., billing_owner_org_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: customer_org_id :type: str .. py:attribute:: billing_owner_org_id :type: str .. py:type:: Global___SendPaymentRequiredEmailRequest :canonical: SendPaymentRequiredEmailRequest .. py:class:: SendPaymentRequiredEmailResponse Bases: :py:obj:`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. .. py:type:: Global___SendPaymentRequiredEmailResponse :canonical: SendPaymentRequiredEmailResponse .. py:class:: GetAvailableBillingTiersRequest Bases: :py:obj:`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. .. py:type:: Global___GetAvailableBillingTiersRequest :canonical: GetAvailableBillingTiersRequest .. py:class:: GetAvailableBillingTiersResponse(*, tiers: collections.abc.Iterable[str] | None = ...) Bases: :py:obj:`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. .. py:method:: tiers() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:type:: Global___GetAvailableBillingTiersResponse :canonical: GetAvailableBillingTiersResponse .. py:class:: UpdateOrganizationBillingTierRequest(*, organization_id: str = ..., billing_tier: str = ...) Bases: :py:obj:`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. .. py:attribute:: organization_id :type: str .. py:attribute:: billing_tier :type: str .. py:type:: Global___UpdateOrganizationBillingTierRequest :canonical: UpdateOrganizationBillingTierRequest .. py:class:: UpdateOrganizationBillingTierResponse Bases: :py:obj:`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. .. py:type:: Global___UpdateOrganizationBillingTierResponse :canonical: UpdateOrganizationBillingTierResponse .. py:class:: GetLocationBillingOrganizationRequest(*, location_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: location_id :type: str .. py:type:: Global___GetLocationBillingOrganizationRequest :canonical: GetLocationBillingOrganizationRequest .. py:class:: GetLocationBillingOrganizationResponse(*, billing_organization_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: billing_organization_id :type: str .. py:type:: Global___GetLocationBillingOrganizationResponse :canonical: GetLocationBillingOrganizationResponse .. py:class:: UpdateLocationBillingOrganizationRequest(*, location_id: str = ..., billing_organization_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: location_id :type: str .. py:attribute:: billing_organization_id :type: str .. py:type:: Global___UpdateLocationBillingOrganizationRequest :canonical: UpdateLocationBillingOrganizationRequest .. py:class:: UpdateLocationBillingOrganizationResponse Bases: :py:obj:`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. .. py:type:: Global___UpdateLocationBillingOrganizationResponse :canonical: UpdateLocationBillingOrganizationResponse .. py:class:: ChargeOrganizationRequest(*, org_id_to_charge: str = ..., description: str | None = ..., subtotal: float = ..., tax: float = ..., org_id_for_branding: str | None = ..., disable_confirmation_email: bool = ...) Bases: :py:obj:`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. .. py:attribute:: org_id_to_charge :type: str .. py:attribute:: description :type: str .. py:attribute:: subtotal :type: float .. py:attribute:: tax :type: float .. py:attribute:: org_id_for_branding :type: str .. py:attribute:: disable_confirmation_email :type: bool .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___ChargeOrganizationRequest :canonical: ChargeOrganizationRequest .. py:class:: ChargeOrganizationResponse(*, invoice_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: invoice_id :type: str .. py:type:: Global___ChargeOrganizationResponse :canonical: ChargeOrganizationResponse .. py:class:: CreateInvoiceAndChargeImmediatelyRequest(*, org_id_to_charge: str = ..., amount: float = ..., description: str | None = ..., org_id_for_branding: str | None = ..., disable_email: bool = ...) Bases: :py:obj:`google.protobuf.message.Message` Deprecated: Use ChargeOrganizationRequest instead .. py:attribute:: org_id_to_charge :type: str .. py:attribute:: amount :type: float .. py:attribute:: description :type: str .. py:attribute:: org_id_for_branding :type: str .. py:attribute:: disable_email :type: bool .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: 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. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___CreateInvoiceAndChargeImmediatelyRequest :canonical: CreateInvoiceAndChargeImmediatelyRequest .. py:class:: CreateInvoiceAndChargeImmediatelyResponse(*, invoice_id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Deprecated: Use ChargeOrganizationResponse instead .. py:attribute:: invoice_id :type: str .. py:type:: Global___CreateInvoiceAndChargeImmediatelyResponse :canonical: CreateInvoiceAndChargeImmediatelyResponse