From 50129131a330b6e5bebe57844b527e7188446cfe Mon Sep 17 00:00:00 2001 From: John Wang Date: Mon, 18 May 2015 21:13:24 -0700 Subject: [PATCH] wip mkdocs --- docs/{quick-start.md => quickstart.md} | 0 docs/usage/Messages-Fax.md | 23 +++++++++++++++++++++++ docs/usage/messages.md | 1 - 3 files changed, 23 insertions(+), 1 deletion(-) rename docs/{quick-start.md => quickstart.md} (100%) create mode 100644 docs/usage/Messages-Fax.md delete mode 100644 docs/usage/messages.md diff --git a/docs/quick-start.md b/docs/quickstart.md similarity index 100% rename from docs/quick-start.md rename to docs/quickstart.md diff --git a/docs/usage/Messages-Fax.md b/docs/usage/Messages-Fax.md new file mode 100644 index 0000000..410ff26 --- /dev/null +++ b/docs/usage/Messages-Fax.md @@ -0,0 +1,23 @@ +# Fax Messages + +## Faxing a Text Message + +## Faxing a PDF or TIFF + +### Faxing a PDF or TIFF + +### Faxing a PDF or TIFF Using Base64 Encoding + +```ruby +fax = RingCentralSdk::Helpers::CreateFaxRequest.new( + { :account_id => '~', :extension_id => '~' }, # Can be nil or {} for defaults '~' + { + # phone numbers are in E.164 format with or without leading '+' + :to => [{ :phoneNumber => '+16505551212' }], + :faxResolution => 'High', + :coverPageText => 'RingCentral fax PDF example using Ruby!' + }, + :file_name => '/path/to/my_file.pdf' + :base64_encode => true +) +``` \ No newline at end of file diff --git a/docs/usage/messages.md b/docs/usage/messages.md deleted file mode 100644 index fbebf53..0000000 --- a/docs/usage/messages.md +++ /dev/null @@ -1 +0,0 @@ -# Messages