Class: PureCloud::DataExtensionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/data_extensions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataExtensionsApi

Returns a new instance of DataExtensionsApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/data_extensions_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/data_extensions_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_dataextensions_coretype(coretype_name, opts = {}) ⇒ Coretype

Get a specific named core type.

Parameters:

  • coretype_name —

    The core type's name

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



32
33
34
35
 
# 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 = {}) ⇒ Array<(Coretype, Fixnum, Hash)>

Get a specific named core type.

Parameters:

  • coretype_name —

    The core type&#39;s name

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Coretype, Fixnum, Hash)>) —

    Coretype data, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# 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 = {}) ⇒ CoretypeListing

Get the core types from which all schemas are built.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



101
102
103
104
 
# 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 = {}) ⇒ Array<(CoretypeListing, Fixnum, Hash)>

Get the core types from which all schemas are built.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CoretypeListing, Fixnum, Hash)>) —

    CoretypeListing data, response status code and response headers



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# 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 = {}) ⇒ SchemaQuantityLimits

Get quantitative limits on schemas

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



156
157
158
159
 
# 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 = {}) ⇒ Array<(SchemaQuantityLimits, Fixnum, Hash)>

Get quantitative limits on schemas

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SchemaQuantityLimits, Fixnum, Hash)>) —

    SchemaQuantityLimits data, response status code and response headers



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# 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