doc_out/PresenceApi.html.md in purecloud-0.62.1 vs doc_out/PresenceApi.html.md in purecloud-0.63.1

- old
+ new

@@ -7,16 +7,16 @@ 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 a Presence Definition| +|[**get**](PresenceApi.html#get) | **GET** /api/v2/presencedefinitions | Get an Organization&#39;s list of Presence Definitions| |[**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&#39;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&#39;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&#39;s Presence| -|[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create a Presence Definition| +|[**post**](PresenceApi.html#post) | **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> @@ -71,15 +71,15 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="get_presence_id"></a> +<a name="get"></a> -## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id, opts) +## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get(opts) -Get a Presence Definition +Get an Organization's list of Presence Definitions ### Example ~~~ruby @@ -96,50 +96,53 @@ config.access_token = @authToken end api_instance = PureCloud::PresenceApi.new -presence_id = "presence_id_example" # String | Organization Presence ID - opts = { - locale_code: "locale_code_example" # String | The locale code to fetch for the presence definition. Use ALL to fetch everything. + page_number: 1, # Integer | Page number + page_size: 25, # Integer | Page size + deleted: "false", # String | Deleted query can be TRUE, FALSE or ALL + locale_code: "locale_code_example" # String | The locale code to fetch for each presence definition. Use ALL to fetch everything. } begin - #Get a Presence Definition - result = api_instance.get_presence_id(presence_id, opts) + #Get an Organization's list of Presence Definitions + result = api_instance.get(opts) p result rescue PureCloud::ApiError => e - puts "Exception when calling PresenceApi->get_presence_id: #{e}" + puts "Exception when calling PresenceApi->get: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **presence_id** | **String**| Organization Presence ID | - **locale_code** | **String**| The locale code to fetch for the presence definition. Use ALL to fetch everything. | [optional] + **page_number** | **Integer**| Page number | [optional] [default to 1] + **page_size** | **Integer**| Page size | [optional] [default to 25] + **deleted** | **String**| Deleted query can be TRUE, FALSE or ALL | [optional] [default to false] + **locale_code** | **String**| The locale code to fetch for each presence definition. Use ALL to fetch everything. | [optional] {: class="table table-striped"} ### Return type -[**OrganizationPresence**](OrganizationPresence.html) +[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json -<a name="get_presencedefinitions"></a> +<a name="get_presence_id"></a> -## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get_presencedefinitions(opts) +## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id, opts) -Get an Organization's list of Presence Definitions +Get a Presence Definition ### Example ~~~ruby @@ -156,40 +159,37 @@ config.access_token = @authToken end api_instance = PureCloud::PresenceApi.new +presence_id = "presence_id_example" # String | Organization Presence ID + opts = { - page_number: 1, # Integer | Page number - page_size: 25, # Integer | Page size - deleted: "false", # String | Deleted query can be TRUE, FALSE or ALL - locale_code: "locale_code_example" # String | The locale code to fetch for each presence definition. Use ALL to fetch everything. + locale_code: "locale_code_example" # String | The locale code to fetch for the presence definition. Use ALL to fetch everything. } begin - #Get an Organization's list of Presence Definitions - result = api_instance.get_presencedefinitions(opts) + #Get a Presence Definition + result = api_instance.get_presence_id(presence_id, opts) p result rescue PureCloud::ApiError => e - puts "Exception when calling PresenceApi->get_presencedefinitions: #{e}" + puts "Exception when calling PresenceApi->get_presence_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_number** | **Integer**| Page number | [optional] [default to 1] - **page_size** | **Integer**| Page size | [optional] [default to 25] - **deleted** | **String**| Deleted query can be TRUE, FALSE or ALL | [optional] [default to false] - **locale_code** | **String**| The locale code to fetch for each presence definition. Use ALL to fetch everything. | [optional] + **presence_id** | **String**| Organization Presence ID | + **locale_code** | **String**| The locale code to fetch for the presence definition. Use ALL to fetch everything. | [optional] {: class="table table-striped"} ### Return type -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) +[**OrganizationPresence**](OrganizationPresence.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json @@ -365,13 +365,13 @@ - **Content-Type**: application/json - **Accept**: application/json -<a name="post_presencedefinitions"></a> +<a name="post"></a> -## -[**OrganizationPresence**](OrganizationPresence.html) post_presencedefinitions(body) +## -[**OrganizationPresence**](OrganizationPresence.html) post(body) Create a Presence Definition @@ -395,13 +395,13 @@ body = PureCloud::OrganizationPresence.new # OrganizationPresence | The Presence Definition to create begin #Create a Presence Definition - result = api_instance.post_presencedefinitions(body) + result = api_instance.post(body) p result rescue PureCloud::ApiError => e - puts "Exception when calling PresenceApi->post_presencedefinitions: #{e}" + puts "Exception when calling PresenceApi->post: #{e}" end ~~~ ### Parameters