---
title: ArchitectApi
---

## PureCloud::ArchitectApi

All URIs are relative to *https://api.mypurecloud.com*

Method | Description
------------- | ------------- | -------------
[**delete_architect_ivr**](ArchitectApi.html#delete_architect_ivr) | Delete an IVR Config.
[**delete_architect_prompt**](ArchitectApi.html#delete_architect_prompt) | Delete specified user prompt
[**delete_architect_prompt_resource**](ArchitectApi.html#delete_architect_prompt_resource) | Delete specified user prompt resource
[**delete_architect_prompts**](ArchitectApi.html#delete_architect_prompts) | Batch-delete a list of prompts
[**delete_architect_schedule**](ArchitectApi.html#delete_architect_schedule) | Delete a schedule by id
[**delete_architect_schedulegroup**](ArchitectApi.html#delete_architect_schedulegroup) | Deletes a schedule group by ID
[**delete_architect_systemprompt_resource**](ArchitectApi.html#delete_architect_systemprompt_resource) | Delete a system prompt resource override.
[**delete_flow**](ArchitectApi.html#delete_flow) | Delete flow
[**delete_flows**](ArchitectApi.html#delete_flows) | Batch-delete a list of flows
[**get_architect_dependencytracking**](ArchitectApi.html#get_architect_dependencytracking) | Get Dependency Tracking objects that have a given display name
[**get_architect_dependencytracking_build**](ArchitectApi.html#get_architect_dependencytracking_build) | Get Dependency Tracking build status for an organization
[**get_architect_dependencytracking_consumedresources**](ArchitectApi.html#get_architect_dependencytracking_consumedresources) | Get resources that are consumed by a given Dependency Tracking object
[**get_architect_dependencytracking_consumingresources**](ArchitectApi.html#get_architect_dependencytracking_consumingresources) | Get resources that consume a given Dependency Tracking object
[**get_architect_dependencytracking_deletedresourceconsumers**](ArchitectApi.html#get_architect_dependencytracking_deletedresourceconsumers) | Get Dependency Tracking objects that consume deleted resources
[**get_architect_dependencytracking_object**](ArchitectApi.html#get_architect_dependencytracking_object) | Get a Dependency Tracking object
[**get_architect_dependencytracking_type**](ArchitectApi.html#get_architect_dependencytracking_type) | Get a Dependency Tracking type.
[**get_architect_dependencytracking_types**](ArchitectApi.html#get_architect_dependencytracking_types) | Get Dependency Tracking types.
[**get_architect_dependencytracking_updatedresourceconsumers**](ArchitectApi.html#get_architect_dependencytracking_updatedresourceconsumers) | Get Dependency Tracking objects that depend on updated resources
[**get_architect_ivr**](ArchitectApi.html#get_architect_ivr) | Get an IVR config.
[**get_architect_ivrs**](ArchitectApi.html#get_architect_ivrs) | Get IVR configs.
[**get_architect_prompt**](ArchitectApi.html#get_architect_prompt) | Get specified user prompt
[**get_architect_prompt_resource**](ArchitectApi.html#get_architect_prompt_resource) | Get specified user prompt resource
[**get_architect_prompt_resources**](ArchitectApi.html#get_architect_prompt_resources) | Get a pageable list of user prompt resources
[**get_architect_prompts**](ArchitectApi.html#get_architect_prompts) | Get a pageable list of user prompts
[**get_architect_schedule**](ArchitectApi.html#get_architect_schedule) | Get a schedule by ID
[**get_architect_schedulegroup**](ArchitectApi.html#get_architect_schedulegroup) | Gets a schedule group by ID
[**get_architect_schedulegroups**](ArchitectApi.html#get_architect_schedulegroups) | Get a list of schedule groups.
[**get_architect_schedules**](ArchitectApi.html#get_architect_schedules) | Get a list of schedules.
[**get_architect_systemprompt**](ArchitectApi.html#get_architect_systemprompt) | Get a system prompt
[**get_architect_systemprompt_resource**](ArchitectApi.html#get_architect_systemprompt_resource) | Get a system prompt resource.
[**get_architect_systemprompt_resources**](ArchitectApi.html#get_architect_systemprompt_resources) | Get system prompt resources.
[**get_architect_systemprompts**](ArchitectApi.html#get_architect_systemprompts) | Get System Prompts
[**get_flow**](ArchitectApi.html#get_flow) | Get flow
[**get_flow_history_history_id**](ArchitectApi.html#get_flow_history_history_id) | Get generated flow history
[**get_flow_latestconfiguration**](ArchitectApi.html#get_flow_latestconfiguration) | Get the latest configuration for flow
[**get_flow_version**](ArchitectApi.html#get_flow_version) | Get flow version
[**get_flow_version_configuration**](ArchitectApi.html#get_flow_version_configuration) | Create flow version configuration
[**get_flow_versions**](ArchitectApi.html#get_flow_versions) | Get flow version list
[**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
[**post_architect_dependencytracking_build**](ArchitectApi.html#post_architect_dependencytracking_build) | Rebuild Dependency Tracking data for an organization
[**post_architect_ivrs**](ArchitectApi.html#post_architect_ivrs) | Create IVR config.
[**post_architect_prompt_resources**](ArchitectApi.html#post_architect_prompt_resources) | Create a new user prompt resource
[**post_architect_prompts**](ArchitectApi.html#post_architect_prompts) | Create a new user prompt
[**post_architect_schedulegroups**](ArchitectApi.html#post_architect_schedulegroups) | Creates a new schedule group
[**post_architect_schedules**](ArchitectApi.html#post_architect_schedules) | Create a new schedule.
[**post_architect_systemprompt_resources**](ArchitectApi.html#post_architect_systemprompt_resources) | Create system prompt resource override.
[**post_flow_versions**](ArchitectApi.html#post_flow_versions) | Create flow version
[**post_flows**](ArchitectApi.html#post_flows) | Create flow
[**post_flows_actions_checkin**](ArchitectApi.html#post_flows_actions_checkin) | Check-in flow
[**post_flows_actions_checkout**](ArchitectApi.html#post_flows_actions_checkout) | Check-out flow
[**post_flows_actions_deactivate**](ArchitectApi.html#post_flows_actions_deactivate) | Deactivate flow
[**post_flows_actions_publish**](ArchitectApi.html#post_flows_actions_publish) | Publish flow
[**post_flows_actions_revert**](ArchitectApi.html#post_flows_actions_revert) | Revert flow
[**post_flows_actions_unlock**](ArchitectApi.html#post_flows_actions_unlock) | Unlock flow
[**put_architect_ivr**](ArchitectApi.html#put_architect_ivr) | Update an IVR Config.
[**put_architect_prompt**](ArchitectApi.html#put_architect_prompt) | Update specified user prompt
[**put_architect_prompt_resource**](ArchitectApi.html#put_architect_prompt_resource) | Update specified user prompt resource
[**put_architect_schedule**](ArchitectApi.html#put_architect_schedule) | Update schedule by ID
[**put_architect_schedulegroup**](ArchitectApi.html#put_architect_schedulegroup) | Updates a schedule group by ID
[**put_architect_systemprompt_resource**](ArchitectApi.html#put_architect_systemprompt_resource) | Updates a system prompt resource override.
[**put_flow**](ArchitectApi.html#put_flow) | Update flow
{: class="table table-striped"}

<a name="delete_architect_ivr"></a>

## - delete_architect_ivr(ivr_id)

Delete an IVR Config.



Wraps DELETE /api/v2/architect/ivrs/{ivrId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

ivr_id = "ivr_id_example" # String | IVR id


begin
  #Delete an IVR Config.
  api_instance.delete_architect_ivr(ivr_id)
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_architect_ivr: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ivr_id** | **String**| IVR id |  |
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_architect_prompt"></a>

## - delete_architect_prompt(prompt_id, opts)

Delete specified user prompt



Wraps DELETE /api/v2/architect/prompts/{promptId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

opts = { 
  all_resources: true # BOOLEAN | Whether or not to delete all the prompt resources
}

begin
  #Delete specified user prompt
  api_instance.delete_architect_prompt(prompt_id, opts)
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_architect_prompt: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **all_resources** | **BOOLEAN**| Whether or not to delete all the prompt resources | [optional]  |
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_architect_prompt_resource"></a>

## - delete_architect_prompt_resource(prompt_id, language_code)

Delete specified user prompt resource



Wraps DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

language_code = "language_code_example" # String | Language


begin
  #Delete specified user prompt resource
  api_instance.delete_architect_prompt_resource(prompt_id, language_code)
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_architect_prompt_resource: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **language_code** | **String**| Language |  |
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_architect_prompts"></a>

## -[**Operation**](Operation.html) delete_architect_prompts(id)

Batch-delete a list of prompts

Multiple IDs can be specified, in which case all specified prompts will be deleted.  Asynchronous.  Notification topic: v2.architect.prompts.{promptId}

Wraps DELETE /api/v2/architect/prompts 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

id = ["id_example"] # Array<String> | List of Prompt IDs


begin
  #Batch-delete a list of prompts
  result = api_instance.delete_architect_prompts(id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_architect_prompts: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | [**Array&lt;String&gt;**](String.html)| List of Prompt IDs |  |
{: class="table table-striped"}


### Return type

[**Operation**](Operation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_architect_schedule"></a>

## - delete_architect_schedule(schedule_id)

Delete a schedule by id



Wraps DELETE /api/v2/architect/schedules/{scheduleId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

schedule_id = "schedule_id_example" # String | Schedule ID


begin
  #Delete a schedule by id
  api_instance.delete_architect_schedule(schedule_id)
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_architect_schedule: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID |  |
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_architect_schedulegroup"></a>

## - delete_architect_schedulegroup(schedule_group_id)

Deletes a schedule group by ID



Wraps DELETE /api/v2/architect/schedulegroups/{scheduleGroupId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

schedule_group_id = "schedule_group_id_example" # String | Schedule group ID


begin
  #Deletes a schedule group by ID
  api_instance.delete_architect_schedulegroup(schedule_group_id)
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_architect_schedulegroup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_group_id** | **String**| Schedule group ID |  |
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_architect_systemprompt_resource"></a>

## - delete_architect_systemprompt_resource(prompt_id, language_code)

Delete a system prompt resource override.



Wraps DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

language_code = "language_code_example" # String | Language


begin
  #Delete a system prompt resource override.
  api_instance.delete_architect_systemprompt_resource(prompt_id, language_code)
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_architect_systemprompt_resource: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **language_code** | **String**| Language |  |
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_flow"></a>

## - delete_flow(flow_id)

Delete flow



Wraps DELETE /api/v2/flows/{flowId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID


begin
  #Delete flow
  api_instance.delete_flow(flow_id)
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_flow: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_flows"></a>

## -[**Operation**](Operation.html) delete_flows(id)

Batch-delete a list of flows

Multiple IDs can be specified, in which case all specified flows will be deleted.  Asynchronous.  Notification topic: v2.flows.{flowId}

Wraps DELETE /api/v2/flows 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

id = ["id_example"] # Array<String> | List of Flow IDs


begin
  #Batch-delete a list of flows
  result = api_instance.delete_flows(id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->delete_flows: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | [**Array&lt;String&gt;**](String.html)| List of Flow IDs |  |
{: class="table table-striped"}


### Return type

[**Operation**](Operation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking"></a>

## -[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking(name, opts)

Get Dependency Tracking objects that have a given display name



Wraps GET /api/v2/architect/dependencytracking 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

name = "name_example" # String | Object name to search for

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  object_type: ["object_type_example"], # Array<String> | Object type(s) to search for
  consumed_resources: true, # BOOLEAN | Include resources each result item consumes
  consuming_resources: true, # BOOLEAN | Include resources that consume each result item
  consumed_resource_type: ["consumed_resource_type_example"], # Array<String> | Types of consumed resources to return, if consumed resources are requested
  consuming_resource_type: ["consuming_resource_type_example"] # Array<String> | Types of consuming resources to return, if consuming resources are requested
}

begin
  #Get Dependency Tracking objects that have a given display name
  result = api_instance.get_architect_dependencytracking(name, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **name** | **String**| Object name to search for |  |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
 **object_type** | [**Array&lt;String&gt;**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **consumed_resources** | **BOOLEAN**| Include resources each result item consumes | [optional]  |
 **consuming_resources** | **BOOLEAN**| Include resources that consume each result item | [optional]  |
 **consumed_resource_type** | [**Array&lt;String&gt;**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **consuming_resource_type** | [**Array&lt;String&gt;**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
{: class="table table-striped"}


### Return type

[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_build"></a>

## -[**DependencyStatus**](DependencyStatus.html) get_architect_dependencytracking_build

Get Dependency Tracking build status for an organization



Wraps GET /api/v2/architect/dependencytracking/build 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

begin
  #Get Dependency Tracking build status for an organization
  result = api_instance.get_architect_dependencytracking_build
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_build: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**DependencyStatus**](DependencyStatus.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_consumedresources"></a>

## -[**ConsumedResourcesEntityListing**](ConsumedResourcesEntityListing.html) get_architect_dependencytracking_consumedresources(id, version, object_type, opts)

Get resources that are consumed by a given Dependency Tracking object



Wraps GET /api/v2/architect/dependencytracking/consumedresources 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

id = "id_example" # String | Consuming object ID

version = "version_example" # String | Consuming object version

object_type = "object_type_example" # String | Consuming object type.  Only versioned types are allowed here.

opts = { 
  resource_type: ["resource_type_example"] # Array<String> | Types of consumed resources to show
}

begin
  #Get resources that are consumed by a given Dependency Tracking object
  result = api_instance.get_architect_dependencytracking_consumedresources(id, version, object_type, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_consumedresources: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Consuming object ID |  |
 **version** | **String**| Consuming object version |  |
 **object_type** | **String**| Consuming object type.  Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **resource_type** | [**Array&lt;String&gt;**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
{: class="table table-striped"}


### Return type

[**ConsumedResourcesEntityListing**](ConsumedResourcesEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_consumingresources"></a>

## -[**ConsumingResourcesEntityListing**](ConsumingResourcesEntityListing.html) get_architect_dependencytracking_consumingresources(id, object_type, opts)

Get resources that consume a given Dependency Tracking object



Wraps GET /api/v2/architect/dependencytracking/consumingresources 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

id = "id_example" # String | Consumed object ID

object_type = "object_type_example" # String | Consumed object type

opts = { 
  resource_type: ["resource_type_example"] # Array<String> | Types of consuming resources to show.  Only versioned types are allowed here.
}

begin
  #Get resources that consume a given Dependency Tracking object
  result = api_instance.get_architect_dependencytracking_consumingresources(id, object_type, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_consumingresources: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Consumed object ID |  |
 **object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **resource_type** | [**Array&lt;String&gt;**](String.html)| Types of consuming resources to show.  Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
{: class="table table-striped"}


### Return type

[**ConsumingResourcesEntityListing**](ConsumingResourcesEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_deletedresourceconsumers"></a>

## -[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking_deletedresourceconsumers(opts)

Get Dependency Tracking objects that consume deleted resources



Wraps GET /api/v2/architect/dependencytracking/deletedresourceconsumers 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  name: "name_example", # String | Name to search for
  object_type: ["object_type_example"], # Array<String> | Object type(s) to search for
  flow_filter: "flow_filter_example", # String | Show only checkedIn or published flows
  consumed_resources: false, # BOOLEAN | Return consumed resources?
  consumed_resource_type: ["consumed_resource_type_example"], # Array<String> | Resource type(s) to return
  page_number: 1, # Integer | Page number
  page_size: 25 # Integer | Page size
}

begin
  #Get Dependency Tracking objects that consume deleted resources
  result = api_instance.get_architect_dependencytracking_deletedresourceconsumers(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_deletedresourceconsumers: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **name** | **String**| Name to search for | [optional]  |
 **object_type** | [**Array&lt;String&gt;**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
 **consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
 **consumed_resource_type** | [**Array&lt;String&gt;**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
{: class="table table-striped"}


### Return type

[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_object"></a>

## -[**DependencyObject**](DependencyObject.html) get_architect_dependencytracking_object(id, opts)

Get a Dependency Tracking object



Wraps GET /api/v2/architect/dependencytracking/object 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

id = "id_example" # String | Object ID

opts = { 
  version: "version_example", # String | Object version
  object_type: "object_type_example", # String | Object type
  consumed_resources: true, # BOOLEAN | Include resources this item consumes
  consuming_resources: true, # BOOLEAN | Include resources that consume this item
  consumed_resource_type: ["consumed_resource_type_example"], # Array<String> | Types of consumed resources to return, if consumed resources are requested
  consuming_resource_type: ["consuming_resource_type_example"] # Array<String> | Types of consuming resources to return, if consuming resources are requested
}

begin
  #Get a Dependency Tracking object
  result = api_instance.get_architect_dependencytracking_object(id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_object: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Object ID |  |
 **version** | **String**| Object version | [optional]  |
 **object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **consumed_resources** | **BOOLEAN**| Include resources this item consumes | [optional]  |
 **consuming_resources** | **BOOLEAN**| Include resources that consume this item | [optional]  |
 **consumed_resource_type** | [**Array&lt;String&gt;**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **consuming_resource_type** | [**Array&lt;String&gt;**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
{: class="table table-striped"}


### Return type

[**DependencyObject**](DependencyObject.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_type"></a>

## -[**DependencyType**](DependencyType.html) get_architect_dependencytracking_type(type_id)

Get a Dependency Tracking type.



Wraps GET /api/v2/architect/dependencytracking/types/{typeId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

type_id = "type_id_example" # String | Type ID


begin
  #Get a Dependency Tracking type.
  result = api_instance.get_architect_dependencytracking_type(type_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_type: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type_id** | **String**| Type ID |  |
{: class="table table-striped"}


### Return type

[**DependencyType**](DependencyType.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_types"></a>

## -[**DependencyTypeEntityListing**](DependencyTypeEntityListing.html) get_architect_dependencytracking_types(opts)

Get Dependency Tracking types.



Wraps GET /api/v2/architect/dependencytracking/types 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25 # Integer | Page size
}

begin
  #Get Dependency Tracking types.
  result = api_instance.get_architect_dependencytracking_types(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_types: #{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] |
{: class="table table-striped"}


### Return type

[**DependencyTypeEntityListing**](DependencyTypeEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_dependencytracking_updatedresourceconsumers"></a>

## -[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking_updatedresourceconsumers(opts)

Get Dependency Tracking objects that depend on updated resources



Wraps GET /api/v2/architect/dependencytracking/updatedresourceconsumers 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  name: "name_example", # String | Name to search for
  object_type: ["object_type_example"], # Array<String> | Object type(s) to search for
  consumed_resources: false, # BOOLEAN | Return consumed resources?
  consumed_resource_type: ["consumed_resource_type_example"], # Array<String> | Resource type(s) to return
  page_number: 1, # Integer | Page number
  page_size: 25 # Integer | Page size
}

begin
  #Get Dependency Tracking objects that depend on updated resources
  result = api_instance.get_architect_dependencytracking_updatedresourceconsumers(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_dependencytracking_updatedresourceconsumers: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **name** | **String**| Name to search for | [optional]  |
 **object_type** | [**Array&lt;String&gt;**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
 **consumed_resource_type** | [**Array&lt;String&gt;**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
{: class="table table-striped"}


### Return type

[**DependencyObjectEntityListing**](DependencyObjectEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_ivr"></a>

## -[**IVR**](IVR.html) get_architect_ivr(ivr_id)

Get an IVR config.



Wraps GET /api/v2/architect/ivrs/{ivrId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

ivr_id = "ivr_id_example" # String | IVR id


begin
  #Get an IVR config.
  result = api_instance.get_architect_ivr(ivr_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_ivr: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ivr_id** | **String**| IVR id |  |
{: class="table table-striped"}


### Return type

[**IVR**](IVR.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_ivrs"></a>

## -[**IVREntityListing**](IVREntityListing.html) get_architect_ivrs(opts)

Get IVR configs.



Wraps GET /api/v2/architect/ivrs 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  sort_by: "name", # String | Sort by
  sort_order: "ASC", # String | Sort order
  name: "name_example" # String | Name of the IVR to filter by.
}

begin
  #Get IVR configs.
  result = api_instance.get_architect_ivrs(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_ivrs: #{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] |
 **sort_by** | **String**| Sort by | [optional] [default to name] |
 **sort_order** | **String**| Sort order | [optional] [default to ASC] |
 **name** | **String**| Name of the IVR to filter by. | [optional]  |
{: class="table table-striped"}


### Return type

[**IVREntityListing**](IVREntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_prompt"></a>

## -[**Prompt**](Prompt.html) get_architect_prompt(prompt_id)

Get specified user prompt



Wraps GET /api/v2/architect/prompts/{promptId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID


begin
  #Get specified user prompt
  result = api_instance.get_architect_prompt(prompt_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_prompt: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
{: class="table table-striped"}


### Return type

[**Prompt**](Prompt.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_prompt_resource"></a>

## -[**PromptAsset**](PromptAsset.html) get_architect_prompt_resource(prompt_id, language_code)

Get specified user prompt resource



Wraps GET /api/v2/architect/prompts/{promptId}/resources/{languageCode} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

language_code = "language_code_example" # String | Language


begin
  #Get specified user prompt resource
  result = api_instance.get_architect_prompt_resource(prompt_id, language_code)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_prompt_resource: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **language_code** | **String**| Language |  |
{: class="table table-striped"}


### Return type

[**PromptAsset**](PromptAsset.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_prompt_resources"></a>

## -[**PromptAssetEntityListing**](PromptAssetEntityListing.html) get_architect_prompt_resources(prompt_id, opts)

Get a pageable list of user prompt resources

The returned list is pageable, and query parameters can be used for filtering.

Wraps GET /api/v2/architect/prompts/{promptId}/resources 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25 # Integer | Page size
}

begin
  #Get a pageable list of user prompt resources
  result = api_instance.get_architect_prompt_resources(prompt_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_prompt_resources: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
{: class="table table-striped"}


### Return type

[**PromptAssetEntityListing**](PromptAssetEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_prompts"></a>

## -[**PromptEntityListing**](PromptEntityListing.html) get_architect_prompts(opts)

Get a pageable list of user prompts

The returned list is pageable, and query parameters can be used for filtering.  Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

Wraps GET /api/v2/architect/prompts 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  name: "name_example", # String | Name
  description: "description_example", # String | Description
  name_or_description: "name_or_description_example" # String | Name or description
}

begin
  #Get a pageable list of user prompts
  result = api_instance.get_architect_prompts(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_prompts: #{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] |
 **name** | **String**| Name | [optional]  |
 **description** | **String**| Description | [optional]  |
 **name_or_description** | **String**| Name or description | [optional]  |
{: class="table table-striped"}


### Return type

[**PromptEntityListing**](PromptEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_schedule"></a>

## -[**Schedule**](Schedule.html) get_architect_schedule(schedule_id)

Get a schedule by ID



Wraps GET /api/v2/architect/schedules/{scheduleId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

schedule_id = "schedule_id_example" # String | Schedule ID


begin
  #Get a schedule by ID
  result = api_instance.get_architect_schedule(schedule_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_schedule: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID |  |
{: class="table table-striped"}


### Return type

[**Schedule**](Schedule.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_schedulegroup"></a>

## -[**ScheduleGroup**](ScheduleGroup.html) get_architect_schedulegroup(schedule_group_id)

Gets a schedule group by ID



Wraps GET /api/v2/architect/schedulegroups/{scheduleGroupId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

schedule_group_id = "schedule_group_id_example" # String | Schedule group ID


begin
  #Gets a schedule group by ID
  result = api_instance.get_architect_schedulegroup(schedule_group_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_schedulegroup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_group_id** | **String**| Schedule group ID |  |
{: class="table table-striped"}


### Return type

[**ScheduleGroup**](ScheduleGroup.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_schedulegroups"></a>

## -[**ScheduleGroupEntityListing**](ScheduleGroupEntityListing.html) get_architect_schedulegroups(opts)

Get a list of schedule groups.



Wraps GET /api/v2/architect/schedulegroups 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  sort_by: "name", # String | Sort by
  sort_order: "ASC", # String | Sort order
  name: "name_example" # String | Name of the Schedule Group to filter by.
}

begin
  #Get a list of schedule groups.
  result = api_instance.get_architect_schedulegroups(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_schedulegroups: #{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] |
 **sort_by** | **String**| Sort by | [optional] [default to name] |
 **sort_order** | **String**| Sort order | [optional] [default to ASC] |
 **name** | **String**| Name of the Schedule Group to filter by. | [optional]  |
{: class="table table-striped"}


### Return type

[**ScheduleGroupEntityListing**](ScheduleGroupEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_schedules"></a>

## -[**ScheduleEntityListing**](ScheduleEntityListing.html) get_architect_schedules(opts)

Get a list of schedules.



Wraps GET /api/v2/architect/schedules 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  sort_by: "name", # String | Sort by
  sort_order: "ASC", # String | Sort order
  name: "name_example" # String | Name of the Schedule to filter by.
}

begin
  #Get a list of schedules.
  result = api_instance.get_architect_schedules(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_schedules: #{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] |
 **sort_by** | **String**| Sort by | [optional] [default to name] |
 **sort_order** | **String**| Sort order | [optional] [default to ASC] |
 **name** | **String**| Name of the Schedule to filter by. | [optional]  |
{: class="table table-striped"}


### Return type

[**ScheduleEntityListing**](ScheduleEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_systemprompt"></a>

## -[**SystemPrompt**](SystemPrompt.html) get_architect_systemprompt(prompt_id)

Get a system prompt



Wraps GET /api/v2/architect/systemprompts/{promptId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | promptId


begin
  #Get a system prompt
  result = api_instance.get_architect_systemprompt(prompt_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_systemprompt: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| promptId |  |
{: class="table table-striped"}


### Return type

[**SystemPrompt**](SystemPrompt.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_systemprompt_resource"></a>

## -[**SystemPromptAsset**](SystemPromptAsset.html) get_architect_systemprompt_resource(prompt_id, language_code)

Get a system prompt resource.



Wraps GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

language_code = "language_code_example" # String | Language


begin
  #Get a system prompt resource.
  result = api_instance.get_architect_systemprompt_resource(prompt_id, language_code)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_systemprompt_resource: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **language_code** | **String**| Language |  |
{: class="table table-striped"}


### Return type

[**SystemPromptAsset**](SystemPromptAsset.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_systemprompt_resources"></a>

## -[**SystemPromptAssetEntityListing**](SystemPromptAssetEntityListing.html) get_architect_systemprompt_resources(prompt_id, opts)

Get system prompt resources.



Wraps GET /api/v2/architect/systemprompts/{promptId}/resources 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  sort_by: "id", # String | Sort by
  sort_order: "asc" # String | Sort order
}

begin
  #Get system prompt resources.
  result = api_instance.get_architect_systemprompt_resources(prompt_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_systemprompt_resources: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
 **sort_by** | **String**| Sort by | [optional] [default to id] |
 **sort_order** | **String**| Sort order | [optional] [default to asc] |
{: class="table table-striped"}


### Return type

[**SystemPromptAssetEntityListing**](SystemPromptAssetEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_architect_systemprompts"></a>

## -[**SystemPromptEntityListing**](SystemPromptEntityListing.html) get_architect_systemprompts(opts)

Get System Prompts



Wraps GET /api/v2/architect/systemprompts 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  sort_by: "id", # String | Sort by
  sort_order: "asc", # String | Sort order
  name: "name_example", # String | Name
  description: "description_example", # String | Description
  name_or_description: "name_or_description_example" # String | Name or description
}

begin
  #Get System Prompts
  result = api_instance.get_architect_systemprompts(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_architect_systemprompts: #{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] |
 **sort_by** | **String**| Sort by | [optional] [default to id] |
 **sort_order** | **String**| Sort order | [optional] [default to asc] |
 **name** | **String**| Name | [optional]  |
 **description** | **String**| Description | [optional]  |
 **name_or_description** | **String**| Name or description | [optional]  |
{: class="table table-striped"}


### Return type

[**SystemPromptEntityListing**](SystemPromptEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_flow"></a>

## -[**Flow**](Flow.html) get_flow(flow_id, opts)

Get flow



Wraps GET /api/v2/flows/{flowId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

opts = { 
  deleted: false # BOOLEAN | Include deleted flows
}

begin
  #Get flow
  result = api_instance.get_flow(flow_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_flow: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **deleted** | **BOOLEAN**| Include deleted flows | [optional] [default to false] |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_flow_history_history_id"></a>

## -[**HistoryListing**](HistoryListing.html) get_flow_history_history_id(flow_id, history_id, opts)

Get generated flow history



Wraps GET /api/v2/flows/{flowId}/history/{historyId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

history_id = "history_id_example" # String | History ID (generated history)

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  sort_order: "desc", # String | Sort order
  sort_by: "timestamp", # String | Sort by
  action: ["action_example"] # Array<String> | Flow actions to include (omit to include all)
}

begin
  #Get generated flow history
  result = api_instance.get_flow_history_history_id(flow_id, history_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_flow_history_history_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **history_id** | **String**| History ID (generated history) |  |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
 **sort_order** | **String**| Sort order | [optional] [default to desc] |
 **sort_by** | **String**| Sort by | [optional] [default to timestamp]<br />**Values**: action, timestamp, user |
 **action** | [**Array&lt;String&gt;**](String.html)| Flow actions to include (omit to include all) | [optional] <br />**Values**: checkin, checkout, create, deactivate, debug, delete, publish, revert, save |
{: class="table table-striped"}


### Return type

[**HistoryListing**](HistoryListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_flow_latestconfiguration"></a>

## -Object** get_flow_latestconfiguration(flow_id, opts)

Get the latest configuration for flow



Wraps GET /api/v2/flows/{flowId}/latestconfiguration 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

opts = { 
  deleted: false # BOOLEAN | Include deleted flows
}

begin
  #Get the latest configuration for flow
  result = api_instance.get_flow_latestconfiguration(flow_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_flow_latestconfiguration: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **deleted** | **BOOLEAN**| Include deleted flows | [optional] [default to false] |
{: class="table table-striped"}


### Return type

**Object**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_flow_version"></a>

## -[**FlowVersion**](FlowVersion.html) get_flow_version(flow_id, version_id, opts)

Get flow version



Wraps GET /api/v2/flows/{flowId}/versions/{versionId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

version_id = "version_id_example" # String | Version ID

opts = { 
  deleted: "deleted_example" # String | Include deleted flows
}

begin
  #Get flow version
  result = api_instance.get_flow_version(flow_id, version_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_flow_version: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **version_id** | **String**| Version ID |  |
 **deleted** | **String**| Include deleted flows | [optional]  |
{: class="table table-striped"}


### Return type

[**FlowVersion**](FlowVersion.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_flow_version_configuration"></a>

## -Object** get_flow_version_configuration(flow_id, version_id, opts)

Create flow version configuration



Wraps GET /api/v2/flows/{flowId}/versions/{versionId}/configuration 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

version_id = "version_id_example" # String | Version ID

opts = { 
  deleted: "deleted_example" # String | Include deleted flows
}

begin
  #Create flow version configuration
  result = api_instance.get_flow_version_configuration(flow_id, version_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_flow_version_configuration: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **version_id** | **String**| Version ID |  |
 **deleted** | **String**| Include deleted flows | [optional]  |
{: class="table table-striped"}


### Return type

**Object**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_flow_versions"></a>

## -[**FlowVersionEntityListing**](FlowVersionEntityListing.html) get_flow_versions(flow_id, opts)

Get flow version list



Wraps GET /api/v2/flows/{flowId}/versions 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  deleted: true # BOOLEAN | Include deleted flows
}

begin
  #Get flow version list
  result = api_instance.get_flow_versions(flow_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_flow_versions: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
 **deleted** | **BOOLEAN**| Include deleted flows | [optional]  |
{: class="table table-striped"}


### Return type

[**FlowVersionEntityListing**](FlowVersionEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_flows"></a>

## -[**FlowEntityListing**](FlowEntityListing.html) get_flows(type, opts)

Get a pageable list of flows, filtered by query parameters

Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.

Wraps GET /api/v2/flows 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

type = "type_example" # String | Type

opts = { 
  page_number: 1, # Integer | Page number
  page_size: 25, # Integer | Page size
  sort_by: "id", # String | Sort by
  sort_order: "asc", # String | Sort order
  id: ["id_example"], # Array<String> | ID
  name: "name_example", # String | Name
  description: "description_example", # String | Description
  name_or_description: "name_or_description_example", # String | Name or description
  publish_version_id: "publish_version_id_example", # String | Publish version ID
  editable_by: "editable_by_example", # String | Editable by
  locked_by: "locked_by_example", # String | Locked by
  secure: "secure_example", # String | Secure
  deleted: false, # BOOLEAN | Include deleted
  include_schemas: false # BOOLEAN | Include variable schemas
}

begin
  #Get a pageable list of flows, filtered by query parameters
  result = api_instance.get_flows(type, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->get_flows: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | **String**| Type | <br />**Values**: inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow |
 **page_number** | **Integer**| Page number | [optional] [default to 1] |
 **page_size** | **Integer**| Page size | [optional] [default to 25] |
 **sort_by** | **String**| Sort by | [optional] [default to id] |
 **sort_order** | **String**| Sort order | [optional] [default to asc] |
 **id** | [**Array&lt;String&gt;**](String.html)| ID | [optional]  |
 **name** | **String**| Name | [optional]  |
 **description** | **String**| Description | [optional]  |
 **name_or_description** | **String**| Name or description | [optional]  |
 **publish_version_id** | **String**| Publish version ID | [optional]  |
 **editable_by** | **String**| Editable by | [optional]  |
 **locked_by** | **String**| Locked by | [optional]  |
 **secure** | **String**| Secure | [optional] <br />**Values**: any, checkedin, published |
 **deleted** | **BOOLEAN**| Include deleted | [optional] [default to false] |
 **include_schemas** | **BOOLEAN**| Include variable schemas | [optional] [default to false] |
{: class="table table-striped"}


### Return type

[**FlowEntityListing**](FlowEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_architect_dependencytracking_build"></a>

## - post_architect_dependencytracking_build

Rebuild Dependency Tracking data for an organization

Asynchronous.  Notification topic: v2.architect.dependencytracking.build

Wraps POST /api/v2/architect/dependencytracking/build 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

begin
  #Rebuild Dependency Tracking data for an organization
  api_instance.post_architect_dependencytracking_build
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_architect_dependencytracking_build: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_architect_ivrs"></a>

## -[**IVR**](IVR.html) post_architect_ivrs(opts)

Create IVR config.



Wraps POST /api/v2/architect/ivrs 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  body: PureCloud::IVR.new # IVR | 
}

begin
  #Create IVR config.
  result = api_instance.post_architect_ivrs(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_architect_ivrs: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**IVR**](IVR.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**IVR**](IVR.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_architect_prompt_resources"></a>

## -[**PromptAsset**](PromptAsset.html) post_architect_prompt_resources(prompt_id, opts)

Create a new user prompt resource



Wraps POST /api/v2/architect/prompts/{promptId}/resources 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

opts = { 
  body: PureCloud::PromptAssetCreate.new # PromptAssetCreate | 
}

begin
  #Create a new user prompt resource
  result = api_instance.post_architect_prompt_resources(prompt_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_architect_prompt_resources: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **body** | [**PromptAssetCreate**](PromptAssetCreate.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**PromptAsset**](PromptAsset.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_architect_prompts"></a>

## -[**Prompt**](Prompt.html) post_architect_prompts(opts)

Create a new user prompt



Wraps POST /api/v2/architect/prompts 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  body: PureCloud::Prompt.new # Prompt | 
}

begin
  #Create a new user prompt
  result = api_instance.post_architect_prompts(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_architect_prompts: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**Prompt**](Prompt.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**Prompt**](Prompt.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_architect_schedulegroups"></a>

## -[**ScheduleGroup**](ScheduleGroup.html) post_architect_schedulegroups(opts)

Creates a new schedule group



Wraps POST /api/v2/architect/schedulegroups 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  body: PureCloud::ScheduleGroup.new # ScheduleGroup | 
}

begin
  #Creates a new schedule group
  result = api_instance.post_architect_schedulegroups(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_architect_schedulegroups: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ScheduleGroup**](ScheduleGroup.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**ScheduleGroup**](ScheduleGroup.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_architect_schedules"></a>

## -[**Schedule**](Schedule.html) post_architect_schedules(opts)

Create a new schedule.



Wraps POST /api/v2/architect/schedules 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  body: PureCloud::Schedule.new # Schedule | 
}

begin
  #Create a new schedule.
  result = api_instance.post_architect_schedules(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_architect_schedules: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**Schedule**](Schedule.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**Schedule**](Schedule.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_architect_systemprompt_resources"></a>

## -[**SystemPromptAsset**](SystemPromptAsset.html) post_architect_systemprompt_resources(prompt_id, opts)

Create system prompt resource override.



Wraps POST /api/v2/architect/systemprompts/{promptId}/resources 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

opts = { 
  body: PureCloud::SystemPromptAsset.new # SystemPromptAsset | 
}

begin
  #Create system prompt resource override.
  result = api_instance.post_architect_systemprompt_resources(prompt_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_architect_systemprompt_resources: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **body** | [**SystemPromptAsset**](SystemPromptAsset.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**SystemPromptAsset**](SystemPromptAsset.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flow_versions"></a>

## -[**FlowVersion**](FlowVersion.html) post_flow_versions(flow_id, opts)

Create flow version



Wraps POST /api/v2/flows/{flowId}/versions 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

opts = { 
  body: nil # Object | 
}

begin
  #Create flow version
  result = api_instance.post_flow_versions(flow_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flow_versions: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **body** | **Object**|  | [optional]  |
{: class="table table-striped"}


### Return type

[**FlowVersion**](FlowVersion.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flows"></a>

## -[**Flow**](Flow.html) post_flows(opts)

Create flow



Wraps POST /api/v2/flows 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

opts = { 
  body: PureCloud::Flow.new # Flow | 
}

begin
  #Create flow
  result = api_instance.post_flows(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flows: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**Flow**](Flow.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flows_actions_checkin"></a>

## -[**Flow**](Flow.html) post_flows_actions_checkin(flow)

Check-in flow

Asynchronous.  Notification topic: v2.flows.{flowId}

Wraps POST /api/v2/flows/actions/checkin 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow = "flow_example" # String | Flow ID


begin
  #Check-in flow
  result = api_instance.post_flows_actions_checkin(flow)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flows_actions_checkin: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow** | **String**| Flow ID |  |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flows_actions_checkout"></a>

## -[**Flow**](Flow.html) post_flows_actions_checkout(flow)

Check-out flow



Wraps POST /api/v2/flows/actions/checkout 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow = "flow_example" # String | Flow ID


begin
  #Check-out flow
  result = api_instance.post_flows_actions_checkout(flow)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flows_actions_checkout: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow** | **String**| Flow ID |  |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flows_actions_deactivate"></a>

## -[**Flow**](Flow.html) post_flows_actions_deactivate(flow)

Deactivate flow



Wraps POST /api/v2/flows/actions/deactivate 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow = "flow_example" # String | Flow ID


begin
  #Deactivate flow
  result = api_instance.post_flows_actions_deactivate(flow)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flows_actions_deactivate: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow** | **String**| Flow ID |  |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flows_actions_publish"></a>

## -[**Operation**](Operation.html) post_flows_actions_publish(flow, opts)

Publish flow

Asynchronous.  Notification topic: v2.flows.{flowId}

Wraps POST /api/v2/flows/actions/publish 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow = "flow_example" # String | Flow ID

opts = { 
  version: "version_example" # String | version
}

begin
  #Publish flow
  result = api_instance.post_flows_actions_publish(flow, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flows_actions_publish: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow** | **String**| Flow ID |  |
 **version** | **String**| version | [optional]  |
{: class="table table-striped"}


### Return type

[**Operation**](Operation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flows_actions_revert"></a>

## -[**Flow**](Flow.html) post_flows_actions_revert(flow)

Revert flow



Wraps POST /api/v2/flows/actions/revert 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow = "flow_example" # String | Flow ID


begin
  #Revert flow
  result = api_instance.post_flows_actions_revert(flow)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flows_actions_revert: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow** | **String**| Flow ID |  |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_flows_actions_unlock"></a>

## -[**Flow**](Flow.html) post_flows_actions_unlock(flow)

Unlock flow

Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

Wraps POST /api/v2/flows/actions/unlock 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow = "flow_example" # String | Flow ID


begin
  #Unlock flow
  result = api_instance.post_flows_actions_unlock(flow)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->post_flows_actions_unlock: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow** | **String**| Flow ID |  |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_architect_ivr"></a>

## -[**IVR**](IVR.html) put_architect_ivr(ivr_id, opts)

Update an IVR Config.



Wraps PUT /api/v2/architect/ivrs/{ivrId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

ivr_id = "ivr_id_example" # String | IVR id

opts = { 
  body: PureCloud::IVR.new # IVR | 
}

begin
  #Update an IVR Config.
  result = api_instance.put_architect_ivr(ivr_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->put_architect_ivr: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ivr_id** | **String**| IVR id |  |
 **body** | [**IVR**](IVR.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**IVR**](IVR.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_architect_prompt"></a>

## -[**Prompt**](Prompt.html) put_architect_prompt(prompt_id, opts)

Update specified user prompt



Wraps PUT /api/v2/architect/prompts/{promptId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

opts = { 
  body: PureCloud::Prompt.new # Prompt | 
}

begin
  #Update specified user prompt
  result = api_instance.put_architect_prompt(prompt_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->put_architect_prompt: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **body** | [**Prompt**](Prompt.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**Prompt**](Prompt.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_architect_prompt_resource"></a>

## -[**PromptAsset**](PromptAsset.html) put_architect_prompt_resource(prompt_id, language_code, opts)

Update specified user prompt resource



Wraps PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

language_code = "language_code_example" # String | Language

opts = { 
  body: PureCloud::PromptAsset.new # PromptAsset | 
}

begin
  #Update specified user prompt resource
  result = api_instance.put_architect_prompt_resource(prompt_id, language_code, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->put_architect_prompt_resource: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **language_code** | **String**| Language |  |
 **body** | [**PromptAsset**](PromptAsset.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**PromptAsset**](PromptAsset.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_architect_schedule"></a>

## -[**Schedule**](Schedule.html) put_architect_schedule(schedule_id, opts)

Update schedule by ID



Wraps PUT /api/v2/architect/schedules/{scheduleId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

schedule_id = "schedule_id_example" # String | Schedule ID

opts = { 
  body: PureCloud::Schedule.new # Schedule | 
}

begin
  #Update schedule by ID
  result = api_instance.put_architect_schedule(schedule_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->put_architect_schedule: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_id** | **String**| Schedule ID |  |
 **body** | [**Schedule**](Schedule.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**Schedule**](Schedule.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_architect_schedulegroup"></a>

## -[**ScheduleGroup**](ScheduleGroup.html) put_architect_schedulegroup(schedule_group_id, opts)

Updates a schedule group by ID



Wraps PUT /api/v2/architect/schedulegroups/{scheduleGroupId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

schedule_group_id = "schedule_group_id_example" # String | Schedule group ID

opts = { 
  body: PureCloud::ScheduleGroup.new # ScheduleGroup | 
}

begin
  #Updates a schedule group by ID
  result = api_instance.put_architect_schedulegroup(schedule_group_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->put_architect_schedulegroup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **schedule_group_id** | **String**| Schedule group ID |  |
 **body** | [**ScheduleGroup**](ScheduleGroup.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**ScheduleGroup**](ScheduleGroup.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_architect_systemprompt_resource"></a>

## -[**SystemPromptAsset**](SystemPromptAsset.html) put_architect_systemprompt_resource(prompt_id, language_code, opts)

Updates a system prompt resource override.



Wraps PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

prompt_id = "prompt_id_example" # String | Prompt ID

language_code = "language_code_example" # String | Language

opts = { 
  body: PureCloud::SystemPromptAsset.new # SystemPromptAsset | 
}

begin
  #Updates a system prompt resource override.
  result = api_instance.put_architect_systemprompt_resource(prompt_id, language_code, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->put_architect_systemprompt_resource: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prompt_id** | **String**| Prompt ID |  |
 **language_code** | **String**| Language |  |
 **body** | [**SystemPromptAsset**](SystemPromptAsset.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**SystemPromptAsset**](SystemPromptAsset.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_flow"></a>

## -[**Flow**](Flow.html) put_flow(flow_id, opts)

Update flow



Wraps PUT /api/v2/flows/{flowId} 


### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# 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::ArchitectApi.new

flow_id = "flow_id_example" # String | Flow ID

opts = { 
  body: PureCloud::Flow.new # Flow | 
}

begin
  #Update flow
  result = api_instance.put_flow(flow_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ArchitectApi->put_flow: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **flow_id** | **String**| Flow ID |  |
 **body** | [**Flow**](Flow.html)|  | [optional]  |
{: class="table table-striped"}


### Return type

[**Flow**](Flow.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json