Class: Shipeasy::Admin::Generated::CreateUniverseRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/shipeasy_admin/models/create_universe_request.rb

Overview

Body for POST /api/admin/universes. Only name is required.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateUniverseRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 71

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::CreateUniverseRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::CreateUniverseRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'folder')
    self.folder = attributes[:'folder']
  end

  if attributes.key?(:'unit_type')
    self.unit_type = attributes[:'unit_type']
  else
    self.unit_type = 'user_id'
  end

  if attributes.key?(:'holdout_range')
    if (value = attributes[:'holdout_range']).is_a?(Array)
      self.holdout_range = value
    end
  else
    self.holdout_range = nil
  end
end

Instance Attribute Details

#folder ⇒ Object

Optional folder name used to group items in the dashboard. Part of the SDK lookup key: an item in folder checkout named new-cart is referenced as checkout/new-cart from the SDK.



23
24
25
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 23

def folder
  @folder
end

#holdout_range ⇒ Object

Inclusive [lo, hi] bucket range (0–9999) reserved as the holdout — callers hashed into this slice are excluded from every experiment in the universe. null disables the holdout. Pro plan or higher required.



29
30
31
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 29

def holdout_range
  @holdout_range
end

#name ⇒ Object

Stable universe key. Single segment or folder.name. Lowercase letters, digits, _ or -; max 128 chars. Immutable after create.



20
21
22
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 20

def name
  @name
end

#unit_type ⇒ Object

Unit of randomisation. Typically user_id. Use account_id to keep whole accounts in the same group across an experiment.



26
27
28
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 26

def unit_type
  @unit_type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



32
33
34
35
36
37
38
39
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 32

def self.attribute_map
  {
    :'name' => :'name',
    :'folder' => :'folder',
    :'unit_type' => :'unit_type',
    :'holdout_range' => :'holdout_range'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 251

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
67
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 62

def self.openapi_nullable
  Set.new([
    :'folder',
    :'holdout_range'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 52

def self.openapi_types
  {
    :'name' => :'String',
    :'folder' => :'String',
    :'unit_type' => :'String',
    :'holdout_range' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      folder == o.folder &&
      unit_type == o.unit_type &&
      holdout_range == o.holdout_range
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 244

def hash
  [name, folder, unit_type, holdout_range].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 112

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 128
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
  end

  pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

  if !@folder.nil? && @folder.to_s.length > 256
    invalid_properties.push('invalid value for "folder", the character length must be smaller than or equal to 256.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if !@folder.nil? && @folder !~ pattern
    invalid_properties.push("invalid value for \"folder\", must conform to the pattern #{pattern}.")
  end

  if @unit_type.nil?
    invalid_properties.push('invalid value for "unit_type", unit_type cannot be nil.')
  end

  if @holdout_range.length > 2
    invalid_properties.push('invalid value for "holdout_range", number of items must be less than or equal to 2.')
  end

  if @holdout_range.length < 2
    invalid_properties.push('invalid value for "holdout_range", number of items must be greater than or equal to 2.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 273

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/shipeasy_admin/models/create_universe_request.rb', line 154

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 128
  return false if @name !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
  return false if !@folder.nil? && @folder.to_s.length > 256
  return false if !@folder.nil? && @folder !~ Regexp.new(/^[a-zA-Z0-9_-]+$/)
  return false if @unit_type.nil?
  return false if @holdout_range.length > 2
  return false if @holdout_range.length < 2
  true
end