Documentation ¶
Index ¶
- Variables
- type Alphanumeric
- type Country
- type E164
- type ImeiSv
- type Imsi
- type IpAddressV4
- type National
- type NetworkIdentity
- func (*NetworkIdentity) Descriptor() ([]byte, []int)deprecated
- func (x *NetworkIdentity) GetMcc() string
- func (x *NetworkIdentity) GetMnc() string
- func (*NetworkIdentity) ProtoMessage()
- func (x *NetworkIdentity) ProtoReflect() protoreflect.Message
- func (x *NetworkIdentity) Reset()
- func (x *NetworkIdentity) String() string
- type SubscriptionIdentifier
- func (*SubscriptionIdentifier) Descriptor() ([]byte, []int)deprecated
- func (x *SubscriptionIdentifier) GetValue() stringdeprecated
- func (x *SubscriptionIdentifier) GetWg2Rn() string
- func (*SubscriptionIdentifier) ProtoMessage()
- func (x *SubscriptionIdentifier) ProtoReflect() protoreflect.Message
- func (x *SubscriptionIdentifier) Reset()
- func (x *SubscriptionIdentifier) String() string
Constants ¶
This section is empty.
Variables ¶
var File_wgtwo_common_v1_phonenumber_proto protoreflect.FileDescriptor
var File_wgtwo_common_v1_types_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Alphanumeric ¶
type Alphanumeric struct { // The value as a string, e.g.: `"MyService"` Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"` // contains filtered or unexported fields }
* An alphanumeric address. This is usually just be the name of a product or service. Alphanumeric addresses are usually not routable, and can thus only be used in origin addresses.
func (*Alphanumeric) Descriptor
deprecated
func (*Alphanumeric) Descriptor() ([]byte, []int)
Deprecated: Use Alphanumeric.ProtoReflect.Descriptor instead.
func (*Alphanumeric) GetText ¶
func (x *Alphanumeric) GetText() string
func (*Alphanumeric) ProtoMessage ¶
func (*Alphanumeric) ProtoMessage()
func (*Alphanumeric) ProtoReflect ¶
func (x *Alphanumeric) ProtoReflect() protoreflect.Message
func (*Alphanumeric) Reset ¶
func (x *Alphanumeric) Reset()
func (*Alphanumeric) String ¶
func (x *Alphanumeric) String() string
type Country ¶
type Country struct { // ISO 3166-1 alpha-2 code. Examples: US, NO, SE Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"` // Human readable name Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
Country information
All programmatic use should depend on the alpha-2 code, and NOT the human readable name
func (*Country) Descriptor
deprecated
func (*Country) ProtoMessage ¶
func (*Country) ProtoMessage()
func (*Country) ProtoReflect ¶
func (x *Country) ProtoReflect() protoreflect.Message
type E164 ¶
type E164 struct { // The value as a string, e.g.: `"+4787654321"` E164 string `protobuf:"bytes,1,opt,name=e164,proto3" json:"e164,omitempty"` // contains filtered or unexported fields }
* An international phone number formatted as E.164 with leading plus sign
This contains three components: - The plus prefix - Country code, 1 to 3 digits - Subscriber number
Example "+4787654321" as '+' '47' '87654321'.
The number may contain sequences that do not strictly conform to the E.164 number standard (e.g. too long), but shall always follow the three components as described above.
func (*E164) Descriptor
deprecated
func (*E164) ProtoMessage ¶
func (*E164) ProtoMessage()
func (*E164) ProtoReflect ¶
func (x *E164) ProtoReflect() protoreflect.Message
type ImeiSv ¶
type ImeiSv struct { // The imei as a string. Imei string `protobuf:"bytes,1,opt,name=imei,proto3" json:"imei,omitempty"` // The software version as a string. SoftwareVersion string `protobuf:"bytes,2,opt,name=software_version,json=softwareVersion,proto3" json:"software_version,omitempty"` // contains filtered or unexported fields }
International Mobile station Equipment Identity and Software Version number An IMEI is composed of four parts:
- an 8 digit Type Allocation Code (TAC);
- a 6 digit Serial Number (SNR);
- an optional Check Digit (CD); and
- an optional 2 digit Software Version Number (handled separately).
For more information see ETSI 123.003 Chapter 6 and Appendix B.
func (*ImeiSv) Descriptor
deprecated
func (*ImeiSv) GetSoftwareVersion ¶
func (*ImeiSv) ProtoMessage ¶
func (*ImeiSv) ProtoMessage()
func (*ImeiSv) ProtoReflect ¶
func (x *ImeiSv) ProtoReflect() protoreflect.Message
type Imsi ¶
type Imsi struct { // The value of the imsi as a string. Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
International Mobile Subscription Identity An IMSI is composed of three parts:
- Mobile Country Code (MCC) consisting of three digits. The MCC is 3 digits long and identifies uniquely the country of domicile of the mobile subscription;
- Mobile Network Code (MNC), 2 or 3 digits for 3GPP network applications. The MNC identifies the home PLMN of the mobile subscription. The length of the MNC depends on the value of the MCC. A mixture of two and three digit MNC codes within a single MCC area is not recommended.
- Mobile Subscriber Identification Number (MSIN) identifying the mobile subscription within a PLMN. Normally there are 10 digits, but can be fewer in the case of a 3-digit MNC or if national regulations indicate that the total length of the IMSI should be less than 15 digits.
func (*Imsi) Descriptor
deprecated
func (*Imsi) ProtoMessage ¶
func (*Imsi) ProtoMessage()
func (*Imsi) ProtoReflect ¶
func (x *Imsi) ProtoReflect() protoreflect.Message
type IpAddressV4 ¶ added in v0.1.3
type IpAddressV4 struct { // The ip address as a string. Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
IpAddress v4
func (*IpAddressV4) Descriptor
deprecated
added in
v0.1.3
func (*IpAddressV4) Descriptor() ([]byte, []int)
Deprecated: Use IpAddressV4.ProtoReflect.Descriptor instead.
func (*IpAddressV4) GetValue ¶ added in v0.1.3
func (x *IpAddressV4) GetValue() string
func (*IpAddressV4) ProtoMessage ¶ added in v0.1.3
func (*IpAddressV4) ProtoMessage()
func (*IpAddressV4) ProtoReflect ¶ added in v0.1.3
func (x *IpAddressV4) ProtoReflect() protoreflect.Message
func (*IpAddressV4) Reset ¶ added in v0.1.3
func (x *IpAddressV4) Reset()
func (*IpAddressV4) String ¶ added in v0.1.3
func (x *IpAddressV4) String() string
type National ¶
type National struct { // The value as a string, e.g.: `"87654321"` Number string `protobuf:"bytes,1,opt,name=number,proto3" json:"number,omitempty"` // contains filtered or unexported fields }
* A national number can be anything that is usually typed into a number field for phone numbers, SMS etc. It shall only contains digits (0-9), and the meaning of the number sequence is dependent on the country of the relevant operator.
func (*National) Descriptor
deprecated
func (*National) ProtoMessage ¶
func (*National) ProtoMessage()
func (*National) ProtoReflect ¶
func (x *National) ProtoReflect() protoreflect.Message
type NetworkIdentity ¶
type NetworkIdentity struct { // Mobile Country Code, e.g. `"262"` for Germany. Mcc string `protobuf:"bytes,1,opt,name=mcc,proto3" json:"mcc,omitempty"` // Mobile Network Code, e.g. `"01"` for T-Mobile Germany, when mcc is `"262"`. Mnc string `protobuf:"bytes,2,opt,name=mnc,proto3" json:"mnc,omitempty"` // contains filtered or unexported fields }
Home network identity; composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC).
func (*NetworkIdentity) Descriptor
deprecated
func (*NetworkIdentity) Descriptor() ([]byte, []int)
Deprecated: Use NetworkIdentity.ProtoReflect.Descriptor instead.
func (*NetworkIdentity) GetMcc ¶
func (x *NetworkIdentity) GetMcc() string
func (*NetworkIdentity) GetMnc ¶
func (x *NetworkIdentity) GetMnc() string
func (*NetworkIdentity) ProtoMessage ¶
func (*NetworkIdentity) ProtoMessage()
func (*NetworkIdentity) ProtoReflect ¶
func (x *NetworkIdentity) ProtoReflect() protoreflect.Message
func (*NetworkIdentity) Reset ¶
func (x *NetworkIdentity) Reset()
func (*NetworkIdentity) String ¶
func (x *NetworkIdentity) String() string
type SubscriptionIdentifier ¶
type SubscriptionIdentifier struct { // Deprecated: Marked as deprecated in wgtwo/common/v1/types.proto. Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // The value of the Subscription identifier as a string Wg2Rn string `protobuf:"bytes,2,opt,name=wg2rn,proto3" json:"wg2rn,omitempty"` // contains filtered or unexported fields }
Subscription Identification: The `wg2rn` field follows the format `{tenant}:{region}:{id}`, where: - `tenant`: The tenant to which this subscription belongs - `region`: The region code of the subscription's MSISDN - `id`: A static identifier for the subscription
The `wg2rn` uniquely identifies a subscription.
Note: Our OAuth 2.0 server supports Pairwise Pseudonymous Identifiers for the 'sub' field. All clients of a product share the same identifier for a single subscription, stored in the 'value' field. Please be aware that the 'value' field is deprecated and will be removed in the future.
func (*SubscriptionIdentifier) Descriptor
deprecated
func (*SubscriptionIdentifier) Descriptor() ([]byte, []int)
Deprecated: Use SubscriptionIdentifier.ProtoReflect.Descriptor instead.
func (*SubscriptionIdentifier) GetValue
deprecated
func (x *SubscriptionIdentifier) GetValue() string
Deprecated: Marked as deprecated in wgtwo/common/v1/types.proto.
func (*SubscriptionIdentifier) GetWg2Rn ¶ added in v0.1.7
func (x *SubscriptionIdentifier) GetWg2Rn() string
func (*SubscriptionIdentifier) ProtoMessage ¶
func (*SubscriptionIdentifier) ProtoMessage()
func (*SubscriptionIdentifier) ProtoReflect ¶
func (x *SubscriptionIdentifier) ProtoReflect() protoreflect.Message
func (*SubscriptionIdentifier) Reset ¶
func (x *SubscriptionIdentifier) Reset()
func (*SubscriptionIdentifier) String ¶
func (x *SubscriptionIdentifier) String() string