Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ [RUM-7019] Add Account properties #241

Merged
merged 1 commit into from
Jan 7, 2025
Merged

✨ [RUM-7019] Add Account properties #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions lib/cjs/generated/rum.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1245,6 +1245,20 @@ export interface CommonProperties {
readonly anonymous_id?: string;
[k: string]: unknown;
};
/**
* Account properties
*/
readonly account?: {
/**
* Identifier of the account
*/
readonly id: string;
/**
* Name of the account
*/
readonly name?: string;
[k: string]: unknown;
};
/**
* Device connectivity properties
*/
Expand Down
9 changes: 8 additions & 1 deletion lib/cjs/generated/telemetry.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ export declare type TelemetryUsageEvent = CommonTelemetryProperties & {
/**
* Schema of features usage common across SDKs
*/
export declare type TelemetryCommonFeaturesUsage = SetTrackingConsent | StopSession | StartView | AddAction | AddError | SetGlobalContext | SetUser | AddFeatureFlagEvaluation;
export declare type TelemetryCommonFeaturesUsage = SetTrackingConsent | StopSession | StartView | AddAction | AddError | SetGlobalContext | SetUser | SetAccount | AddFeatureFlagEvaluation;
/**
* Schema of browser specific features usage
*/
Expand Down Expand Up @@ -592,6 +592,13 @@ export interface SetUser {
feature: 'set-user';
[k: string]: unknown;
}
export interface SetAccount {
/**
* setAccount, setAccountProperty APIs
*/
feature: 'set-account';
[k: string]: unknown;
}
export interface AddFeatureFlagEvaluation {
/**
* addFeatureFlagEvaluation API
Expand Down
14 changes: 14 additions & 0 deletions lib/esm/generated/rum.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1245,6 +1245,20 @@ export interface CommonProperties {
readonly anonymous_id?: string;
[k: string]: unknown;
};
/**
* Account properties
*/
readonly account?: {
/**
* Identifier of the account
*/
readonly id: string;
/**
* Name of the account
*/
readonly name?: string;
[k: string]: unknown;
};
/**
* Device connectivity properties
*/
Expand Down
9 changes: 8 additions & 1 deletion lib/esm/generated/telemetry.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ export declare type TelemetryUsageEvent = CommonTelemetryProperties & {
/**
* Schema of features usage common across SDKs
*/
export declare type TelemetryCommonFeaturesUsage = SetTrackingConsent | StopSession | StartView | AddAction | AddError | SetGlobalContext | SetUser | AddFeatureFlagEvaluation;
export declare type TelemetryCommonFeaturesUsage = SetTrackingConsent | StopSession | StartView | AddAction | AddError | SetGlobalContext | SetUser | SetAccount | AddFeatureFlagEvaluation;
/**
* Schema of browser specific features usage
*/
Expand Down Expand Up @@ -592,6 +592,13 @@ export interface SetUser {
feature: 'set-user';
[k: string]: unknown;
}
export interface SetAccount {
/**
* setAccount, setAccountProperty APIs
*/
feature: 'set-account';
[k: string]: unknown;
}
export interface AddFeatureFlagEvaluation {
/**
* addFeatureFlagEvaluation API
Expand Down
19 changes: 19 additions & 0 deletions schemas/rum/_common-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,25 @@
},
"readOnly": true
},
"account": {
"type": "object",
"description": "Account properties",
"additionalProperties": true,
"required": ["id"],
"properties": {
"id": {
"type": "string",
"description": "Identifier of the account",
"readOnly": true
},
"name": {
"type": "string",
"description": "Name of the account",
"readOnly": true
}
},
"readOnly": true
},
"connectivity": {
"type": "object",
"description": "Device connectivity properties",
Expand Down
11 changes: 11 additions & 0 deletions schemas/telemetry/usage/common-features-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,17 @@
}
}
},
{
"required": ["feature"],
"title": "SetAccount",
"properties": {
"feature": {
"type": "string",
"description": "setAccount, setAccountProperty APIs",
"const": "set-account"
}
}
},
{
"required": ["feature"],
"title": "AddFeatureFlagEvaluation",
Expand Down
Loading