Firm class

Inheritance

Constructors

Firm({String? firmId, String? name, @Deprecated('This field is deprecated.') String? subscriptionPlan, @Deprecated('This field is deprecated.') int? subscriptionSeats, @Deprecated('This field is deprecated.') Timestamp? subscriptionStartTimestampUTC, @Deprecated('This field is deprecated.') Timestamp? subscriptionEndTimestampUTC, bool? status, Timestamp? statusUpdateTimestampUTC, Timestamp? lastUpdateTimestampUTC, String? lastUpdatedByuserId, bool? isMailVerified, Timestamp? creationDateUTC, String? stripeCustomerId, Iterable<License>? licenses, Map<String, String>? providerCustomerIds, String? referralCode, int? referralCreditBalanceCents, String? currency, bool? isDualCurrencyEnabled, String? secondaryDisplayCurrency})
factory
Firm.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
Firm.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

creationDateUTC Timestamp
getter/setter pair
currency String
/ ISO 4217 code (e.g. EUR, XOF). Default for new chains/boutiques; resolved with platform default if empty.
getter/setter pair
firmId String
getter/setter pair
hashCode int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isDualCurrencyEnabled bool
/ When true, clients may show amounts in secondaryDisplayCurrency using per-ticket FX snapshot.
getter/setter pair
isFrozen bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
isMailVerified bool
getter/setter pair
lastUpdatedByuserId String
getter/setter pair
lastUpdateTimestampUTC Timestamp
getter/setter pair
licenses List<License>
/ Active licenses. A firm can have multiple licenses (e.g. add-ons, renewals).
no setter
name String
getter/setter pair
providerCustomerIds Map<String, String>
/ Customer IDs per payment provider. Keys: "stripe", "pawapay", etc.
no setter
referralCode String
/ Per-firm referral code. Share with others; 20% commission on referred license sales.
getter/setter pair
referralCreditBalanceCents int
/ Referral credit balance in EUR cents. Auto-applied at checkout or cash-out above €15.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
secondaryDisplayCurrency String
/ ISO 4217 secondary display code (e.g. USD). Meaningful when dualCurrencyEnabled is true.
getter/setter pair
status bool
getter/setter pair
statusUpdateTimestampUTC Timestamp
getter/setter pair
stripeCustomerId String
getter/setter pair
subscriptionEndTimestampUTC Timestamp
/ @deprecated Use licenses[].validUntil and LicenseSeat.validUntil instead.
getter/setter pair
subscriptionPlan String
/ @deprecated Use licenses instead.
getter/setter pair
subscriptionSeats int
/ @deprecated Use licenses[].maxUsers instead.
getter/setter pair
subscriptionStartTimestampUTC Timestamp
/ @deprecated Use licenses[].validFrom instead.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearCreationDateUTC() → void
clearCurrency() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearFirmId() → void
clearIsDualCurrencyEnabled() → void
clearIsMailVerified() → void
clearLastUpdatedByuserId() → void
clearLastUpdateTimestampUTC() → void
clearName() → void
clearReferralCode() → void
clearReferralCreditBalanceCents() → void
clearSecondaryDisplayCurrency() → void
clearStatus() → void
clearStatusUpdateTimestampUTC() → void
clearStripeCustomerId() → void
clearSubscriptionEndTimestampUTC() → void
clearSubscriptionPlan() → void
clearSubscriptionSeats() → void
clearSubscriptionStartTimestampUTC() → void
clone() Firm
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(Firm)) Firm
Apply updates to a copy of this message.
override
createEmptyInstance() Firm
Creates an empty instance of the same message type as this.
override
ensureCreationDateUTC() Timestamp
ensureLastUpdateTimestampUTC() Timestamp
ensureStatusUpdateTimestampUTC() Timestamp
ensureSubscriptionEndTimestampUTC() Timestamp
ensureSubscriptionStartTimestampUTC() Timestamp
extensionsAreInitialized() bool
inherited
freeze() GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) int?
inherited
hasCreationDateUTC() bool
hasCurrency() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasFirmId() bool
hasIsDualCurrencyEnabled() bool
hasIsMailVerified() bool
hasLastUpdatedByuserId() bool
hasLastUpdateTimestampUTC() bool
hasName() bool
hasReferralCode() bool
hasReferralCreditBalanceCents() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasSecondaryDisplayCurrency() bool
hasStatus() bool
hasStatusUpdateTimestampUTC() bool
hasStripeCustomerId() bool
hasSubscriptionEndTimestampUTC() bool
hasSubscriptionPlan() bool
hasSubscriptionSeats() bool
hasSubscriptionStartTimestampUTC() bool
isInitialized() bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() String
Returns a String representation of this message.
inherited
writeToBuffer() Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

create() Firm
createRepeated() PbList<Firm>
getDefault() Firm