docs/FaxApi.md in purecloudplatformclientv2-49.0.0 vs docs/FaxApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -16,11 +16,11 @@
[**put_fax_document**](FaxApi.html#put_fax_document) | Update a fax document.
{: class="table table-striped"}
<a name="delete_fax_document"></a>
-## - delete_fax_document(document_id)
+## delete_fax_document(document_id)
Delete a fax document.
@@ -31,11 +31,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -56,11 +56,11 @@
#Delete a fax document.
api_instance.delete_fax_document(document_id)
rescue PureCloud::ApiError => e
puts "Exception when calling FaxApi->delete_fax_document: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -79,11 +79,11 @@
<a name="get_fax_document"></a>
-## -[**FaxDocument**](FaxDocument.html) get_fax_document(document_id)
+## [**FaxDocument**](FaxDocument.html) get_fax_document(document_id)
Get a document.
@@ -94,11 +94,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -120,11 +120,11 @@
result = api_instance.get_fax_document(document_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling FaxApi->get_fax_document: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -143,11 +143,11 @@
<a name="get_fax_document_content"></a>
-## -[**DownloadResponse**](DownloadResponse.html) get_fax_document_content(document_id)
+## [**DownloadResponse**](DownloadResponse.html) get_fax_document_content(document_id)
Download a fax document.
@@ -158,11 +158,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -184,11 +184,11 @@
result = api_instance.get_fax_document_content(document_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling FaxApi->get_fax_document_content: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -207,11 +207,11 @@
<a name="get_fax_documents"></a>
-## -[**FaxDocumentEntityListing**](FaxDocumentEntityListing.html) get_fax_documents(opts)
+## [**FaxDocumentEntityListing**](FaxDocumentEntityListing.html) get_fax_documents(opts)
Get a list of fax documents.
@@ -222,11 +222,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -250,11 +250,11 @@
result = api_instance.get_fax_documents(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling FaxApi->get_fax_documents: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -274,11 +274,11 @@
<a name="get_fax_summary"></a>
-## -[**FaxSummary**](FaxSummary.html) get_fax_summary
+## [**FaxSummary**](FaxSummary.html) get_fax_summary
Get fax summary
@@ -289,11 +289,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -312,11 +312,11 @@
result = api_instance.get_fax_summary
p result
rescue PureCloud::ApiError => e
puts "Exception when calling FaxApi->get_fax_summary: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -332,11 +332,11 @@
<a name="put_fax_document"></a>
-## -[**FaxDocument**](FaxDocument.html) put_fax_document(document_id, body)
+## [**FaxDocument**](FaxDocument.html) put_fax_document(document_id, body)
Update a fax document.
@@ -347,11 +347,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -375,10 +375,10 @@
result = api_instance.put_fax_document(document_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling FaxApi->put_fax_document: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------