Class: CrelateClient::DomainApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crelate_client/api/domain_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainApi

Returns a new instance of DomainApi.



19
20
21
 
# File 'lib/crelate_client/api/domain_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/crelate_client/api/domain_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#public_api_get_document_types(api_key, opts = {}) ⇒ Array<PublicApiDocumentType>

returns a list of attachment types

Parameters:

  • api_key —

    crelate api_key

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/crelate_client/api/domain_api.rb', line 28

def public_api_get_document_types(api_key, opts = {})
  data, _status_code, _headers = public_api_get_document_types_with_http_info(api_key, opts)
  return data
end

#public_api_get_document_types_with_http_info(api_key, opts = {}) ⇒ Array<(Array<PublicApiDocumentType>, Fixnum, Hash)>

returns a list of attachment types

Parameters:

  • api_key —

    crelate api_key

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

    the optional parameters

Returns:

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

    Array<PublicApiDocumentType> data, response status code and response headers



38
39
40
41
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
 
# File 'lib/crelate_client/api/domain_api.rb', line 38

def public_api_get_document_types_with_http_info(api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DomainApi.public_api_get_document_types ..."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DomainApi.public_api_get_document_types"
  end
  # resource path
  local_var_path = "/api/pub/v1/domain/documentTypes"

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Array<PublicApiDocumentType>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#public_api_get_document_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_domain_category_tags(api_key, opts = {}) ⇒ Array<PublicApiTagCategory>

get category tags

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/crelate_client/api/domain_api.rb', line 82

def public_api_get_domain_category_tags(api_key, opts = {})
  data, _status_code, _headers = public_api_get_domain_category_tags_with_http_info(api_key, opts)
  return data
end

#public_api_get_domain_category_tags_with_http_info(api_key, opts = {}) ⇒ Array<(Array<PublicApiTagCategory>, Fixnum, Hash)>

get category tags

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

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

    Array<PublicApiTagCategory> data, response status code and response headers



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/crelate_client/api/domain_api.rb', line 92

def public_api_get_domain_category_tags_with_http_info(api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DomainApi.public_api_get_domain_category_tags ..."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DomainApi.public_api_get_domain_category_tags"
  end
  # resource path
  local_var_path = "/api/pub/v1/domain/tagCategories"

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Array<PublicApiTagCategory>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#public_api_get_domain_category_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_domain_workflow_statuses(api_key, opts = {}) ⇒ Array<PublicApiWorkflowStatus>

get workflow status information

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/crelate_client/api/domain_api.rb', line 136

def public_api_get_domain_workflow_statuses(api_key, opts = {})
  data, _status_code, _headers = public_api_get_domain_workflow_statuses_with_http_info(api_key, opts)
  return data
end

#public_api_get_domain_workflow_statuses_with_http_info(api_key, opts = {}) ⇒ Array<(Array<PublicApiWorkflowStatus>, Fixnum, Hash)>

get workflow status information

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

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

    Array<PublicApiWorkflowStatus> data, response status code and response headers



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/crelate_client/api/domain_api.rb', line 146

def public_api_get_domain_workflow_statuses_with_http_info(api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DomainApi.public_api_get_domain_workflow_statuses ..."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DomainApi.public_api_get_domain_workflow_statuses"
  end
  # resource path
  local_var_path = "/api/pub/v1/domain/workflowStatuses"

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Array<PublicApiWorkflowStatus>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#public_api_get_domain_workflow_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#public_api_get_domain_workflow_types(api_key, opts = {}) ⇒ Array<PublicApiWorkflowType>

get workflow types

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:



190
191
192
193
 
# File 'lib/crelate_client/api/domain_api.rb', line 190

def public_api_get_domain_workflow_types(api_key, opts = {})
  data, _status_code, _headers = public_api_get_domain_workflow_types_with_http_info(api_key, opts)
  return data
end

#public_api_get_domain_workflow_types_with_http_info(api_key, opts = {}) ⇒ Array<(Array<PublicApiWorkflowType>, Fixnum, Hash)>

get workflow types

Parameters:

  • api_key —

    crelate api key

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

    the optional parameters

Returns:

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

    Array<PublicApiWorkflowType> data, response status code and response headers



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/crelate_client/api/domain_api.rb', line 200

def public_api_get_domain_workflow_types_with_http_info(api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DomainApi.public_api_get_domain_workflow_types ..."
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DomainApi.public_api_get_domain_workflow_types"
  end
  # resource path
  local_var_path = "/api/pub/v1/domain/workflowTypes"

  # query parameters
  query_params = {}
  query_params[:'api_key'] = api_key

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'Array<PublicApiWorkflowType>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#public_api_get_domain_workflow_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end