Skip to content

Commit 1eee9ca

Browse files
Update retention_policy.md
1 parent 6b0cf03 commit 1eee9ca

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/usage/retention_policy.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ print('Finite Retention Policy ID is {0} and the policy name is {1}'.format(fini
5151
Get Retention Policy
5252
--------------------
5353

54-
To get a retention policy object, first call [`client.retention_policy(policy_id)`][retention_policy] to construct the
54+
To get a retention policy object, first call [`client.retention_policy(retention_id)`][retention_policy] to construct the
5555
appropriate [`RetentionPolicy`][retention_policy_class] object, and then calling [`retention_policy.get(fields=None)`][get]
5656
will return the [`RetentionPolicy`][retention_policy_class] object populated with data from the API.
5757

5858
<!-- sample get_retention_policies_id -->
5959
```python
60-
retention_policy = client.retention_policy(policy_id='12345').get()
60+
retention_policy = client.retention_policy(retention_id='12345').get()
6161
print('Retention Policy ID is {0} and the name is {1}'.format(retention_policy.id, retention_policy.policy_name))
6262
```
6363

@@ -90,7 +90,7 @@ properties to update on the retention policy. This method returns a newly update
9090
<!-- sample put_retention_policies_id -->
9191
```python
9292
policy_update = {'policy_name': 'New Policy Name',}
93-
updated_retention_policy = client.retention_policy(policy_id='12345').update_info(policy_update)
93+
updated_retention_policy = client.retention_policy(retention_id='12345').update_info(policy_update)
9494
print('Retention Policy ID is {0} and the new policy name is {1}'.format(updated_retention_policy.id, updated_retention_policy.policy_name))
9595
```
9696

@@ -105,7 +105,7 @@ To assign a retention policy, call [`retention_policy.assign(folder)`][assign] w
105105
<!-- sample post_retention_policy_assignments -->
106106
```python
107107
folder = client.folder(folder_id='1111')
108-
assignment = client.retention_policy(policy_id='12345').assign(folder)
108+
assignment = client.retention_policy(retention_id='12345').assign(folder)
109109
print('Assignment ID is {0} and it is assigned by {1}'.format(assignment.id, assignment.assigned_by.name))
110110
```
111111

@@ -140,7 +140,7 @@ will return a `BoxObjectCollection` that allows you to iterate over the
140140

141141
<!-- sample get_retention_policy_id_assignments -->
142142
```python
143-
assignments = client.retention_policy(policy_id='12345').assignments(limit=10)
143+
assignments = client.retention_policy(retention_id='12345').assignments(limit=10)
144144
for assignment in assignments:
145145
print('Assignment ID is {0} and it is assigned by {1}'.format(assignment.id, assignment.assigned_by.name))
146146
```
@@ -149,7 +149,7 @@ Alternatively, you can also specify the `type` of assignment to retrieve with
149149
[`retention_policy.assignments(assignment_type='folder')`][get_assignments].
150150

151151
```python
152-
assignments = client.retention_policy(policy_id='12345').assignments(assignment_type='folder', limit=10)
152+
assignments = client.retention_policy(retention_id='12345').assignments(assignment_type='folder', limit=10)
153153
for assignment in assignments:
154154
print('Assignment ID is {0} and it is assigned by {1}'.format(assignment.id, assignment.assigned_by.name))
155155
```
@@ -159,7 +159,7 @@ for assignment in assignments:
159159
Get File Version Retentions
160160
---------------------------
161161

162-
To retrieve all file version retentions, call [`client.get_file_version_retentions(target_file=None, file_version=None, policy_id=None, disposition_action=None, disposition_before=None, disposition_after=None, limit=None, marker=None, fields=None)`][get_file_version_retentions]. This method will return a
162+
To retrieve all file version retentions, call [`client.get_file_version_retentions(target_file=None, file_version=None, policy=None, disposition_action=None, disposition_before=None, disposition_after=None, limit=None, marker=None, fields=None)`][get_file_version_retentions]. This method will return a
163163
`BoxObjectCollection` that allows you to iterate over the [`FileVersionRetention`][file_version_retention_class]
164164
objects in the collection.
165165

0 commit comments

Comments
 (0)