Class: Fastly::AclEntryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/acl_entry_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AclEntryApi

Returns a new instance of AclEntryApi.



17
18
19
 
# File 'lib/fastly/api/acl_entry_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/acl_entry_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#bulk_update_acl_entries(opts = {}) ⇒ InlineResponse200

Update multiple ACL entries Update multiple ACL entries on the same ACL.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :acl_id (String) —

    Alphanumeric string identifying a ACL. (required)

  • :bulk_update_acl_entries_request (BulkUpdateAclEntriesRequest)

Returns:



26
27
28
29
 
# File 'lib/fastly/api/acl_entry_api.rb', line 26

def bulk_update_acl_entries(opts = {})
  data, _status_code, _headers = bulk_update_acl_entries_with_http_info(opts)
  data
end

#bulk_update_acl_entries_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Update multiple ACL entries Update multiple ACL entries on the same ACL.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :acl_id (String) —

    Alphanumeric string identifying a ACL. (required)

  • :bulk_update_acl_entries_request (BulkUpdateAclEntriesRequest)

Returns:

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

    InlineResponse200 data, response status code and response headers



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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/fastly/api/acl_entry_api.rb', line 37

def bulk_update_acl_entries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AclEntryApi.bulk_update_acl_entries ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  acl_id = opts[:'acl_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.bulk_update_acl_entries"
  end
  # verify the required parameter 'acl_id' is set
  if @api_client.config.client_side_validation && acl_id.nil?
    fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.bulk_update_acl_entries"
  end
  # resource path
  local_var_path = '/service/{service_id}/acl/{acl_id}/entries'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"AclEntryApi.bulk_update_acl_entries",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AclEntryApi#bulk_update_acl_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_acl_entry(opts = {}) ⇒ InlineResponse200

Delete an ACL entry Delete an ACL entry from a specified ACL.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :acl_id (String) —

    Alphanumeric string identifying a ACL. (required)

  • :acl_entry_id (String) —

    Alphanumeric string identifying an ACL Entry. (required)

Returns:



103
104
105
106
 
# File 'lib/fastly/api/acl_entry_api.rb', line 103

def delete_acl_entry(opts = {})
  data, _status_code, _headers = delete_acl_entry_with_http_info(opts)
  data
end

#delete_acl_entry_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete an ACL entry Delete an ACL entry from a specified ACL.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :acl_id (String) —

    Alphanumeric string identifying a ACL. (required)

  • :acl_entry_id (String) —

    Alphanumeric string identifying an ACL Entry. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/fastly/api/acl_entry_api.rb', line 114

def delete_acl_entry_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AclEntryApi.delete_acl_entry ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  acl_id = opts[:'acl_id']
  acl_entry_id = opts[:'acl_entry_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.delete_acl_entry"
  end
  # verify the required parameter 'acl_id' is set
  if @api_client.config.client_side_validation && acl_id.nil?
    fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.delete_acl_entry"
  end
  # verify the required parameter 'acl_entry_id' is set
  if @api_client.config.client_side_validation && acl_entry_id.nil?
    fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.delete_acl_entry"
  end
  # resource path
  local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"AclEntryApi.delete_acl_entry",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AclEntryApi#delete_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end