Class: Insion::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/Insion/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(token:, base_url: nil, max_retries: 2) ⇒ void

Parameters:

  • token (String)
  • base_url (String, nil) (defaults to: nil)
  • max_retries (Integer) (defaults to: 2) 


394
395
396
397
398
399
400
401
402
 
# File 'lib/Insion/client.rb', line 394

def initialize(token:, base_url: nil, max_retries: 2)
  @raw_client = Insion::Internal::Http::RawClient.new(
    base_url: base_url || Insion::Environment::DEFAULT,
    headers: {
      Authorization: "Bearer #{token}"
    },
    max_retries: max_retries
  )
end

Instance Method Details

#create_an_appeal(request_options: {}, **params) ⇒ Insion::Types::CreateAppealResponse

Create an appeal for a suspended user. Appeals must be enabled for the organization.

Examples:

client.create_an_appeal(
  user_id: "userId",
  text: "text"
)

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :user_id (String)

Returns:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/Insion/client.rb', line 362

def create_an_appeal(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  request_data = Insion::Types::PostAPIV1UsersUserIDCreateAppealRequest.new(params).to_h
  non_body_param_names = %w[userId]
  body = request_data.except(*non_body_param_names)

  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "api/v1/users/#{URI.encode_uri_component(params[:user_id].to_s)}/create_appeal",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::CreateAppealResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#delete_a_record(request_options: {}, **params) ⇒ Insion::Types::SuccessResponse

Remove a record from the moderation system by its client ID.

Examples:

client.delete_a_record(client_id: "clientId")

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/Insion/client.rb', line 104

def delete_a_record(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "DELETE",
    path: "api/v1/ingest",
    body: Insion::Types::DeleteAPIV1IngestRequest.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::SuccessResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#ingest_a_record(request_options: {}, **params) ⇒ Insion::Types::IngestRecordResponse

Create or update a content record for asynchronous moderation. Results are delivered through webhook events when moderation is performed.

Examples:

client.ingest_a_record(
  client_id: "clientId",
  name: "name",
  entity: "entity",
  content: "content"
)

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/Insion/client.rb', line 67

def ingest_a_record(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "api/v1/ingest",
    body: Insion::Types::RecordInput.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::IngestRecordResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#ingest_a_user(request_options: {}, **params) ⇒ Insion::Types::IngestUserResponse

Create or update a user without ingesting a record.

Examples:

client.ingest_a_user(client_id: "clientId")

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/Insion/client.rb', line 141

def ingest_a_user(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "api/v1/ingest/user",
    body: Insion::Types::UserInput.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::IngestUserResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#list_records(request_options: {}, **params) ⇒ Insion::Types::ListRecordsResponse

List the records belonging to the authenticated organization.

Examples:

client.list_records

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

Returns:



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
 
# File 'lib/Insion/client.rb', line 185

def list_records(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  query_params = {}
  query_params["limit"] = params[:limit] if params.key?(:limit)
  query_params["starting_after"] = params[:starting_after] if params.key?(:starting_after)
  query_params["ending_before"] = params[:ending_before] if params.key?(:ending_before)
  query_params["clientId"] = params[:client_id] if params.key?(:client_id)
  query_params["user"] = params[:user] if params.key?(:user)
  query_params["entity"] = params[:entity] if params.key?(:entity)
  query_params["status"] = params[:status] if params.key?(:status)

  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "api/v1/records",
    query: query_params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::ListRecordsResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#list_users(request_options: {}, **params) ⇒ Insion::Types::ListUsersResponse

List the users belonging to the authenticated organization.

Examples:

client.list_users

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :limit (Integer, nil)
  • :starting_after (String, nil)
  • :ending_before (String, nil)
  • :client_id (String, nil)
  • :email (String, nil)
  • :status (Insion::Types::GetAPIV1UsersRequestStatus, nil)
  • :user (String, nil)

Returns:



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/Insion/client.rb', line 275

def list_users(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  query_params = {}
  query_params["limit"] = params[:limit] if params.key?(:limit)
  query_params["starting_after"] = params[:starting_after] if params.key?(:starting_after)
  query_params["ending_before"] = params[:ending_before] if params.key?(:ending_before)
  query_params["clientId"] = params[:client_id] if params.key?(:client_id)
  query_params["email"] = params[:email] if params.key?(:email)
  query_params["status"] = params[:status] if params.key?(:status)
  query_params["user"] = params[:user] if params.key?(:user)

  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "api/v1/users",
    query: query_params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::ListUsersResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#moderate_a_record(request_options: {}, **params) ⇒ Insion::Types::ModerateResponse

Create or update a record and return its moderation result immediately.

Examples:

client.moderate_a_record(
  client_id: "clientId",
  name: "name",
  entity: "entity",
  content: "content"
)

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/Insion/client.rb', line 24

def moderate_a_record(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "api/v1/moderate",
    body: Insion::Types::ModerateRequest.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::ModerateResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#retrieve_a_record(request_options: {}, **params) ⇒ Insion::Types::RecordResponse

Retrieve one record by its Insion record ID.

Examples:

client.retrieve_a_record(record_id: "recordId")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :record_id (String)

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/Insion/client.rb', line 232

def retrieve_a_record(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "api/v1/records/#{URI.encode_uri_component(params[:record_id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::RecordResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#retrieve_a_user(request_options: {}, **params) ⇒ Insion::Types::UserResponse

Retrieve one user by its Insion user ID.

Examples:

client.retrieve_a_user(user_id: "userId")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :user_id (String)

Returns:



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/Insion/client.rb', line 322

def retrieve_a_user(request_options: {}, **params)
  params = Insion::Internal::Types::Utils.normalize_keys(params)
  request = Insion::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "api/v1/users/#{URI.encode_uri_component(params[:user_id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Insion::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Insion::Types::UserResponse.load(response.body)
  else
    error_class = Insion::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end