📚 More doc updates

araluce · Mar 7, 2024 · 25e5bff · 25e5bff
1 parent b20e1b7
commit 25e5bff
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 1 deletion.
diff --git a/docs/resources/availabily/1_user_busy_time.md b/docs/resources/availabily/1_user_busy_time.md
@@ -9,6 +9,10 @@ Date range can be no greater than 1 week (7 days).
 Visit official [API Doc](https://developer.calendly.com/api-docs/5920076156501-list-user-busy-times) to see [query parameters](https://developer.calendly.com/api-docs/5920076156501-list-user-busy-times) and [response body](https://developer.calendly.com/api-docs/5920076156501-list-user-busy-times#response-body)
 
 ```ruby
-user_busy_times = client.user_busy_times.list(user_uri: `user_uri`, start_time: `start_time`, end_time: `end_time`)
+client.user_busy_times.list(user_uri: `user_uri`, start_time: `start_time`, end_time: `end_time`)
 #=> #<Calendlyr::Collection:0x0000000108f30698 @data=[#<Calendlyr::UserBusyTime type="calendly", start_time="2020-01-02T20:00:00.000000Z", end_time="2020-01-02T20:30:00.000000Z", buffered_start_time="2020-01-02T19:30:00.000000Z", buffered_end_time="2020-01-02T21:00:00.000000Z", event=#<OpenStruct uri="https://api.calendly.com/scheduled_events/abc123">, client=#<Calendlyr::Client>, uuid=nil>, #<Calendlyr::UserBusyTime type="calendly", start_time="2020-01-05T20:00:00.000000Z", end_time="2020-01-05T20:30:00.000000Z", buffered_start_time="2020-01-05T19:30:00.000000Z", buffered_end_time="2020-01-05T21:00:00.000000Z", event=#<OpenStruct uri="https://api.calendly.com/scheduled_events/abc12345">, client=#<Calendlyr::Client>, uuid=nil>, #<Calendlyr::UserBusyTime type="external", start_time="2020-01-07T20:00:00.000000Z", end_time="2020-01-07T20:30:00.000000Z", client=#<Calendlyr::Client>, uuid=nil>], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
 ```
+
+## Next
+
+[User Availability Schedule](2_user_availability_schedule.md)
diff --git a/docs/resources/availabily/2_user_availability_schedule.md b/docs/resources/availabily/2_user_availability_schedule.md
@@ -0,0 +1,32 @@
+# User Availability Schedule
+
+## Retrieve
+
+This will return the availability schedule of the given UUID.See [official API doc](https://developer.calendly.com/api-docs/3b1c2d5f97b5c-get-user-availability-schedule)
+
+```ruby
+client.user_availability_schedules.retrieve(uuid: @uuid)
+#=> #<Calendlyr::UserAvailabilitySchedule uri="https://api.calendly.com/user_availability_schedule/abc123", default=true, name="Working Hours", user="https://api.calendly.com/users/abc123", timezone="America/New_York", rules=[#<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="09:30">], wday="sunday", date="2022-12-31">], client=#<Calendlyr::Client>, uuid="abc123">
+```
+
+## List
+
+Return the availability schedules of the given user. See [official API doc](https://developer.calendly.com/api-docs/8098de44af94c-list-user-availability-schedules)
+
+```ruby
+client.user_availability_schedules.list(user_uri: @user_uri)
+#=> #<Calendlyr::Collection:0x0000000105b6e0d0 @data=[#<Calendlyr::UserAvailabilitySchedule uri="https://api.calendly.com/user_availability_schedule/abc123", default=true, name="Working Hours", user="https://api.calendly.com/users/abc123", timezone="America/New_York", rules=[#<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="09:30">], wday="sunday", date="2022-12-31">], client=#<Calendlyr::Client>, uuid="abc123">, #<Calendlyr::UserAvailabilitySchedule uri="https://api.calendly.com/user_availability_schedule/abc456", default=false, name="Evening Hours", user="https://api.calendly.com/users/abc123", timezone="America/New_York", rules=[#<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="monday">, #<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="tuesday">, #<OpenStruct type="wday", intervals=[], wday="wednesday">, #<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="thursday">, #<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="friday">, #<OpenStruct type="wday", intervals=[], wday="saturday">, #<OpenStruct type="date", intervals=[#<OpenStruct from="08:30", to="09:30">], date="2028-12-31">], client=#<Calendlyr::Client>, uuid="abc456">], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### List on me
+
+Use `me` user
+
+```ruby
+client.me.availability_schedules
+#=> #<Calendlyr::Collection:0x0000000105b6e0d0 @data=[#<Calendlyr::UserAvailabilitySchedule uri="https://api.calendly.com/user_availability_schedule/abc123", default=true, name="Working Hours", user="https://api.calendly.com/users/abc123", timezone="America/New_York", rules=[#<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="09:30">], wday="sunday", date="2022-12-31">], client=#<Calendlyr::Client>, uuid="abc123">, #<Calendlyr::UserAvailabilitySchedule uri="https://api.calendly.com/user_availability_schedule/abc456", default=false, name="Evening Hours", user="https://api.calendly.com/users/abc123", timezone="America/New_York", rules=[#<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="monday">, #<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="tuesday">, #<OpenStruct type="wday", intervals=[], wday="wednesday">, #<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="thursday">, #<OpenStruct type="wday", intervals=[#<OpenStruct from="08:30", to="17:00">], wday="friday">, #<OpenStruct type="wday", intervals=[], wday="saturday">, #<OpenStruct type="date", intervals=[#<OpenStruct from="08:30", to="09:30">], date="2028-12-31">], client=#<Calendlyr::Client>, uuid="abc456">], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+## Next
+
+[User Availability Schedule](2_user_availability_schedule.md)