Class: RecombeeApiClient::DeleteSegmentation

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

Overview

Delete existing Segmentation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_hash_to_camel_case

Constructor Details

#initialize(segmentation_id) ⇒ DeleteSegmentation

  • *Required arguments*

    • segmentation_id -> ID of the Segmentation that should be deleted



20
21
22
23
24
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 20

def initialize(segmentation_id)
  @segmentation_id = segmentation_id
  @timeout = 10_000
  @ensure_https = false
end

Instance Attribute Details

#ensure_httpsObject

Returns the value of attribute ensure_https.



14
15
16
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 14

def ensure_https
  @ensure_https
end

#segmentation_idObject (readonly)

Returns the value of attribute segmentation_id.



13
14
15
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 13

def segmentation_id
  @segmentation_id
end

#timeoutObject

Returns the value of attribute timeout.



14
15
16
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 14

def timeout
  @timeout
end

Instance Method Details

#body_parametersObject

Values of body parameters as a Hash



32
33
34
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 32

def body_parameters
  {}
end

#methodObject

HTTP method



27
28
29
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 27

def method
  :delete
end

#pathObject

Relative path to the endpoint



43
44
45
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 43

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

#query_parametersObject

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



38
39
40
# File 'lib/recombee_api_client/api/delete_segmentation.rb', line 38

def query_parameters
  {}
end