Class: RecombeeApiClient::CreateManualReqlSegmentation

Inherits:
ApiRequest
  • Object
show all
Defined in:
lib/recombee_api_client/api/create_manual_reql_segmentation.rb

Overview

Segment the items using multiple ReQL filters.

Use the Add Manual ReQL Items Segment endpoint to create the individual segments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_hash_to_camel_case

Constructor Details

#initialize(segmentation_id, source_type, optional = {}) ⇒ CreateManualReqlSegmentation

  • Required arguments

    • segmentation_id -> ID of the newly created Segmentation
    • source_type -> What type of data should be segmented. Currently only items are supported.

  • Optional arguments (given as hash optional)

    • title -> Human-readable name that is shown in the Recombee Admin UI.

    • description -> Description that is shown in the Recombee Admin UI.



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 30

def initialize(segmentation_id, source_type, optional = {})
  @segmentation_id = segmentation_id
  @source_type = source_type
  optional = normalize_hash_to_camel_case(optional)
  @title = optional['title']
  @description = optional['description']
  @optional = optional
  @timeout = 10_000
  @ensure_https = false
  @optional.each do |par, _|
    raise UnknownOptionalParameter.new(par) unless %w[title description].include? par
  end
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



15
16
17
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 15

def description
  @description
end

#ensure_https ⇒ Object

Returns the value of attribute ensure_https.



16
17
18
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 16

def ensure_https
  @ensure_https
end

#segmentation_id ⇒ Object (readonly)

Returns the value of attribute segmentation_id.



15
16
17
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 15

def segmentation_id
  @segmentation_id
end

#source_type ⇒ Object (readonly)

Returns the value of attribute source_type.



15
16
17
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 15

def source_type
  @source_type
end

#timeout ⇒ Object

Returns the value of attribute timeout.



16
17
18
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 16

def timeout
  @timeout
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



15
16
17
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 15

def title
  @title
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



50
51
52
53
54
55
56
57
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 50

def body_parameters
  p = {}
  p['sourceType'] = @source_type
  p['title'] = @optional['title'] if @optional.include? 'title'
  p['description'] = @optional['description'] if @optional.include? 'description'

  p
end

#method ⇒ Object

HTTP method



45
46
47
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 45

def method
  :put
end

#path ⇒ Object

Relative path to the endpoint



66
67
68
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 66

def path
  "/{databaseId}/segmentations/manual-reql/#{@segmentation_id}"
end

#query_parameters ⇒ Object

Values of query parameters as a Hash. name of parameter => value of the parameter



61
62
63
 
# File 'lib/recombee_api_client/api/create_manual_reql_segmentation.rb', line 61

def query_parameters
  {}
end