class PureCloud::DataExtensionsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/purecloudplatformclientv2/api/data_extensions_api.rb, line 23
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_dataextensions_coretype(coretype_name, opts = {}) click to toggle source

Get a specific named core type.

@param coretype_name The core type's name @param [Hash] opts the optional parameters @return [Coretype]

# File lib/purecloudplatformclientv2/api/data_extensions_api.rb, line 32
def get_dataextensions_coretype(coretype_name, opts = {})
  data, _status_code, _headers = get_dataextensions_coretype_with_http_info(coretype_name, opts)
  return data
end
get_dataextensions_coretype_with_http_info(coretype_name, opts = {}) click to toggle source

Get a specific named core type.

@param coretype_name The core type&#39;s name @param [Hash] opts the optional parameters @return [Array<(Coretype, Fixnum, Hash)>] Coretype data, response status code and response headers

# File lib/purecloudplatformclientv2/api/data_extensions_api.rb, line 42
def get_dataextensions_coretype_with_http_info(coretype_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataExtensionsApi.get_dataextensions_coretype ..."
  end
  
  
  # verify the required parameter 'coretype_name' is set
  fail ArgumentError, "Missing the required parameter 'coretype_name' when calling DataExtensionsApi.get_dataextensions_coretype" if coretype_name.nil?
  
  # verify enum value
  unless ['text', 'longtext', 'url', 'identifier', 'enum', 'date', 'datetime', 'integer', 'number', 'checkbox', 'tag'].include?(coretype_name)
    fail ArgumentError, "invalid value for 'coretype_name', must be one of text, longtext, url, identifier, enum, date, datetime, integer, number, checkbox, tag"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/dataextensions/coretypes/{coretypeName}".sub('{format}','json').sub('{' + 'coretypeName' + '}', coretype_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 = 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 => 'Coretype')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataExtensionsApi#get_dataextensions_coretype\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_dataextensions_coretypes(opts = {}) click to toggle source

Get the core types from which all schemas are built.

@param [Hash] opts the optional parameters @return [CoretypeListing]

# File lib/purecloudplatformclientv2/api/data_extensions_api.rb, line 101
def get_dataextensions_coretypes(opts = {})
  data, _status_code, _headers = get_dataextensions_coretypes_with_http_info(opts)
  return data
end
get_dataextensions_coretypes_with_http_info(opts = {}) click to toggle source

Get the core types from which all schemas are built.

@param [Hash] opts the optional parameters @return [Array<(CoretypeListing, Fixnum, Hash)>] CoretypeListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/data_extensions_api.rb, line 110
def get_dataextensions_coretypes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataExtensionsApi.get_dataextensions_coretypes ..."
  end
  
  # resource path
  local_var_path = "/api/v2/dataextensions/coretypes".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 => 'CoretypeListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataExtensionsApi#get_dataextensions_coretypes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_dataextensions_limits(opts = {}) click to toggle source

Get quantitative limits on schemas

@param [Hash] opts the optional parameters @return [SchemaQuantityLimits]

# File lib/purecloudplatformclientv2/api/data_extensions_api.rb, line 156
def get_dataextensions_limits(opts = {})
  data, _status_code, _headers = get_dataextensions_limits_with_http_info(opts)
  return data
end
get_dataextensions_limits_with_http_info(opts = {}) click to toggle source

Get quantitative limits on schemas

@param [Hash] opts the optional parameters @return [Array<(SchemaQuantityLimits, Fixnum, Hash)>] SchemaQuantityLimits data, response status code and response headers

# File lib/purecloudplatformclientv2/api/data_extensions_api.rb, line 165
def get_dataextensions_limits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataExtensionsApi.get_dataextensions_limits ..."
  end
  
  # resource path
  local_var_path = "/api/v2/dataextensions/limits".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 => 'SchemaQuantityLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataExtensionsApi#get_dataextensions_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end