class PureCloud::OrganizationApi
Attributes
Public Class Methods
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Fetch field config for an entity type
@param type Field type @param [Hash] opts the optional parameters @return [FieldConfig]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 32 def get_fieldconfig(type, opts = {}) data, _status_code, _headers = get_fieldconfig_with_http_info(type, opts) return data end
Fetch field config for an entity type
@param type Field type @param [Hash] opts the optional parameters @return [Array<(FieldConfig
, Fixnum, Hash)>] FieldConfig
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 42 def get_fieldconfig_with_http_info(type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.get_fieldconfig ..." end # verify the required parameter 'type' is set fail ArgumentError, "Missing the required parameter 'type' when calling OrganizationApi.get_fieldconfig" if type.nil? # verify enum value unless ['person', 'group', 'org', 'externalContact'].include?(type) fail ArgumentError, "invalid value for 'type', must be one of person, group, org, externalContact" end # resource path local_var_path = "/api/v2/fieldconfig".sub('{format}','json') # query parameters query_params = {} query_params[:'type'] = type # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FieldConfig') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#get_fieldconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get the list of domains that will be allowed to embed PureCloud
applications
@param [Hash] opts the optional parameters @return [EmbeddedIntegration]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 102 def get_organizations_embeddedintegration(opts = {}) data, _status_code, _headers = get_organizations_embeddedintegration_with_http_info(opts) return data end
Get the list of domains that will be allowed to embed PureCloud
applications
@param [Hash] opts the optional parameters @return [Array<(EmbeddedIntegration
, Fixnum, Hash)>] EmbeddedIntegration
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 111 def get_organizations_embeddedintegration_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.get_organizations_embeddedintegration ..." end # resource path local_var_path = "/api/v2/organizations/embeddedintegration".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EmbeddedIntegration') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#get_organizations_embeddedintegration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get organization IP address whitelist settings
@param [Hash] opts the optional parameters @return [IpAddressAuthentication]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 157 def get_organizations_ipaddressauthentication(opts = {}) data, _status_code, _headers = get_organizations_ipaddressauthentication_with_http_info(opts) return data end
Get organization IP address whitelist settings
@param [Hash] opts the optional parameters @return [Array<(IpAddressAuthentication
, Fixnum, Hash)>] IpAddressAuthentication
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 166 def get_organizations_ipaddressauthentication_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.get_organizations_ipaddressauthentication ..." end # resource path local_var_path = "/api/v2/organizations/ipaddressauthentication".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'IpAddressAuthentication') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#get_organizations_ipaddressauthentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get organization.
@param [Hash] opts the optional parameters @return [Organization]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 212 def get_organizations_me(opts = {}) data, _status_code, _headers = get_organizations_me_with_http_info(opts) return data end
Get organization.
@param [Hash] opts the optional parameters @return [Array<(Organization
, Fixnum, Hash)>] Organization
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 221 def get_organizations_me_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.get_organizations_me ..." end # resource path local_var_path = "/api/v2/organizations/me".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Organization') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#get_organizations_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Use PUT /api/v2/organizations/embeddedintegration instead
@param [Hash] opts the optional parameters @return [OrgWhitelistSettings]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 267 def get_organizations_whitelist(opts = {}) data, _status_code, _headers = get_organizations_whitelist_with_http_info(opts) return data end
Use PUT /api/v2/organizations/embeddedintegration instead
@param [Hash] opts the optional parameters @return [Array<(OrgWhitelistSettings
, Fixnum, Hash)>] OrgWhitelistSettings
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 276 def get_organizations_whitelist_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.get_organizations_whitelist ..." end # resource path local_var_path = "/api/v2/organizations/whitelist".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OrgWhitelistSettings') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#get_organizations_whitelist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update organization
@param feature_name Organization
feature @param enabled New state of feature @param [Hash] opts the optional parameters @return [OrganizationFeatures]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 324 def patch_organizations_feature(feature_name, enabled, opts = {}) data, _status_code, _headers = patch_organizations_feature_with_http_info(feature_name, enabled, opts) return data end
Update organization
@param feature_name Organization
feature @param enabled New state of feature @param [Hash] opts the optional parameters @return [Array<(OrganizationFeatures
, Fixnum, Hash)>] OrganizationFeatures
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 335 def patch_organizations_feature_with_http_info(feature_name, enabled, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.patch_organizations_feature ..." end # verify the required parameter 'feature_name' is set fail ArgumentError, "Missing the required parameter 'feature_name' when calling OrganizationApi.patch_organizations_feature" if feature_name.nil? # verify enum value unless ['realtimeCIC', 'purecloud', 'hipaa', 'ucEnabled', 'pci', 'purecloudVoice', 'xmppFederation', 'chat', 'informalPhotos', 'directory', 'contactCenter', 'unifiedCommunications', 'custserv'].include?(feature_name) fail ArgumentError, "invalid value for 'feature_name', must be one of realtimeCIC, purecloud, hipaa, ucEnabled, pci, purecloudVoice, xmppFederation, chat, informalPhotos, directory, contactCenter, unifiedCommunications, custserv" end # verify the required parameter 'enabled' is set fail ArgumentError, "Missing the required parameter 'enabled' when calling OrganizationApi.patch_organizations_feature" if enabled.nil? # resource path local_var_path = "/api/v2/organizations/features/{featureName}".sub('{format}','json').sub('{' + 'featureName' + '}', feature_name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(enabled) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OrganizationFeatures') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#patch_organizations_feature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update the list of domains that will be allowed to embed PureCloud
applications
@param body Whitelist settings @param [Hash] opts the optional parameters @return [EmbeddedIntegration]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 403 def put_organizations_embeddedintegration(body, opts = {}) data, _status_code, _headers = put_organizations_embeddedintegration_with_http_info(body, opts) return data end
Update the list of domains that will be allowed to embed PureCloud
applications
@param body Whitelist settings @param [Hash] opts the optional parameters @return [Array<(EmbeddedIntegration
, Fixnum, Hash)>] EmbeddedIntegration
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 413 def put_organizations_embeddedintegration_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.put_organizations_embeddedintegration ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.put_organizations_embeddedintegration" if body.nil? # resource path local_var_path = "/api/v2/organizations/embeddedintegration".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EmbeddedIntegration') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#put_organizations_embeddedintegration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update organization IP address whitelist settings
@param body IP address Whitelist settings @param [Hash] opts the optional parameters @return [IpAddressAuthentication]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 468 def put_organizations_ipaddressauthentication(body, opts = {}) data, _status_code, _headers = put_organizations_ipaddressauthentication_with_http_info(body, opts) return data end
Update organization IP address whitelist settings
@param body IP address Whitelist settings @param [Hash] opts the optional parameters @return [Array<(IpAddressAuthentication
, Fixnum, Hash)>] IpAddressAuthentication
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 478 def put_organizations_ipaddressauthentication_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.put_organizations_ipaddressauthentication ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.put_organizations_ipaddressauthentication" if body.nil? # resource path local_var_path = "/api/v2/organizations/ipaddressauthentication".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'IpAddressAuthentication') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#put_organizations_ipaddressauthentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update organization.
@param [Hash] opts the optional parameters @option opts [Organization] :body Organization
@return [Organization]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 533 def put_organizations_me(opts = {}) data, _status_code, _headers = put_organizations_me_with_http_info(opts) return data end
Update organization.
@param [Hash] opts the optional parameters @option opts [Organization] :body Organization
@return [Array<(Organization
, Fixnum, Hash)>] Organization
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 543 def put_organizations_me_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.put_organizations_me ..." end # resource path local_var_path = "/api/v2/organizations/me".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Organization') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#put_organizations_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Use PUT /api/v2/organizations/embeddedintegration instead
@param body Whitelist settings @param [Hash] opts the optional parameters @return [OrgWhitelistSettings]
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 596 def put_organizations_whitelist(body, opts = {}) data, _status_code, _headers = put_organizations_whitelist_with_http_info(body, opts) return data end
Use PUT /api/v2/organizations/embeddedintegration instead
@param body Whitelist settings @param [Hash] opts the optional parameters @return [Array<(OrgWhitelistSettings
, Fixnum, Hash)>] OrgWhitelistSettings
data, response status code and response headers
# File lib/purecloudplatformclientv2/api/organization_api.rb, line 606 def put_organizations_whitelist_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationApi.put_organizations_whitelist ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationApi.put_organizations_whitelist" if body.nil? # resource path local_var_path = "/api/v2/organizations/whitelist".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud OAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OrgWhitelistSettings') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationApi#put_organizations_whitelist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end