files.com 1.1.339 → 1.1.340
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/_VERSION +1 -1
 - data/docs/gpg_key.md +9 -1
 - data/docs/partner.md +18 -10
 - data/docs/permission.md +2 -0
 - data/docs/public_key.md +1 -0
 - data/docs/scim_log.md +13 -0
 - data/docs/site.md +1 -0
 - data/docs/user.md +9 -1
 - data/docs/user_lifecycle_rule.md +40 -23
 - data/lib/files.com/models/gpg_key.rb +16 -1
 - data/lib/files.com/models/partner.rb +18 -3
 - data/lib/files.com/models/permission.rb +9 -0
 - data/lib/files.com/models/public_key.rb +2 -0
 - data/lib/files.com/models/scim_log.rb +16 -0
 - data/lib/files.com/models/user.rb +16 -1
 - data/lib/files.com/models/user_lifecycle_rule.rb +68 -36
 - data/lib/files.com/version.rb +1 -1
 - metadata +2 -2
 
    
        checksums.yaml
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            SHA256:
         
     | 
| 
       3 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       4 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 3 
     | 
    
         
            +
              metadata.gz: 61e01471e2c6277f23438f082c9dae59306ca9fa9ca180fc1310eda60aa28dee
         
     | 
| 
      
 4 
     | 
    
         
            +
              data.tar.gz: 1e8f5995141b934415f2be6be6ac82503f2ad1b2ad6159f256fc550380644617
         
     | 
| 
       5 
5 
     | 
    
         
             
            SHA512:
         
     | 
| 
       6 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       7 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 6 
     | 
    
         
            +
              metadata.gz: efe17072a26e1747506dfa491e4b0e7a204a12c267105a212ebeb1e1f27fa21f0ef1e7696da22f038bed06df62e32fa73f75d145ddeecc9fb18c9b6f7387ac6a
         
     | 
| 
      
 7 
     | 
    
         
            +
              data.tar.gz: f36cc93bb9ff3a186de6cbe65b96e45f62b00022dd5b9c3c3cfe9f7a823ab13c2fc9142acb8b4ad87650f40fec675462273e4db8440ce97cada8bd650e271b9c
         
     | 
    
        data/_VERSION
    CHANGED
    
    | 
         @@ -1 +1 @@ 
     | 
|
| 
       1 
     | 
    
         
            -
            1.1. 
     | 
| 
      
 1 
     | 
    
         
            +
            1.1.340
         
     | 
    
        data/docs/gpg_key.md
    CHANGED
    
    | 
         @@ -7,6 +7,7 @@ 
     | 
|
| 
       7 
7 
     | 
    
         
             
              "id": 1,
         
     | 
| 
       8 
8 
     | 
    
         
             
              "expires_at": "2000-01-01T01:00:00Z",
         
     | 
| 
       9 
9 
     | 
    
         
             
              "name": "key name",
         
     | 
| 
      
 10 
     | 
    
         
            +
              "partner_id": 1,
         
     | 
| 
       10 
11 
     | 
    
         
             
              "user_id": 1,
         
     | 
| 
       11 
12 
     | 
    
         
             
              "public_key_md5": "7f8bc1210b09b9ddf469e6b6b8920e76",
         
     | 
| 
       12 
13 
     | 
    
         
             
              "private_key_md5": "ab236cfe4a195f0226bc2e674afdd6b0",
         
     | 
| 
         @@ -19,7 +20,8 @@ 
     | 
|
| 
       19 
20 
     | 
    
         
             
            * `id` (int64): Your GPG key ID.
         
     | 
| 
       20 
21 
     | 
    
         
             
            * `expires_at` (date-time): Your GPG key expiration date.
         
     | 
| 
       21 
22 
     | 
    
         
             
            * `name` (string): Your GPG key name.
         
     | 
| 
       22 
     | 
    
         
            -
            * ` 
     | 
| 
      
 23 
     | 
    
         
            +
            * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
      
 24 
     | 
    
         
            +
            * `user_id` (int64): User ID who owns this GPG Key, if applicable.
         
     | 
| 
       23 
25 
     | 
    
         
             
            * `public_key_md5` (string): MD5 hash of your GPG public key
         
     | 
| 
       24 
26 
     | 
    
         
             
            * `private_key_md5` (string): MD5 hash of your GPG private key.
         
     | 
| 
       25 
27 
     | 
    
         
             
            * `generated_public_key` (string): Your GPG public key
         
     | 
| 
         @@ -72,6 +74,7 @@ Files::GpgKey.find(id) 
     | 
|
| 
       72 
74 
     | 
    
         
             
            ```
         
     | 
| 
       73 
75 
     | 
    
         
             
            Files::GpgKey.create(
         
     | 
| 
       74 
76 
     | 
    
         
             
              user_id: 1, 
         
     | 
| 
      
 77 
     | 
    
         
            +
              partner_id: 1, 
         
     | 
| 
       75 
78 
     | 
    
         
             
              public_key: "7f8bc1210b09b9ddf469e6b6b8920e76", 
         
     | 
| 
       76 
79 
     | 
    
         
             
              private_key: "ab236cfe4a195f0226bc2e674afdd6b0", 
         
     | 
| 
       77 
80 
     | 
    
         
             
              private_key_password: "[your GPG private key password]", 
         
     | 
| 
         @@ -86,6 +89,7 @@ Files::GpgKey.create( 
     | 
|
| 
       86 
89 
     | 
    
         
             
            ### Parameters
         
     | 
| 
       87 
90 
     | 
    
         | 
| 
       88 
91 
     | 
    
         
             
            * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
         
     | 
| 
      
 92 
     | 
    
         
            +
            * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
       89 
93 
     | 
    
         
             
            * `public_key` (string): MD5 hash of your GPG public key
         
     | 
| 
       90 
94 
     | 
    
         
             
            * `private_key` (string): MD5 hash of your GPG private key.
         
     | 
| 
       91 
95 
     | 
    
         
             
            * `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
         
     | 
| 
         @@ -102,6 +106,7 @@ Files::GpgKey.create( 
     | 
|
| 
       102 
106 
     | 
    
         | 
| 
       103 
107 
     | 
    
         
             
            ```
         
     | 
| 
       104 
108 
     | 
    
         
             
            Files::GpgKey.update(id, 
         
     | 
| 
      
 109 
     | 
    
         
            +
              partner_id: 1, 
         
     | 
| 
       105 
110 
     | 
    
         
             
              public_key: "7f8bc1210b09b9ddf469e6b6b8920e76", 
         
     | 
| 
       106 
111 
     | 
    
         
             
              private_key: "ab236cfe4a195f0226bc2e674afdd6b0", 
         
     | 
| 
       107 
112 
     | 
    
         
             
              private_key_password: "[your GPG private key password]", 
         
     | 
| 
         @@ -112,6 +117,7 @@ Files::GpgKey.update(id, 
     | 
|
| 
       112 
117 
     | 
    
         
             
            ### Parameters
         
     | 
| 
       113 
118 
     | 
    
         | 
| 
       114 
119 
     | 
    
         
             
            * `id` (int64): Required - Gpg Key ID.
         
     | 
| 
      
 120 
     | 
    
         
            +
            * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
       115 
121 
     | 
    
         
             
            * `public_key` (string): MD5 hash of your GPG public key
         
     | 
| 
       116 
122 
     | 
    
         
             
            * `private_key` (string): MD5 hash of your GPG private key.
         
     | 
| 
       117 
123 
     | 
    
         
             
            * `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
         
     | 
| 
         @@ -139,6 +145,7 @@ Files::GpgKey.delete(id) 
     | 
|
| 
       139 
145 
     | 
    
         
             
            gpg_key = Files::GpgKey.find(id)
         
     | 
| 
       140 
146 
     | 
    
         | 
| 
       141 
147 
     | 
    
         
             
            gpg_key.update(
         
     | 
| 
      
 148 
     | 
    
         
            +
              partner_id: 1,
         
     | 
| 
       142 
149 
     | 
    
         
             
              public_key: "7f8bc1210b09b9ddf469e6b6b8920e76",
         
     | 
| 
       143 
150 
     | 
    
         
             
              private_key: "ab236cfe4a195f0226bc2e674afdd6b0",
         
     | 
| 
       144 
151 
     | 
    
         
             
              private_key_password: "[your GPG private key password]",
         
     | 
| 
         @@ -149,6 +156,7 @@ gpg_key.update( 
     | 
|
| 
       149 
156 
     | 
    
         
             
            ### Parameters
         
     | 
| 
       150 
157 
     | 
    
         | 
| 
       151 
158 
     | 
    
         
             
            * `id` (int64): Required - Gpg Key ID.
         
     | 
| 
      
 159 
     | 
    
         
            +
            * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
       152 
160 
     | 
    
         
             
            * `public_key` (string): MD5 hash of your GPG public key
         
     | 
| 
       153 
161 
     | 
    
         
             
            * `private_key` (string): MD5 hash of your GPG private key.
         
     | 
| 
       154 
162 
     | 
    
         
             
            * `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
         
     | 
    
        data/docs/partner.md
    CHANGED
    
    | 
         @@ -10,7 +10,8 @@ 
     | 
|
| 
       10 
10 
     | 
    
         
             
              "id": 1,
         
     | 
| 
       11 
11 
     | 
    
         
             
              "name": "Acme Corp",
         
     | 
| 
       12 
12 
     | 
    
         
             
              "notes": "This is a note about the partner.",
         
     | 
| 
       13 
     | 
    
         
            -
              "root_folder": "/AcmeCorp"
         
     | 
| 
      
 13 
     | 
    
         
            +
              "root_folder": "/AcmeCorp",
         
     | 
| 
      
 14 
     | 
    
         
            +
              "tags": "example"
         
     | 
| 
       14 
15 
     | 
    
         
             
            }
         
     | 
| 
       15 
16 
     | 
    
         
             
            ```
         
     | 
| 
       16 
17 
     | 
    
         | 
| 
         @@ -21,6 +22,7 @@ 
     | 
|
| 
       21 
22 
     | 
    
         
             
            * `name` (string): The name of the Partner.
         
     | 
| 
       22 
23 
     | 
    
         
             
            * `notes` (string): Notes about this Partner.
         
     | 
| 
       23 
24 
     | 
    
         
             
            * `root_folder` (string): The root folder path for this Partner.
         
     | 
| 
      
 25 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       24 
26 
     | 
    
         | 
| 
       25 
27 
     | 
    
         | 
| 
       26 
28 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -57,23 +59,25 @@ Files::Partner.find(id) 
     | 
|
| 
       57 
59 
     | 
    
         | 
| 
       58 
60 
     | 
    
         
             
            ```
         
     | 
| 
       59 
61 
     | 
    
         
             
            Files::Partner.create(
         
     | 
| 
      
 62 
     | 
    
         
            +
              name: "Acme Corp", 
         
     | 
| 
       60 
63 
     | 
    
         
             
              allow_bypassing_2fa_policies: false, 
         
     | 
| 
       61 
64 
     | 
    
         
             
              allow_credential_changes: false, 
         
     | 
| 
       62 
65 
     | 
    
         
             
              allow_user_creation: false, 
         
     | 
| 
       63 
     | 
    
         
            -
              name: "Acme Corp", 
         
     | 
| 
       64 
66 
     | 
    
         
             
              notes: "This is a note about the partner.", 
         
     | 
| 
       65 
     | 
    
         
            -
              root_folder: "/AcmeCorp"
         
     | 
| 
      
 67 
     | 
    
         
            +
              root_folder: "/AcmeCorp", 
         
     | 
| 
      
 68 
     | 
    
         
            +
              tags: "example"
         
     | 
| 
       66 
69 
     | 
    
         
             
            )
         
     | 
| 
       67 
70 
     | 
    
         
             
            ```
         
     | 
| 
       68 
71 
     | 
    
         | 
| 
       69 
72 
     | 
    
         
             
            ### Parameters
         
     | 
| 
       70 
73 
     | 
    
         | 
| 
      
 74 
     | 
    
         
            +
            * `name` (string): The name of the Partner.
         
     | 
| 
       71 
75 
     | 
    
         
             
            * `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
         
     | 
| 
       72 
76 
     | 
    
         
             
            * `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
         
     | 
| 
       73 
77 
     | 
    
         
             
            * `allow_user_creation` (boolean): Allow Partner Admins to create users.
         
     | 
| 
       74 
     | 
    
         
            -
            * `name` (string): The name of the Partner.
         
     | 
| 
       75 
78 
     | 
    
         
             
            * `notes` (string): Notes about this Partner.
         
     | 
| 
       76 
79 
     | 
    
         
             
            * `root_folder` (string): The root folder path for this Partner.
         
     | 
| 
      
 80 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       77 
81 
     | 
    
         | 
| 
       78 
82 
     | 
    
         | 
| 
       79 
83 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -82,24 +86,26 @@ Files::Partner.create( 
     | 
|
| 
       82 
86 
     | 
    
         | 
| 
       83 
87 
     | 
    
         
             
            ```
         
     | 
| 
       84 
88 
     | 
    
         
             
            Files::Partner.update(id, 
         
     | 
| 
      
 89 
     | 
    
         
            +
              name: "Acme Corp", 
         
     | 
| 
       85 
90 
     | 
    
         
             
              allow_bypassing_2fa_policies: false, 
         
     | 
| 
       86 
91 
     | 
    
         
             
              allow_credential_changes: false, 
         
     | 
| 
       87 
92 
     | 
    
         
             
              allow_user_creation: false, 
         
     | 
| 
       88 
     | 
    
         
            -
              name: "Acme Corp", 
         
     | 
| 
       89 
93 
     | 
    
         
             
              notes: "This is a note about the partner.", 
         
     | 
| 
       90 
     | 
    
         
            -
              root_folder: "/AcmeCorp"
         
     | 
| 
      
 94 
     | 
    
         
            +
              root_folder: "/AcmeCorp", 
         
     | 
| 
      
 95 
     | 
    
         
            +
              tags: "example"
         
     | 
| 
       91 
96 
     | 
    
         
             
            )
         
     | 
| 
       92 
97 
     | 
    
         
             
            ```
         
     | 
| 
       93 
98 
     | 
    
         | 
| 
       94 
99 
     | 
    
         
             
            ### Parameters
         
     | 
| 
       95 
100 
     | 
    
         | 
| 
       96 
101 
     | 
    
         
             
            * `id` (int64): Required - Partner ID.
         
     | 
| 
      
 102 
     | 
    
         
            +
            * `name` (string): The name of the Partner.
         
     | 
| 
       97 
103 
     | 
    
         
             
            * `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
         
     | 
| 
       98 
104 
     | 
    
         
             
            * `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
         
     | 
| 
       99 
105 
     | 
    
         
             
            * `allow_user_creation` (boolean): Allow Partner Admins to create users.
         
     | 
| 
       100 
     | 
    
         
            -
            * `name` (string): The name of the Partner.
         
     | 
| 
       101 
106 
     | 
    
         
             
            * `notes` (string): Notes about this Partner.
         
     | 
| 
       102 
107 
     | 
    
         
             
            * `root_folder` (string): The root folder path for this Partner.
         
     | 
| 
      
 108 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       103 
109 
     | 
    
         | 
| 
       104 
110 
     | 
    
         | 
| 
       105 
111 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -123,24 +129,26 @@ Files::Partner.delete(id) 
     | 
|
| 
       123 
129 
     | 
    
         
             
            partner = Files::Partner.find(id)
         
     | 
| 
       124 
130 
     | 
    
         | 
| 
       125 
131 
     | 
    
         
             
            partner.update(
         
     | 
| 
      
 132 
     | 
    
         
            +
              name: "Acme Corp",
         
     | 
| 
       126 
133 
     | 
    
         
             
              allow_bypassing_2fa_policies: false,
         
     | 
| 
       127 
134 
     | 
    
         
             
              allow_credential_changes: false,
         
     | 
| 
       128 
135 
     | 
    
         
             
              allow_user_creation: false,
         
     | 
| 
       129 
     | 
    
         
            -
              name: "Acme Corp",
         
     | 
| 
       130 
136 
     | 
    
         
             
              notes: "This is a note about the partner.",
         
     | 
| 
       131 
     | 
    
         
            -
              root_folder: "/AcmeCorp"
         
     | 
| 
      
 137 
     | 
    
         
            +
              root_folder: "/AcmeCorp",
         
     | 
| 
      
 138 
     | 
    
         
            +
              tags: "example"
         
     | 
| 
       132 
139 
     | 
    
         
             
            )
         
     | 
| 
       133 
140 
     | 
    
         
             
            ```
         
     | 
| 
       134 
141 
     | 
    
         | 
| 
       135 
142 
     | 
    
         
             
            ### Parameters
         
     | 
| 
       136 
143 
     | 
    
         | 
| 
       137 
144 
     | 
    
         
             
            * `id` (int64): Required - Partner ID.
         
     | 
| 
      
 145 
     | 
    
         
            +
            * `name` (string): The name of the Partner.
         
     | 
| 
       138 
146 
     | 
    
         
             
            * `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
         
     | 
| 
       139 
147 
     | 
    
         
             
            * `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
         
     | 
| 
       140 
148 
     | 
    
         
             
            * `allow_user_creation` (boolean): Allow Partner Admins to create users.
         
     | 
| 
       141 
     | 
    
         
            -
            * `name` (string): The name of the Partner.
         
     | 
| 
       142 
149 
     | 
    
         
             
            * `notes` (string): Notes about this Partner.
         
     | 
| 
       143 
150 
     | 
    
         
             
            * `root_folder` (string): The root folder path for this Partner.
         
     | 
| 
      
 151 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       144 
152 
     | 
    
         | 
| 
       145 
153 
     | 
    
         | 
| 
       146 
154 
     | 
    
         
             
            ---
         
     | 
    
        data/docs/permission.md
    CHANGED
    
    | 
         @@ -11,6 +11,7 @@ 
     | 
|
| 
       11 
11 
     | 
    
         
             
              "group_id": 1,
         
     | 
| 
       12 
12 
     | 
    
         
             
              "group_name": "example",
         
     | 
| 
       13 
13 
     | 
    
         
             
              "partner_id": 1,
         
     | 
| 
      
 14 
     | 
    
         
            +
              "partner_name": "Acme Corp.",
         
     | 
| 
       14 
15 
     | 
    
         
             
              "permission": "full",
         
     | 
| 
       15 
16 
     | 
    
         
             
              "recursive": true,
         
     | 
| 
       16 
17 
     | 
    
         
             
              "site_id": 1
         
     | 
| 
         @@ -24,6 +25,7 @@ 
     | 
|
| 
       24 
25 
     | 
    
         
             
            * `group_id` (int64): Group ID
         
     | 
| 
       25 
26 
     | 
    
         
             
            * `group_name` (string): Group name (if applicable)
         
     | 
| 
       26 
27 
     | 
    
         
             
            * `partner_id` (int64): Partner ID (if applicable)
         
     | 
| 
      
 28 
     | 
    
         
            +
            * `partner_name` (string): Partner name (if applicable)
         
     | 
| 
       27 
29 
     | 
    
         
             
            * `permission` (string): Permission type.  See the table referenced in the documentation for an explanation of each permission.
         
     | 
| 
       28 
30 
     | 
    
         
             
            * `recursive` (boolean): Recursive: does this permission apply to subfolders?
         
     | 
| 
       29 
31 
     | 
    
         
             
            * `site_id` (int64): Site ID
         
     | 
    
        data/docs/public_key.md
    CHANGED
    
    | 
         @@ -51,6 +51,7 @@ Files::PublicKey.list( 
     | 
|
| 
       51 
51 
     | 
    
         
             
            * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
         
     | 
| 
       52 
52 
     | 
    
         
             
            * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
         
     | 
| 
       53 
53 
     | 
    
         
             
            * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
         
     | 
| 
      
 54 
     | 
    
         
            +
            * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `title`, `created_at` or `user_id`.
         
     | 
| 
       54 
55 
     | 
    
         
             
            * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
         
     | 
| 
       55 
56 
     | 
    
         
             
            * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
         
     | 
| 
       56 
57 
     | 
    
         
             
            * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
         
     | 
    
        data/docs/scim_log.md
    CHANGED
    
    | 
         @@ -38,3 +38,16 @@ Files::ScimLog.list 
     | 
|
| 
       38 
38 
     | 
    
         
             
            * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
         
     | 
| 
       39 
39 
     | 
    
         
             
            * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
         
     | 
| 
       40 
40 
     | 
    
         
             
            * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
         
     | 
| 
      
 41 
     | 
    
         
            +
             
     | 
| 
      
 42 
     | 
    
         
            +
             
     | 
| 
      
 43 
     | 
    
         
            +
            ---
         
     | 
| 
      
 44 
     | 
    
         
            +
             
     | 
| 
      
 45 
     | 
    
         
            +
            ## Show Scim Log
         
     | 
| 
      
 46 
     | 
    
         
            +
             
     | 
| 
      
 47 
     | 
    
         
            +
            ```
         
     | 
| 
      
 48 
     | 
    
         
            +
            Files::ScimLog.find(id)
         
     | 
| 
      
 49 
     | 
    
         
            +
            ```
         
     | 
| 
      
 50 
     | 
    
         
            +
             
     | 
| 
      
 51 
     | 
    
         
            +
            ### Parameters
         
     | 
| 
      
 52 
     | 
    
         
            +
             
     | 
| 
      
 53 
     | 
    
         
            +
            * `id` (int64): Required - Scim Log ID.
         
     | 
    
        data/docs/site.md
    CHANGED
    
    
    
        data/docs/user.md
    CHANGED
    
    | 
         @@ -68,6 +68,7 @@ 
     | 
|
| 
       68 
68 
     | 
    
         
             
              "sso_strategy_id": 1,
         
     | 
| 
       69 
69 
     | 
    
         
             
              "subscribe_to_newsletter": true,
         
     | 
| 
       70 
70 
     | 
    
         
             
              "externally_managed": true,
         
     | 
| 
      
 71 
     | 
    
         
            +
              "tags": "example",
         
     | 
| 
       71 
72 
     | 
    
         
             
              "time_zone": "Pacific Time (US & Canada)",
         
     | 
| 
       72 
73 
     | 
    
         
             
              "type_of_2fa": "yubi",
         
     | 
| 
       73 
74 
     | 
    
         
             
              "type_of_2fa_for_display": "yubi",
         
     | 
| 
         @@ -140,6 +141,7 @@ 
     | 
|
| 
       140 
141 
     | 
    
         
             
            * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
         
     | 
| 
       141 
142 
     | 
    
         
             
            * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
         
     | 
| 
       142 
143 
     | 
    
         
             
            * `externally_managed` (boolean): Is this user managed by a SsoStrategy?
         
     | 
| 
      
 144 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       143 
145 
     | 
    
         
             
            * `time_zone` (string): User time zone
         
     | 
| 
       144 
146 
     | 
    
         
             
            * `type_of_2fa` (string): Type(s) of 2FA methods in use, for programmatic use.  Will be either `sms`, `totp`, `webauthn`, `yubi`, `email`, or multiple values sorted alphabetically and joined by an underscore.  Does not specify whether user has more than one of a given method.
         
     | 
| 
       145 
147 
     | 
    
         
             
            * `type_of_2fa_for_display` (string): Type(s) of 2FA methods in use, formatted for displaying in the UI.  Unlike `type_of_2fa`, this value will make clear when a user has more than 1 of the same type of method.
         
     | 
| 
         @@ -175,7 +177,7 @@ Files::User.list( 
     | 
|
| 
       175 
177 
     | 
    
         
             
            * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
         
     | 
| 
       176 
178 
     | 
    
         
             
            * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
         
     | 
| 
       177 
179 
     | 
    
         
             
            * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username`, `site_admin` or `disabled`.
         
     | 
| 
       178 
     | 
    
         
            -
            * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin` or ` 
     | 
| 
      
 180 
     | 
    
         
            +
            * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled` or `partner_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
         
     | 
| 
       179 
181 
     | 
    
         
             
            * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
         
     | 
| 
       180 
182 
     | 
    
         
             
            * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
         
     | 
| 
       181 
183 
     | 
    
         
             
            * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
         
     | 
| 
         @@ -244,6 +246,7 @@ Files::User.create( 
     | 
|
| 
       244 
246 
     | 
    
         
             
              sso_strategy_id: 1, 
         
     | 
| 
       245 
247 
     | 
    
         
             
              subscribe_to_newsletter: true, 
         
     | 
| 
       246 
248 
     | 
    
         
             
              require_2fa: "always_require", 
         
     | 
| 
      
 249 
     | 
    
         
            +
              tags: "example", 
         
     | 
| 
       247 
250 
     | 
    
         
             
              time_zone: "Pacific Time (US & Canada)", 
         
     | 
| 
       248 
251 
     | 
    
         
             
              user_root: "example", 
         
     | 
| 
       249 
252 
     | 
    
         
             
              user_home: "example", 
         
     | 
| 
         @@ -299,6 +302,7 @@ Files::User.create( 
     | 
|
| 
       299 
302 
     | 
    
         
             
            * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
         
     | 
| 
       300 
303 
     | 
    
         
             
            * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
         
     | 
| 
       301 
304 
     | 
    
         
             
            * `require_2fa` (string): 2FA required setting
         
     | 
| 
      
 305 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       302 
306 
     | 
    
         
             
            * `time_zone` (string): User time zone
         
     | 
| 
       303 
307 
     | 
    
         
             
            * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
       304 
308 
     | 
    
         
             
            * `user_home` (string): Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
         @@ -389,6 +393,7 @@ Files::User.update(id, 
     | 
|
| 
       389 
393 
     | 
    
         
             
              sso_strategy_id: 1, 
         
     | 
| 
       390 
394 
     | 
    
         
             
              subscribe_to_newsletter: true, 
         
     | 
| 
       391 
395 
     | 
    
         
             
              require_2fa: "always_require", 
         
     | 
| 
      
 396 
     | 
    
         
            +
              tags: "example", 
         
     | 
| 
       392 
397 
     | 
    
         
             
              time_zone: "Pacific Time (US & Canada)", 
         
     | 
| 
       393 
398 
     | 
    
         
             
              user_root: "example", 
         
     | 
| 
       394 
399 
     | 
    
         
             
              user_home: "example", 
         
     | 
| 
         @@ -446,6 +451,7 @@ Files::User.update(id, 
     | 
|
| 
       446 
451 
     | 
    
         
             
            * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
         
     | 
| 
       447 
452 
     | 
    
         
             
            * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
         
     | 
| 
       448 
453 
     | 
    
         
             
            * `require_2fa` (string): 2FA required setting
         
     | 
| 
      
 454 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       449 
455 
     | 
    
         
             
            * `time_zone` (string): User time zone
         
     | 
| 
       450 
456 
     | 
    
         
             
            * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
       451 
457 
     | 
    
         
             
            * `user_home` (string): Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
         @@ -561,6 +567,7 @@ user.update( 
     | 
|
| 
       561 
567 
     | 
    
         
             
              sso_strategy_id: 1,
         
     | 
| 
       562 
568 
     | 
    
         
             
              subscribe_to_newsletter: true,
         
     | 
| 
       563 
569 
     | 
    
         
             
              require_2fa: "always_require",
         
     | 
| 
      
 570 
     | 
    
         
            +
              tags: "example",
         
     | 
| 
       564 
571 
     | 
    
         
             
              time_zone: "Pacific Time (US & Canada)",
         
     | 
| 
       565 
572 
     | 
    
         
             
              user_root: "example",
         
     | 
| 
       566 
573 
     | 
    
         
             
              user_home: "example",
         
     | 
| 
         @@ -618,6 +625,7 @@ user.update( 
     | 
|
| 
       618 
625 
     | 
    
         
             
            * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
         
     | 
| 
       619 
626 
     | 
    
         
             
            * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
         
     | 
| 
       620 
627 
     | 
    
         
             
            * `require_2fa` (string): 2FA required setting
         
     | 
| 
      
 628 
     | 
    
         
            +
            * `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       621 
629 
     | 
    
         
             
            * `time_zone` (string): User time zone
         
     | 
| 
       622 
630 
     | 
    
         
             
            * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
       623 
631 
     | 
    
         
             
            * `user_home` (string): Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
         
     | 
    
        data/docs/user_lifecycle_rule.md
    CHANGED
    
    | 
         @@ -11,26 +11,30 @@ 
     | 
|
| 
       11 
11 
     | 
    
         
             
                2,
         
     | 
| 
       12 
12 
     | 
    
         
             
                3
         
     | 
| 
       13 
13 
     | 
    
         
             
              ],
         
     | 
| 
      
 14 
     | 
    
         
            +
              "action": "disable",
         
     | 
| 
       14 
15 
     | 
    
         
             
              "inactivity_days": 12,
         
     | 
| 
       15 
16 
     | 
    
         
             
              "include_folder_admins": true,
         
     | 
| 
       16 
17 
     | 
    
         
             
              "include_site_admins": true,
         
     | 
| 
       17 
     | 
    
         
            -
              "action": "disable",
         
     | 
| 
       18 
     | 
    
         
            -
              "user_state": "inactive",
         
     | 
| 
       19 
18 
     | 
    
         
             
              "name": "password specific rules",
         
     | 
| 
       20 
     | 
    
         
            -
              " 
     | 
| 
      
 19 
     | 
    
         
            +
              "partner_tag": "guest",
         
     | 
| 
      
 20 
     | 
    
         
            +
              "site_id": 1,
         
     | 
| 
      
 21 
     | 
    
         
            +
              "user_state": "inactive",
         
     | 
| 
      
 22 
     | 
    
         
            +
              "user_tag": "guest"
         
     | 
| 
       21 
23 
     | 
    
         
             
            }
         
     | 
| 
       22 
24 
     | 
    
         
             
            ```
         
     | 
| 
       23 
25 
     | 
    
         | 
| 
       24 
26 
     | 
    
         
             
            * `id` (int64): User Lifecycle Rule ID
         
     | 
| 
       25 
     | 
    
         
            -
            * `authentication_method` (string): User authentication method for the rule
         
     | 
| 
      
 27 
     | 
    
         
            +
            * `authentication_method` (string): User authentication method for which the rule will apply.
         
     | 
| 
       26 
28 
     | 
    
         
             
            * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         
     | 
| 
       27 
     | 
    
         
            -
            * `inactivity_days` (int64): Number of days of inactivity before the rule applies
         
     | 
| 
       28 
     | 
    
         
            -
            * `include_folder_admins` (boolean): Include folder admins in the rule
         
     | 
| 
       29 
     | 
    
         
            -
            * `include_site_admins` (boolean): Include site admins in the rule
         
     | 
| 
       30 
29 
     | 
    
         
             
            * `action` (string): Action to take on inactive users (disable or delete)
         
     | 
| 
       31 
     | 
    
         
            -
            * ` 
     | 
| 
      
 30 
     | 
    
         
            +
            * `inactivity_days` (int64): Number of days of inactivity before the rule applies
         
     | 
| 
      
 31 
     | 
    
         
            +
            * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
         
     | 
| 
      
 32 
     | 
    
         
            +
            * `include_site_admins` (boolean): If true, the rule will apply to site admins.
         
     | 
| 
       32 
33 
     | 
    
         
             
            * `name` (string): User Lifecycle Rule name
         
     | 
| 
      
 34 
     | 
    
         
            +
            * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       33 
35 
     | 
    
         
             
            * `site_id` (int64): Site ID
         
     | 
| 
      
 36 
     | 
    
         
            +
            * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 37 
     | 
    
         
            +
            * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       34 
38 
     | 
    
         | 
| 
       35 
39 
     | 
    
         | 
| 
       36 
40 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -45,6 +49,7 @@ Files::UserLifecycleRule.list 
     | 
|
| 
       45 
49 
     | 
    
         | 
| 
       46 
50 
     | 
    
         
             
            * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
         
     | 
| 
       47 
51 
     | 
    
         
             
            * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
         
     | 
| 
      
 52 
     | 
    
         
            +
            * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
         
     | 
| 
       48 
53 
     | 
    
         | 
| 
       49 
54 
     | 
    
         | 
| 
       50 
55 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -71,21 +76,25 @@ Files::UserLifecycleRule.create( 
     | 
|
| 
       71 
76 
     | 
    
         
             
              inactivity_days: 12, 
         
     | 
| 
       72 
77 
     | 
    
         
             
              include_site_admins: true, 
         
     | 
| 
       73 
78 
     | 
    
         
             
              include_folder_admins: true, 
         
     | 
| 
      
 79 
     | 
    
         
            +
              name: "password specific rules", 
         
     | 
| 
      
 80 
     | 
    
         
            +
              partner_tag: "guest", 
         
     | 
| 
       74 
81 
     | 
    
         
             
              user_state: "inactive", 
         
     | 
| 
       75 
     | 
    
         
            -
               
     | 
| 
      
 82 
     | 
    
         
            +
              user_tag: "guest"
         
     | 
| 
       76 
83 
     | 
    
         
             
            )
         
     | 
| 
       77 
84 
     | 
    
         
             
            ```
         
     | 
| 
       78 
85 
     | 
    
         | 
| 
       79 
86 
     | 
    
         
             
            ### Parameters
         
     | 
| 
       80 
87 
     | 
    
         | 
| 
       81 
88 
     | 
    
         
             
            * `action` (string): Action to take on inactive users (disable or delete)
         
     | 
| 
       82 
     | 
    
         
            -
            * `authentication_method` (string): User authentication method for the rule
         
     | 
| 
      
 89 
     | 
    
         
            +
            * `authentication_method` (string): User authentication method for which the rule will apply.
         
     | 
| 
       83 
90 
     | 
    
         
             
            * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         
     | 
| 
       84 
91 
     | 
    
         
             
            * `inactivity_days` (int64): Number of days of inactivity before the rule applies
         
     | 
| 
       85 
     | 
    
         
            -
            * `include_site_admins` (boolean):  
     | 
| 
       86 
     | 
    
         
            -
            * `include_folder_admins` (boolean):  
     | 
| 
       87 
     | 
    
         
            -
            * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 92 
     | 
    
         
            +
            * `include_site_admins` (boolean): If true, the rule will apply to site admins.
         
     | 
| 
      
 93 
     | 
    
         
            +
            * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
         
     | 
| 
       88 
94 
     | 
    
         
             
            * `name` (string): User Lifecycle Rule name
         
     | 
| 
      
 95 
     | 
    
         
            +
            * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 96 
     | 
    
         
            +
            * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 97 
     | 
    
         
            +
            * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       89 
98 
     | 
    
         | 
| 
       90 
99 
     | 
    
         | 
| 
       91 
100 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -99,8 +108,10 @@ Files::UserLifecycleRule.update(id, 
     | 
|
| 
       99 
108 
     | 
    
         
             
              inactivity_days: 12, 
         
     | 
| 
       100 
109 
     | 
    
         
             
              include_site_admins: true, 
         
     | 
| 
       101 
110 
     | 
    
         
             
              include_folder_admins: true, 
         
     | 
| 
      
 111 
     | 
    
         
            +
              name: "password specific rules", 
         
     | 
| 
      
 112 
     | 
    
         
            +
              partner_tag: "guest", 
         
     | 
| 
       102 
113 
     | 
    
         
             
              user_state: "inactive", 
         
     | 
| 
       103 
     | 
    
         
            -
               
     | 
| 
      
 114 
     | 
    
         
            +
              user_tag: "guest"
         
     | 
| 
       104 
115 
     | 
    
         
             
            )
         
     | 
| 
       105 
116 
     | 
    
         
             
            ```
         
     | 
| 
       106 
117 
     | 
    
         | 
| 
         @@ -108,13 +119,15 @@ Files::UserLifecycleRule.update(id, 
     | 
|
| 
       108 
119 
     | 
    
         | 
| 
       109 
120 
     | 
    
         
             
            * `id` (int64): Required - User Lifecycle Rule ID.
         
     | 
| 
       110 
121 
     | 
    
         
             
            * `action` (string): Action to take on inactive users (disable or delete)
         
     | 
| 
       111 
     | 
    
         
            -
            * `authentication_method` (string): User authentication method for the rule
         
     | 
| 
      
 122 
     | 
    
         
            +
            * `authentication_method` (string): User authentication method for which the rule will apply.
         
     | 
| 
       112 
123 
     | 
    
         
             
            * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         
     | 
| 
       113 
124 
     | 
    
         
             
            * `inactivity_days` (int64): Number of days of inactivity before the rule applies
         
     | 
| 
       114 
     | 
    
         
            -
            * `include_site_admins` (boolean):  
     | 
| 
       115 
     | 
    
         
            -
            * `include_folder_admins` (boolean):  
     | 
| 
       116 
     | 
    
         
            -
            * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 125 
     | 
    
         
            +
            * `include_site_admins` (boolean): If true, the rule will apply to site admins.
         
     | 
| 
      
 126 
     | 
    
         
            +
            * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
         
     | 
| 
       117 
127 
     | 
    
         
             
            * `name` (string): User Lifecycle Rule name
         
     | 
| 
      
 128 
     | 
    
         
            +
            * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 129 
     | 
    
         
            +
            * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 130 
     | 
    
         
            +
            * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       118 
131 
     | 
    
         | 
| 
       119 
132 
     | 
    
         | 
| 
       120 
133 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -143,8 +156,10 @@ user_lifecycle_rule.update( 
     | 
|
| 
       143 
156 
     | 
    
         
             
              inactivity_days: 12,
         
     | 
| 
       144 
157 
     | 
    
         
             
              include_site_admins: true,
         
     | 
| 
       145 
158 
     | 
    
         
             
              include_folder_admins: true,
         
     | 
| 
      
 159 
     | 
    
         
            +
              name: "password specific rules",
         
     | 
| 
      
 160 
     | 
    
         
            +
              partner_tag: "guest",
         
     | 
| 
       146 
161 
     | 
    
         
             
              user_state: "inactive",
         
     | 
| 
       147 
     | 
    
         
            -
               
     | 
| 
      
 162 
     | 
    
         
            +
              user_tag: "guest"
         
     | 
| 
       148 
163 
     | 
    
         
             
            )
         
     | 
| 
       149 
164 
     | 
    
         
             
            ```
         
     | 
| 
       150 
165 
     | 
    
         | 
| 
         @@ -152,13 +167,15 @@ user_lifecycle_rule.update( 
     | 
|
| 
       152 
167 
     | 
    
         | 
| 
       153 
168 
     | 
    
         
             
            * `id` (int64): Required - User Lifecycle Rule ID.
         
     | 
| 
       154 
169 
     | 
    
         
             
            * `action` (string): Action to take on inactive users (disable or delete)
         
     | 
| 
       155 
     | 
    
         
            -
            * `authentication_method` (string): User authentication method for the rule
         
     | 
| 
      
 170 
     | 
    
         
            +
            * `authentication_method` (string): User authentication method for which the rule will apply.
         
     | 
| 
       156 
171 
     | 
    
         
             
            * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         
     | 
| 
       157 
172 
     | 
    
         
             
            * `inactivity_days` (int64): Number of days of inactivity before the rule applies
         
     | 
| 
       158 
     | 
    
         
            -
            * `include_site_admins` (boolean):  
     | 
| 
       159 
     | 
    
         
            -
            * `include_folder_admins` (boolean):  
     | 
| 
       160 
     | 
    
         
            -
            * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 173 
     | 
    
         
            +
            * `include_site_admins` (boolean): If true, the rule will apply to site admins.
         
     | 
| 
      
 174 
     | 
    
         
            +
            * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
         
     | 
| 
       161 
175 
     | 
    
         
             
            * `name` (string): User Lifecycle Rule name
         
     | 
| 
      
 176 
     | 
    
         
            +
            * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 177 
     | 
    
         
            +
            * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 178 
     | 
    
         
            +
            * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       162 
179 
     | 
    
         | 
| 
       163 
180 
     | 
    
         | 
| 
       164 
181 
     | 
    
         
             
            ---
         
     | 
| 
         @@ -36,7 +36,16 @@ module Files 
     | 
|
| 
       36 
36 
     | 
    
         
             
                  @attributes[:name] = value
         
     | 
| 
       37 
37 
     | 
    
         
             
                end
         
     | 
| 
       38 
38 
     | 
    
         | 
| 
       39 
     | 
    
         
            -
                # int64 - GPG  
     | 
| 
      
 39 
     | 
    
         
            +
                # int64 - Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
      
 40 
     | 
    
         
            +
                def partner_id
         
     | 
| 
      
 41 
     | 
    
         
            +
                  @attributes[:partner_id]
         
     | 
| 
      
 42 
     | 
    
         
            +
                end
         
     | 
| 
      
 43 
     | 
    
         
            +
             
     | 
| 
      
 44 
     | 
    
         
            +
                def partner_id=(value)
         
     | 
| 
      
 45 
     | 
    
         
            +
                  @attributes[:partner_id] = value
         
     | 
| 
      
 46 
     | 
    
         
            +
                end
         
     | 
| 
      
 47 
     | 
    
         
            +
             
     | 
| 
      
 48 
     | 
    
         
            +
                # int64 - User ID who owns this GPG Key, if applicable.
         
     | 
| 
       40 
49 
     | 
    
         
             
                def user_id
         
     | 
| 
       41 
50 
     | 
    
         
             
                  @attributes[:user_id]
         
     | 
| 
       42 
51 
     | 
    
         
             
                end
         
     | 
| 
         @@ -154,6 +163,7 @@ module Files 
     | 
|
| 
       154 
163 
     | 
    
         
             
                end
         
     | 
| 
       155 
164 
     | 
    
         | 
| 
       156 
165 
     | 
    
         
             
                # Parameters:
         
     | 
| 
      
 166 
     | 
    
         
            +
                #   partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
       157 
167 
     | 
    
         
             
                #   public_key - string - MD5 hash of your GPG public key
         
     | 
| 
       158 
168 
     | 
    
         
             
                #   private_key - string - MD5 hash of your GPG private key.
         
     | 
| 
       159 
169 
     | 
    
         
             
                #   private_key_password - string - Your GPG private key password. Only required for password protected keys.
         
     | 
| 
         @@ -163,6 +173,7 @@ module Files 
     | 
|
| 
       163 
173 
     | 
    
         
             
                  params[:id] = @attributes[:id]
         
     | 
| 
       164 
174 
     | 
    
         
             
                  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
         
     | 
| 
       165 
175 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
         
     | 
| 
      
 176 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
         
     | 
| 
       166 
177 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
         
     | 
| 
       167 
178 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
         
     | 
| 
       168 
179 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
         
     | 
| 
         @@ -236,6 +247,7 @@ module Files 
     | 
|
| 
       236 
247 
     | 
    
         | 
| 
       237 
248 
     | 
    
         
             
                # Parameters:
         
     | 
| 
       238 
249 
     | 
    
         
             
                #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
         
     | 
| 
      
 250 
     | 
    
         
            +
                #   partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
       239 
251 
     | 
    
         
             
                #   public_key - string - MD5 hash of your GPG public key
         
     | 
| 
       240 
252 
     | 
    
         
             
                #   private_key - string - MD5 hash of your GPG private key.
         
     | 
| 
       241 
253 
     | 
    
         
             
                #   private_key_password - string - Your GPG private key password. Only required for password protected keys.
         
     | 
| 
         @@ -246,6 +258,7 @@ module Files 
     | 
|
| 
       246 
258 
     | 
    
         
             
                #   generate_email - string - Email address of the key owner. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
         
     | 
| 
       247 
259 
     | 
    
         
             
                def self.create(params = {}, options = {})
         
     | 
| 
       248 
260 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
         
     | 
| 
      
 261 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
         
     | 
| 
       249 
262 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
         
     | 
| 
       250 
263 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
         
     | 
| 
       251 
264 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
         
     | 
| 
         @@ -260,6 +273,7 @@ module Files 
     | 
|
| 
       260 
273 
     | 
    
         
             
                end
         
     | 
| 
       261 
274 
     | 
    
         | 
| 
       262 
275 
     | 
    
         
             
                # Parameters:
         
     | 
| 
      
 276 
     | 
    
         
            +
                #   partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
         
     | 
| 
       263 
277 
     | 
    
         
             
                #   public_key - string - MD5 hash of your GPG public key
         
     | 
| 
       264 
278 
     | 
    
         
             
                #   private_key - string - MD5 hash of your GPG private key.
         
     | 
| 
       265 
279 
     | 
    
         
             
                #   private_key_password - string - Your GPG private key password. Only required for password protected keys.
         
     | 
| 
         @@ -268,6 +282,7 @@ module Files 
     | 
|
| 
       268 
282 
     | 
    
         
             
                  params ||= {}
         
     | 
| 
       269 
283 
     | 
    
         
             
                  params[:id] = id
         
     | 
| 
       270 
284 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
         
     | 
| 
      
 285 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
         
     | 
| 
       271 
286 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
         
     | 
| 
       272 
287 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
         
     | 
| 
       273 
288 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
         
     | 
| 
         @@ -72,13 +72,23 @@ module Files 
     | 
|
| 
       72 
72 
     | 
    
         
             
                  @attributes[:root_folder] = value
         
     | 
| 
       73 
73 
     | 
    
         
             
                end
         
     | 
| 
       74 
74 
     | 
    
         | 
| 
      
 75 
     | 
    
         
            +
                # string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 76 
     | 
    
         
            +
                def tags
         
     | 
| 
      
 77 
     | 
    
         
            +
                  @attributes[:tags]
         
     | 
| 
      
 78 
     | 
    
         
            +
                end
         
     | 
| 
      
 79 
     | 
    
         
            +
             
     | 
| 
      
 80 
     | 
    
         
            +
                def tags=(value)
         
     | 
| 
      
 81 
     | 
    
         
            +
                  @attributes[:tags] = value
         
     | 
| 
      
 82 
     | 
    
         
            +
                end
         
     | 
| 
      
 83 
     | 
    
         
            +
             
     | 
| 
       75 
84 
     | 
    
         
             
                # Parameters:
         
     | 
| 
      
 85 
     | 
    
         
            +
                #   name - string - The name of the Partner.
         
     | 
| 
       76 
86 
     | 
    
         
             
                #   allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
         
     | 
| 
       77 
87 
     | 
    
         
             
                #   allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
         
     | 
| 
       78 
88 
     | 
    
         
             
                #   allow_user_creation - boolean - Allow Partner Admins to create users.
         
     | 
| 
       79 
     | 
    
         
            -
                #   name - string - The name of the Partner.
         
     | 
| 
       80 
89 
     | 
    
         
             
                #   notes - string - Notes about this Partner.
         
     | 
| 
       81 
90 
     | 
    
         
             
                #   root_folder - string - The root folder path for this Partner.
         
     | 
| 
      
 91 
     | 
    
         
            +
                #   tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       82 
92 
     | 
    
         
             
                def update(params = {})
         
     | 
| 
       83 
93 
     | 
    
         
             
                  params ||= {}
         
     | 
| 
       84 
94 
     | 
    
         
             
                  params[:id] = @attributes[:id]
         
     | 
| 
         @@ -87,6 +97,7 @@ module Files 
     | 
|
| 
       87 
97 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
         
     | 
| 
       88 
98 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
         
     | 
| 
       89 
99 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
         
     | 
| 
      
 100 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
         
     | 
| 
       90 
101 
     | 
    
         
             
                  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
         
     | 
| 
       91 
102 
     | 
    
         | 
| 
       92 
103 
     | 
    
         
             
                  Api.send_request("/partners/#{@attributes[:id]}", :patch, params, @options)
         
     | 
| 
         @@ -153,28 +164,31 @@ module Files 
     | 
|
| 
       153 
164 
     | 
    
         
             
                end
         
     | 
| 
       154 
165 
     | 
    
         | 
| 
       155 
166 
     | 
    
         
             
                # Parameters:
         
     | 
| 
      
 167 
     | 
    
         
            +
                #   name - string - The name of the Partner.
         
     | 
| 
       156 
168 
     | 
    
         
             
                #   allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
         
     | 
| 
       157 
169 
     | 
    
         
             
                #   allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
         
     | 
| 
       158 
170 
     | 
    
         
             
                #   allow_user_creation - boolean - Allow Partner Admins to create users.
         
     | 
| 
       159 
     | 
    
         
            -
                #   name - string - The name of the Partner.
         
     | 
| 
       160 
171 
     | 
    
         
             
                #   notes - string - Notes about this Partner.
         
     | 
| 
       161 
172 
     | 
    
         
             
                #   root_folder - string - The root folder path for this Partner.
         
     | 
| 
      
 173 
     | 
    
         
            +
                #   tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       162 
174 
     | 
    
         
             
                def self.create(params = {}, options = {})
         
     | 
| 
       163 
175 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
         
     | 
| 
       164 
176 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
         
     | 
| 
       165 
177 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
         
     | 
| 
      
 178 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
         
     | 
| 
       166 
179 
     | 
    
         | 
| 
       167 
180 
     | 
    
         
             
                  response, options = Api.send_request("/partners", :post, params, options)
         
     | 
| 
       168 
181 
     | 
    
         
             
                  Partner.new(response.data, options)
         
     | 
| 
       169 
182 
     | 
    
         
             
                end
         
     | 
| 
       170 
183 
     | 
    
         | 
| 
       171 
184 
     | 
    
         
             
                # Parameters:
         
     | 
| 
      
 185 
     | 
    
         
            +
                #   name - string - The name of the Partner.
         
     | 
| 
       172 
186 
     | 
    
         
             
                #   allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
         
     | 
| 
       173 
187 
     | 
    
         
             
                #   allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
         
     | 
| 
       174 
188 
     | 
    
         
             
                #   allow_user_creation - boolean - Allow Partner Admins to create users.
         
     | 
| 
       175 
     | 
    
         
            -
                #   name - string - The name of the Partner.
         
     | 
| 
       176 
189 
     | 
    
         
             
                #   notes - string - Notes about this Partner.
         
     | 
| 
       177 
190 
     | 
    
         
             
                #   root_folder - string - The root folder path for this Partner.
         
     | 
| 
      
 191 
     | 
    
         
            +
                #   tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       178 
192 
     | 
    
         
             
                def self.update(id, params = {}, options = {})
         
     | 
| 
       179 
193 
     | 
    
         
             
                  params ||= {}
         
     | 
| 
       180 
194 
     | 
    
         
             
                  params[:id] = id
         
     | 
| 
         @@ -182,6 +196,7 @@ module Files 
     | 
|
| 
       182 
196 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
         
     | 
| 
       183 
197 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
         
     | 
| 
       184 
198 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
         
     | 
| 
      
 199 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
         
     | 
| 
       185 
200 
     | 
    
         
             
                  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
         
     | 
| 
       186 
201 
     | 
    
         | 
| 
       187 
202 
     | 
    
         
             
                  response, options = Api.send_request("/partners/#{params[:id]}", :patch, params, options)
         
     | 
| 
         @@ -72,6 +72,15 @@ module Files 
     | 
|
| 
       72 
72 
     | 
    
         
             
                  @attributes[:partner_id] = value
         
     | 
| 
       73 
73 
     | 
    
         
             
                end
         
     | 
| 
       74 
74 
     | 
    
         | 
| 
      
 75 
     | 
    
         
            +
                # string - Partner name (if applicable)
         
     | 
| 
      
 76 
     | 
    
         
            +
                def partner_name
         
     | 
| 
      
 77 
     | 
    
         
            +
                  @attributes[:partner_name]
         
     | 
| 
      
 78 
     | 
    
         
            +
                end
         
     | 
| 
      
 79 
     | 
    
         
            +
             
     | 
| 
      
 80 
     | 
    
         
            +
                def partner_name=(value)
         
     | 
| 
      
 81 
     | 
    
         
            +
                  @attributes[:partner_name] = value
         
     | 
| 
      
 82 
     | 
    
         
            +
                end
         
     | 
| 
      
 83 
     | 
    
         
            +
             
     | 
| 
       75 
84 
     | 
    
         
             
                # string - Permission type.  See the table referenced in the documentation for an explanation of each permission.
         
     | 
| 
       76 
85 
     | 
    
         
             
                def permission
         
     | 
| 
       77 
86 
     | 
    
         
             
                  @attributes[:permission]
         
     | 
| 
         @@ -193,6 +193,7 @@ module Files 
     | 
|
| 
       193 
193 
     | 
    
         
             
                #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
         
     | 
| 
       194 
194 
     | 
    
         
             
                #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
         
     | 
| 
       195 
195 
     | 
    
         
             
                #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
         
     | 
| 
      
 196 
     | 
    
         
            +
                #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `title`, `created_at` or `user_id`.
         
     | 
| 
       196 
197 
     | 
    
         
             
                #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
         
     | 
| 
       197 
198 
     | 
    
         
             
                #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
         
     | 
| 
       198 
199 
     | 
    
         
             
                #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
         
     | 
| 
         @@ -202,6 +203,7 @@ module Files 
     | 
|
| 
       202 
203 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
         
     | 
| 
       203 
204 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
         
     | 
| 
       204 
205 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
         
     | 
| 
      
 206 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
         
     | 
| 
       205 
207 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
         
     | 
| 
       206 
208 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
         
     | 
| 
       207 
209 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
         
     | 
| 
         @@ -66,5 +66,21 @@ module Files 
     | 
|
| 
       66 
66 
     | 
    
         
             
                def self.all(params = {}, options = {})
         
     | 
| 
       67 
67 
     | 
    
         
             
                  list(params, options)
         
     | 
| 
       68 
68 
     | 
    
         
             
                end
         
     | 
| 
      
 69 
     | 
    
         
            +
             
     | 
| 
      
 70 
     | 
    
         
            +
                # Parameters:
         
     | 
| 
      
 71 
     | 
    
         
            +
                #   id (required) - int64 - Scim Log ID.
         
     | 
| 
      
 72 
     | 
    
         
            +
                def self.find(id, params = {}, options = {})
         
     | 
| 
      
 73 
     | 
    
         
            +
                  params ||= {}
         
     | 
| 
      
 74 
     | 
    
         
            +
                  params[:id] = id
         
     | 
| 
      
 75 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
         
     | 
| 
      
 76 
     | 
    
         
            +
                  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
         
     | 
| 
      
 77 
     | 
    
         
            +
             
     | 
| 
      
 78 
     | 
    
         
            +
                  response, options = Api.send_request("/scim_logs/#{params[:id]}", :get, params, options)
         
     | 
| 
      
 79 
     | 
    
         
            +
                  ScimLog.new(response.data, options)
         
     | 
| 
      
 80 
     | 
    
         
            +
                end
         
     | 
| 
      
 81 
     | 
    
         
            +
             
     | 
| 
      
 82 
     | 
    
         
            +
                def self.get(id, params = {}, options = {})
         
     | 
| 
      
 83 
     | 
    
         
            +
                  find(id, params, options)
         
     | 
| 
      
 84 
     | 
    
         
            +
                end
         
     | 
| 
       69 
85 
     | 
    
         
             
              end
         
     | 
| 
       70 
86 
     | 
    
         
             
            end
         
     | 
| 
         @@ -563,6 +563,15 @@ module Files 
     | 
|
| 
       563 
563 
     | 
    
         
             
                  @attributes[:externally_managed] = value
         
     | 
| 
       564 
564 
     | 
    
         
             
                end
         
     | 
| 
       565 
565 
     | 
    
         | 
| 
      
 566 
     | 
    
         
            +
                # string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 567 
     | 
    
         
            +
                def tags
         
     | 
| 
      
 568 
     | 
    
         
            +
                  @attributes[:tags]
         
     | 
| 
      
 569 
     | 
    
         
            +
                end
         
     | 
| 
      
 570 
     | 
    
         
            +
             
     | 
| 
      
 571 
     | 
    
         
            +
                def tags=(value)
         
     | 
| 
      
 572 
     | 
    
         
            +
                  @attributes[:tags] = value
         
     | 
| 
      
 573 
     | 
    
         
            +
                end
         
     | 
| 
      
 574 
     | 
    
         
            +
             
     | 
| 
       566 
575 
     | 
    
         
             
                # string - User time zone
         
     | 
| 
       567 
576 
     | 
    
         
             
                def time_zone
         
     | 
| 
       568 
577 
     | 
    
         
             
                  @attributes[:time_zone]
         
     | 
| 
         @@ -805,6 +814,7 @@ module Files 
     | 
|
| 
       805 
814 
     | 
    
         
             
                #   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
         
     | 
| 
       806 
815 
     | 
    
         
             
                #   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
         
     | 
| 
       807 
816 
     | 
    
         
             
                #   require_2fa - string - 2FA required setting
         
     | 
| 
      
 817 
     | 
    
         
            +
                #   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       808 
818 
     | 
    
         
             
                #   time_zone - string - User time zone
         
     | 
| 
       809 
819 
     | 
    
         
             
                #   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
       810 
820 
     | 
    
         
             
                #   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
         @@ -840,6 +850,7 @@ module Files 
     | 
|
| 
       840 
850 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: ssl_required must be an String") if params[:ssl_required] and !params[:ssl_required].is_a?(String)
         
     | 
| 
       841 
851 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: sso_strategy_id must be an Integer") if params[:sso_strategy_id] and !params[:sso_strategy_id].is_a?(Integer)
         
     | 
| 
       842 
852 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: require_2fa must be an String") if params[:require_2fa] and !params[:require_2fa].is_a?(String)
         
     | 
| 
      
 853 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
         
     | 
| 
       843 
854 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
         
     | 
| 
       844 
855 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
         
     | 
| 
       845 
856 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_home must be an String") if params[:user_home] and !params[:user_home].is_a?(String)
         
     | 
| 
         @@ -882,7 +893,7 @@ module Files 
     | 
|
| 
       882 
893 
     | 
    
         
             
                #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
         
     | 
| 
       883 
894 
     | 
    
         
             
                #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
         
     | 
| 
       884 
895 
     | 
    
         
             
                #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username`, `site_admin` or `disabled`.
         
     | 
| 
       885 
     | 
    
         
            -
                #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin` or ` 
     | 
| 
      
 896 
     | 
    
         
            +
                #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled` or `partner_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
         
     | 
| 
       886 
897 
     | 
    
         
             
                #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
         
     | 
| 
       887 
898 
     | 
    
         
             
                #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
         
     | 
| 
       888 
899 
     | 
    
         
             
                #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
         
     | 
| 
         @@ -976,6 +987,7 @@ module Files 
     | 
|
| 
       976 
987 
     | 
    
         
             
                #   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
         
     | 
| 
       977 
988 
     | 
    
         
             
                #   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
         
     | 
| 
       978 
989 
     | 
    
         
             
                #   require_2fa - string - 2FA required setting
         
     | 
| 
      
 990 
     | 
    
         
            +
                #   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       979 
991 
     | 
    
         
             
                #   time_zone - string - User time zone
         
     | 
| 
       980 
992 
     | 
    
         
             
                #   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
       981 
993 
     | 
    
         
             
                #   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
         @@ -1006,6 +1018,7 @@ module Files 
     | 
|
| 
       1006 
1018 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: ssl_required must be an String") if params[:ssl_required] and !params[:ssl_required].is_a?(String)
         
     | 
| 
       1007 
1019 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: sso_strategy_id must be an Integer") if params[:sso_strategy_id] and !params[:sso_strategy_id].is_a?(Integer)
         
     | 
| 
       1008 
1020 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: require_2fa must be an String") if params[:require_2fa] and !params[:require_2fa].is_a?(String)
         
     | 
| 
      
 1021 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
         
     | 
| 
       1009 
1022 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
         
     | 
| 
       1010 
1023 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
         
     | 
| 
       1011 
1024 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_home must be an String") if params[:user_home] and !params[:user_home].is_a?(String)
         
     | 
| 
         @@ -1096,6 +1109,7 @@ module Files 
     | 
|
| 
       1096 
1109 
     | 
    
         
             
                #   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
         
     | 
| 
       1097 
1110 
     | 
    
         
             
                #   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
         
     | 
| 
       1098 
1111 
     | 
    
         
             
                #   require_2fa - string - 2FA required setting
         
     | 
| 
      
 1112 
     | 
    
         
            +
                #   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       1099 
1113 
     | 
    
         
             
                #   time_zone - string - User time zone
         
     | 
| 
       1100 
1114 
     | 
    
         
             
                #   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
       1101 
1115 
     | 
    
         
             
                #   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
         
     | 
| 
         @@ -1130,6 +1144,7 @@ module Files 
     | 
|
| 
       1130 
1144 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: ssl_required must be an String") if params[:ssl_required] and !params[:ssl_required].is_a?(String)
         
     | 
| 
       1131 
1145 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: sso_strategy_id must be an Integer") if params[:sso_strategy_id] and !params[:sso_strategy_id].is_a?(Integer)
         
     | 
| 
       1132 
1146 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: require_2fa must be an String") if params[:require_2fa] and !params[:require_2fa].is_a?(String)
         
     | 
| 
      
 1147 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
         
     | 
| 
       1133 
1148 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
         
     | 
| 
       1134 
1149 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
         
     | 
| 
       1135 
1150 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: user_home must be an String") if params[:user_home] and !params[:user_home].is_a?(String)
         
     | 
| 
         @@ -18,7 +18,7 @@ module Files 
     | 
|
| 
       18 
18 
     | 
    
         
             
                  @attributes[:id] = value
         
     | 
| 
       19 
19 
     | 
    
         
             
                end
         
     | 
| 
       20 
20 
     | 
    
         | 
| 
       21 
     | 
    
         
            -
                # string - User authentication method for the rule
         
     | 
| 
      
 21 
     | 
    
         
            +
                # string - User authentication method for which the rule will apply.
         
     | 
| 
       22 
22 
     | 
    
         
             
                def authentication_method
         
     | 
| 
       23 
23 
     | 
    
         
             
                  @attributes[:authentication_method]
         
     | 
| 
       24 
24 
     | 
    
         
             
                end
         
     | 
| 
         @@ -36,6 +36,15 @@ module Files 
     | 
|
| 
       36 
36 
     | 
    
         
             
                  @attributes[:group_ids] = value
         
     | 
| 
       37 
37 
     | 
    
         
             
                end
         
     | 
| 
       38 
38 
     | 
    
         | 
| 
      
 39 
     | 
    
         
            +
                # string - Action to take on inactive users (disable or delete)
         
     | 
| 
      
 40 
     | 
    
         
            +
                def action
         
     | 
| 
      
 41 
     | 
    
         
            +
                  @attributes[:action]
         
     | 
| 
      
 42 
     | 
    
         
            +
                end
         
     | 
| 
      
 43 
     | 
    
         
            +
             
     | 
| 
      
 44 
     | 
    
         
            +
                def action=(value)
         
     | 
| 
      
 45 
     | 
    
         
            +
                  @attributes[:action] = value
         
     | 
| 
      
 46 
     | 
    
         
            +
                end
         
     | 
| 
      
 47 
     | 
    
         
            +
             
     | 
| 
       39 
48 
     | 
    
         
             
                # int64 - Number of days of inactivity before the rule applies
         
     | 
| 
       40 
49 
     | 
    
         
             
                def inactivity_days
         
     | 
| 
       41 
50 
     | 
    
         
             
                  @attributes[:inactivity_days]
         
     | 
| 
         @@ -45,7 +54,7 @@ module Files 
     | 
|
| 
       45 
54 
     | 
    
         
             
                  @attributes[:inactivity_days] = value
         
     | 
| 
       46 
55 
     | 
    
         
             
                end
         
     | 
| 
       47 
56 
     | 
    
         | 
| 
       48 
     | 
    
         
            -
                # boolean -  
     | 
| 
      
 57 
     | 
    
         
            +
                # boolean - If true, the rule will apply to folder admins.
         
     | 
| 
       49 
58 
     | 
    
         
             
                def include_folder_admins
         
     | 
| 
       50 
59 
     | 
    
         
             
                  @attributes[:include_folder_admins]
         
     | 
| 
       51 
60 
     | 
    
         
             
                end
         
     | 
| 
         @@ -54,7 +63,7 @@ module Files 
     | 
|
| 
       54 
63 
     | 
    
         
             
                  @attributes[:include_folder_admins] = value
         
     | 
| 
       55 
64 
     | 
    
         
             
                end
         
     | 
| 
       56 
65 
     | 
    
         | 
| 
       57 
     | 
    
         
            -
                # boolean -  
     | 
| 
      
 66 
     | 
    
         
            +
                # boolean - If true, the rule will apply to site admins.
         
     | 
| 
       58 
67 
     | 
    
         
             
                def include_site_admins
         
     | 
| 
       59 
68 
     | 
    
         
             
                  @attributes[:include_site_admins]
         
     | 
| 
       60 
69 
     | 
    
         
             
                end
         
     | 
| 
         @@ -63,24 +72,6 @@ module Files 
     | 
|
| 
       63 
72 
     | 
    
         
             
                  @attributes[:include_site_admins] = value
         
     | 
| 
       64 
73 
     | 
    
         
             
                end
         
     | 
| 
       65 
74 
     | 
    
         | 
| 
       66 
     | 
    
         
            -
                # string - Action to take on inactive users (disable or delete)
         
     | 
| 
       67 
     | 
    
         
            -
                def action
         
     | 
| 
       68 
     | 
    
         
            -
                  @attributes[:action]
         
     | 
| 
       69 
     | 
    
         
            -
                end
         
     | 
| 
       70 
     | 
    
         
            -
             
     | 
| 
       71 
     | 
    
         
            -
                def action=(value)
         
     | 
| 
       72 
     | 
    
         
            -
                  @attributes[:action] = value
         
     | 
| 
       73 
     | 
    
         
            -
                end
         
     | 
| 
       74 
     | 
    
         
            -
             
     | 
| 
       75 
     | 
    
         
            -
                # string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
       76 
     | 
    
         
            -
                def user_state
         
     | 
| 
       77 
     | 
    
         
            -
                  @attributes[:user_state]
         
     | 
| 
       78 
     | 
    
         
            -
                end
         
     | 
| 
       79 
     | 
    
         
            -
             
     | 
| 
       80 
     | 
    
         
            -
                def user_state=(value)
         
     | 
| 
       81 
     | 
    
         
            -
                  @attributes[:user_state] = value
         
     | 
| 
       82 
     | 
    
         
            -
                end
         
     | 
| 
       83 
     | 
    
         
            -
             
     | 
| 
       84 
75 
     | 
    
         
             
                # string - User Lifecycle Rule name
         
     | 
| 
       85 
76 
     | 
    
         
             
                def name
         
     | 
| 
       86 
77 
     | 
    
         
             
                  @attributes[:name]
         
     | 
| 
         @@ -90,6 +81,15 @@ module Files 
     | 
|
| 
       90 
81 
     | 
    
         
             
                  @attributes[:name] = value
         
     | 
| 
       91 
82 
     | 
    
         
             
                end
         
     | 
| 
       92 
83 
     | 
    
         | 
| 
      
 84 
     | 
    
         
            +
                # string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 85 
     | 
    
         
            +
                def partner_tag
         
     | 
| 
      
 86 
     | 
    
         
            +
                  @attributes[:partner_tag]
         
     | 
| 
      
 87 
     | 
    
         
            +
                end
         
     | 
| 
      
 88 
     | 
    
         
            +
             
     | 
| 
      
 89 
     | 
    
         
            +
                def partner_tag=(value)
         
     | 
| 
      
 90 
     | 
    
         
            +
                  @attributes[:partner_tag] = value
         
     | 
| 
      
 91 
     | 
    
         
            +
                end
         
     | 
| 
      
 92 
     | 
    
         
            +
             
     | 
| 
       93 
93 
     | 
    
         
             
                # int64 - Site ID
         
     | 
| 
       94 
94 
     | 
    
         
             
                def site_id
         
     | 
| 
       95 
95 
     | 
    
         
             
                  @attributes[:site_id]
         
     | 
| 
         @@ -99,15 +99,35 @@ module Files 
     | 
|
| 
       99 
99 
     | 
    
         
             
                  @attributes[:site_id] = value
         
     | 
| 
       100 
100 
     | 
    
         
             
                end
         
     | 
| 
       101 
101 
     | 
    
         | 
| 
      
 102 
     | 
    
         
            +
                # string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 103 
     | 
    
         
            +
                def user_state
         
     | 
| 
      
 104 
     | 
    
         
            +
                  @attributes[:user_state]
         
     | 
| 
      
 105 
     | 
    
         
            +
                end
         
     | 
| 
      
 106 
     | 
    
         
            +
             
     | 
| 
      
 107 
     | 
    
         
            +
                def user_state=(value)
         
     | 
| 
      
 108 
     | 
    
         
            +
                  @attributes[:user_state] = value
         
     | 
| 
      
 109 
     | 
    
         
            +
                end
         
     | 
| 
      
 110 
     | 
    
         
            +
             
     | 
| 
      
 111 
     | 
    
         
            +
                # string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 112 
     | 
    
         
            +
                def user_tag
         
     | 
| 
      
 113 
     | 
    
         
            +
                  @attributes[:user_tag]
         
     | 
| 
      
 114 
     | 
    
         
            +
                end
         
     | 
| 
      
 115 
     | 
    
         
            +
             
     | 
| 
      
 116 
     | 
    
         
            +
                def user_tag=(value)
         
     | 
| 
      
 117 
     | 
    
         
            +
                  @attributes[:user_tag] = value
         
     | 
| 
      
 118 
     | 
    
         
            +
                end
         
     | 
| 
      
 119 
     | 
    
         
            +
             
     | 
| 
       102 
120 
     | 
    
         
             
                # Parameters:
         
     | 
| 
       103 
121 
     | 
    
         
             
                #   action - string - Action to take on inactive users (disable or delete)
         
     | 
| 
       104 
     | 
    
         
            -
                #   authentication_method - string - User authentication method for the rule
         
     | 
| 
      
 122 
     | 
    
         
            +
                #   authentication_method - string - User authentication method for which the rule will apply.
         
     | 
| 
       105 
123 
     | 
    
         
             
                #   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         
     | 
| 
       106 
124 
     | 
    
         
             
                #   inactivity_days - int64 - Number of days of inactivity before the rule applies
         
     | 
| 
       107 
     | 
    
         
            -
                #   include_site_admins - boolean -  
     | 
| 
       108 
     | 
    
         
            -
                #   include_folder_admins - boolean -  
     | 
| 
       109 
     | 
    
         
            -
                #   user_state - string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 125 
     | 
    
         
            +
                #   include_site_admins - boolean - If true, the rule will apply to site admins.
         
     | 
| 
      
 126 
     | 
    
         
            +
                #   include_folder_admins - boolean - If true, the rule will apply to folder admins.
         
     | 
| 
       110 
127 
     | 
    
         
             
                #   name - string - User Lifecycle Rule name
         
     | 
| 
      
 128 
     | 
    
         
            +
                #   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 129 
     | 
    
         
            +
                #   user_state - string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 130 
     | 
    
         
            +
                #   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       111 
131 
     | 
    
         
             
                def update(params = {})
         
     | 
| 
       112 
132 
     | 
    
         
             
                  params ||= {}
         
     | 
| 
       113 
133 
     | 
    
         
             
                  params[:id] = @attributes[:id]
         
     | 
| 
         @@ -117,8 +137,10 @@ module Files 
     | 
|
| 
       117 
137 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
         
     | 
| 
       118 
138 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: group_ids must be an Array") if params[:group_ids] and !params[:group_ids].is_a?(Array)
         
     | 
| 
       119 
139 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
         
     | 
| 
       120 
     | 
    
         
            -
                  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
         
     | 
| 
       121 
140 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
         
     | 
| 
      
 141 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: partner_tag must be an String") if params[:partner_tag] and !params[:partner_tag].is_a?(String)
         
     | 
| 
      
 142 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
         
     | 
| 
      
 143 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: user_tag must be an String") if params[:user_tag] and !params[:user_tag].is_a?(String)
         
     | 
| 
       122 
144 
     | 
    
         
             
                  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
         
     | 
| 
       123 
145 
     | 
    
         | 
| 
       124 
146 
     | 
    
         
             
                  Api.send_request("/user_lifecycle_rules/#{@attributes[:id]}", :patch, params, @options)
         
     | 
| 
         @@ -153,9 +175,11 @@ module Files 
     | 
|
| 
       153 
175 
     | 
    
         
             
                # Parameters:
         
     | 
| 
       154 
176 
     | 
    
         
             
                #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
         
     | 
| 
       155 
177 
     | 
    
         
             
                #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
         
     | 
| 
      
 178 
     | 
    
         
            +
                #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
         
     | 
| 
       156 
179 
     | 
    
         
             
                def self.list(params = {}, options = {})
         
     | 
| 
       157 
180 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
         
     | 
| 
       158 
181 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
         
     | 
| 
      
 182 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
         
     | 
| 
       159 
183 
     | 
    
         | 
| 
       160 
184 
     | 
    
         
             
                  List.new(UserLifecycleRule, params) do
         
     | 
| 
       161 
185 
     | 
    
         
             
                    Api.send_request("/user_lifecycle_rules", :get, params, options)
         
     | 
| 
         @@ -184,20 +208,24 @@ module Files 
     | 
|
| 
       184 
208 
     | 
    
         | 
| 
       185 
209 
     | 
    
         
             
                # Parameters:
         
     | 
| 
       186 
210 
     | 
    
         
             
                #   action - string - Action to take on inactive users (disable or delete)
         
     | 
| 
       187 
     | 
    
         
            -
                #   authentication_method - string - User authentication method for the rule
         
     | 
| 
      
 211 
     | 
    
         
            +
                #   authentication_method - string - User authentication method for which the rule will apply.
         
     | 
| 
       188 
212 
     | 
    
         
             
                #   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         
     | 
| 
       189 
213 
     | 
    
         
             
                #   inactivity_days - int64 - Number of days of inactivity before the rule applies
         
     | 
| 
       190 
     | 
    
         
            -
                #   include_site_admins - boolean -  
     | 
| 
       191 
     | 
    
         
            -
                #   include_folder_admins - boolean -  
     | 
| 
       192 
     | 
    
         
            -
                #   user_state - string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 214 
     | 
    
         
            +
                #   include_site_admins - boolean - If true, the rule will apply to site admins.
         
     | 
| 
      
 215 
     | 
    
         
            +
                #   include_folder_admins - boolean - If true, the rule will apply to folder admins.
         
     | 
| 
       193 
216 
     | 
    
         
             
                #   name - string - User Lifecycle Rule name
         
     | 
| 
      
 217 
     | 
    
         
            +
                #   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 218 
     | 
    
         
            +
                #   user_state - string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 219 
     | 
    
         
            +
                #   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       194 
220 
     | 
    
         
             
                def self.create(params = {}, options = {})
         
     | 
| 
       195 
221 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
         
     | 
| 
       196 
222 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
         
     | 
| 
       197 
223 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: group_ids must be an Array") if params[:group_ids] and !params[:group_ids].is_a?(Array)
         
     | 
| 
       198 
224 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
         
     | 
| 
       199 
     | 
    
         
            -
                  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
         
     | 
| 
       200 
225 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
         
     | 
| 
      
 226 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: partner_tag must be an String") if params[:partner_tag] and !params[:partner_tag].is_a?(String)
         
     | 
| 
      
 227 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
         
     | 
| 
      
 228 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: user_tag must be an String") if params[:user_tag] and !params[:user_tag].is_a?(String)
         
     | 
| 
       201 
229 
     | 
    
         | 
| 
       202 
230 
     | 
    
         
             
                  response, options = Api.send_request("/user_lifecycle_rules", :post, params, options)
         
     | 
| 
       203 
231 
     | 
    
         
             
                  UserLifecycleRule.new(response.data, options)
         
     | 
| 
         @@ -205,13 +233,15 @@ module Files 
     | 
|
| 
       205 
233 
     | 
    
         | 
| 
       206 
234 
     | 
    
         
             
                # Parameters:
         
     | 
| 
       207 
235 
     | 
    
         
             
                #   action - string - Action to take on inactive users (disable or delete)
         
     | 
| 
       208 
     | 
    
         
            -
                #   authentication_method - string - User authentication method for the rule
         
     | 
| 
      
 236 
     | 
    
         
            +
                #   authentication_method - string - User authentication method for which the rule will apply.
         
     | 
| 
       209 
237 
     | 
    
         
             
                #   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         
     | 
| 
       210 
238 
     | 
    
         
             
                #   inactivity_days - int64 - Number of days of inactivity before the rule applies
         
     | 
| 
       211 
     | 
    
         
            -
                #   include_site_admins - boolean -  
     | 
| 
       212 
     | 
    
         
            -
                #   include_folder_admins - boolean -  
     | 
| 
       213 
     | 
    
         
            -
                #   user_state - string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 239 
     | 
    
         
            +
                #   include_site_admins - boolean - If true, the rule will apply to site admins.
         
     | 
| 
      
 240 
     | 
    
         
            +
                #   include_folder_admins - boolean - If true, the rule will apply to folder admins.
         
     | 
| 
       214 
241 
     | 
    
         
             
                #   name - string - User Lifecycle Rule name
         
     | 
| 
      
 242 
     | 
    
         
            +
                #   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
      
 243 
     | 
    
         
            +
                #   user_state - string - State of the users to apply the rule to (inactive or disabled)
         
     | 
| 
      
 244 
     | 
    
         
            +
                #   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         
     | 
| 
       215 
245 
     | 
    
         
             
                def self.update(id, params = {}, options = {})
         
     | 
| 
       216 
246 
     | 
    
         
             
                  params ||= {}
         
     | 
| 
       217 
247 
     | 
    
         
             
                  params[:id] = id
         
     | 
| 
         @@ -220,8 +250,10 @@ module Files 
     | 
|
| 
       220 
250 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
         
     | 
| 
       221 
251 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: group_ids must be an Array") if params[:group_ids] and !params[:group_ids].is_a?(Array)
         
     | 
| 
       222 
252 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
         
     | 
| 
       223 
     | 
    
         
            -
                  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
         
     | 
| 
       224 
253 
     | 
    
         
             
                  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
         
     | 
| 
      
 254 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: partner_tag must be an String") if params[:partner_tag] and !params[:partner_tag].is_a?(String)
         
     | 
| 
      
 255 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: user_state must be an String") if params[:user_state] and !params[:user_state].is_a?(String)
         
     | 
| 
      
 256 
     | 
    
         
            +
                  raise InvalidParameterError.new("Bad parameter: user_tag must be an String") if params[:user_tag] and !params[:user_tag].is_a?(String)
         
     | 
| 
       225 
257 
     | 
    
         
             
                  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
         
     | 
| 
       226 
258 
     | 
    
         | 
| 
       227 
259 
     | 
    
         
             
                  response, options = Api.send_request("/user_lifecycle_rules/#{params[:id]}", :patch, params, options)
         
     | 
    
        data/lib/files.com/version.rb
    CHANGED
    
    
    
        metadata
    CHANGED
    
    | 
         @@ -1,14 +1,14 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            --- !ruby/object:Gem::Specification
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: files.com
         
     | 
| 
       3 
3 
     | 
    
         
             
            version: !ruby/object:Gem::Version
         
     | 
| 
       4 
     | 
    
         
            -
              version: 1.1. 
     | 
| 
      
 4 
     | 
    
         
            +
              version: 1.1.340
         
     | 
| 
       5 
5 
     | 
    
         
             
            platform: ruby
         
     | 
| 
       6 
6 
     | 
    
         
             
            authors:
         
     | 
| 
       7 
7 
     | 
    
         
             
            - files.com
         
     | 
| 
       8 
8 
     | 
    
         
             
            autorequire: 
         
     | 
| 
       9 
9 
     | 
    
         
             
            bindir: bin
         
     | 
| 
       10 
10 
     | 
    
         
             
            cert_chain: []
         
     | 
| 
       11 
     | 
    
         
            -
            date: 2025-10- 
     | 
| 
      
 11 
     | 
    
         
            +
            date: 2025-10-17 00:00:00.000000000 Z
         
     | 
| 
       12 
12 
     | 
    
         
             
            dependencies:
         
     | 
| 
       13 
13 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       14 
14 
     | 
    
         
             
              name: addressable
         
     |