Class: OsunyApi::CommunicationWebsitePageCategoryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/osuny_api/api/communication_website_page_category_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CommunicationWebsitePageCategoryApi

Returns a new instance of CommunicationWebsitePageCategoryApi.



16
17
18
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#communication_websites_website_id_pages_categories_get(website_id, opts = {}) ⇒ Array<CommunicationWebsitePageCategory>

Lists a website’s page categories

Parameters:

  • website_id —

    Website identifier

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

    the optional parameters

Options Hash (opts):

  • :page_num (Integer) —

    Page number (default to 1)

  • :per_page (Integer) —

    Number of items per page (default to 10000)

Returns:



25
26
27
28
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 25

def communication_websites_website_id_pages_categories_get(website_id, opts = {})
  data, _status_code, _headers = communication_websites_website_id_pages_categories_get_with_http_info(website_id, opts)
  data
end

#communication_websites_website_id_pages_categories_get_with_http_info(website_id, opts = {}) ⇒ Array<(Array<CommunicationWebsitePageCategory>, Integer, Hash)>

Lists a website&#x27;s page categories

Parameters:

  • website_id —

    Website identifier

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

    the optional parameters

Options Hash (opts):

  • :page_num (Integer) —

    Page number

  • :per_page (Integer) —

    Number of items per page

Returns:



36
37
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
76
77
78
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 36

def communication_websites_website_id_pages_categories_get_with_http_info(website_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_get ...'
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_get"
  end
  # resource path
  local_var_path = '/communication/websites/{website_id}/pages/categories'.sub('{' + 'website_id' + '}', website_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page_num'] = opts[:'page_num'] if !opts[:'page_num'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<CommunicationWebsitePageCategory>' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommunicationWebsitePageCategoryApi#communication_websites_website_id_pages_categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#communication_websites_website_id_pages_categories_id_delete(website_id, id, opts = {}) ⇒ nil

Deletes a page category

Parameters:

  • website_id —

    Website identifier

  • id —

    Category identifier

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

    the optional parameters

Returns:

  • (nil) 


84
85
86
87
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 84

def communication_websites_website_id_pages_categories_id_delete(website_id, id, opts = {})
  communication_websites_website_id_pages_categories_id_delete_with_http_info(website_id, id, opts)
  nil
end

#communication_websites_website_id_pages_categories_id_delete_with_http_info(website_id, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes a page category

Parameters:

  • website_id —

    Website identifier

  • id —

    Category identifier

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
130
131
132
133
134
135
136
137
138
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 94

def communication_websites_website_id_pages_categories_id_delete_with_http_info(website_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_delete ...'
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_delete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_delete"
  end
  # resource path
  local_var_path = '/communication/websites/{website_id}/pages/categories/{id}'.sub('{' + 'website_id' + '}', website_id.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommunicationWebsitePageCategoryApi#communication_websites_website_id_pages_categories_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#communication_websites_website_id_pages_categories_id_get(website_id, id, opts = {}) ⇒ nil

Shows a page category

Parameters:

  • website_id —

    Website identifier

  • id —

    Category identifier

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

    the optional parameters

Returns:

  • (nil) 


144
145
146
147
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 144

def communication_websites_website_id_pages_categories_id_get(website_id, id, opts = {})
  communication_websites_website_id_pages_categories_id_get_with_http_info(website_id, id, opts)
  nil
end

#communication_websites_website_id_pages_categories_id_get_with_http_info(website_id, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Shows a page category

Parameters:

  • website_id —

    Website identifier

  • id —

    Category identifier

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 154

def communication_websites_website_id_pages_categories_id_get_with_http_info(website_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_get ...'
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_get"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_get"
  end
  # resource path
  local_var_path = '/communication/websites/{website_id}/pages/categories/{id}'.sub('{' + 'website_id' + '}', website_id.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommunicationWebsitePageCategoryApi#communication_websites_website_id_pages_categories_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#communication_websites_website_id_pages_categories_id_patch(website_id, id, opts = {}) ⇒ nil

Updates a page category

Parameters:

  • website_id —

    Website identifier

  • id —

    Category identifier

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


205
206
207
208
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 205

def communication_websites_website_id_pages_categories_id_patch(website_id, id, opts = {})
  communication_websites_website_id_pages_categories_id_patch_with_http_info(website_id, id, opts)
  nil
end

#communication_websites_website_id_pages_categories_id_patch_with_http_info(website_id, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Updates a page category

Parameters:

  • website_id —

    Website identifier

  • id —

    Category identifier

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 216

def communication_websites_website_id_pages_categories_id_patch_with_http_info(website_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_patch ...'
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_patch"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_id_patch"
  end
  # resource path
  local_var_path = '/communication/websites/{website_id}/pages/categories/{id}'.sub('{' + 'website_id' + '}', website_id.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommunicationWebsitePageCategoryApi#communication_websites_website_id_pages_categories_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#communication_websites_website_id_pages_categories_post(website_id, opts = {}) ⇒ nil

Creates a page category

Parameters:

  • website_id —

    Website identifier

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


268
269
270
271
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 268

def communication_websites_website_id_pages_categories_post(website_id, opts = {})
  communication_websites_website_id_pages_categories_post_with_http_info(website_id, opts)
  nil
end

#communication_websites_website_id_pages_categories_post_with_http_info(website_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Creates a page category

Parameters:

  • website_id —

    Website identifier

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 278

def communication_websites_website_id_pages_categories_post_with_http_info(website_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_post ...'
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_post"
  end
  # resource path
  local_var_path = '/communication/websites/{website_id}/pages/categories'.sub('{' + 'website_id' + '}', website_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommunicationWebsitePageCategoryApi#communication_websites_website_id_pages_categories_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#communication_websites_website_id_pages_categories_upsert_post(website_id, opts = {}) ⇒ nil

Upsert page categories

Parameters:

  • website_id —

    Website identifier

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


326
327
328
329
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 326

def communication_websites_website_id_pages_categories_upsert_post(website_id, opts = {})
  communication_websites_website_id_pages_categories_upsert_post_with_http_info(website_id, opts)
  nil
end

#communication_websites_website_id_pages_categories_upsert_post_with_http_info(website_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upsert page categories

Parameters:

  • website_id —

    Website identifier

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/osuny_api/api/communication_website_page_category_api.rb', line 336

def communication_websites_website_id_pages_categories_upsert_post_with_http_info(website_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_upsert_post ...'
  end
  # verify the required parameter 'website_id' is set
  if @api_client.config.client_side_validation && website_id.nil?
    fail ArgumentError, "Missing the required parameter 'website_id' when calling CommunicationWebsitePageCategoryApi.communication_websites_website_id_pages_categories_upsert_post"
  end
  # resource path
  local_var_path = '/communication/websites/{website_id}/pages/categories/upsert'.sub('{' + 'website_id' + '}', website_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommunicationWebsitePageCategoryApi#communication_websites_website_id_pages_categories_upsert_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end