Skip to content

Commit 7c282e9

Browse files
stainless-botstainless-app[bot]
authored andcommitted
docs: update some doc strings (#309)
1 parent 91ccaa3 commit 7c282e9

File tree

2 files changed

+7
-14
lines changed

2 files changed

+7
-14
lines changed

src/finch/types/hris/employment_data.py

+1-10
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,4 @@ class EmploymentData(BaseModel):
101101
"""The current title of the individual."""
102102

103103
work_id: Optional[str] = None
104-
"""Note: This property is only available if enabled for your account.
105-
106-
Please reach out to your Finch representative if you would like access.
107-
"""
108-
109-
work_id_2: Optional[str] = None
110-
"""Note: This property is only available if enabled for your account.
111-
112-
Please reach out to your Finch representative if you would like access.
113-
"""
104+
"""This field is deprecated in favour of `source_id`"""

src/finch/types/hris/individual.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ class Individual(BaseModel):
3030
emails: Optional[List[Email]] = None
3131

3232
encrypted_ssn: Optional[str] = None
33-
"""Note: This property is only available if enabled for your account.
33+
"""Social Security Number of the individual in **encrypted** format.
3434
35-
Please reach out to your Finch representative if you would like access.
35+
This field is only available with the `ssn` scope enabled and the
36+
`options: { include: ['ssn'] }` param set in the body.
3637
"""
3738

3839
ethnicity: Optional[
@@ -69,7 +70,8 @@ class Individual(BaseModel):
6970
residence: Optional[Location] = None
7071

7172
ssn: Optional[str] = None
72-
"""Note: This property is only available if enabled for your account.
73+
"""Social Security Number of the individual.
7374
74-
Please reach out to your Finch representative if you would like access.
75+
This field is only available with the `ssn` scope enabled and the
76+
`options: { include: ['ssn'] }` param set in the body.
7577
"""

0 commit comments

Comments
 (0)