Class: AgentPushKit::CustomerAccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/agent_push_kit/api/customer_accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomerAccountsApi

Returns a new instance of CustomerAccountsApi.



19
20
21
 
# File 'lib/agent_push_kit/api/customer_accounts_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/agent_push_kit/api/customer_accounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_organization_member(organization_id, add_member_input, opts = {}) ⇒ Membership

Add an already-registered user to a customer account

Parameters:

  • organization_id (String)
  • add_member_input (AddMemberInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 27

def add_organization_member(organization_id, add_member_input, opts = {})
  data, _status_code, _headers = add_organization_member_with_http_info(organization_id, add_member_input, opts)
  data
end

#add_organization_member_with_http_info(organization_id, add_member_input, opts = {}) ⇒ Array<(Membership, Integer, Hash)>

Add an already-registered user to a customer account

Parameters:

  • organization_id (String)
  • add_member_input (AddMemberInput)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Membership 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
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 37

def add_organization_member_with_http_info(organization_id, add_member_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerAccountsApi.add_organization_member ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling CustomerAccountsApi.add_organization_member"
  end
  # verify the required parameter 'add_member_input' is set
  if @api_client.config.client_side_validation && add_member_input.nil?
    fail ArgumentError, "Missing the required parameter 'add_member_input' when calling CustomerAccountsApi.add_organization_member"
  end
  # resource path
  local_var_path = '/organizations/{organizationId}/members'.sub('{organizationId}', CGI.escape(organization_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']) 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(add_member_input)

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

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

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

#create_organization(create_organization_input, opts = {}) ⇒ OrganizationCreated

Create another Agent Push Kit customer account

Parameters:

Returns:



98
99
100
101
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 98

def create_organization(create_organization_input, opts = {})
  data, _status_code, _headers = create_organization_with_http_info(create_organization_input, opts)
  data
end

#create_organization_with_http_info(create_organization_input, opts = {}) ⇒ Array<(OrganizationCreated, Integer, Hash)>

Create another Agent Push Kit customer account

Parameters:

Returns:

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

    OrganizationCreated data, response status code and response headers



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 107

def create_organization_with_http_info(create_organization_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerAccountsApi.create_organization ...'
  end
  # verify the required parameter 'create_organization_input' is set
  if @api_client.config.client_side_validation && create_organization_input.nil?
    fail ArgumentError, "Missing the required parameter 'create_organization_input' when calling CustomerAccountsApi.create_organization"
  end
  # resource path
  local_var_path = '/organizations'

  # 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']) 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(create_organization_input)

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

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

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

#list_organization_members(organization_id, opts = {}) ⇒ Array<Membership>

List members of a customer account

Parameters:

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 164

def list_organization_members(organization_id, opts = {})
  data, _status_code, _headers = list_organization_members_with_http_info(organization_id, opts)
  data
end

#list_organization_members_with_http_info(organization_id, opts = {}) ⇒ Array<(Array<Membership>, Integer, Hash)>

List members of a customer account

Parameters:

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



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
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 173

def list_organization_members_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerAccountsApi.list_organization_members ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling CustomerAccountsApi.list_organization_members"
  end
  # resource path
  local_var_path = '/organizations/{organizationId}/members'.sub('{organizationId}', CGI.escape(organization_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']) 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] || 'Array<Membership>'

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

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

#list_organizations(opts = {}) ⇒ Array<Organization>

List customer accounts available to the current user

Parameters:

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 224

def list_organizations(opts = {})
  data, _status_code, _headers = list_organizations_with_http_info(opts)
  data
end

#list_organizations_with_http_info(opts = {}) ⇒ Array<(Array<Organization>, Integer, Hash)>

List customer accounts available to the current user

Parameters:

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



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
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 232

def list_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerAccountsApi.list_organizations ...'
  end
  # resource path
  local_var_path = '/organizations'

  # 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']) 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] || 'Array<Organization>'

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

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

#regenerate_organization_api_key(organization_id, opts = {}) ⇒ OrganizationApiKeyCreated

Rotate the application event-ingestion key The previous apk_ key stops working immediately. The replacement is returned only in this response.

Parameters:

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 281

def regenerate_organization_api_key(organization_id, opts = {})
  data, _status_code, _headers = regenerate_organization_api_key_with_http_info(organization_id, opts)
  data
end

#regenerate_organization_api_key_with_http_info(organization_id, opts = {}) ⇒ Array<(OrganizationApiKeyCreated, Integer, Hash)>

Rotate the application event-ingestion key The previous `apk_` key stops working immediately. The replacement is returned only in this response.

Parameters:

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

    the optional parameters

Returns:

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

    OrganizationApiKeyCreated data, response status code and response headers



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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/agent_push_kit/api/customer_accounts_api.rb', line 291

def regenerate_organization_api_key_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerAccountsApi.regenerate_organization_api_key ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling CustomerAccountsApi.regenerate_organization_api_key"
  end
  # resource path
  local_var_path = '/organizations/{organizationId}/api-key/regenerate'.sub('{organizationId}', CGI.escape(organization_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']) 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] || 'OrganizationApiKeyCreated'

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

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