files.com 1.0.482 → 1.0.484

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9a08490c2f45105230c911aa54c4c144313ef6067bf4faed90ec4bd481f7eb9b
4
- data.tar.gz: 55abe94fc0cfa4486b53e3f543782c896e817ae6f20869064c0e1856e8c37b53
3
+ metadata.gz: cc80dcdae3f57912eac86d50f56b5d9756d8a2eed6d7f61280f54a1d7b08e21d
4
+ data.tar.gz: 2f39fce8d46a173acad3961aa9e6de4f84166ce1b4bcb475c6abec3d0d46df04
5
5
  SHA512:
6
- metadata.gz: 6027863ba2c590ab67dca691974f0a38a531c98244c13cff9d7fbd2593a9992b54a0a5d9c9a866eab329839fc9147da6c1bcbcaa3849cf1ca5ec67ea19c10bf6
7
- data.tar.gz: eba006acf16ba7cfea175a1beb235acb9099aeade38d7f9054a0264a446f5d0333c7b81d17d02fded772d545ac7431b1c9ef34c67a2b1dfc20b6a1acf524b871
6
+ metadata.gz: b8bd6cb084ca27dd649020cb34554be625a5ef28f02062093a323d8721e67751c5268fad30000470850b10df0396c6598b44fbacd5856c3275b219e31c604271
7
+ data.tar.gz: f000807e98a5244b4f3b750de84980a1514aa1ad7706b19e90703317e0262ed478414136ff622958961c5bb9f0e54f62062b8fa06d067b67ae116b28f77f55b2
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.482
1
+ 1.0.484
data/docs/app.md CHANGED
@@ -4,45 +4,53 @@
4
4
 
5
5
  ```
6
6
  {
7
- "name": "example",
8
- "extended_description": "example",
9
- "short_description": "example",
7
+ "app_type": "example",
10
8
  "documentation_links": {
11
9
  "Important Info": "http://files.test/learn-more"
12
10
  },
11
+ "extended_description": "example",
12
+ "extended_description_for_marketing_site": "example",
13
+ "external_homepage_url": "example",
14
+ "featured": true,
15
+ "folder_behavior_type": "example",
13
16
  "icon_url": "example",
17
+ "logo_thumbnail_url": "example",
14
18
  "logo_url": "example",
19
+ "marketing_intro": "example",
20
+ "marketing_youtube_url": "example",
21
+ "name": "example",
22
+ "package_manager_install_command": "example",
23
+ "remote_server_type": "example",
15
24
  "screenshot_list_urls": [
16
25
  "example"
17
26
  ],
18
- "logo_thumbnail_url": "example",
27
+ "sdk_installation_instructions_link": "example",
28
+ "short_description": "example",
19
29
  "sso_strategy_type": "example",
20
- "remote_server_type": "example",
21
- "folder_behavior_type": "example",
22
- "external_homepage_url": "example",
23
- "marketing_youtube_url": "example",
24
- "tutorial_youtube_url": "example",
25
- "app_type": "example",
26
- "featured": true
30
+ "tutorial_youtube_url": "example"
27
31
  }
28
32
  ```
29
33
 
30
- * `name` (string): Name of the App
31
- * `extended_description` (string): Long form description of the App
32
- * `short_description` (string): Short description of the App
34
+ * `app_type` (string): The type of the App
33
35
  * `documentation_links` (object): Collection of named links to documentation
36
+ * `extended_description` (string): Long description for the in-App landing page
37
+ * `extended_description_for_marketing_site` (string): Long form description of the App
38
+ * `external_homepage_url` (string): Link to external homepage
39
+ * `featured` (boolean): Is featured on the App listing?
40
+ * `folder_behavior_type` (string): Associated Folder Behavior type, if any
34
41
  * `icon_url` (string): App icon
42
+ * `logo_thumbnail_url` (string): Logo thumbnail for the App
35
43
  * `logo_url` (string): Full size logo for the App
44
+ * `marketing_intro` (string): Marketing introdution of the App
45
+ * `marketing_youtube_url` (string): Marketing video page
46
+ * `name` (string): Name of the App
47
+ * `package_manager_install_command` (string): Package manager install command
48
+ * `remote_server_type` (string): Associated Remote Server type, if any
36
49
  * `screenshot_list_urls` (array): Screenshots of the App
37
- * `logo_thumbnail_url` (string): Logo thumbnail for the App
50
+ * `sdk_installation_instructions_link` (string): Link to SDK installation instructions
51
+ * `short_description` (string): Short description of the App
38
52
  * `sso_strategy_type` (string): Associated SSO Strategy type, if any
39
- * `remote_server_type` (string): Associated Remote Server type, if any
40
- * `folder_behavior_type` (string): Associated Folder Behavior type, if any
41
- * `external_homepage_url` (string): Link to external homepage
42
- * `marketing_youtube_url` (string): Marketing video page
43
53
  * `tutorial_youtube_url` (string): Tutorial video page
44
- * `app_type` (string): The type of the App
45
- * `featured` (boolean): Is featured on the App listing?
46
54
 
47
55
 
48
56
  ---
data/docs/group.md CHANGED
@@ -60,19 +60,19 @@ Files::Group.find(id)
60
60
 
61
61
  ```
62
62
  Files::Group.create(
63
- name: "owners",
64
63
  notes: "example",
65
64
  user_ids: "1",
66
- admin_ids: "1"
65
+ admin_ids: "1",
66
+ name: "name"
67
67
  )
68
68
  ```
69
69
 
70
70
  ### Parameters
71
71
 
72
- * `name` (string): Group name.
73
72
  * `notes` (string): Group notes.
74
73
  * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
75
74
  * `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
75
+ * `name` (string): Required - Group name.
76
76
 
77
77
 
78
78
  ---
@@ -81,20 +81,20 @@ Files::Group.create(
81
81
 
82
82
  ```
83
83
  Files::Group.update(id,
84
- name: "owners",
85
84
  notes: "example",
86
85
  user_ids: "1",
87
- admin_ids: "1"
86
+ admin_ids: "1",
87
+ name: "owners"
88
88
  )
89
89
  ```
90
90
 
91
91
  ### Parameters
92
92
 
93
93
  * `id` (int64): Required - Group ID.
94
- * `name` (string): Group name.
95
94
  * `notes` (string): Group notes.
96
95
  * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
97
96
  * `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
97
+ * `name` (string): Group name.
98
98
 
99
99
 
100
100
  ---
@@ -118,20 +118,20 @@ Files::Group.delete(id)
118
118
  group = Files::Group.list.first
119
119
 
120
120
  group.update(
121
- name: "owners",
122
121
  notes: "example",
123
122
  user_ids: "1",
124
- admin_ids: "1"
123
+ admin_ids: "1",
124
+ name: "owners"
125
125
  )
126
126
  ```
127
127
 
128
128
  ### Parameters
129
129
 
130
130
  * `id` (int64): Required - Group ID.
131
- * `name` (string): Group name.
132
131
  * `notes` (string): Group notes.
133
132
  * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
134
133
  * `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
134
+ * `name` (string): Group name.
135
135
 
136
136
 
137
137
  ---
data/docs/user.md CHANGED
@@ -279,7 +279,7 @@ Files::User.create(
279
279
  * `require_2fa` (string): 2FA required setting
280
280
  * `time_zone` (string): User time zone
281
281
  * `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.
282
- * `username` (string): User's username
282
+ * `username` (string): Required - User's username
283
283
 
284
284
 
285
285
  ---
@@ -9,24 +9,39 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
- # string - Name of the App
13
- def name
14
- @attributes[:name]
12
+ # string - The type of the App
13
+ def app_type
14
+ @attributes[:app_type]
15
15
  end
16
16
 
17
- # string - Long form description of the App
17
+ # object - Collection of named links to documentation
18
+ def documentation_links
19
+ @attributes[:documentation_links]
20
+ end
21
+
22
+ # string - Long description for the in-App landing page
18
23
  def extended_description
19
24
  @attributes[:extended_description]
20
25
  end
21
26
 
22
- # string - Short description of the App
23
- def short_description
24
- @attributes[:short_description]
27
+ # string - Long form description of the App
28
+ def extended_description_for_marketing_site
29
+ @attributes[:extended_description_for_marketing_site]
25
30
  end
26
31
 
27
- # object - Collection of named links to documentation
28
- def documentation_links
29
- @attributes[:documentation_links]
32
+ # string - Link to external homepage
33
+ def external_homepage_url
34
+ @attributes[:external_homepage_url]
35
+ end
36
+
37
+ # boolean - Is featured on the App listing?
38
+ def featured
39
+ @attributes[:featured]
40
+ end
41
+
42
+ # string - Associated Folder Behavior type, if any
43
+ def folder_behavior_type
44
+ @attributes[:folder_behavior_type]
30
45
  end
31
46
 
32
47
  # string - App icon
@@ -34,24 +49,34 @@ module Files
34
49
  @attributes[:icon_url]
35
50
  end
36
51
 
52
+ # string - Logo thumbnail for the App
53
+ def logo_thumbnail_url
54
+ @attributes[:logo_thumbnail_url]
55
+ end
56
+
37
57
  # string - Full size logo for the App
38
58
  def logo_url
39
59
  @attributes[:logo_url]
40
60
  end
41
61
 
42
- # array - Screenshots of the App
43
- def screenshot_list_urls
44
- @attributes[:screenshot_list_urls]
62
+ # string - Marketing introdution of the App
63
+ def marketing_intro
64
+ @attributes[:marketing_intro]
45
65
  end
46
66
 
47
- # string - Logo thumbnail for the App
48
- def logo_thumbnail_url
49
- @attributes[:logo_thumbnail_url]
67
+ # string - Marketing video page
68
+ def marketing_youtube_url
69
+ @attributes[:marketing_youtube_url]
50
70
  end
51
71
 
52
- # string - Associated SSO Strategy type, if any
53
- def sso_strategy_type
54
- @attributes[:sso_strategy_type]
72
+ # string - Name of the App
73
+ def name
74
+ @attributes[:name]
75
+ end
76
+
77
+ # string - Package manager install command
78
+ def package_manager_install_command
79
+ @attributes[:package_manager_install_command]
55
80
  end
56
81
 
57
82
  # string - Associated Remote Server type, if any
@@ -59,19 +84,24 @@ module Files
59
84
  @attributes[:remote_server_type]
60
85
  end
61
86
 
62
- # string - Associated Folder Behavior type, if any
63
- def folder_behavior_type
64
- @attributes[:folder_behavior_type]
87
+ # array - Screenshots of the App
88
+ def screenshot_list_urls
89
+ @attributes[:screenshot_list_urls]
65
90
  end
66
91
 
67
- # string - Link to external homepage
68
- def external_homepage_url
69
- @attributes[:external_homepage_url]
92
+ # string - Link to SDK installation instructions
93
+ def sdk_installation_instructions_link
94
+ @attributes[:sdk_installation_instructions_link]
70
95
  end
71
96
 
72
- # string - Marketing video page
73
- def marketing_youtube_url
74
- @attributes[:marketing_youtube_url]
97
+ # string - Short description of the App
98
+ def short_description
99
+ @attributes[:short_description]
100
+ end
101
+
102
+ # string - Associated SSO Strategy type, if any
103
+ def sso_strategy_type
104
+ @attributes[:sso_strategy_type]
75
105
  end
76
106
 
77
107
  # string - Tutorial video page
@@ -79,16 +109,6 @@ module Files
79
109
  @attributes[:tutorial_youtube_url]
80
110
  end
81
111
 
82
- # string - The type of the App
83
- def app_type
84
- @attributes[:app_type]
85
- end
86
-
87
- # boolean - Is featured on the App listing?
88
- def featured
89
- @attributes[:featured]
90
- end
91
-
92
112
  # Parameters:
93
113
  # 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.
94
114
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
@@ -64,19 +64,19 @@ module Files
64
64
  end
65
65
 
66
66
  # Parameters:
67
- # name - string - Group name.
68
67
  # notes - string - Group notes.
69
68
  # user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
70
69
  # admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
70
+ # name - string - Group name.
71
71
  def update(params = {})
72
72
  params ||= {}
73
73
  params[:id] = @attributes[:id]
74
74
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
75
75
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
76
- raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
77
76
  raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
78
77
  raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
79
78
  raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
79
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
80
80
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
81
81
 
82
82
  Api.send_request("/groups/#{@attributes[:id]}", :patch, params, @options)
@@ -146,33 +146,34 @@ module Files
146
146
  end
147
147
 
148
148
  # Parameters:
149
- # name - string - Group name.
150
149
  # notes - string - Group notes.
151
150
  # user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
152
151
  # admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
152
+ # name (required) - string - Group name.
153
153
  def self.create(params = {}, options = {})
154
- raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
155
154
  raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
156
155
  raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
157
156
  raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
157
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
158
+ raise MissingParameterError.new("Parameter missing: name") unless params[:name]
158
159
 
159
160
  response, options = Api.send_request("/groups", :post, params, options)
160
161
  Group.new(response.data, options)
161
162
  end
162
163
 
163
164
  # Parameters:
164
- # name - string - Group name.
165
165
  # notes - string - Group notes.
166
166
  # user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
167
167
  # admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
168
+ # name - string - Group name.
168
169
  def self.update(id, params = {}, options = {})
169
170
  params ||= {}
170
171
  params[:id] = id
171
172
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
172
- raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
173
173
  raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
174
174
  raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
175
175
  raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
176
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
176
177
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
177
178
 
178
179
  response, options = Api.send_request("/groups/#{params[:id]}", :patch, params, options)
@@ -875,7 +875,7 @@ module Files
875
875
  # require_2fa - string - 2FA required setting
876
876
  # time_zone - string - User time zone
877
877
  # 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.
878
- # username - string - User's username
878
+ # username (required) - string - User's username
879
879
  def self.create(params = {}, options = {})
880
880
  raise InvalidParameterError.new("Bad parameter: change_password must be an String") if params[:change_password] and !params[:change_password].is_a?(String)
881
881
  raise InvalidParameterError.new("Bad parameter: change_password_confirmation must be an String") if params[:change_password_confirmation] and !params[:change_password_confirmation].is_a?(String)
@@ -903,6 +903,7 @@ module Files
903
903
  raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
904
904
  raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
905
905
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
906
+ raise MissingParameterError.new("Parameter missing: username") unless params[:username]
906
907
 
907
908
  response, options = Api.send_request("/users", :post, params, options)
908
909
  User.new(response.data, options)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.0.482"
4
+ VERSION = "1.0.484"
5
5
  end
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.0.482
4
+ version: 1.0.484
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-01 00:00:00.000000000 Z
11
+ date: 2023-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable