purecloud 0.37.1 → 0.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5661ebed300c04d9a206f2341af08ac2d598b3c
-  data.tar.gz: 83487d526051b55d1634118fc822fc1a4956c5e3
+  metadata.gz: 72c401211de589c476c53f5bb0c369174ca89efc
+  data.tar.gz: 0426cb0b02f21d55f73ab92228bfac965758af0a
 SHA512:
-  metadata.gz: 06352aa310f087f315d750851430dd5dd1c96c12920ba0221e04a78442041b4730bb529ef411fda4b8f0a4559cd0d39a9313452963d287aa11e9c1057755b085
-  data.tar.gz: 15f1e51633d08d08bb5a8294cd9042eebb1ae11b8ca7ea044a32a98cfe3058576a766f39e77b6d612922a8154e056213af390c920475d4b3b431d1fc0a9ad98b
+  metadata.gz: 8ede94dc8d40338e6ca8487c3b6ed0096f6e8ef2fa0a1f8b5ff80f1f8ae38c0d5f34a3d2421d16d52e1d75b52d8653436d63ecf112515b1ac56568d3460d667a
+  data.tar.gz: 9eae8a438a99386c1da62e5b6874163ffe5fdd98857a8e9003d2f1edba915fa7cad70034d2d9d35ba107de2fc18fafb897a6e1c3188cd866060ecfb6fc451073

data/README.md

@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v2
-- Package version: 0.37.1
-- Build date: 2016-04-21T12:51:39.418Z
+- Package version: 0.38.1
+- Build date: 2016-05-01T03:13:46.334Z
 
 For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
 
 ### from rubygems.org
 
-    gem 'purecloud', '~> 0.37.1'
+    gem 'purecloud', '~> 0.38.1'
 
 ### Install from Git
 

data/config-ruby.json

@@ -1 +1 @@
-{"gemVersion":"0.37.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.37.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
+{"gemVersion":"0.38.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.38.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}

data/doc_out/AuthorizationApi.html.md

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 |[**delete_roles_role_id**](AuthorizationApi.html#delete_roles_role_id) | **DELETE** /api/v2/authorization/roles/{roleId} | Delete an organization role.|
 |[**delete_user_id_roles**](AuthorizationApi.html#delete_user_id_roles) | **DELETE** /api/v2/users/{userId}/roles | Removes all the roles from the user.|
+|[**get_objects_object_id**](AuthorizationApi.html#get_objects_object_id) | **GET** /api/v2/authorization/objects/{objectId} | Returns a permission-protected object, showing the permission contexts it belongs to.|
 |[**get_permissions**](AuthorizationApi.html#get_permissions) | **GET** /api/v2/authorization/permissions | Get all permissions.|
 |[**get_products**](AuthorizationApi.html#get_products) | **GET** /api/v2/authorization/products | Get the list of enabled products|
 |[**get_roles**](AuthorizationApi.html#get_roles) | **GET** /api/v2/authorization/roles | Retrieve a list of all roles defined for the organization|
@@ -137,6 +138,62 @@ nil (empty response body)
 
 
 
+<a name="get_objects_object_id"></a>
+
+## -[**AuthzObject**](AuthzObject.html) get_objects_object_id(object_id)
+
+Returns a permission-protected object, showing the permission contexts it belongs to.
+
+
+
+### 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::AuthorizationApi.new
+
+object_id = "object_id_example" # String | Object ID
+
+
+begin
+  #Returns a permission-protected object, showing the permission contexts it belongs to.
+  result = api_instance.get_objects_object_id(object_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuthorizationApi->get_objects_object_id: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **object_id** | **String**| Object ID | 
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuthzObject**](AuthzObject.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_permissions"></a>
 
 ## -[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_permissions(opts)

data/doc_out/AuthzGrant.html.md

@@ -0,0 +1,15 @@
+---
+title: AuthzGrant
+---
+## PureCloud::AuthzGrant
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **permission_context** | [**AuthzPermissionContext**](AuthzPermissionContext.html) |  | [optional] |
+| **role** | [**AuthzGrantRole**](AuthzGrantRole.html) |  | [optional] |
+| **grant_made_at** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/AuthzGrantPolicy.html.md

@@ -0,0 +1,16 @@
+---
+title: AuthzGrantPolicy
+---
+## PureCloud::AuthzGrantPolicy
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **actions** | **Array<String>** |  | [optional] |
+| **condition** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **entity_name** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/AuthzGrantRole.html.md

@@ -0,0 +1,17 @@
+---
+title: AuthzGrantRole
+---
+## PureCloud::AuthzGrantRole
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **policies** | [**Array<AuthzGrantPolicy>**](AuthzGrantPolicy.html) |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/AuthzObject.html.md

@@ -0,0 +1,17 @@
+---
+title: AuthzObject
+---
+## PureCloud::AuthzObject
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **last_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **permission_contexts** | [**Array<AuthzPermissionContext>**](AuthzPermissionContext.html) |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/AuthzPermissionContext.html.md

@@ -0,0 +1,14 @@
+---
+title: AuthzPermissionContext
+---
+## PureCloud::AuthzPermissionContext
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **context_id** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/AuthzSubject.html.md

@@ -0,0 +1,16 @@
+---
+title: AuthzSubject
+---
+## PureCloud::AuthzSubject
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **grants** | [**Array<AuthzGrant>**](AuthzGrant.html) |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CreateUser.html.md

@@ -13,7 +13,6 @@ title: CreateUser
 | **addresses** | [**Array<Contact>**](Contact.html) | Email addresses and phone numbers for this user | [optional] |
 | **title** | **String** |  | [optional] |
 | **password** | **String** | User's password | |
-| **version** | **String** | Use version number 1 when creating | |
 {: class="table table-striped"}
 
 

data/doc_out/ExportUri.html.md

@@ -0,0 +1,14 @@
+---
+title: ExportUri
+---
+## PureCloud::ExportUri
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **uri** | **String** |  | [optional] |
+| **export_timestamp** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/FaxSendRequest.html.md

@@ -9,11 +9,11 @@ title: FaxSendRequest
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **addresses** | **Array<String>** |  | [optional] |
-| **original_filename** | **String** |  | [optional] |
-| **content_type** | **String** |  | [optional] |
-| **workspace** | [**Workspace**](Workspace.html) |  | [optional] |
-| **cover_sheet** | [**CoverSheet**](CoverSheet.html) |  | [optional] |
+| **addresses** | **Array<String>** | A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555 | |
+| **document_id** | **String** | DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null | [optional] |
+| **content_type** | **String** | The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored | [optional] |
+| **workspace** | [**Workspace**](Workspace.html) | Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored | [optional] |
+| **cover_sheet** | [**CoverSheet**](CoverSheet.html) | Data for coversheet generation. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/GroupsApi.html.md

@@ -8,14 +8,74 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+|[**delete_group_id_members**](GroupsApi.html#delete_group_id_members) | **DELETE** /api/v2/groups/{groupId}/members | Remove members|
 |[**get_group_id**](GroupsApi.html#get_group_id) | **GET** /api/v2/groups/{groupId} | Get group|
 |[**get_group_id_members**](GroupsApi.html#get_group_id_members) | **GET** /api/v2/groups/{groupId}/members | Get group members|
 |[**get_groups**](GroupsApi.html#get_groups) | **GET** /api/v2/groups | Get a group list|
 |[**get_search**](GroupsApi.html#get_search) | **GET** /api/v2/groups/search | Search using q64|
+|[**post_group_id_members**](GroupsApi.html#post_group_id_members) | **POST** /api/v2/groups/{groupId}/members | Add members|
 |[**post_groups**](GroupsApi.html#post_groups) | **POST** /api/v2/groups | Create a group|
 |[**post_search**](GroupsApi.html#post_search) | **POST** /api/v2/groups/search | Search|
 {: class="table table-striped"}
 
+<a name="delete_group_id_members"></a>
+
+## - delete_group_id_members(group_id, ids)
+
+Remove members
+
+
+
+### 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::GroupsApi.new
+
+group_id = "group_id_example" # String | Group ID
+
+ids = "ids_example" # String | Comma separated list of userIds to remove
+
+
+begin
+  #Remove members
+  api_instance.delete_group_id_members(group_id, ids)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling GroupsApi->delete_group_id_members: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| Group ID | 
+ **ids** | **String**| Comma separated list of userIds to remove | 
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_group_id"></a>
 
 ## -[**Group**](Group.html) get_group_id(group_id)
@@ -256,6 +316,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_group_id_members"></a>
+
+## - post_group_id_members(group_id, opts)
+
+Add members
+
+
+
+### 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::GroupsApi.new
+
+group_id = "group_id_example" # String | Group ID
+
+opts = { 
+  body: PureCloud::GroupMembersUpdate.new # GroupMembersUpdate | Add members
+}
+
+begin
+  #Add members
+  api_instance.post_group_id_members(group_id, opts)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling GroupsApi->post_group_id_members: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| Group ID | 
+ **body** | [**GroupMembersUpdate**](GroupMembersUpdate.html)| Add members | [optional] 
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_groups"></a>
 
 ## -[**Group**](Group.html) post_groups(opts)

data/doc_out/JsonNode.html.md

@@ -9,15 +9,15 @@ title: JsonNode
 |------------ | ------------- | ------------- | -------------|
 | **node_type** | **String** |  | [optional] |
 | **float** | **BOOLEAN** |  | [optional] [default to false]|
-| **object** | **BOOLEAN** |  | [optional] [default to false]|
 | **boolean** | **BOOLEAN** |  | [optional] [default to false]|
 | **number** | **BOOLEAN** |  | [optional] [default to false]|
+| **object** | **BOOLEAN** |  | [optional] [default to false]|
 | **value_node** | **BOOLEAN** |  | [optional] [default to false]|
-| **floating_point_number** | **BOOLEAN** |  | [optional] [default to false]|
 | **container_node** | **BOOLEAN** |  | [optional] [default to false]|
 | **missing_node** | **BOOLEAN** |  | [optional] [default to false]|
 | **pojo** | **BOOLEAN** |  | [optional] [default to false]|
 | **integral_number** | **BOOLEAN** |  | [optional] [default to false]|
+| **floating_point_number** | **BOOLEAN** |  | [optional] [default to false]|
 | **short** | **BOOLEAN** |  | [optional] [default to false]|
 | **int** | **BOOLEAN** |  | [optional] [default to false]|
 | **long** | **BOOLEAN** |  | [optional] [default to false]|

data/doc_out/Location.html.md

@@ -0,0 +1,20 @@
+---
+title: Location
+---
+## PureCloud::Location
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **address** | [**LocationAddress**](LocationAddress.html) |  | [optional] |
+| **address_verified** | **BOOLEAN** |  | [optional] [default to false]|
+| **emergency_number** | [**LocationEmergencyNumber**](LocationEmergencyNumber.html) |  | [optional] |
+| **state** | **String** | Current activity status of the location. | [optional] |
+| **version** | **Integer** |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/LocationAddress.html.md

@@ -0,0 +1,19 @@
+---
+title: LocationAddress
+---
+## PureCloud::LocationAddress
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **city** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **country_name** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **street1** | **String** |  | [optional] |
+| **street2** | **String** |  | [optional] |
+| **zipcode** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+