From 40da799d09582a76faab273d1d2317b7144c8b98 Mon Sep 17 00:00:00 2001 From: kr-mykyta Date: Fri, 21 Apr 2023 12:26:46 +0100 Subject: [PATCH] Fix links in Ruby SDK documentation --- README.md | 16 ++++++------- lib/cronofy/auth.rb | 2 +- lib/cronofy/client.rb | 54 +++++++++++++++++++++---------------------- 3 files changed, 36 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 936dc3a..65d14f3 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,8 @@ When using a [personal access token](https://app.cronofy.com/oauth/applications/ you only need to provide the `access_token` argument. When working against your own OAuth application you will need to provide the -`client_id` and `client_secret` when [going through the authorization process](https://www.cronofy.com/developers/api/#authorization) -for a user, and when [refreshing an access token](https://www.cronofy.com/developers/api/#token-refresh). +`client_id` and `client_secret` when [going through the authorization process](https://docs.cronofy.com/developers/api/authorization/request-authorization/) +for a user, and when [refreshing an access token](https://docs.cronofy.com/developers/api/authorization/refresh-token/). If `client_id` and `client_secret` are not specified explicitly the values from the environment variables `CRONOFY_CLIENT_ID` and `CRONOFY_CLIENT_SECRET` will @@ -56,7 +56,7 @@ be used if present. ## Authorization -[API documentation](https://www.cronofy.com/developers/api/#authorization) +[API documentation](https://docs.cronofy.com/developers/api/authorization/request-authorization/) Generate a link for a user to grant access to their calendars: @@ -83,7 +83,7 @@ to perform this process. ## List calendars -[API documentation](https://www.cronofy.com/developers/api/#calendars) +[API documentation](https://docs.cronofy.com/developers/api/calendars/list-calendars/) Get a list of all the user's calendars: @@ -93,7 +93,7 @@ calendars = cronofy.list_calendars ## Read events -[API documentation](https://www.cronofy.com/developers/api/#read-events) +[API documentation](https://docs.cronofy.com/developers/api/events/read-events/) Get a list of events from the user's calendars: @@ -105,7 +105,7 @@ Note that the gem handles iterating through the pages on your behalf. ## Create or update events -[API documentation](https://www.cronofy.com/developers/api/#upsert-event) +[API documentation](https://docs.cronofy.com/developers/api/events/upsert-event/) To create/update an event in the user's calendar: @@ -126,7 +126,7 @@ cronofy.upsert_event(calendar_id, event_data) ## Delete events -[API documentation](https://www.cronofy.com/developers/api/#delete-event) +[API documentation](https://docs.cronofy.com/developers/api/events/delete-event/) To delete an event from user's calendar: @@ -145,6 +145,6 @@ If you would like to request a feature is added by our team then please let us k ## Links - * [API documentation](https://www.cronofy.com/developers/api) + * [API documentation](https://docs.cronofy.com/developers/api/) * [API mailing list](https://groups.google.com/d/forum/cronofy-api) diff --git a/lib/cronofy/auth.rb b/lib/cronofy/auth.rb index bb82c4e..558b473 100644 --- a/lib/cronofy/auth.rb +++ b/lib/cronofy/auth.rb @@ -35,7 +35,7 @@ def initialize(options = {}) # :state - Array of states to retain during the OAuth # authorization process (optional). # - # See http://www.cronofy.com/developers/api#authorization for reference. + # See https://docs.cronofy.com/developers/api/authorization/request-authorization/ for reference. # # Returns the URL as a String. def user_auth_link(redirect_uri, options = {}) diff --git a/lib/cronofy/client.rb b/lib/cronofy/client.rb index 4043476..e5815f8 100644 --- a/lib/cronofy/client.rb +++ b/lib/cronofy/client.rb @@ -54,7 +54,7 @@ def initialize(options = {}) # (default: {}): # :color - The color to make the calendar (optional). # - # See https://www.cronofy.com/developers/api/#create-calendar for reference. + # See https://docs.cronofy.com/developers/api/calendars/create-calendar/ for reference. # # Returns the created Calendar # @@ -77,7 +77,7 @@ def create_calendar(profile_id, name, options = {}) # Public: Lists all the calendars for the account. # - # See http://www.cronofy.com/developers/api#calendars for reference. + # See https://docs.cronofy.com/developers/api/calendars/list-calendars/ for reference. # # Returns an Array of Calendars # @@ -148,7 +148,7 @@ def list_calendars # long: "0.1234" # }) # - # See http://www.cronofy.com/developers/api#upsert-event for reference. + # See https://docs.cronofy.com/developers/api/events/upsert-event/ for reference. # # Returns nothing. # @@ -214,7 +214,7 @@ def upsert_event(calendar_id, event) # The first page will be retrieved eagerly so that common errors will happen # inline. However, subsequent pages (if any) will be requested lazily. # - # See http://www.cronofy.com/developers/api#read-events for reference. + # See https://docs.cronofy.com/developers/api/events/read-events/ for reference. # # Returns a lazily-evaluated Enumerable of Events # @@ -262,7 +262,7 @@ def read_events(options = {}) # The first page will be retrieved eagerly so that common errors will happen # inline. However, subsequent pages (if any) will be requested lazily. # - # See http://www.cronofy.com/developers/api/#free-busy for reference. + # See https://docs.cronofy.com/developers/api/events/free-busy/ for reference. # # Returns a lazily-evaluated Enumerable of FreeBusy # @@ -293,7 +293,7 @@ def free_busy(options = {}) # event_id - A String uniquely identifying the event for your application # (note: this is NOT an ID generated by Cronofy). # - # See http://www.cronofy.com/developers/api#delete-event for reference. + # See https://docs.cronofy.com/developers/api/events/delete-event/ for reference. # # Returns nothing. # @@ -407,7 +407,7 @@ def delete_external_event(calendar_id, event_uid) # Public: Deletes all events you are managing for the account. # - # See https://www.cronofy.com/developers/api/#bulk-delete-events for + # See https://docs.cronofy.com/developers/api/events/bulk-delete-events/ for # reference. # # options - The Hash options used to refine the selection (optional): @@ -451,7 +451,7 @@ def delete_all_events(options = nil) # trigger notifications # (optional). # - # See http://www.cronofy.com/developers/api#create-channel for reference. + # See https://docs.cronofy.com/developers/api/push-notifications/create-channel/ for reference. # # Returns a Channel. # @@ -502,7 +502,7 @@ def hmac_valid?(args) # Public: Lists all the notification channels for the account. # - # See http://www.cronofy.com/developers/api#list-channels for reference. + # See https://docs.cronofy.com/developers/api/push-notifications/list-channels/ for reference. # # Returns an Array of Channels. # @@ -522,7 +522,7 @@ def list_channels # # channel_id - The String Cronofy ID for the channel to close. # - # See http://www.cronofy.com/developers/api#close-channel for reference. + # See https://docs.cronofy.com/developers/api/push-notifications/close-channel/ for reference. # # Returns nothing. # @@ -541,7 +541,7 @@ def close_channel(channel_id) # Public: Retrieves the details of the account. # - # See http://www.cronofy.com/developers/api#account for reference. + # See https://docs.cronofy.com/developers/api/identity/account/ for reference. # # Returns an Account. # @@ -559,7 +559,7 @@ def account # Public: Lists all the profiles for the account. # - # See https://www.cronofy.com/developers/api/#profiles for reference. + # See https://docs.cronofy.com/developers/api/identity/profile/ for reference. # # Returns an Array of Profiles # @@ -575,7 +575,7 @@ def list_profiles # Public: Retrieves the userinfo for the account # - # See http://openid.net/specs/openid-connect-core-1_0.html#UserInfo for + # See https://docs.cronofy.com/developers/api/identity/userinfo/ for # reference. # # Returns an UserInfo. @@ -603,7 +603,7 @@ def userinfo # invite to # # - # See http://www.cronofy.com/developers/api#delete-event for reference. + # See https://docs.cronofy.com/developers/api/events/delete-event/ for reference. # # Returns nothing. # @@ -669,7 +669,7 @@ def authorize_with_service_account(email, scope, callback_url, state) # :state - Array of states to retain during the OAuth # authorization process (optional). # - # See http://www.cronofy.com/developers/api#authorization for reference. + # See https://docs.cronofy.com/developers/api/authorization/request-authorization/ for reference. # # Returns the URL as a String. def user_auth_link(redirect_url, options = {}) @@ -684,7 +684,7 @@ def user_auth_link(redirect_url, options = {}) # redirect_url - A String specifing the URL the user returned to once they # had completed the authorization steps. # - # See http://www.cronofy.com/developers/api#token-issue for reference. + # See https://docs.cronofy.com/developers/api/authorization/request-token/ for reference. # # Returns a set of Cronofy::Credentials for the account. # @@ -702,7 +702,7 @@ def get_token_from_code(code, redirect_url) # these usually occur when the access token has expired and needs # refreshing. # - # See http://www.cronofy.com/developers/api#token-refresh for reference. + # See https://docs.cronofy.com/developers/api/authorization/refresh-token/ for reference. # # Returns a set of Cronofy::Credentials for the account. # @@ -717,7 +717,7 @@ def refresh_access_token # Public: Obtains access to an application calendar # - # See http://www.cronofy.com/developers/alpha/api#application-calendar for reference. + # See https://docs.cronofy.com/developers/api/calendars/application-calendars/ for reference. # # Returns a set of Cronofy::Credentials for the account. # @@ -735,7 +735,7 @@ def application_calendar(application_calendar_id) # After making this call the Client will become unusable. You should also # delete the stored credentials used to create this instance. # - # See http://www.cronofy.com/developers/api#revoke-authorization for + # See https://docs.cronofy.com/developers/api/authorization/revoke/ for # reference. # # Returns nothing. @@ -961,7 +961,7 @@ def sequenced_availability(options = {}) # long: "0.1234" # }) # - # See http://www.cronofy.com/developers/api#upsert-event for reference. + # See https://docs.cronofy.com/developers/api/events/upsert-event/ for reference. # # Returns a AddToCalendarResponse. # @@ -1081,7 +1081,7 @@ def add_to_calendar(args = {}) # }] # ) # - # See http://www.cronofy.com/developers/api#real-time-scheduling for reference. + # See https://docs.cronofy.com/developers/api/scheduling/real-time-scheduling/ for reference. # # Returns a AddToCalendarResponse. # @@ -1260,7 +1260,7 @@ def real_time_sequencing(args) # Public: Creates a link_token to allow explicitly linking of an account # - # See https://www.cronofy.com/developers/api/alpha/#auth-explicit-linking for + # See https://docs.cronofy.com/developers/api-alpha/explicit-linking/ for # reference. # # Returns a link token @@ -1277,7 +1277,7 @@ def link_token # Public: Revokes the authorization to the given profile. # - # See https://www.cronofy.com/developers/api/alpha/#revoke-profile for + # See https://docs.cronofy.com/developers/api/authorization/revoke-profile/ for # reference. # # Returns nothing. @@ -1355,7 +1355,7 @@ def revoke_profile_authorization(profile_id) # } # ) # - # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference. + # See https://docs.cronofy.com/developers/api/smart-invites/create-smart-invite/ for reference. # # Returns a SmartInviteResponse. # @@ -1382,7 +1382,7 @@ def upsert_smart_invite(body={}) # :email - A String for thee email address you are # going to send the Smart Invite to. # - # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference. + # See https://docs.cronofy.com/developers/api/smart-invites/cancel-invite/ for reference. # # Returns a SmartInviteResponse. # @@ -1430,7 +1430,7 @@ def remove_recipient_smart_invite(body={}) # by Cronofy). # recipient_email - The email address for the recipient to get details for. # - # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference. + # See https://docs.cronofy.com/developers/api/smart-invites/invite-status/ for reference. # # Returns a SmartInviteResponse. # @@ -1504,7 +1504,7 @@ def element_token(options) # ] # ) # - # See http://www.cronofy.com/developers/alpha/api#availability_rules for reference. + # See https://docs.cronofy.com/developers/api/scheduling/availability-rules/ for reference. # # Returns an AvailabilityRuleResponse. #