Class: DirectusSDK::SettingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/directus_sdk/api/settings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SettingsApi

Returns a new instance of SettingsApi.



19
20
21
 
# File 'lib/directus_sdk/api/settings_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/directus_sdk/api/settings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_settings(opts = {}) ⇒ GetSettings

Returns settings

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/directus_sdk/api/settings_api.rb', line 27

def get_settings(opts = {})
  data, _status_code, _headers = get_settings_with_http_info(opts)
  return data
end

#get_settings_for(collection_name, opts = {}) ⇒ GetSettingsFor

Returns settings for collection

Parameters:

  • collection_name —

    Name of collection to return settings for

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

    the optional parameters

Returns:



75
76
77
78
 
# File 'lib/directus_sdk/api/settings_api.rb', line 75

def get_settings_for(collection_name, opts = {})
  data, _status_code, _headers = get_settings_for_with_http_info(collection_name, opts)
  return data
end

#get_settings_for_with_http_info(collection_name, opts = {}) ⇒ Array<(GetSettingsFor, Fixnum, Hash)>

Returns settings for collection

Parameters:

  • collection_name —

    Name of collection to return settings for

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

    the optional parameters

Returns:

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

    GetSettingsFor data, response status code and response headers



85
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
 
# File 'lib/directus_sdk/api/settings_api.rb', line 85

def get_settings_for_with_http_info(collection_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SettingsApi.get_settings_for ..."
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling SettingsApi.get_settings_for"
  end
  # resource path
  local_var_path = "/settings/{collectionName}".sub('{' + 'collectionName' + '}', collection_name.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_settings_with_http_info(opts = {}) ⇒ Array<(GetSettings, Fixnum, Hash)>

Returns settings

Parameters:

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

    the optional parameters

Returns:

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

    GetSettings data, response status code and response headers



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
 
# File 'lib/directus_sdk/api/settings_api.rb', line 36

def get_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SettingsApi.get_settings ..."
  end
  # resource path
  local_var_path = "/settings"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_settings(collection_name, custom_data, opts = {}) ⇒ nil

Update settings

Parameters:

  • collection_name —

    Name of collection to return settings for

  • custom_data —

    Data based on your specific schema eg: active&#x3D;1&amp;title&#x3D;LoremIpsum

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

    the optional parameters

Returns:

  • (nil) 


129
130
131
132
 
# File 'lib/directus_sdk/api/settings_api.rb', line 129

def update_settings(collection_name, custom_data, opts = {})
  update_settings_with_http_info(collection_name, custom_data, opts)
  return nil
end

#update_settings_with_http_info(collection_name, custom_data, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update settings

Parameters:

  • collection_name —

    Name of collection to return settings for

  • custom_data —

    Data based on your specific schema eg: active&#x3D;1&amp;title&#x3D;LoremIpsum

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



140
141
142
143
144
145
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
 
# File 'lib/directus_sdk/api/settings_api.rb', line 140

def update_settings_with_http_info(collection_name, custom_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SettingsApi.update_settings ..."
  end
  # verify the required parameter 'collection_name' is set
  if @api_client.config.client_side_validation && collection_name.nil?
    fail ArgumentError, "Missing the required parameter 'collection_name' when calling SettingsApi.update_settings"
  end
  # verify the required parameter 'custom_data' is set
  if @api_client.config.client_side_validation && custom_data.nil?
    fail ArgumentError, "Missing the required parameter 'custom_data' when calling SettingsApi.update_settings"
  end
  # resource path
  local_var_path = "/settings/{collectionName}".sub('{' + 'collectionName' + '}', collection_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(custom_data)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#update_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end