class RecombeeApiClient::UpdatePropertyBasedSegmentation

Updates a Property Based Segmentation

Attributes

description[R]
ensure_https[RW]
property_name[R]
segmentation_id[R]
timeout[RW]
title[R]

Public Class Methods

new(segmentation_id, optional = {}) click to toggle source
  • *Required arguments*

    • segmentation_id -> ID of the updated Segmentation

  • *Optional arguments (given as hash optional)*

    • propertyName -> Name of the property on which the Segmentation should be based

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

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

# File lib/recombee_api_client/api/update_property_based_segmentation.rb, line 29
def initialize(segmentation_id, optional = {})
  @segmentation_id = segmentation_id
  optional = normalize_optional(optional)
  @property_name = optional['propertyName']
  @title = optional['title']
  @description = optional['description']
  @optional = optional
  @timeout = 10000
  @ensure_https = false
  @optional.each do |par, _|
    fail UnknownOptionalParameter.new(par) unless ["propertyName","title","description"].include? par
  end
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/update_property_based_segmentation.rb, line 49
def body_parameters
  p = Hash.new
  p['propertyName'] = @optional['propertyName'] if @optional.include? 'propertyName'
  p['title'] = @optional['title'] if @optional.include? 'title'
  p['description'] = @optional['description'] if @optional.include? 'description'
  p
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/update_property_based_segmentation.rb, line 44
def method
  :post
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/update_property_based_segmentation.rb, line 65
def path
  "/{databaseId}/segmentations/property-based/#{@segmentation_id}"
end
query_parameters() click to toggle source

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

# File lib/recombee_api_client/api/update_property_based_segmentation.rb, line 59
def query_parameters
  params = {}
  params
end