Contents

module DropboxApi::Endpoints::Sharing
  class CreateSharedLinkWithSettings < DropboxApi::Endpoints::Rpc
    Method      = :post
    Path        = "/2/sharing/create_shared_link_with_settings".freeze
    ResultType  = DropboxApi::Metadata::SharedLinkMetadata
    ErrorType   = DropboxApi::Errors::CreateSharedLinkWithSettingsError

    # Create a shared link with custom settings. If no settings are given then
    # the default visibility is :public. (The resolved
    # visibility, though, may depend on other aspects such as team and shared
    # folder settings).
    #
    # @param path [String] The path to be shared by the shared link.
    # @param settings [SharedLinkSettings] The requested settings for the newly
    #   created shared link This field is optional.
    # @return [DropboxApi::Metadata::SharedLinkMetadata]
    add_endpoint :create_shared_link_with_settings do |path, settings = {}|
      # NOTE: This endpoint accepts an additional option `settings` which
      #       hasn't been implemented.
      perform_request :path => path
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
dropbox_api-0.1.15	lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb
dropbox_api-0.1.14	lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb
dropbox_api-0.1.13	lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb
dropbox_api-0.1.12	lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb
dropbox_api-0.1.11	lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb