doc_out/PresenceApi.html.md in purecloud-0.38.1 vs doc_out/PresenceApi.html.md in purecloud-0.39.1
- old
+ new
@@ -6,24 +6,25 @@
All URIs are relative to *https://api.mypurecloud.com*
Method | HTTP request | Description
------------- | ------------- | -------------
-|[**delete_presence_id**](PresenceApi.html#delete_presence_id) | **DELETE** /api/v2/presencedefinitions/{presenceId} | Delete an OrganizationPresence|
-|[**get_presence_id**](PresenceApi.html#get_presence_id) | **GET** /api/v2/presencedefinitions/{presenceId} | Get an OrganizationPresence|
-|[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presences|
+|[**delete_presence_id**](PresenceApi.html#delete_presence_id) | **DELETE** /api/v2/presencedefinitions/{presenceId} | Delete a Presence Definition|
+|[**get_presence_id**](PresenceApi.html#get_presence_id) | **GET** /api/v2/presencedefinitions/{presenceId} | Get a Presence Definition|
+|[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presence Definitions|
+|[**get_systempresences**](PresenceApi.html#get_systempresences) | **GET** /api/v2/systempresences | Get the list of SystemPresences|
|[**get_user_id_presences_source_id**](PresenceApi.html#get_user_id_presences_source_id) | **GET** /api/v2/users/{userId}/presences/{sourceId} | Get a user's Presence|
|[**patch_user_id_presences_source_id**](PresenceApi.html#patch_user_id_presences_source_id) | **PATCH** /api/v2/users/{userId}/presences/{sourceId} | Patch a user's Presence|
-|[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create an OrganizationPresence|
-|[**put_presence_id**](PresenceApi.html#put_presence_id) | **PUT** /api/v2/presencedefinitions/{presenceId} | Update an OrganizationPresence|
+|[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create a Presence Definition|
+|[**put_presence_id**](PresenceApi.html#put_presence_id) | **PUT** /api/v2/presencedefinitions/{presenceId} | Update a Presence Definition|
{: class="table table-striped"}
<a name="delete_presence_id"></a>
## -[**OrganizationPresence**](OrganizationPresence.html) delete_presence_id(presence_id)
-Delete an OrganizationPresence
+Delete a Presence Definition
### Example
~~~ruby
@@ -44,11 +45,11 @@
presence_id = "presence_id_example" # String | Organization Presence ID
begin
- #Delete an OrganizationPresence
+ #Delete a Presence Definition
result = api_instance.delete_presence_id(presence_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling PresenceApi->delete_presence_id: #{e}"
end
@@ -75,11 +76,11 @@
<a name="get_presence_id"></a>
## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id)
-Get an OrganizationPresence
+Get a Presence Definition
### Example
~~~ruby
@@ -100,11 +101,11 @@
presence_id = "presence_id_example" # String | Organization Presence ID
begin
- #Get an OrganizationPresence
+ #Get a Presence Definition
result = api_instance.get_presence_id(presence_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling PresenceApi->get_presence_id: #{e}"
end
@@ -131,11 +132,11 @@
<a name="get_presencedefinitions"></a>
## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get_presencedefinitions(opts)
-Get an Organization's list of Presences
+Get an Organization's list of Presence Definitions
### Example
~~~ruby
@@ -158,11 +159,11 @@
page_number: 1, # Integer | Page number
page_size: 25 # Integer | Page size
}
begin
- #Get an Organization's list of Presences
+ #Get an Organization's list of Presence Definitions
result = api_instance.get_presencedefinitions(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling PresenceApi->get_presencedefinitions: #{e}"
end
@@ -186,10 +187,60 @@
- **Content-Type**: application/json
- **Accept**: application/json
+<a name="get_systempresences"></a>
+
+## -[**SystemPresence**](SystemPresence.html) get_systempresences
+
+Get the list of SystemPresences
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+ config.access_token = @authToken
+end
+
+api_instance = PureCloud::PresenceApi.new
+
+begin
+ #Get the list of SystemPresences
+ result = api_instance.get_systempresences
+ p result
+rescue PureCloud::ApiError => e
+ puts "Exception when calling PresenceApi->get_systempresences: #{e}"
+end
+~~~
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**SystemPresence**](SystemPresence.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
<a name="get_user_id_presences_source_id"></a>
## -[**UserPresence**](UserPresence.html) get_user_id_presences_source_id(user_id, source_id)
Get a user's Presence
@@ -312,11 +363,11 @@
<a name="post_presencedefinitions"></a>
## -[**OrganizationPresence**](OrganizationPresence.html) post_presencedefinitions(body)
-Create an OrganizationPresence
+Create a Presence Definition
### Example
~~~ruby
@@ -333,15 +384,15 @@
config.access_token = @authToken
end
api_instance = PureCloud::PresenceApi.new
-body = PureCloud::OrganizationPresence.new # OrganizationPresence | The OrganizationPresence to create
+body = PureCloud::OrganizationPresence.new # OrganizationPresence | The Presence Definition to create
begin
- #Create an OrganizationPresence
+ #Create a Presence Definition
result = api_instance.post_presencedefinitions(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling PresenceApi->post_presencedefinitions: #{e}"
end
@@ -349,11 +400,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **body** | [**OrganizationPresence**](OrganizationPresence.html)| The OrganizationPresence to create |
+ **body** | [**OrganizationPresence**](OrganizationPresence.html)| The Presence Definition to create |
{: class="table table-striped"}
### Return type
@@ -368,11 +419,11 @@
<a name="put_presence_id"></a>
## -[**OrganizationPresence**](OrganizationPresence.html) put_presence_id(presence_id, body)
-Update an OrganizationPresence
+Update a Presence Definition
### Example
~~~ruby
@@ -395,10 +446,10 @@
body = PureCloud::OrganizationPresence.new # OrganizationPresence | The OrganizationPresence to update
begin
- #Update an OrganizationPresence
+ #Update a Presence Definition
result = api_instance.put_presence_id(presence_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling PresenceApi->put_presence_id: #{e}"
end