Class: Lockally::AliasesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lockally/api/aliases_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AliasesApi

Returns a new instance of AliasesApi.



19
20
21
 
# File 'lib/lockally/api/aliases_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/lockally/api/aliases_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_aliases_address_delete(address, opts = {}) ⇒ nil

Delete an alias Hard-delete (no soft-delete window — aliases are cheap to recreate).

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/lockally/api/aliases_api.rb', line 27

def v1_aliases_address_delete(address, opts = {})
  v1_aliases_address_delete_with_http_info(address, opts)
  nil
end

#v1_aliases_address_delete_with_http_info(address, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an alias Hard-delete (no soft-delete window — aliases are cheap to recreate).

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/lockally/api/aliases_api.rb', line 37

def v1_aliases_address_delete_with_http_info(address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AliasesApi.v1_aliases_address_delete ...'
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling AliasesApi.v1_aliases_address_delete"
  end
  # resource path
  local_var_path = '/v1/aliases/{address}'.sub('{address}', CGI.escape(address.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/problem+json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"AliasesApi.v1_aliases_address_delete",
    :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: AliasesApi#v1_aliases_address_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_aliases_get(opts = {}) ⇒ V1AliasesGet200Response

List aliases

Parameters:

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/lockally/api/aliases_api.rb', line 88

def v1_aliases_get(opts = {})
  data, _status_code, _headers = v1_aliases_get_with_http_info(opts)
  data
end

#v1_aliases_get_with_http_info(opts = {}) ⇒ Array<(V1AliasesGet200Response, Integer, Hash)>

List aliases

Parameters:

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

    the optional parameters

Returns:

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

    V1AliasesGet200Response data, response status code and response headers



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/lockally/api/aliases_api.rb', line 96

def v1_aliases_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AliasesApi.v1_aliases_get ...'
  end
  # resource path
  local_var_path = '/v1/aliases'

  # 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', 'application/problem+json']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"AliasesApi.v1_aliases_get",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AliasesApi#v1_aliases_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_aliases_post(v1_aliases_post_request, opts = {}) ⇒ ModelAlias

Create an alias Creates an email alias. alias_address must be on a verified tenant-owned domain. alias_target can be any email — intra-tenant or external (forwarding to a Gmail account is a legitimate use).

Parameters:

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/lockally/api/aliases_api.rb', line 145

def v1_aliases_post(v1_aliases_post_request, opts = {})
  data, _status_code, _headers = v1_aliases_post_with_http_info(v1_aliases_post_request, opts)
  data
end

#v1_aliases_post_with_http_info(v1_aliases_post_request, opts = {}) ⇒ Array<(ModelAlias, Integer, Hash)>

Create an alias Creates an email alias. `alias_address` must be on a verified tenant-owned domain. `alias_target` can be any email — intra-tenant or external (forwarding to a Gmail account is a legitimate use).

Parameters:

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

    the optional parameters

Returns:

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

    ModelAlias data, response status code and response headers



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
199
200
201
202
203
204
205
206
 
# File 'lib/lockally/api/aliases_api.rb', line 155

def v1_aliases_post_with_http_info(v1_aliases_post_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AliasesApi.v1_aliases_post ...'
  end
  # verify the required parameter 'v1_aliases_post_request' is set
  if @api_client.config.client_side_validation && v1_aliases_post_request.nil?
    fail ArgumentError, "Missing the required parameter 'v1_aliases_post_request' when calling AliasesApi.v1_aliases_post"
  end
  # resource path
  local_var_path = '/v1/aliases'

  # 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', 'application/problem+json']) unless header_params['Accept']
  # 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(v1_aliases_post_request)

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

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

  new_options = opts.merge(
    :operation => :"AliasesApi.v1_aliases_post",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AliasesApi#v1_aliases_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end