files.com 1.1.283 → 1.1.284

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4f0f87feb1ff29fbb4bf594b654ac77b55bd3c3d771253d4a488a2fd8ebf3909
4
- data.tar.gz: 0c10e3aee4976a4beceaa2633afa2088411627f8c398eb25fee487c09e6deea1
3
+ metadata.gz: 3a4ce408d8a2136aacd899cd0d477615641819d42006d9860696ccf85b2b5788
4
+ data.tar.gz: 7c28c2894ea72d3aadc811673bd7a2f1b8e13404426f83767d6ffc80a68966ce
5
5
  SHA512:
6
- metadata.gz: 120feb78a7f6d69a9a707aa592dd7f66e4d81e852b27114322c84b525732141ae37d23cc4f604d0bb1b8ee2a40cfd64e8f4ffaa0bbd5ea949f096fae1c48eabd
7
- data.tar.gz: fcc6ae3de360a972e6fc84b7c5509c4cf4a746621c6eaca33383e3f6197b64c8de61418108e199a3f9eaa46f31d0ee284115a8ea1e60887678aeb56122168cb1
6
+ metadata.gz: 4b29598141afa51b236bccf8837c80c2e1a3d8e8f2b80050f59a277fd1d64b66c5bb389061a0e624d471fecc0f1336dbaf7710a60614e7e7c6217bdc0ef6a98c
7
+ data.tar.gz: 6152b9e09dfcefc7137072e8e24abefdcef0b79a718624ab99d47fa376e568f01d9d67b3e613e368df10973de3087179c60b1fb7e6b382514531bad63fb0559c
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.283
1
+ 1.1.284
data/docs/automation.md CHANGED
@@ -86,7 +86,8 @@
86
86
  "value": {
87
87
  "limit": "1"
88
88
  },
89
- "webhook_url": "https://app.files.com/api/webhooks/abc123"
89
+ "webhook_url": "https://app.files.com/api/webhooks/abc123",
90
+ "holiday_region": "us_dc"
90
91
  }
91
92
  ```
92
93
 
@@ -128,6 +129,7 @@
128
129
  * `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
129
130
  * `value` (object): A Hash of attributes specific to the automation type.
130
131
  * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
132
+ * `holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
131
133
 
132
134
 
133
135
  ---
@@ -0,0 +1,27 @@
1
+ # HolidayRegion
2
+
3
+ ## Example HolidayRegion Object
4
+
5
+ ```
6
+ {
7
+ "code": "us_dc",
8
+ "name": "United States - District of Columbia"
9
+ }
10
+ ```
11
+
12
+ * `code` (string): The code representing a region
13
+ * `name` (string): The name of the region
14
+
15
+
16
+ ---
17
+
18
+ ## List all possible holiday regions
19
+
20
+ ```
21
+ Files::HolidayRegion.get_supported
22
+ ```
23
+
24
+ ### Parameters
25
+
26
+ * `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.
27
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
data/docs/sync.md CHANGED
@@ -39,7 +39,8 @@
39
39
  "06:30",
40
40
  "14:30"
41
41
  ],
42
- "schedule_time_zone": "Eastern Time (US & Canada)"
42
+ "schedule_time_zone": "Eastern Time (US & Canada)",
43
+ "holiday_region": "us_dc"
43
44
  }
44
45
  ```
45
46
 
@@ -68,6 +69,7 @@
68
69
  * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
69
70
  * `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
70
71
  * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
72
+ * `holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
71
73
 
72
74
 
73
75
  ---
@@ -351,6 +351,15 @@ module Files
351
351
  @attributes[:webhook_url] = value
352
352
  end
353
353
 
354
+ # string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
355
+ def holiday_region
356
+ @attributes[:holiday_region]
357
+ end
358
+
359
+ def holiday_region=(value)
360
+ @attributes[:holiday_region] = value
361
+ end
362
+
354
363
  # Manually Run Automation
355
364
  def manual_run(params = {})
356
365
  params ||= {}
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class HolidayRegion
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # string - The code representing a region
13
+ def code
14
+ @attributes[:code]
15
+ end
16
+
17
+ # string - The name of the region
18
+ def name
19
+ @attributes[:name]
20
+ end
21
+
22
+ # Parameters:
23
+ # 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.
24
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
25
+ def self.get_supported(params = {}, options = {})
26
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
27
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
28
+
29
+ List.new(HolidayRegion, params) do
30
+ Api.send_request("/holiday_regions/supported", :get, params, options)
31
+ end
32
+ end
33
+ end
34
+ end
@@ -226,6 +226,15 @@ module Files
226
226
  @attributes[:schedule_time_zone] = value
227
227
  end
228
228
 
229
+ # string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
230
+ def holiday_region
231
+ @attributes[:holiday_region]
232
+ end
233
+
234
+ def holiday_region=(value)
235
+ @attributes[:holiday_region] = value
236
+ end
237
+
229
238
  # Manually Run Sync
230
239
  def manual_run(params = {})
231
240
  params ||= {}
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.283"
4
+ VERSION = "1.1.284"
5
5
  end
data/lib/files.com.rb CHANGED
@@ -80,6 +80,7 @@ require "files.com/models/group_user"
80
80
  require "files.com/models/history"
81
81
  require "files.com/models/history_export"
82
82
  require "files.com/models/history_export_result"
83
+ require "files.com/models/holiday_region"
83
84
  require "files.com/models/image"
84
85
  require "files.com/models/inbox_recipient"
85
86
  require "files.com/models/inbox_registration"
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.283
4
+ version: 1.1.284
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-06-25 00:00:00.000000000 Z
11
+ date: 2025-06-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -163,6 +163,7 @@ files:
163
163
  - docs/history.md
164
164
  - docs/history_export.md
165
165
  - docs/history_export_result.md
166
+ - docs/holiday_region.md
166
167
  - docs/image.md
167
168
  - docs/inbox_recipient.md
168
169
  - docs/inbox_registration.md
@@ -273,6 +274,7 @@ files:
273
274
  - lib/files.com/models/history.rb
274
275
  - lib/files.com/models/history_export.rb
275
276
  - lib/files.com/models/history_export_result.rb
277
+ - lib/files.com/models/holiday_region.rb
276
278
  - lib/files.com/models/image.rb
277
279
  - lib/files.com/models/inbox_recipient.rb
278
280
  - lib/files.com/models/inbox_registration.rb