Class: OsunyApi::CommunicationWebsiteApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CommunicationWebsiteApi

Returns a new instance of CommunicationWebsiteApi.



16
17
18
 
# File 'lib/osuny_api/api/communication_website_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_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#communication_websites_get(opts = {}) ⇒ Array<CommunicationWebsite>

Lists the websites

Parameters:

  • 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:



24
25
26
27
 
# File 'lib/osuny_api/api/communication_website_api.rb', line 24

def communication_websites_get(opts = {})
  data, _status_code, _headers = communication_websites_get_with_http_info(opts)
  data
end

#communication_websites_get_with_http_info(opts = {}) ⇒ Array<(Array<CommunicationWebsite>, Integer, Hash)>

Lists the websites

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_num (Integer) —

    Page number

  • :per_page (Integer) —

    Number of items per page

Returns:

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

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



34
35
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
 
# File 'lib/osuny_api/api/communication_website_api.rb', line 34

def communication_websites_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsiteApi.communication_websites_get ...'
  end
  # resource path
  local_var_path = '/communication/websites'

  # 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<CommunicationWebsite>' 

  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: CommunicationWebsiteApi#communication_websites_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#communication_websites_id_get(id, opts = {}) ⇒ CommunicationWebsite

Shows a website

Parameters:

  • id —

    Website identifier

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/osuny_api/api/communication_website_api.rb', line 77

def communication_websites_id_get(id, opts = {})
  data, _status_code, _headers = communication_websites_id_get_with_http_info(id, opts)
  data
end

#communication_websites_id_get_with_http_info(id, opts = {}) ⇒ Array<(CommunicationWebsite, Integer, Hash)>

Shows a website

Parameters:

  • id —

    Website identifier

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

    the optional parameters

Returns:

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

    CommunicationWebsite data, response status code and response headers



86
87
88
89
90
91
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
 
# File 'lib/osuny_api/api/communication_website_api.rb', line 86

def communication_websites_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommunicationWebsiteApi.communication_websites_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 CommunicationWebsiteApi.communication_websites_id_get"
  end
  # resource path
  local_var_path = '/communication/websites/{id}'.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] || 'CommunicationWebsite' 

  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: CommunicationWebsiteApi#communication_websites_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end