summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/UpkProperty.md
diff options
context:
space:
mode:
authorMax Nanis2026-02-18 20:42:03 -0500
committerMax Nanis2026-02-18 20:42:03 -0500
commit3eaa56f0306ead818f64c3d99fc6d230d9b970a4 (patch)
tree9fecc2f1456e6321572e0e65f57106916df173e2 /jb-ui/src/api_fsb/docs/UpkProperty.md
downloadamt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.tar.gz
amt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.zip
HERE WE GO, HERE WE GO, HERE WE GO
Diffstat (limited to 'jb-ui/src/api_fsb/docs/UpkProperty.md')
-rw-r--r--jb-ui/src/api_fsb/docs/UpkProperty.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/UpkProperty.md b/jb-ui/src/api_fsb/docs/UpkProperty.md
new file mode 100644
index 0000000..8ab4b6e
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/UpkProperty.md
@@ -0,0 +1,35 @@
+# UpkProperty
+
+This used to be called \"QuestionInfo\", which is a bad name, as this describes a UPK Property, like \"educational_attainment\", not the question that asks for your education.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property_id** | **string** | | [default to undefined]
+**property_label** | **string** | | [default to undefined]
+**prop_type** | [**PropertyType**](PropertyType.md) | Allowed values: - __i__ *(UPK_ITEM)*: UserProfileKnowledge Item - __n__ *(UPK_NUMERICAL)*: UserProfileKnowledge Numerical - __x__ *(UPK_TEXT)*: UserProfileKnowledge Text | [optional] [default to undefined]
+**cardinality** | [**Cardinality**](Cardinality.md) | Allowed values: - __*__ *(ZERO_OR_MORE)*: Zero or More - __?__ *(ZERO_OR_ONE)*: Zero or One | [optional] [default to undefined]
+**country_iso** | **string** | | [default to undefined]
+**gold_standard** | **boolean** | A Gold-Standard question has been enumerated for all possible values (per country) as best as possible by GRL,allowing it to be mapped across inventory sources. A property not marked as Gold-Standard may have: 1) marketplace qid associations & 2) category associations, but doesn\'t have a defined \'range\' (list of allowed itemsin a multiple choice question). This is used for exposing a user\'s profiling data & forthe Nudge API. | [optional] [default to false]
+**allowed_items** | [**Array<UpkItem>**](UpkItem.md) | | [optional] [default to undefined]
+**categories** | [**Array<Category>**](Category.md) | | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpkProperty } from './api';
+
+const instance: UpkProperty = {
+ property_id,
+ property_label,
+ prop_type,
+ cardinality,
+ country_iso,
+ gold_standard,
+ allowed_items,
+ categories,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)